diff options
Diffstat (limited to 'lib/keyboard_utils.coffee')
| -rw-r--r-- | lib/keyboard_utils.coffee | 117 |
1 files changed, 21 insertions, 96 deletions
diff --git a/lib/keyboard_utils.coffee b/lib/keyboard_utils.coffee index ead8c037..35e584e3 100644 --- a/lib/keyboard_utils.coffee +++ b/lib/keyboard_utils.coffee @@ -3,28 +3,9 @@ mapKeyRegistry = {} Utils?.monitorChromeStorage "mapKeyRegistry", (value) => mapKeyRegistry = value KeyboardUtils = - keyCodes: - { ESC: 27, backspace: 8, deleteKey: 46, enter: 13, ctrlEnter: 10, space: 32, shiftKey: 16, ctrlKey: 17, f1: 112, - f12: 123, tab: 9, downArrow: 40, upArrow: 38 } - + # This maps event.key key names to Vimium key names. keyNames: - { 37: "left", 38: "up", 39: "right", 40: "down", 32: "space", 8: "backspace" } - - # This is a mapping of the incorrect keyIdentifiers generated by Webkit on Windows during keydown events to - # the correct identifiers, which are correctly generated on Mac. We require this mapping to properly handle - # these keys on Windows. See https://bugs.webkit.org/show_bug.cgi?id=19906 for more details. - keyIdentifierCorrectionMap: - "U+00C0": ["U+0060", "U+007E"] # `~ - "U+00BD": ["U+002D", "U+005F"] # -_ - "U+00BB": ["U+003D", "U+002B"] # =+ - "U+00DB": ["U+005B", "U+007B"] # [{ - "U+00DD": ["U+005D", "U+007D"] # ]} - "U+00DC": ["U+005C", "U+007C"] # \| - "U+00BA": ["U+003B", "U+003A"] # ;: - "U+00DE": ["U+0027", "U+0022"] # '" - "U+00BC": ["U+002C", "U+003C"] # ,< - "U+00BE": ["U+002E", "U+003E"] # .> - "U+00BF": ["U+002F", "U+003F"] # /? + "ArrowLeft": "left", "ArrowUp": "up", "ArrowRight": "right", "ArrowDown": "down", " ": "space", "Backspace": "backspace" init: -> if (navigator.userAgent.indexOf("Mac") != -1) @@ -34,19 +15,9 @@ KeyboardUtils = else @platform = "Windows" - # We are migrating from using event.keyIdentifier to using event.key. For some period of time, we must - # support both. This wrapper can be removed once Chrome 52 is considered too old to support. getKeyChar: (event) -> - # We favor using event.keyIdentifier due to Chromium's currently (Chrome 51) incorrect implementataion of - # event.key; see #2147. - if event.keyIdentifier? - @getKeyCharUsingKeyIdentifier event - else - @getKeyCharUsingKey event - - getKeyCharUsingKey: (event) -> - if event.keyCode of @keyNames - @keyNames[event.keyCode] + if event.key of @keyNames + @keyNames[event.key] # It appears that event.key is not always defined (see #2453). else if not event.key? "" @@ -59,44 +30,28 @@ KeyboardUtils = else "" - getKeyCharUsingKeyIdentifier: (event) -> - # Handle named keys. - keyCode = event.keyCode - if keyCode - if keyCode of @keyNames - return @keyNames[keyCode] - # Function keys. - if @keyCodes.f1 <= keyCode <= @keyCodes.f12 - return "f" + (1 + keyCode - keyCodes.f1) - - keyIdentifier = event.keyIdentifier - - # Not a letter. - if not keyIdentifier.startsWith "U+" - return "" + getKeyCharString: (event) -> + if keyChar = @getKeyChar event + modifiers = [] - # On Windows, the keyIdentifiers for non-letter keys are incorrect. See - # https://bugs.webkit.org/show_bug.cgi?id=19906 for more details. - if ((@platform == "Windows" || @platform == "Linux") && @keyIdentifierCorrectionMap[keyIdentifier]) - correctedIdentifiers = @keyIdentifierCorrectionMap[keyIdentifier] - keyIdentifier = if event.shiftKey then correctedIdentifiers[1] else correctedIdentifiers[0] - unicodeKeyInHex = "0x" + keyIdentifier.substring(2) - character = String.fromCharCode(parseInt(unicodeKeyInHex)).toLowerCase() - if event.shiftKey then character.toUpperCase() else character + keyChar = keyChar.toUpperCase() if event.shiftKey and keyChar.length == 1 + # These must be in alphabetical order (to match the sorted modifier order in Commands.normalizeKey). + modifiers.push "a" if event.altKey + modifiers.push "c" if event.ctrlKey + modifiers.push "m" if event.metaKey - isPrimaryModifierKey: (event) -> if (@platform == "Mac") then event.metaKey else event.ctrlKey + keyChar = [modifiers..., keyChar].join "-" + keyChar = "<#{keyChar}>" if 1 < keyChar.length + keyChar = mapKeyRegistry[keyChar] ? keyChar + keyChar - isEscape: do -> + isEscape: (event) -> + # <c-[> is mapped to Escape in Vim by default. + event.key == "Escape" || @getKeyCharString(event) == "<c-[>" - # TODO(smblott) Change this to use event.key. - (event) -> - event.keyCode == @keyCodes.ESC || do => - keyChar = @getKeyCharString event - # <c-[> is mapped to Escape in Vim by default. - keyChar == "<c-[>" + isBackspace: (event) -> + event.key in ["Backspace", "Delete"] - # TODO. This is probably a poor way of detecting printable characters. However, it shouldn't incorrectly - # identify any of chrome's own keyboard shortcuts as printable. isPrintable: (event) -> return false if event.metaKey or event.ctrlKey or event.altKey keyChar = @@ -106,37 +61,7 @@ KeyboardUtils = @getKeyChar event keyChar.length == 1 - # Return the Vimium key representation for this keyboard event. Return a falsy value (the empty string or - # undefined) when no Vimium representation is appropriate. - getKeyCharString: (event) -> - switch event.type - when "keypress" - # Ignore modifier keys by themselves. - if 31 < event.keyCode - String.fromCharCode event.charCode - - # TODO(smblott). Currently all (almost?) keyhandling is being done on keydown. All legacy code related - # to key handling on keypress should be reviewed and probably removed. This is not being done right now - # (2017-03-22) because it is better to wait until we've verified that the change to keydown is indeed - # correct and reliable. - when "keydown" - if keyChar = @getKeyChar event - modifiers = [] - - keyChar = keyChar.toUpperCase() if event.shiftKey and keyChar.length == 1 - # These must be in alphabetical order (to match the sorted modifier order in Commands.normalizeKey). - modifiers.push "a" if event.altKey - modifiers.push "c" if event.ctrlKey - modifiers.push "m" if event.metaKey - - keyChar = [modifiers..., keyChar].join "-" - keyChar = "<#{keyChar}>" if 1 < keyChar.length - keyChar = mapKeyRegistry[keyChar] ? keyChar - keyChar - KeyboardUtils.init() root = exports ? window root.KeyboardUtils = KeyboardUtils -# TODO(philc): A lot of code uses this keyCodes hash... maybe we shouldn't export it as a global. -root.keyCodes = KeyboardUtils.keyCodes |