Merge pull request #4694 from atom/common-accelerator

Remove duplicated keyboard code

atom/browser/ui/accelerator_util.cc

@@ -18,13 +18,12 @@
 
 namespace accelerator_util {
 
-bool StringToAccelerator(const std::string& description,
+bool StringToAccelerator(const std::string& shortcut,
                          ui::Accelerator* accelerator) {
-  if (!base::IsStringASCII(description)) {
+  if (!base::IsStringASCII(shortcut)) {
     LOG(ERROR) << "The accelerator string can only contain ASCII characters";
     return false;
   }
-  std::string shortcut(base::ToLowerASCII(description));
 
   std::vector<std::string> tokens = base::SplitString(
      shortcut, "+", base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
@@ -33,95 +32,35 @@ bool StringToAccelerator(const std::string& description,
   int modifiers = ui::EF_NONE;
   ui::KeyboardCode key = ui::VKEY_UNKNOWN;
   for (size_t i = 0; i < tokens.size(); i++) {
-    // We use straight comparing instead of map because the accelerator tends
-    // to be correct and usually only uses few special tokens.
-    if (tokens[i].size() == 1) {
     bool shifted = false;
-      key = atom::KeyboardCodeFromCharCode(tokens[i][0], &shifted);
+    ui::KeyboardCode code = atom::KeyboardCodeFromStr(tokens[i], &shifted);
     if (shifted)
       modifiers |= ui::EF_SHIFT_DOWN;
-    } else if (tokens[i] == "ctrl" || tokens[i] == "control") {
+    switch (code) {
+      // The token can be a modifier.
+      case ui::VKEY_SHIFT:
+        modifiers |= ui::EF_SHIFT_DOWN;
+        break;
+      case ui::VKEY_CONTROL:
         modifiers |= ui::EF_CONTROL_DOWN;
-    } else if (tokens[i] == "super") {
+        break;
-      modifiers |= ui::EF_COMMAND_DOWN;
+      case ui::VKEY_MENU:
-#if defined(OS_MACOSX)
-    } else if (tokens[i] == "cmd" || tokens[i] == "command") {
-      modifiers |= ui::EF_COMMAND_DOWN;
-#endif
-    } else if (tokens[i] == "commandorcontrol" || tokens[i] == "cmdorctrl") {
-#if defined(OS_MACOSX)
-      modifiers |= ui::EF_COMMAND_DOWN;
-#else
-      modifiers |= ui::EF_CONTROL_DOWN;
-#endif
-    } else if (tokens[i] == "alt") {
         modifiers |= ui::EF_ALT_DOWN;
-    } else if (tokens[i] == "shift") {
+        break;
-      modifiers |= ui::EF_SHIFT_DOWN;
+      case ui::VKEY_COMMAND:
-    } else if (tokens[i] == "plus") {
+        modifiers |= ui::EF_COMMAND_DOWN;
-      modifiers |= ui::EF_SHIFT_DOWN;
+        break;
-      key = ui::VKEY_OEM_PLUS;
+      case ui::VKEY_ALTGR:
-    } else if (tokens[i] == "tab") {
+        modifiers |= ui::EF_ALTGR_DOWN;
-      key = ui::VKEY_TAB;
+        break;
-    } else if (tokens[i] == "space") {
+      // Or it is a normal key.
-      key = ui::VKEY_SPACE;
+      default:
-    } else if (tokens[i] == "backspace") {
+        key = code;
-      key = ui::VKEY_BACK;
-    } else if (tokens[i] == "delete") {
-      key = ui::VKEY_DELETE;
-    } else if (tokens[i] == "insert") {
-      key = ui::VKEY_INSERT;
-    } else if (tokens[i] == "enter" || tokens[i] == "return") {
-      key = ui::VKEY_RETURN;
-    } else if (tokens[i] == "up") {
-      key = ui::VKEY_UP;
-    } else if (tokens[i] == "down") {
-      key = ui::VKEY_DOWN;
-    } else if (tokens[i] == "left") {
-      key = ui::VKEY_LEFT;
-    } else if (tokens[i] == "right") {
-      key = ui::VKEY_RIGHT;
-    } else if (tokens[i] == "home") {
-      key = ui::VKEY_HOME;
-    } else if (tokens[i] == "end") {
-      key = ui::VKEY_END;
-    } else if (tokens[i] == "pageup") {
-      key = ui::VKEY_PRIOR;
-    } else if (tokens[i] == "pagedown") {
-      key = ui::VKEY_NEXT;
-    } else if (tokens[i] == "esc" || tokens[i] == "escape") {
-      key = ui::VKEY_ESCAPE;
-    } else if (tokens[i] == "volumemute") {
-      key = ui::VKEY_VOLUME_MUTE;
-    } else if (tokens[i] == "volumeup") {
-      key = ui::VKEY_VOLUME_UP;
-    } else if (tokens[i] == "volumedown") {
-      key = ui::VKEY_VOLUME_DOWN;
-    } else if (tokens[i] == "medianexttrack") {
-      key = ui::VKEY_MEDIA_NEXT_TRACK;
-    } else if (tokens[i] == "mediaprevioustrack") {
-      key = ui::VKEY_MEDIA_PREV_TRACK;
-    } else if (tokens[i] == "mediastop") {
-      key = ui::VKEY_MEDIA_STOP;
-    } else if (tokens[i] == "mediaplaypause") {
-      key = ui::VKEY_MEDIA_PLAY_PAUSE;
-    } else if (tokens[i].size() > 1 && tokens[i][0] == 'f') {
-      // F1 - F24.
-      int n;
-      if (base::StringToInt(tokens[i].c_str() + 1, &n) && n > 0 && n < 25) {
-        key = static_cast<ui::KeyboardCode>(ui::VKEY_F1 + n - 1);
-      } else {
-        LOG(WARNING) << tokens[i] << "is not available on keyboard";
-        return false;
-      }
-    } else {
-      LOG(WARNING) << "Invalid accelerator token: " << tokens[i];
-      return false;
     }
   }
 
   if (key == ui::VKEY_UNKNOWN) {
-    LOG(WARNING) << "The accelerator doesn't contain a valid key";
+    LOG(WARNING) << shortcut << " doesn't contain a valid key";
     return false;
   }
 

atom/common/keyboard_util.cc

@@ -3,12 +3,19 @@
 // found in the LICENSE file.
 
 #include <string>
+
 #include "atom/common/keyboard_util.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/strings/string_util.h"
 
 namespace atom {
 
-// Return key code of the char.
+namespace {
+
+// Return key code of the char, and also determine whether the SHIFT key is
+// pressed.
 ui::KeyboardCode KeyboardCodeFromCharCode(base::char16 c, bool* shifted) {
+  c = base::ToLowerASCII(c);
   *shifted = false;
   switch (c) {
     case 0x08: return ui::VKEY_BACK;
@@ -72,38 +79,98 @@ ui::KeyboardCode KeyboardCodeFromCharCode(base::char16 c, bool* shifted) {
   }
 }
 
-// Return key code of the char.
+// Return key code represented by |str|.
-ui::KeyboardCode KeyboardCodeFromKeyIdentifier(const std::string& chr) {
+ui::KeyboardCode KeyboardCodeFromKeyIdentifier(const std::string& s,
-  if (chr == "enter")        return ui::VKEY_RETURN;
+                                               bool* shifted) {
-  if (chr == "backspace")    return ui::VKEY_BACK;
+  std::string str = base::ToLowerASCII(s);
-  if (chr == "delete")       return ui::VKEY_DELETE;
+  if (str == "ctrl" || str == "control") {
-  if (chr == "tab")          return ui::VKEY_TAB;
+    return ui::VKEY_CONTROL;
-  if (chr == "escape")       return ui::VKEY_ESCAPE;
+  } else if (str == "super" || str == "cmd" || str == "command" ||
-  if (chr == "control")      return ui::VKEY_CONTROL;
+             str == "meta") {
+    return ui::VKEY_COMMAND;
+  } else if (str == "commandorcontrol" || str == "cmdorctrl") {
 #if defined(OS_MACOSX)
-  if (chr == "command"
+    return ui::VKEY_COMMAND;
-    || chr == "cmd"
+#else
-    || chr == "meta")        return ui::VKEY_COMMAND;
+    return ui::VKEY_CONTROL;
-  if (chr == "option")       return ui::VKEY_MENU;
 #endif
-#if defined(OS_WIN)
+  } else if (str == "alt" || str == "option") {
-  if (chr == "meta")         return ui::VKEY_LWIN;
+    return ui::VKEY_MENU;
-  if (chr == "altgr")        return ui::VKEY_ALTGR;
+  } else if (str == "shift") {
-#endif
+    return ui::VKEY_SHIFT;
-  if (chr == "alt")          return ui::VKEY_MENU;
+  } else if (str == "altgr") {
-  if (chr == "shift")        return ui::VKEY_SHIFT;
+    return ui::VKEY_ALTGR;
-  if (chr == "end")          return ui::VKEY_END;
+  } else if (str == "plus") {
-  if (chr == "home")         return ui::VKEY_HOME;
+    *shifted = true;
-  if (chr == "insert")       return ui::VKEY_INSERT;
+    return ui::VKEY_OEM_PLUS;
-  if (chr == "left")         return ui::VKEY_LEFT;
+  } else if (str == "tab") {
-  if (chr == "up")           return ui::VKEY_UP;
+    return ui::VKEY_TAB;
-  if (chr == "right")        return ui::VKEY_RIGHT;
+  } else if (str == "space") {
-  if (chr == "down")         return ui::VKEY_DOWN;
+    return ui::VKEY_SPACE;
-  if (chr == "pageup")       return ui::VKEY_PRIOR;
+  } else if (str == "backspace") {
-  if (chr == "pagedown")     return ui::VKEY_NEXT;
+    return ui::VKEY_BACK;
-  if (chr == "printscreen")  return ui::VKEY_SNAPSHOT;
+  } else if (str == "delete") {
-
+    return ui::VKEY_DELETE;
+  } else if (str == "insert") {
+    return ui::VKEY_INSERT;
+  } else if (str == "enter" || str == "return") {
+    return ui::VKEY_RETURN;
+  } else if (str == "up") {
+    return ui::VKEY_UP;
+  } else if (str == "down") {
+    return ui::VKEY_DOWN;
+  } else if (str == "left") {
+    return ui::VKEY_LEFT;
+  } else if (str == "right") {
+    return ui::VKEY_RIGHT;
+  } else if (str == "home") {
+    return ui::VKEY_HOME;
+  } else if (str == "end") {
+    return ui::VKEY_END;
+  } else if (str == "pageup") {
+    return ui::VKEY_PRIOR;
+  } else if (str == "pagedown") {
+    return ui::VKEY_NEXT;
+  } else if (str == "esc" || str == "escape") {
+    return ui::VKEY_ESCAPE;
+  } else if (str == "volumemute") {
+    return ui::VKEY_VOLUME_MUTE;
+  } else if (str == "volumeup") {
+    return ui::VKEY_VOLUME_UP;
+  } else if (str == "volumedown") {
+    return ui::VKEY_VOLUME_DOWN;
+  } else if (str == "medianexttrack") {
+    return ui::VKEY_MEDIA_NEXT_TRACK;
+  } else if (str == "mediaprevioustrack") {
+    return ui::VKEY_MEDIA_PREV_TRACK;
+  } else if (str == "mediastop") {
+    return ui::VKEY_MEDIA_STOP;
+  } else if (str == "mediaplaypause") {
+    return ui::VKEY_MEDIA_PLAY_PAUSE;
+  } else if (str == "printscreen") {
+    return ui::VKEY_SNAPSHOT;
+  } else if (str.size() > 1 && str[0] == 'f') {
+    // F1 - F24.
+    int n;
+    if (base::StringToInt(str.c_str() + 1, &n) && n > 0 && n < 25) {
+      return static_cast<ui::KeyboardCode>(ui::VKEY_F1 + n - 1);
+    } else {
+      LOG(WARNING) << str << "is not available on keyboard";
       return ui::VKEY_UNKNOWN;
+    }
+  } else {
+    LOG(WARNING) << "Invalid accelerator token: " << str;
+    return ui::VKEY_UNKNOWN;
+  }
+}
+
+}  // namespace
+
+ui::KeyboardCode KeyboardCodeFromStr(const std::string& str, bool* shifted) {
+  if (str.size() == 1)
+    return KeyboardCodeFromCharCode(str[0], shifted);
+  else
+    return KeyboardCodeFromKeyIdentifier(str, shifted);
 }
 
 }  // namespace atom

atom/common/keyboard_util.h

@@ -6,17 +6,14 @@
 #define ATOM_COMMON_KEYBOARD_UTIL_H_
 
 #include <string>
+
 #include "ui/events/keycodes/keyboard_codes.h"
-#include "base/strings/string_util.h"
 
 namespace atom {
 
-// Return key code of the char, and also determine whether the SHIFT key is
+// Return key code of the |str|, and also determine whether the SHIFT key is
 // pressed.
-ui::KeyboardCode KeyboardCodeFromCharCode(base::char16 c, bool* shifted);
+ui::KeyboardCode KeyboardCodeFromStr(const std::string& str, bool* shifted);
-
-// Return key code of the char from a string representation of the char
-ui::KeyboardCode KeyboardCodeFromKeyIdentifier(const std::string& chr);
 
 }  // namespace atom
 

atom/common/native_mate_converters/blink_converter.cc

@@ -159,25 +159,22 @@ bool Converter<blink::WebKeyboardEvent>::FromV8(
     return false;
   if (!ConvertFromV8(isolate, val, static_cast<blink::WebInputEvent*>(out)))
     return false;
-  base::char16 code;
-  std::string identifier;
-  bool shifted = false;
 
-  if (dict.Get("keyCode", &code))
+  std::string str;
-    out->windowsKeyCode = atom::KeyboardCodeFromCharCode(code, &shifted);
+  bool shifted = false;
-  else if (dict.Get("keyCode", &identifier))
+  if (dict.Get("keyCode", &str))
-    out->windowsKeyCode = atom::KeyboardCodeFromKeyIdentifier(
+    out->windowsKeyCode = atom::KeyboardCodeFromStr(str, &shifted);
-      base::ToLowerASCII(identifier));
   else
     return false;
 
   if (shifted)
     out->modifiers |= blink::WebInputEvent::ShiftKey;
   out->setKeyIdentifierFromWindowsKeyCode();
-  if (out->type == blink::WebInputEvent::Char ||
+  if ((out->type == blink::WebInputEvent::Char ||
-      out->type == blink::WebInputEvent::RawKeyDown) {
+       out->type == blink::WebInputEvent::RawKeyDown) &&
-    out->text[0] = code;
+      str.size() == 1) {
-    out->unmodifiedText[0] = code;
+    out->text[0] = str[0];
+    out->unmodifiedText[0] = str[0];
   }
   return true;
 }

docs/api/accelerator.md

@@ -23,6 +23,8 @@ The `Super` key is mapped to the `Windows` key on Windows and Linux and
 * `Control` (or `Ctrl` for short)
 * `CommandOrControl` (or `CmdOrCtrl` for short)
 * `Alt`
+* `Option`
+* `AltGr`
 * `Shift`
 * `Super`
 
@@ -44,3 +46,4 @@ The `Super` key is mapped to the `Windows` key on Windows and Linux and
 * `Escape` (or `Esc` for short)
 * `VolumeUp`, `VolumeDown` and `VolumeMute`
 * `MediaNextTrack`, `MediaPreviousTrack`, `MediaStop` and `MediaPlayPause`
+* `PrintScreen`

docs/api/web-contents.md

@@ -764,13 +764,9 @@ Sends an input `event` to the page.
 
 For keyboard events, the `event` object also have following properties:
 
-* `keyCode` Char or String (**required**) - The character that will be sent
+* `keyCode` String (**required**) - The character that will be sent
-  as the keyboard event. Can be a single UTF-8 character, or the name of the
+  as the keyboard event. Should only use the valid key codes in
-  key that generates the event. Accepted key names are `enter`, `backspace`,
+  [Accelerator](accelerator.md).
-  `delete`, `tab`, `escape`, `control`, `alt`, `altgr` (Windows only), `shift`,
-  `end`, `home`, `insert`, `left`, `up`, `right`, `down`, `pageUp`, `pageDown`,
-  `printScreen`, `meta`, `cmd` (OSX only), `command` (OSX only), `option`
-  (OSX only)
 
 For mouse events, the `event` object also have following properties: