DevTools: Implement extensions-based shortcut bindings

Source/devtools/front_end/KeyboardShortcut.js

 /*
  * Copyright (C) 2009 Apple Inc. All rights reserved.
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 86 matching lines @@
     Tilde: { code: 192, name: "Tilde" },
     Backslash: { code: 220, name: "\\" },
     SingleQuote: { code: 222, name: "\'" },
     get CtrlOrMeta()
     {
         // "default" command/ctrl key for platform, Command on Mac, Ctrl on other platforms
         return WebInspector.isMac() ? this.Meta : this.Ctrl;
     },
 };
 
+WebInspector.KeyboardShortcut.KeyBindings = {

[pfeldman, 2014/02/21 16:29:16]

Lets not copy these definitions.

[apavlov, 2014/02/24 09:57:57]

OK. But do we want to support "?" or replace it by "Shift+/" (and a few other
keys in a similar manner)? Should I perhaps invest some time into implementing
the new DOM4 KeyboardEvent fields? (garykac@ never responded to my queries about
the state of the feature)

[pfeldman, 2014/03/13 05:24:02]

I don't really see how these correlate. I was just opposed to duping the maps.

[apavlov, 2014/03/17 13:40:59]

Okay, I'll build up the required map automatically using the Keys map (since I
need to quickly retrieve the keycode corresponding to any character than can
appear in a shortcut descriptor).

+    // These must be in sync with WebInspector.KeyboardShortcut.Keys.
+    ";": { code: 186 },
+    "+": { code: 187, shiftKey: true},
+    ",": { code: 188 },
+    "-": { code: 189 },
+    ".": { code: 190 },
+    "/": { code: 191 },
+    "?": { code: 191, shiftKey: true },
+    "`": { code: 192 },
+    "~": { code: 192, shiftKey: true },
+    "\\": { code: 220 },
+    "'": { code: 222 }
+}
+
 /**
  * Creates a number encoding keyCode in the lower 8 bits and modifiers mask in the higher 8 bits.
  * It is useful for matching pressed keys.
  *
  * @param {number|string} keyCode The code of the key, or a character "a-z" which is converted to a keyCode value.
  * @param {number=} modifiers Optional list of modifiers passed as additional paramerters.
  * @return {number}
  */
 WebInspector.KeyboardShortcut.makeKey = function(keyCode, modifiers)
 {
@@ skipping 49 matching lines @@
  */
 WebInspector.KeyboardShortcut.makeDescriptor = function(key, modifiers)
 {
     return {
         key: WebInspector.KeyboardShortcut.makeKey(typeof key === "string" ? key : key.code, modifiers),
         name: WebInspector.KeyboardShortcut.shortcutToString(key, modifiers)
     };
 }
 
 /**
+ * @param {string} shortcut
+ * @return {number}
+ */
+WebInspector.KeyboardShortcut.makeKeyFromBindingShortcut = function(shortcut)
+{
+    var parts = shortcut.split(/\+(?!$)/);
+    var modifiers = 0;
+    for (var i = 0; i < parts.length; ++i) {
+        if (typeof WebInspector.KeyboardShortcut.Modifiers[parts[i]] !== "undefined") {
+            modifiers |= WebInspector.KeyboardShortcut.Modifiers[parts[i]];
+            continue;
+        }
+        console.assert(i === parts.length - 1, "Modifiers-only shortcuts are not allowed (encountered <" + shortcut + ">)");
+        var key = WebInspector.KeyboardShortcut.Keys[parts[i]] || WebInspector.KeyboardShortcut.KeyBindings[parts[i]];
+        if (key && key.shiftKey)
+            modifiers |= WebInspector.KeyboardShortcut.Modifiers.Shift;
+        return WebInspector.KeyboardShortcut.makeKey(key ? key.code : parts[i].toLowerCase(), modifiers)
+    }
+    console.assert(false);
+    return 0;
+}
+
+/**
  * @param {string|!WebInspector.KeyboardShortcut.Key} key
  * @param {number=} modifiers
  * @return {string}
  */
 WebInspector.KeyboardShortcut.shortcutToString = function(key, modifiers)
 {
     return WebInspector.KeyboardShortcut._modifiersToString(modifiers) + WebInspector.KeyboardShortcut._keyName(key);
 }
 
 /**
@@ skipping 37 matching lines @@
     if (modifiers & WebInspector.KeyboardShortcut.Modifiers.Alt)
         res += isMac ? optKey : "Alt + ";
     if (modifiers & WebInspector.KeyboardShortcut.Modifiers.Shift)
         res += isMac ? shiftKey : "Shift + ";
     if (modifiers & WebInspector.KeyboardShortcut.Modifiers.Meta)
         res += isMac ? cmdKey : "Win + ";
 
     return res;
 };
 
+/**
+ * @param {!KeyboardEvent} event
+ */
+WebInspector.KeyboardShortcut.handleShortcut = function(event)
+{
+    var key = WebInspector.KeyboardShortcut.makeKeyFromEvent(event);
+    var extensions = WebInspector.KeyboardShortcut._keysToActionExtensions[key];
+    if (!extensions)
+        return;
+
+    function handler(extension)
+    {
+        var result = extension.instance().handleAction(event);
+        if (result)
+            event.consume(true);
+        delete WebInspector.KeyboardShortcut._pendingActionTimer;
+        return result;
+    }
+
+    for (var i = 0; i < extensions.length; ++i) {
+        var ident = event.keyIdentifier;
+        if (/^F\d+|Control|Shift|Alt|U+001B$/.test(ident) || event.ctrlKey || event.altKey || event.metaKey) {
+            if (handler(extensions[i]))
+                return;
+        } else {
+            WebInspector.KeyboardShortcut._pendingActionTimer = setTimeout(handler.bind(null, extensions[i]), 0);
+            break;
+        }
+    }
+}
+
 WebInspector.KeyboardShortcut.SelectAll = WebInspector.KeyboardShortcut.makeKey("a", WebInspector.KeyboardShortcut.Modifiers.CtrlOrMeta);
+
+WebInspector.KeyboardShortcut._onkeypress = function(event)
+{
+    if (!WebInspector.KeyboardShortcut._pendingActionTimer)
+        return;
+
+    var target = event.target;
+    if (WebInspector.isBeingEdited(event.target)) {
+        clearTimeout(WebInspector.KeyboardShortcut._pendingActionTimer);
+        delete WebInspector.KeyboardShortcut._pendingActionTimer;
+    }
+}
+
+WebInspector.KeyboardShortcut.loadBindings = function()

[pfeldman, 2014/02/21 16:29:16]

What is this loading?

[apavlov, 2014/02/24 09:57:57]

It is called from inspector.js once modules have been registered, in order to
create the eventdescriptor->handler map.

[pfeldman, 2014/03/13 05:24:02]

It should be called differently then - loadBindings is about loading from
settings, while you are registering actions from extensions.

+{
+    /**
+     * @param {string=} platformsString
+     * @return {boolean}
+     */
+    function platformMatches(platformsString)
+    {
+        if (!platformsString)
+            return true;
+        var platforms = platformsString.split(",");
+        var isMatch = false;
+        for (var i = 0; i < platforms.length; ++i) {
+            var currentPlatform = platforms[i];
+            var negate = false;
+            if (currentPlatform.charAt(0) === "!") {
+                currentPlatform = currentPlatform.substring(1);
+                negate = true;
+            }
+            var match = WebInspector.platform() === currentPlatform;
+            isMatch |= negate ? !match : match;
+        }
+        return isMatch;
+    }
+
+    /**
+     * @param {!WebInspector.ModuleManager.Extension} extension
+     */
+    function registerBindings(extension)
+    {
+        var bindings = extension.descriptor().bindings;
+        if (!bindings)
+            return;
+        for (var i = 0; i < bindings.length; ++i) {
+            if (!platformMatches(bindings[i].platform))
+                continue;
+            var key = WebInspector.KeyboardShortcut.makeKeyFromBindingShortcut(bindings[i].shortcut);
+            if (key) {
+                if (WebInspector.KeyboardShortcut._keysToActionExtensions[key])
+                    WebInspector.KeyboardShortcut._keysToActionExtensions[key].push(extension);
+                else
+                    WebInspector.KeyboardShortcut._keysToActionExtensions[key] = [extension];
+            }
+        }
+    }
+
+    document.addEventListener("keypress", WebInspector.KeyboardShortcut._onkeypress, true);
+    WebInspector.KeyboardShortcut._keysToActionExtensions = {};
+    var extensions = WebInspector.moduleManager.extensions(WebInspector.ActionDelegate);
+    extensions.forEach(registerBindings);
+}