diff --git a/src/editor/Editor.js b/src/editor/Editor.js index dbc956ac7c0..a1fa73b60d5 100644 --- a/src/editor/Editor.js +++ b/src/editor/Editor.js @@ -62,6 +62,7 @@ define(function (require, exports, module) { "use strict"; var CodeHintManager = require("editor/CodeHintManager"), + ProjectManager = require("project/ProjectManager"), Commands = require("command/Commands"), CommandManager = require("command/CommandManager"), Menus = require("command/Menus"), @@ -69,24 +70,16 @@ define(function (require, exports, module) { PreferencesManager = require("preferences/PreferencesManager"), Strings = require("strings"), TextRange = require("document/TextRange").TextRange, + CollectionUtils = require("utils/CollectionUtils"), TokenUtils = require("utils/TokenUtils"), ViewUtils = require("utils/ViewUtils"); var PREFERENCES_CLIENT_ID = "com.adobe.brackets.Editor", - defaultPrefs = { useTabChar: false, tabSize: 4, indentUnit: 4, closeBrackets: false }; + defaultPrefs = { closeBrackets: false }; /** Editor preferences */ var _prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, defaultPrefs); - /** @type {boolean} Global setting: When inserting new text, use tab characters? (instead of spaces) */ - var _useTabChar = _prefs.getValue("useTabChar"); - - /** @type {number} Global setting: Tab size */ - var _tabSize = _prefs.getValue("tabSize"); - - /** @type {number} Global setting: Indent unit (i.e. number of spaces when indenting) */ - var _indentUnit = _prefs.getValue("indentUnit"); - /** @type {boolean} Global setting: Auto closes (, {, [, " and ' */ var _closeBrackets = _prefs.getValue("closeBrackets"); @@ -143,7 +136,7 @@ define(function (require, exports, module) { if (instance.getOption("indentWithTabs")) { CodeMirror.commands.insertTab(instance); } else { - var i, ins = "", numSpaces = _indentUnit; + var i, ins = "", numSpaces = instance.getOption("indentUnit"); numSpaces -= to.ch % numSpaces; for (i = 0; i < numSpaces; i++) { ins += " "; @@ -164,12 +157,13 @@ define(function (require, exports, module) { function _handleSoftTabNavigation(instance, direction, functionName) { var handled = false; if (!instance.getOption("indentWithTabs")) { - var cursor = instance.getCursor(), - jump = cursor.ch % _indentUnit, + var indentUnit = instance.getOption("indentUnit"), + cursor = instance.getCursor(), + jump = cursor.ch % indentUnit, line = instance.getLine(cursor.line); if (direction === 1) { - jump = _indentUnit - jump; + jump = indentUnit - jump; if (cursor.ch + jump > line.length) { // Jump would go beyond current line return false; @@ -188,7 +182,7 @@ define(function (require, exports, module) { // If we are on the tab boundary, jump by the full amount, // but not beyond the start of the line. if (jump === 0) { - jump = _indentUnit; + jump = indentUnit; } // Search backwards to the first non-space character @@ -341,9 +335,9 @@ define(function (require, exports, module) { // (note: CodeMirror doesn't actually require using 'new', but jslint complains without it) this._codeMirror = new CodeMirror(container, { electricChars: false, // we use our own impl of this to avoid CodeMirror bugs; see _checkElectricChars() - indentWithTabs: _useTabChar, - tabSize: _tabSize, - indentUnit: _indentUnit, + indentWithTabs: this._getTabPreference("indentWithTabs"), + tabSize: this._getTabPreference("tabSize"), + indentUnit: this._getTabPreference("indentUnit"), lineNumbers: true, matchBrackets: true, dragDrop: false, // work around issue #1123 @@ -694,7 +688,7 @@ define(function (require, exports, module) { if (expandTabs) { var line = this._codeMirror.getRange({line: cursor.line, ch: 0}, cursor), - tabSize = Editor.getTabSize(), + tabSize = this.getTabSize(), column = 0, i; @@ -1253,6 +1247,68 @@ define(function (require, exports, module) { return this._codeMirror.getOption("mode"); }; + + /** + * @private + * Sets the given preference option to the current editor and saves it + * @param {string} preference + * @param {number|boolean} value + */ + Editor.prototype._setTabPreference = function (preference, value) { + this._codeMirror.setOption(preference, value); + _prefs.setValue(preference + "_" + this.document.file.fullPath, value); + }; + + /* + * @private + * Returns the value for the given preference key first checking with the file settings and then with the project settings + * @param {string} preference + * @return {number|boolean} + */ + Editor.prototype._getTabPreference = function (preference) { + var value = _prefs.getValue(preference + "_" + this.document.file.fullPath); + return value !== undefined ? value : ProjectManager.getTabSettings()[preference]; + }; + + /** + * Sets whether to use tab characters (vs. spaces) when inserting new text. + */ + Editor.prototype.setUseTabChar = function (value) { + this._setTabPreference("indentWithTabs", Boolean(value)); + }; + + /** @type {boolean} Gets whether all Editors use tab characters (vs. spaces) when inserting new text */ + Editor.prototype.getUseTabChar = function () { + return this._codeMirror.getOption("indentWithTabs"); + }; + + /** + * Sets the tab character width. + * @param {number} value + */ + Editor.prototype.setTabSize = function (value) { + this._setTabPreference("tabSize", value); + }; + + /** @type {number} Get indent unit */ + Editor.prototype.getTabSize = function (value) { + return this._codeMirror.getOption("tabSize"); + }; + + /** + * Sets the indentation width. + * @param {number} value + */ + Editor.prototype.setIndentUnit = function (value) { + this._setTabPreference("indentUnit", value); + }; + + /** @type {number} Get indentation width */ + Editor.prototype.getIndentUnit = function (value) { + return this._codeMirror.getOption("indentUnit"); + }; + + /** * The Document we're bound to * @type {!Document} @@ -1291,60 +1347,6 @@ define(function (require, exports, module) { // Global settings that affect all Editor instances (both currently open Editors as well as those created // in the future) - /** - * Sets whether to use tab characters (vs. spaces) when inserting new text. Affects all Editors. - * @param {boolean} value - */ - Editor.setUseTabChar = function (value) { - _useTabChar = value; - _instances.forEach(function (editor) { - editor._codeMirror.setOption("indentWithTabs", _useTabChar); - }); - - _prefs.setValue("useTabChar", Boolean(_useTabChar)); - }; - - /** @type {boolean} Gets whether all Editors use tab characters (vs. spaces) when inserting new text */ - Editor.getUseTabChar = function () { - return _useTabChar; - }; - - /** - * Sets tab character width. Affects all Editors. - * @param {number} value - */ - Editor.setTabSize = function (value) { - _tabSize = value; - _instances.forEach(function (editor) { - editor._codeMirror.setOption("tabSize", _tabSize); - }); - - _prefs.setValue("tabSize", _tabSize); - }; - - /** @type {number} Get indent unit */ - Editor.getTabSize = function () { - return _tabSize; - }; - - /** - * Sets indentation width. Affects all Editors. - * @param {number} value - */ - Editor.setIndentUnit = function (value) { - _indentUnit = value; - _instances.forEach(function (editor) { - editor._codeMirror.setOption("indentUnit", _indentUnit); - }); - - _prefs.setValue("indentUnit", _indentUnit); - }; - - /** @type {number} Get indentation width */ - Editor.getIndentUnit = function () { - return _indentUnit; - }; - /** * Sets the auto close brackets. Affects all Editors. * @param {boolean} value @@ -1363,6 +1365,25 @@ define(function (require, exports, module) { return _closeBrackets; }; + + /** + * Changes the Tab Settings of all the opened editors within the project with no saved tab preferences after a + * tab preference change and triggers a StatusBar update + */ + Editor.setProjectTabs = function () { + var preferences = ProjectManager.getTabSettings(); + _instances.forEach(function (editor) { + if (ProjectManager.isWithinProject(editor.document.file.fullPath)) { + CollectionUtils.forEach(preferences, function (value, key) { + if (_prefs.getValue(key + "_" + editor.document.file.fullPath) === undefined) { + editor._codeMirror.setOption(key, value); + } + }); + } + }); + }; + + // Define public API exports.Editor = Editor; exports.BOUNDARY_CHECK_NORMAL = BOUNDARY_CHECK_NORMAL; diff --git a/src/editor/EditorStatusBar.js b/src/editor/EditorStatusBar.js index f02e18405e8..ffee2e8ed11 100644 --- a/src/editor/EditorStatusBar.js +++ b/src/editor/EditorStatusBar.js @@ -58,14 +58,15 @@ define(function (require, exports, module) { } function _updateIndentType() { - var indentWithTabs = Editor.getUseTabChar(); + var indentWithTabs = EditorManager.getActiveEditor().getUseTabChar(); $indentType.text(indentWithTabs ? Strings.STATUSBAR_TAB_SIZE : Strings.STATUSBAR_SPACES); $indentType.attr("title", indentWithTabs ? Strings.STATUSBAR_INDENT_TOOLTIP_SPACES : Strings.STATUSBAR_INDENT_TOOLTIP_TABS); $indentWidthLabel.attr("title", indentWithTabs ? Strings.STATUSBAR_INDENT_SIZE_TOOLTIP_TABS : Strings.STATUSBAR_INDENT_SIZE_TOOLTIP_SPACES); } function _getIndentSize() { - return Editor.getUseTabChar() ? Editor.getTabSize() : Editor.getIndentUnit(); + var editor = EditorManager.getActiveEditor(); + return editor.getUseTabChar() ? editor.getTabSize() : editor.getIndentUnit(); } function _updateIndentSize() { @@ -75,7 +76,8 @@ define(function (require, exports, module) { } function _toggleIndentType() { - Editor.setUseTabChar(!Editor.getUseTabChar()); + var editor = EditorManager.getActiveEditor(); + editor.setUseTabChar(!editor.getUseTabChar()); _updateIndentType(); _updateIndentSize(); } @@ -103,10 +105,11 @@ define(function (require, exports, module) { return; } - if (Editor.getUseTabChar()) { - Editor.setTabSize(Math.max(Math.min(value, 10), 1)); + var editor = EditorManager.getActiveEditor(); + if (editor.getUseTabChar()) { + editor.setTabSize(Math.max(Math.min(value, 10), 1)); } else { - Editor.setIndentUnit(Math.max(Math.min(value, 10), 1)); + editor.setIndentUnit(Math.max(Math.min(value, 10), 1)); } // update indicator @@ -177,9 +180,22 @@ define(function (require, exports, module) { _onActiveEditorChange(null, EditorManager.getActiveEditor(), null); } - + + /** + * Updates the Editors tab settings and the StatusBar content + */ + function updateProjectTabs() { + Editor.setProjectTabs(); + _updateIndentType(); + _updateIndentSize(); + } + + // Initialize: status bar focused listener $(EditorManager).on("activeEditorChange", _onActiveEditorChange); AppInit.htmlReady(_init); + + + exports.updateProjectTabs = updateProjectTabs; }); diff --git a/src/htmlContent/project-settings-dialog.html b/src/htmlContent/project-settings-dialog.html index 37d6d5c3161..3d6e2dcb1f3 100644 --- a/src/htmlContent/project-settings-dialog.html +++ b/src/htmlContent/project-settings-dialog.html @@ -1,11 +1,23 @@
-

+

{{title}}

- + + {{#errorMessage}}
{{errorMessage}}
{{/errorMessage}}
+ {{#tabSettings}} +
+ {{PROJECT_SETTING_TABS}}: + + {{#indentWithTabs}}{{/indentWithTabs}} + {{^indentWithTabs}}{{/indentWithTabs}} +
+ {{/tabSettings}}
{{CANCEL}} diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js index 5700321c66b..5ca87478a93 100644 --- a/src/nls/root/strings.js +++ b/src/nls/root/strings.js @@ -290,6 +290,7 @@ define({ "PROJECT_SETTINGS_TITLE" : "Project Settings for: {0}", "PROJECT_SETTING_BASE_URL" : "Live Preview Base URL", "PROJECT_SETTING_BASE_URL_HINT" : "(to use a local server, specify url)", + "PROJECT_SETTING_TABS" : "Project Tabs Settings", "BASEURL_ERROR_INVALID_PROTOCOL" : "The {0} protocol isn't supported by Live Preview—please use http: or https: .", "BASEURL_ERROR_SEARCH_DISALLOWED" : "The base URL can't contain search parameters like \"{0}\".", "BASEURL_ERROR_HASH_DISALLOWED" : "The base URL can't contain hashes like \"{0}\".", diff --git a/src/preferences/PreferencesDialogs.js b/src/preferences/PreferencesDialogs.js index fed8dae2306..34b42f6ad17 100644 --- a/src/preferences/PreferencesDialogs.js +++ b/src/preferences/PreferencesDialogs.js @@ -76,55 +76,53 @@ define(function (require, exports, module) { * Show a dialog that shows the project preferences * @param {String} baseUrl - initial value * @param {String} errorMessage - error to display + * @param {?{indentWithTabs: boolean, tabSize: number, indentUnit: number}} tabSettings * @return {$.Promise} A promise object that will be resolved when user successfully enters * project settings and clicks OK, or rejected if user clicks Cancel. */ - function showProjectPreferencesDialog(baseUrl, errorMessage) { - + function showProjectPreferencesDialog(baseUrl, errorMessage, tabSettings) { var $dlg, - $title, $baseUrlControl, promise; - - promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, Strings)) + + // Title + var projectName = "", + projectRoot = ProjectManager.getProjectRoot(), + title; + if (projectRoot) { + projectName = projectRoot.name; + } + title = StringUtils.format(Strings.PROJECT_SETTINGS_TITLE, projectName); + + var templateVars = $.extend(Strings, { + title : title, + baseUrl : baseUrl, + errorMessage : errorMessage, + tabSettings : tabSettings + }); + + promise = Dialogs.showModalDialogUsingTemplate(Mustache.render(SettingsDialogTemplate, templateVars)) .done(function (id) { if (id === Dialogs.DIALOG_BTN_OK) { var baseUrlValue = $baseUrlControl.val(); var result = _validateBaseUrl(baseUrlValue); + + var indentType = $dlg.find(".indent-type").val(); + var indentUnit = $dlg.find(".indent-size").val(); + if (result === "") { ProjectManager.setBaseUrl(baseUrlValue); + ProjectManager.setTabSettings(indentType === "tabs", indentUnit); } else { // Re-invoke dialog with result (error message) - showProjectPreferencesDialog(baseUrlValue, result); + showProjectPreferencesDialog(baseUrlValue, result, tabSettings); } } }); - - // Populate project settings + $dlg = $(".project-settings-dialog.instance"); - - // Title - $title = $dlg.find(".dialog-title"); - var projectName = "", - projectRoot = ProjectManager.getProjectRoot(), - title; - if (projectRoot) { - projectName = projectRoot.name; - } - title = StringUtils.format(Strings.PROJECT_SETTINGS_TITLE, projectName); - $title.text(title); - - // Base URL $baseUrlControl = $dlg.find(".base-url"); - if (baseUrl) { - $baseUrlControl.val(baseUrl); - } - - // Error message - if (errorMessage) { - $dlg.find(".settings-list").append("
" + errorMessage + "
"); - } - + // Give focus to first control $baseUrlControl.focus(); diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js index dbb19537e24..efdbbc39859 100644 --- a/src/project/ProjectManager.js +++ b/src/project/ProjectManager.js @@ -53,6 +53,7 @@ define(function (require, exports, module) { PreferencesDialogs = require("preferences/PreferencesDialogs"), PreferencesManager = require("preferences/PreferencesManager"), DocumentManager = require("document/DocumentManager"), + EditorStatusBar = require("editor/EditorStatusBar"), CommandManager = require("command/CommandManager"), Commands = require("command/Commands"), Dialogs = require("widgets/Dialogs"), @@ -68,6 +69,9 @@ define(function (require, exports, module) { Urls = require("i18n!nls/urls"), KeyEvent = require("utils/KeyEvent"); + /** @const The default values of the project Tab Settings */ + var DEFAULT_TAB_SETTINGS = {indentWithTabs: false, tabSize: 4, indentUnit: 4}; + /** * @private * Reference to the tree control container div. Initialized by @@ -125,6 +129,12 @@ define(function (require, exports, module) { * @ see getBaseUrl(), setBaseUrl() */ var _projectBaseUrl = ""; + + /** + * @private + * @ see getTabSettings(), setTabSettings() + */ + var _projectTabSettings = ""; /** * Unique PreferencesManager clientID @@ -260,6 +270,47 @@ define(function (require, exports, module) { _prefs.setValue(_getBaseUrlKey(), _projectBaseUrl); } + /** + * @private + */ + function _getTabsSettingsKey() { + return "projectTabSettings_" + _projectRoot; + } + + /** + * @private + * Sets the project Tab Settings to the saved values or the default ones + */ + function _loadTabSettings() { + _projectTabSettings = $.extend(_projectTabSettings, _prefs.getValue(_getTabsSettingsKey()) || DEFAULT_TAB_SETTINGS); + } + + /** + * Returns the Tab Settings of the currently loaded project, or null if no project + * is open (during startup, or running outside of app shell). + * @return {?{indentWithTabs: boolean, tabSize: number, indentUnit: number}} + */ + function getTabSettings() { + return _projectTabSettings; + } + + /** + * Sets the Tab Settings of the currently loaded project. + * @param {boolean} indentWithTabs + * @param {number} indentSize + */ + function setTabSettings(indentWithTabs, indentSize) { + indentSize = Math.max(Math.min(indentSize, 10), 1); + _projectTabSettings = { + indentWithTabs: indentWithTabs, + tabSize: indentWithTabs ? indentSize : _projectTabSettings.tabSize, + indentUnit: !indentWithTabs ? indentSize : _projectTabSettings.indentUnit + }; + + _prefs.setValue(_getTabsSettingsKey(), _projectTabSettings); + EditorStatusBar.updateProjectTabs(); + } + /** * Returns true if absPath lies within the project, false otherwise. * Does not support paths containing ".." @@ -778,6 +829,7 @@ define(function (require, exports, module) { _projectRoot = rootEntry; _projectBaseUrl = _prefs.getValue(_getBaseUrlKey()) || ""; + _loadTabSettings(); // If this is the current welcome project, record it. In future launches, we always // want to substitute the welcome project for the current build instead of using an @@ -978,7 +1030,7 @@ define(function (require, exports, module) { * Invoke project settings dialog. */ function _projectSettings() { - return PreferencesDialogs.showProjectPreferencesDialog(getBaseUrl()); + return PreferencesDialogs.showProjectPreferencesDialog(getBaseUrl(), null, getTabSettings()); } /** @@ -1379,6 +1431,8 @@ define(function (require, exports, module) { exports.getProjectRoot = getProjectRoot; exports.getBaseUrl = getBaseUrl; exports.setBaseUrl = setBaseUrl; + exports.getTabSettings = getTabSettings; + exports.setTabSettings = setTabSettings; exports.isWithinProject = isWithinProject; exports.makeProjectRelativeIfPossible = makeProjectRelativeIfPossible; exports.shouldShow = shouldShow; diff --git a/src/styles/brackets_patterns_override.less b/src/styles/brackets_patterns_override.less index 0cb4be69809..c1f7f44c113 100644 --- a/src/styles/brackets_patterns_override.less +++ b/src/styles/brackets_patterns_override.less @@ -433,6 +433,11 @@ margin: 10px; width: 300px; } + select.indent-type, input.indent-size { + display: inline; + margin: 10px; + width: 100px; + } } /* About dialog */