Merge pull request #10110 from adobe/rlim/extension-key-bindings

Fix two issues of user key map for extension commands.

Author: redmunds

src/command/KeyBindingManager.js

@@ -80,25 +80,32 @@ define(function (require, exports, module) {
      * Maps commandID to the list of shortcuts that are bound to it.
      * @type {!Object.<string, Array.<{key: string, displayKey: string}>>}
      */
-    var _commandMap  = {},
-        _allCommands = [];
+    var _commandMap  = {};
+    
+    /**
+     * @private
+     * An array of command ID for all the available commands including the commands
+     * of installed extensions.
+     * @type {Array.<string>}
+     */
+    var _allCommands = [];
 
     /**
      * @private
      * Maps key names to the corresponding unicode symols
      * @type {{key: string, displayKey: string}}
      */
-    var _displayKeyMap      = { "up":    "\u2191",
-                                "down":  "\u2193",
-                                "left":  "\u2190",
-                                "right": "\u2192",
-                                "-":     "\u2212" };
+    var _displayKeyMap        = { "up":    "\u2191",
+                                  "down":  "\u2193",
+                                  "left":  "\u2190",
+                                  "right": "\u2192",
+                                  "-":     "\u2212" };
 
-    var _specialCommands = [Commands.EDIT_UNDO, Commands.EDIT_REDO, Commands.EDIT_SELECT_ALL,
-                            Commands.EDIT_CUT, Commands.EDIT_COPY, Commands.EDIT_PASTE],
-        _reservedShortcuts = ["Ctrl-Z", "Ctrl-Y", "Ctrl-A", "Ctrl-X", "Ctrl-C", "Ctrl-V"],
+    var _specialCommands      = [Commands.EDIT_UNDO, Commands.EDIT_REDO, Commands.EDIT_SELECT_ALL,
+                                 Commands.EDIT_CUT, Commands.EDIT_COPY, Commands.EDIT_PASTE],
+        _reservedShortcuts    = ["Ctrl-Z", "Ctrl-Y", "Ctrl-A", "Ctrl-X", "Ctrl-C", "Ctrl-V"],
         _macReservedShortcuts = ["Cmd-,", "Cmd-H", "Cmd-Alt-H", "Cmd-M", "Cmd-Shift-Z", "Cmd-Q"],
-        _keyNames = ["Up", "Down", "Left", "Right", "Backspace", "Enter", "Space", "Tab"];
+        _keyNames             = ["Up", "Down", "Left", "Right", "Backspace", "Enter", "Space", "Tab"];
 
     /**
      * @private
@@ -124,6 +131,13 @@ define(function (require, exports, module) {
      * @type {Array.<function(Event): boolean>}
      */
     var _globalKeydownHooks = [];
+    
+    /**
+     * @private
+     * Forward declaration for JSLint.
+     * @type {Function}
+     */
+    var _loadUserKeyMap;
 
     /**
      * @private
@@ -429,6 +443,29 @@ define(function (require, exports, module) {
         }
     }
 
+    /**
+     * @private
+     *
+     * Updates _allCommands array and _defaultKeyMap with the new key binding
+     * if it is not yet in the _allCommands array. _allCommands array is initialized 
+     * only in extensionsLoaded event. So any new commands or key bindings added after
+     * that will be updated here.
+     *
+     * @param {{commandID: string, key: string, displayKey:string, explicitPlatform: string}} newBinding 
+     */
+    function _updateCommandAndKeyMaps(newBinding) {
+        if (_allCommands.length === 0) {
+            return;
+        }
+        
+        if (newBinding && newBinding.commandID && _allCommands.indexOf(newBinding.commandID) === -1) {
+            _defaultKeyMap[newBinding.commandID] = _.cloneDeep(newBinding);
+            
+            // Process user key map again to catch any reassignment to all new key bindings added from extensions.
+            _loadUserKeyMap();
+        }
+    }
+    
     /**
      * @private
      *
@@ -437,11 +474,12 @@ define(function (require, exports, module) {
      * @param {?string} platform
      *     - "all" indicates all platforms, not overridable
      *     - undefined indicates all platforms, overridden by platform-specific binding
+     * @param {boolean=} userBindings true if adding a user key binding or undefined otherwise.
      * @return {?{key: string, displayKey:String}} Returns a record for valid key bindings.
      *     Returns null when key binding platform does not match, binding does not normalize,
      *     or is already assigned.
      */
-    function _addBinding(commandID, keyBinding, platform) {
+    function _addBinding(commandID, keyBinding, platform, userBindings) {
         var key,
             result = null,
             normalized,
@@ -585,6 +623,10 @@ define(function (require, exports, module) {
             explicitPlatform    : explicitPlatform
         };
 
+        if (!userBindings) {
+            _updateCommandAndKeyMaps(_keyMap[normalized]);
+        }
+        
         // notify listeners
         command = CommandManager.get(commandID);
 
@@ -1007,7 +1049,7 @@ define(function (require, exports, module) {
                         var keybinding = { key: normalizedKey };
 
                         keybinding.displayKey = _getDisplayKey(normalizedKey);
-                        addBinding(commandID, keybinding.displayKey ? keybinding : normalizedKey, brackets.platform);
+                        _addBinding(commandID, keybinding.displayKey ? keybinding : normalizedKey, brackets.platform, true);
                         remappedCommands.push(commandID);
                     } else {
                         multipleKeys.push(commandID);
@@ -1158,18 +1200,27 @@ define(function (require, exports, module) {
      * binding by removing the existing one assigned to each key and adding 
      * new one for the specified command id. Shows errors and opens the user 
      * key map file if it cannot be parsed.
+     *
+     * This function is wrapped with debounce so that its execution is always delayed
+     * by 200 ms. The delay is required because when this function is called some 
+     * extensions may still be adding some commands and their key bindings asychronously.
      */
-    function _loadUserKeyMap() {
+    _loadUserKeyMap = _.debounce(function () {
         _readUserKeyMap()
             .then(function (keyMap) {
+                // Some extensions may add a new command without any key binding. So
+                // we always have to get all commands again to ensure that we also have 
+                // those from any extensions installed during the current session. 
+                _allCommands = CommandManager.getAll();
+
                 _customKeyMapCache = _.cloneDeep(_customKeyMap);
                 _customKeyMap = keyMap;
                 _undoPriorUserKeyBindings();
                 _applyUserKeyBindings();
             }, function (err) {
                 _showErrorsAndOpenKeyMap(err);
             });
-    }
+    }, 200);
 
     /**
      * @private
@@ -1214,8 +1265,6 @@ define(function (require, exports, module) {
      *
      * Initializes _allCommands array and _defaultKeyMap so that we can use them for
      * detecting non-existent commands and restoring the original key binding.
-     *
-     * @param {string} fullPath file path to the user key map file.
      */
     function _initCommandAndKeyMaps() {
         _allCommands = CommandManager.getAll();
@@ -1241,7 +1290,7 @@ define(function (require, exports, module) {
         if (params.get("reloadWithoutUserExts") === "true") {
             _showErrors = false;
         }
-        
+
         _initCommandAndKeyMaps();
         _loadUserKeyMap();
     });