Improved global shortcut handler and made fuzzyprompt use it too.

Author: Joseph Atkins-Turkish

ide/static/ide/js/cloudpebble.js

@@ -184,46 +184,3 @@ CloudPebble.Utils = {
         return interpolate(ngettext("%s second", "%s seconds", n), [n]);
     }
 };
-
-CloudPebble.GlobalShortcuts = (function() {
-    var make_shortcut_checker = function (command) {
-        if (!(command.indexOf('-') > -1)) {
-            command = _.findKey(CodeMirror.keyMap.default, _.partial(_.isEqual, command));
-        }
-        var split = command.split('-');
-        var modifier = ({
-            'ctrl': 'ctrlKey',
-            'cmd': 'metaKey'
-        })[split[0].toLowerCase()];
-        return function (e) {
-            return (e[modifier] && String.fromCharCode(e.keyCode) == split[1]);
-        }
-    };
-
-
-    var global_shortcuts = {};
-
-    $(document).keydown(function (e) {
-        if (!e.isDefaultPrevented()) {
-            _.each(global_shortcuts, function (shortcut) {
-                if (shortcut.checker(e)) {
-                    shortcut.func(e);
-                    e.preventDefault();
-                }
-            });
-        }
-    });
-
-    return {
-        SetShortcutHandlers: function (shortcuts) {
-            var new_shortcuts = _.mapObject(shortcuts, function (func, key) {
-                return {
-                    checker: make_shortcut_checker(key),
-                    func: func
-                };
-
-            });
-            _.extend(global_shortcuts, new_shortcuts);
-        }
-    }
-})();

ide/static/ide/js/editor.js

@@ -97,7 +97,7 @@ CloudPebble.Editor = (function() {
                 settings.extraKeys = {'Ctrl-Space': 'autocomplete'};
             }
             if(!is_js && USER_SETTINGS.autocomplete !== 0) {
-                settings.extraKeys['Tab'] = function() {
+                settings.extraKeys['Tab'] = function selectNextArgument() {
                     var marks = code_mirror.getAllMarks();
                     var cursor = code_mirror.getCursor();
                     var closest = null;
@@ -130,7 +130,7 @@ CloudPebble.Editor = (function() {
             if(USER_SETTINGS.use_spaces) {
                 var spaces = Array(settings.indentUnit + 1).join(' ');
                 var oldTab = settings.extraKeys['Tab'];
-                settings.extraKeys['Tab'] = function(cm) {
+                settings.extraKeys['Tab'] = function indentMoreOrSelectNextArgument(cm) {
                     // If we already overrode tab, check that one.
                     if(oldTab) {
                         if(oldTab(cm) !== CodeMirror.Pass) {
@@ -180,10 +180,10 @@ CloudPebble.Editor = (function() {
                     return CodeMirror.Pass;
                 };
             }
-            settings.extraKeys['Cmd-/'] = function(cm) {
+            settings.extraKeys['Cmd-/'] = function toggleComment(cm) {
                 CodeMirror.commands.toggleComment(cm);
             };
-            settings.extraKeys['Ctrl-/']  = function(cm) {
+            settings.extraKeys['Ctrl-/']  = function toggleComment(cm) {
                 CodeMirror.commands.toggleComment(cm);
             };
             if(is_js) {
@@ -227,10 +227,9 @@ CloudPebble.Editor = (function() {
 
             var help_shortcut = /Mac/.test(navigator.platform) ? 'Shift-Cmd-Ctrl-/' : 'Shift-Ctrl-Alt-/';
 
-            settings.extraKeys[help_shortcut] = function(cm) {
+            settings.extraKeys[help_shortcut] = function lookupFunction(cm) {
                 var pos = cm.cursorCoords();
                 var token = code_mirror.getTokenAt(cm.getCursor());
-
                 create_popover(cm, token.string, pos.left, pos.top);
             };
 
@@ -733,7 +732,7 @@ CloudPebble.Editor = (function() {
             cm.showHint({hint: CloudPebble.Editor.Autocomplete.complete, completeSingle: false});
         };
         CodeMirror.commands.save = function(cm) {
-            cm.cloudpebble_save().catch(alert);;
+            cm.cloudpebble_save().catch(alert);
         };
         CodeMirror.commands.saveAll = function(cm) {
             save_all().catch(alert);

ide/static/ide/js/fuzzyprompt.js

@@ -49,17 +49,20 @@ CloudPebble.FuzzyPrompt = (function() {
             var modifier = /Mac/.test(navigator.platform) ? 'metaKey' : 'ctrlKey';
 
             // Register ctrl-p and ctrl-shift-p
-            $(document).keydown(function(e) {
-                if ((e[modifier]) && e.keyCode == 80) {
-                    e.preventDefault();
-                    if (e.shiftKey) {
-                        input.attr('placeholder', gettext("Enter Command"));
-                        show_prompt('commands');
-                    }
-                    else if (!e.shiftKey) {
+            CloudPebble.GlobalShortcuts.SetShortcutHandlers({
+                'PlatformCmd-P': {
+                    func: function () {
                         input.attr('placeholder', gettext("Search Files"));
                         show_prompt('files');
-                    }
+                    },
+                    name: gettext("Find File")
+                },
+                'Shift-PlatformCmd-P': {
+                    func: function () {
+                        input.attr('placeholder', gettext("Enter Command"));
+                        show_prompt('commands');
+                    },
+                    name: gettext("Find Action")
                 }
             });
 

ide/static/ide/js/global_shortcuts.js

@@ -0,0 +1,53 @@
+CloudPebble.GlobalShortcuts = (function () {
+    var global_shortcuts = {};
+
+    $(document).keydown(function (e) {
+        if (!e.isDefaultPrevented()) {
+            var shortcut = global_shortcuts[CodeMirror.keyName(e)];
+            if (shortcut) {
+                e.preventDefault();
+                shortcut.func(e);
+            }
+        }
+    });
+
+    function shortcut_for_command(command) {
+        // If the command is a name like "save", get they key-combo from CodeMirror
+        if (!(command.indexOf('-') > -1)) {
+            command = _.findKey(CodeMirror.keyMap.default, _.partial(_.isEqual, command));
+        }
+
+        // If any of the shortcut items are "platformcmd", convert them to 'Ctrl' or 'Cmd' depending on the platform.
+        function key_for_platform(name) {
+            if (name.toLowerCase() == "platformcmd") {
+                return /Mac/.test(navigator.platform) ? 'Cmd' : 'Ctrl'
+            } else return name;
+        }
+
+        return command.split('-').map(key_for_platform).join('-');
+    }
+
+    return {
+        /** Add or replace global shortcuts
+         *
+         * @param {Object} shortcuts The keys of this object must be strings which represent keyboard shortcuts.
+         * They can Codemirror-compatible shortcut descriptors e.g. "Shift-Cmd-V", or they can reference CodeMirror
+         * commands such as "Save".
+         * The values should be objects which have a descriptive "name" property, and also either have a "func" property
+         * or be functions themselves. For example, a named function fully satisfies the requirements, as does an object
+         * such as {name: "My Function", func: my_anonymous_function}
+         */
+        SetShortcutHandlers: function (shortcuts) {
+            _.each(shortcuts, function (descriptor, key) {
+                var shortcut = shortcut_for_command(key);
+                global_shortcuts[shortcut] = {
+                    name: descriptor.name ? descriptor.name : key,
+                    func: _.isFunction(descriptor) ? descriptor : descriptor.func
+                };
+            });
+        },
+        GetShortcuts: function() {
+            return global_shortcuts;
+        }
+    }
+})();

ide/templates/ide/project.html

@@ -503,6 +503,7 @@ <h3>{% trans 'Compass and Accelerometer' %}</h3>
 <script src="/ide/jsi18n/"></script>
 <script src="{% static 'ide/js/csrf.js' %}" type="text/javascript"></script>
 <script src="{% static 'ide/js/cloudpebble.js' %}" type="text/javascript"></script>
+<script src="{% static 'ide/js/global_shortcuts.js' %}" type="text/javascript"></script>
 <script src="{% static 'ide/js/sidebar.js' %}" type="text/javascript"></script>
 <script src="{% static 'ide/js/radix.js' %}" type="text/javascript"></script>
 <script src="{% static 'ide/js/ycm.js' %}" type="text/javascript"></script>