Merge pull request #8444 from adobe/pflynn/language-switcher-improvements

Language switcher: connect to prefs & clean up some code

Author: JeffryBooher

src/document/Document.js

@@ -65,6 +65,9 @@ define(function (require, exports, module) {
      *
      * __deleted__ -- When the file for this document has been deleted. All views onto the document should
      * be closed. The document will no longer be editable or dispatch "change" events.
+     * 
+     * __languageChanged__ -- When the value of getLanguage() has changed. 2nd argument is the old value,
+     * 3rd argument is the new value.
      *
      * @constructor
      * @param {!File} file  Need not lie within the project.
@@ -672,19 +675,7 @@ define(function (require, exports, module) {
     };
 
     /**
-     * Overrides the default language of this document and sets it to the given
-     * language. This change is not persisted if the document is closed.
-     * @param {?Language} language The language to be set for this document; if
-     * null, the language will be set back to the default.
-     */
-    Document.prototype.setLanguageOverride = function (language) {
-        LanguageManager._setLanguageOverrideForPath(this.file.fullPath, language);
-        this._updateLanguage();
-    };
-
-    /**
-     * Updates the language according to the file extension. If the current
-     * language was forced (set manually by user), don't change it.
+     * Updates the language to match the current mapping given by LanguageManager
      */
     Document.prototype._updateLanguage = function () {
         var oldLanguage = this.language;

src/editor/EditorStatusBar.js

@@ -38,8 +38,10 @@ define(function (require, exports, module) {
         DropdownButton               = require("widgets/DropdownButton").DropdownButton,
         EditorManager                = require("editor/EditorManager"),
         Editor                       = require("editor/Editor").Editor,
+        FileUtils                    = require("file/FileUtils"),
         KeyEvent                     = require("utils/KeyEvent"),
         LanguageManager              = require("language/LanguageManager"),
+        PreferencesManager           = require("preferences/PreferencesManager"),
         StatusBar                    = require("widgets/StatusBar"),
         Strings                      = require("strings"),
         StringUtils                  = require("utils/StringUtils");
@@ -53,6 +55,9 @@ define(function (require, exports, module) {
         $indentWidthInput,
         $statusOverwrite;
 
+    /** Special list item for the 'set as default' gesture in language switcher dropdown */
+    var LANGUAGE_SET_AS_DEFAULT = {};
+    
 
     /**
      * Determine string based on count
@@ -301,6 +306,9 @@ define(function (require, exports, module) {
 
         languageSelect.items = languages;
 
+        // Add option to top of menu for persisting the override
+        languageSelect.items.unshift("---");
+        languageSelect.items.unshift(LANGUAGE_SET_AS_DEFAULT);
     }
 
     /**
@@ -317,8 +325,14 @@ define(function (require, exports, module) {
 
         languageSelect      = new DropdownButton("", [], function (item, index) {
             var document = EditorManager.getActiveEditor().document,
-                defaultLang = LanguageManager.getLanguageForPath(document.file.fullPath, true),
-                html = _.escape(item.getName());
+                defaultLang = LanguageManager.getLanguageForPath(document.file.fullPath, true);
+            
+            if (item === LANGUAGE_SET_AS_DEFAULT) {
+                var label = _.escape(StringUtils.format(Strings.STATUSBAR_SET_DEFAULT_LANG, FileUtils.getSmartFileExtension(document.file.fullPath)));
+                return { html: label, enabled: document.getLanguage() !== defaultLang };
+            }
+            
+            var html = _.escape(item.getName());
 
             // Show indicators for currently selected & default languages for the current file
             if (item === defaultLang) {
@@ -363,13 +377,22 @@ define(function (require, exports, module) {
         $indentWidthInput.focus(function () { $indentWidthInput.select(); });
 
         // Language select change handler
-        $(languageSelect).on("select", function (e, lang, index) {
+        $(languageSelect).on("select", function (e, lang) {
             var document = EditorManager.getActiveEditor().document,
-                fullPath = document.file.fullPath,
-                defaultLang = LanguageManager.getLanguageForPath(fullPath, true);
-            // if default language selected, don't "force" it
-            // (passing in null will reset the force flag)
-            document.setLanguageOverride(lang === defaultLang ? null : lang);
+                fullPath = document.file.fullPath;
+            
+            if (lang === LANGUAGE_SET_AS_DEFAULT) {
+                // Set file's current language in preferences as a file extension override (only enabled if not default already)
+                var fileExtensionMap = PreferencesManager.get("language.fileExtensions");
+                fileExtensionMap[FileUtils.getSmartFileExtension(fullPath)] = document.getLanguage().getId();
+                PreferencesManager.set("language.fileExtensions", fileExtensionMap);
+                
+            } else {
+                // Set selected language as a path override for just this one file (not persisted)
+                var defaultLang = LanguageManager.getLanguageForPath(fullPath, true);
+                // if default language selected, pass null to clear the override
+                LanguageManager.setLanguageOverrideForPath(fullPath, lang === defaultLang ? null : lang);
+            }
         });
 
         $statusOverwrite.on("click", _updateEditorOverwriteMode);

src/extensibility/Package.js

@@ -41,7 +41,7 @@ define(function (require, exports, module) {
         NodeConnection       = require("utils/NodeConnection"),
         PreferencesManager   = require("preferences/PreferencesManager");
 
-    PreferencesManager.definePreference("proxy", "string");
+    PreferencesManager.definePreference("proxy", "string", undefined);
 
     var Errors = {
         ERROR_LOADING: "ERROR_LOADING",

src/extensions/default/JSLint/main.js

@@ -50,7 +50,7 @@ define(function (require, exports, module) {
      */
     var _lastRunOptions;
 
-    prefs.definePreference("options", "object")
+    prefs.definePreference("options", "object", undefined)
         .on("change", function (e, data) {
             var options = prefs.get("options");
             if (!_.isEqual(options, _lastRunOptions)) {

src/extensions/default/JavaScriptCodeHints/ScopeManager.js

@@ -1129,9 +1129,9 @@ define(function (require, exports, module) {
         /**
          *  Do the work to initialize a code hinting session.
          *
-         * @param {Session} session - the active hinting session
-         * @param {Document} document - the document the editor has changed to
-         * @param {Document} previousDocument - the document the editor has changed from
+         * @param {Session} session - the active hinting session (TODO: currently unused)
+         * @param {!Document} document - the document the editor has changed to
+         * @param {?Document} previousDocument - the document the editor has changed from
          */
         function doEditorChange(session, document, previousDocument) {
             var file        = document.file,
@@ -1229,9 +1229,9 @@ define(function (require, exports, module) {
         /**
          * Called each time a new editor becomes active.
          *
-         * @param {Session} session - the active hinting session
-         * @param {Document} document - the document of the editor that has changed
-         * @param {Document} previousDocument - the document of the editor is changing from
+         * @param {Session} session - the active hinting session (TODO: currently unused by doEditorChange())
+         * @param {!Document} document - the document of the editor that has changed
+         * @param {?Document} previousDocument - the document of the editor is changing from
          */
         function handleEditorChange(session, document, previousDocument) {
             if (addFilesPromise === null) {
@@ -1469,7 +1469,7 @@ define(function (require, exports, module) {
      *
      * @param {Session} session - the active hinting session
      * @param {Document} document - the document of the editor that has changed
-     * @param {Document} previousDocument - the document of the editor is changing from
+     * @param {?Document} previousDocument - the document of the editor is changing from
      */
     function handleEditorChange(session, document, previousDocument) {
 

src/extensions/default/JavaScriptCodeHints/main.js

@@ -585,8 +585,8 @@ define(function (require, exports, module) {
          * When the editor is changed, reset the hinting session and cached 
          * information, and reject any pending deferred requests.
          * 
-         * @param {Editor} editor - editor context to be initialized.
-         * @param {Editor} previousEditor - the previous editor.
+         * @param {!Editor} editor - editor context to be initialized.
+         * @param {?Editor} previousEditor - the previous editor.
          */
         function initializeSession(editor, previousEditor) {
             session = new Session(editor);
@@ -597,11 +597,11 @@ define(function (require, exports, module) {
         }
 
         /*
-         * Install editor change listeners
+         * Connects to the given editor, creating a new Session & adding listeners
          * 
-         * @param {Editor} editor - editor context on which to listen for
-         *      changes
-         * @param {Editor} previousEditor - the previous editor
+         * @param {?Editor} editor - editor context on which to listen for
+         *      changes. If null, 'session' is cleared.
+         * @param {?Editor} previousEditor - the previous editor
          */
         function installEditorListeners(editor, previousEditor) {
             // always clean up cached scope and hint info
@@ -650,18 +650,21 @@ define(function (require, exports, module) {
          * @param {Editor} previous - the previous editor context
          */
         function handleActiveEditorChange(event, current, previous) {
-            // Uninstall "languageChanged" event listeners on the previous editor's document
-            if (previous && previous !== current) {
+            // Uninstall "languageChanged" event listeners on previous editor's document & put them on current editor's doc
+            if (previous) {
                 $(previous.document)
                     .off(HintUtils.eventName("languageChanged"));
             }
-            if (current && current.document !== DocumentManager.getCurrentDocument()) {
+            if (current) {
                 $(current.document)
                     .on(HintUtils.eventName("languageChanged"), function () {
+                        // If current doc's language changed, reset our state by treating it as if the user switched to a
+                        // different document altogether
                         uninstallEditorListeners(current);
                         installEditorListeners(current);
                     });
             }
+            
             uninstallEditorListeners(previous);
             installEditorListeners(current, previous);
         }
@@ -829,13 +832,6 @@ define(function (require, exports, module) {
             .on(HintUtils.eventName("activeEditorChange"),
                 handleActiveEditorChange);
 
-        $(DocumentManager)
-            .on("currentDocumentLanguageChanged", function (e) {
-                var activeEditor = EditorManager.getActiveEditor();
-                uninstallEditorListeners(activeEditor);
-                installEditorListeners(activeEditor);
-            });
-        
         $(ProjectManager).on("beforeProjectClose", function () {
             ScopeManager.handleProjectClose();
         });

src/language/LanguageManager.js

@@ -120,6 +120,12 @@
  *         isBinary: true    
  *     }); 
  * 
+ * 
+ * LanguageManager dispatches two events:
+ * 
+ *  - languageAdded -- When any new Language is added. 2nd arg is the new Language.
+ *  - languageModified -- When the attributes of a Language change, or when the Language gains or loses
+ *          file extension / filename mappings. 2nd arg is the modified Language.
  */
 define(function (require, exports, module) {
     "use strict";
@@ -227,28 +233,6 @@ define(function (require, exports, module) {
         _modeToLanguageMap[mode] = language;
     }
 
-    /**
-     * Adds a language mapping for the specified fullPath. If language is falsy (null or undefined), the mapping
-     * is removed.
-     *
-     * @param {!fullPath} fullPath absolute path of the file
-     * @param {?object} language language to associate the file with or falsy value to remove the existing mapping
-     */
-    function _setLanguageOverrideForPath(fullPath, language) {
-        if (!language) {
-            delete _filePathToLanguageMap[fullPath];
-        } else {
-            _filePathToLanguageMap[fullPath] = language;
-        }
-    }
-    
-    /**
-     * Resets all the language overrides for file paths. Used by unit tests only.
-     */
-    function _resetLanguageOverrides() {
-        _filePathToLanguageMap = {};
-    }
-
     /**
      * Resolves a language ID to a Language object.
      * File names have a higher priority than file extensions. 
@@ -260,7 +244,9 @@ define(function (require, exports, module) {
     }
 
     /**
-     * Resolves a language to a file extension
+     * Resolves a file extension to a Language object.
+     * *Warning:* it is almost always better to use getLanguageForPath(), since Language can depend
+     * on file name and even full path. Use this API only if no relevant file/path exists.
      * @param {!string} extension Extension that language should be resolved for
      * @return {?Language} The language for the provided extension or null if none exists
      */
@@ -383,6 +369,37 @@ define(function (require, exports, module) {
         $(exports).triggerHandler("languageModified", [language]);
     }
 
+    /**
+     * Adds a language mapping for the specified fullPath. If language is falsy (null or undefined), the mapping
+     * is removed. The override is NOT persisted across Brackets sessions.
+     *
+     * @param {!fullPath} fullPath absolute path of the file
+     * @param {?object} language language to associate the file with or falsy value to remove any existing override
+     */
+    function setLanguageOverrideForPath(fullPath, language) {
+        var oldLang = getLanguageForPath(fullPath);
+        if (!language) {
+            delete _filePathToLanguageMap[fullPath];
+        } else {
+            _filePathToLanguageMap[fullPath] = language;
+        }
+        var newLang = getLanguageForPath(fullPath);
+        
+        // Old language changed since this path is no longer mapped to it
+        _triggerLanguageModified(oldLang);
+        // New language changed since a path is now mapped to it that wasn't before
+        _triggerLanguageModified(newLang);
+    }
+    
+    /**
+     * Resets all the language overrides for file paths. Used by unit tests only.
+     */
+    function _resetPathLanguageOverrides() {
+        _filePathToLanguageMap = {};
+    }
+
+
+    
 
     /**
      * Model for a language.
@@ -989,7 +1006,7 @@ define(function (require, exports, module) {
      *     }
      */
     function _updateFromPrefs(pref) {
-        var newMapping = PreferencesManager.get(pref) || {},
+        var newMapping = PreferencesManager.get(pref),
             newNames = Object.keys(newMapping),
             state = _prefState[pref],
             last = state.last,
@@ -1086,25 +1103,21 @@ define(function (require, exports, module) {
         // depends on FileUtils) here. Using the async form of require fixes this.
         require(["preferences/PreferencesManager"], function (pm) {
             PreferencesManager = pm;
-            _updateFromPrefs(_EXTENSION_MAP_PREF);
-            _updateFromPrefs(_NAME_MAP_PREF);
-            pm.definePreference(_EXTENSION_MAP_PREF, "object").on("change", function () {
+            pm.definePreference(_EXTENSION_MAP_PREF, "object", {}).on("change", function () {
                 _updateFromPrefs(_EXTENSION_MAP_PREF);
             });
-            pm.definePreference(_NAME_MAP_PREF, "object").on("change", function () {
+            pm.definePreference(_NAME_MAP_PREF, "object", {}).on("change", function () {
                 _updateFromPrefs(_NAME_MAP_PREF);
             });
+            _updateFromPrefs(_EXTENSION_MAP_PREF);
+            _updateFromPrefs(_NAME_MAP_PREF);
         });
     });
 
     // Private for unit tests
     exports._EXTENSION_MAP_PREF         = _EXTENSION_MAP_PREF;
     exports._NAME_MAP_PREF              = _NAME_MAP_PREF;
-    exports._resetLanguageOverrides     = _resetLanguageOverrides;
-    // Internal use only
-    // _setLanguageOverrideForPath is used by Document to help LanguageManager keeping track of
-    // in-document language overrides
-    exports._setLanguageOverrideForPath  = _setLanguageOverrideForPath;
+    exports._resetPathLanguageOverrides = _resetPathLanguageOverrides;
 
     // Public methods
     exports.ready                       = _ready;
@@ -1113,4 +1126,5 @@ define(function (require, exports, module) {
     exports.getLanguageForExtension     = getLanguageForExtension;
     exports.getLanguageForPath          = getLanguageForPath;
     exports.getLanguages                = getLanguages;
+    exports.setLanguageOverrideForPath  = setLanguageOverrideForPath;
 });

src/nls/root/strings.js

@@ -252,6 +252,7 @@ define({
     "STATUSBAR_LANG_TOOLTIP"                : "Click to change file type",
     "STATUSBAR_CODE_INSPECTION_TOOLTIP"     : "{0}. Click to toggle report panel.",
     "STATUSBAR_DEFAULT_LANG"                : "(default)",
+    "STATUSBAR_SET_DEFAULT_LANG"            : "Set as Default for .{0} Files",
 
     // CodeInspection: errors/warnings
     "ERRORS_PANEL_TITLE_MULTIPLE"           : "{0} Problems",

src/project/ProjectManager.js

@@ -1175,8 +1175,8 @@ define(function (require, exports, module) {
     }
 
     /**
-     * Loads the given folder as a project. Normally, you would call openProject() instead to let the
-     * user choose a folder.
+     * Loads the given folder as a project. Does NOT prompt about any unsaved changes - use openProject()
+     * instead to check for unsaved changes and (optionally) let the user choose the folder to open.
      *
      * @param {!string} rootPath  Absolute path to the root folder of the project.
      *  A trailing "/" on the path is optional (unlike many Brackets APIs that assume a trailing "/").
@@ -1213,8 +1213,9 @@ define(function (require, exports, module) {
             DocumentManager.closeAll();
 
             _unwatchProjectRoot().always(function () {
-                // Done closing old project (if any)
+                // Finish closing old project (if any)
                 if (_projectRoot) {
+                    LanguageManager._resetPathLanguageOverrides();
                     PreferencesManager._reloadUserPrefs(_projectRoot);
                     $(exports).triggerHandler("projectClose", _projectRoot);
                 }