[KeyboardEvent] Add embedder APIs to translate between Dom |key| enum and strings

components/test_runner/event_sender.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "components/test_runner/event_sender.h"
 
 #include "base/basictypes.h"
 #include "base/logging.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "components/test_runner/mock_spell_check.h"
 #include "components/test_runner/test_interfaces.h"
 #include "components/test_runner/web_test_delegate.h"
 #include "components/test_runner/web_test_proxy.h"
 #include "gin/handle.h"
 #include "gin/object_template_builder.h"
 #include "gin/wrappable.h"
 #include "third_party/WebKit/public/platform/WebString.h"
 #include "third_party/WebKit/public/platform/WebVector.h"
 #include "third_party/WebKit/public/web/WebContextMenuData.h"
 #include "third_party/WebKit/public/web/WebFrame.h"
 #include "third_party/WebKit/public/web/WebKit.h"
 #include "third_party/WebKit/public/web/WebPagePopup.h"
 #include "third_party/WebKit/public/web/WebView.h"
+#include "ui/events/event_constants.h"
+#include "ui/events/keycodes/dom/dom_key.h"
 #include "ui/events/keycodes/dom/keycode_converter.h"
+#include "ui/events/keycodes/keyboard_code_conversion.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 #include "v8/include/v8.h"
 
 using blink::WebContextMenuData;
 using blink::WebDragData;
 using blink::WebDragOperationsMask;
 using blink::WebFloatPoint;
 using blink::WebFrame;
 using blink::WebGestureEvent;
 using blink::WebInputEvent;
@@ skipping 1198 matching lines @@
                    button_type,
                    last_mouse_pos_,
                    GetCurrentEventTimeSec(),
                    click_count_,
                    modifiers,
                    &event);
     DoMouseUp(event);
   }
 }
 
-void EventSender::KeyDown(const std::string& code_str,
+void EventSender::KeyDown(const std::string& key_code_str,
                           int modifiers,
                           KeyLocationCode location) {
   // FIXME: I'm not exactly sure how we should convert the string to a key
   // event. This seems to work in the cases I tested.
   // FIXME: Should we also generate a KEY_UP?
 
   bool generate_char = false;
 
   // Convert \n -> VK_RETURN. Some layout tests use \n to mean "Enter", when
   // Windows uses \r for "Enter".
-  int code = 0;
+  int key_code = 0;
   int text = 0;
   bool needs_shift_key_modifier = false;
-  std::string domString;
 
-  if ("\n" == code_str) {
+  if ("\n" == key_code_str) {
     generate_char = true;
-    text = code = ui::VKEY_RETURN;
-    domString.assign("Enter");
-  } else if ("rightArrow" == code_str) {
-    code = ui::VKEY_RIGHT;
-    domString.assign("ArrowRight");
-  } else if ("downArrow" == code_str) {
-    code = ui::VKEY_DOWN;
-    domString.assign("ArrowDown");
-  } else if ("leftArrow" == code_str) {
-    code = ui::VKEY_LEFT;
-    domString.assign("ArrowLeft");
-  } else if ("upArrow" == code_str) {
-    code = ui::VKEY_UP;
-    domString.assign("ArrowUp");
-  } else if ("insert" == code_str) {
-    code = ui::VKEY_INSERT;
-    domString.assign("Insert");
-  } else if ("delete" == code_str) {
-    code = ui::VKEY_DELETE;
-    domString.assign("Delete");
-  } else if ("pageUp" == code_str) {
-    code = ui::VKEY_PRIOR;
-    domString.assign("PageUp");
-  } else if ("pageDown" == code_str) {
-    code = ui::VKEY_NEXT;
-    domString.assign("PageDown");
-  } else if ("home" == code_str) {
-    code = ui::VKEY_HOME;
-    domString.assign("Home");
-  } else if ("end" == code_str) {
-    code = ui::VKEY_END;
-    domString.assign("End");
-  } else if ("printScreen" == code_str) {
-    code = ui::VKEY_SNAPSHOT;
-    domString.assign("PrintScreen");
-  } else if ("menu" == code_str) {
-    code = ui::VKEY_APPS;
-    domString.assign("ContextMenu");
-  } else if ("leftControl" == code_str) {
-    code = ui::VKEY_LCONTROL;
-    domString.assign("ControlLeft");
-  } else if ("rightControl" == code_str) {
-    code = ui::VKEY_RCONTROL;
-    domString.assign("ControlRight");
-  } else if ("leftShift" == code_str) {
-    code = ui::VKEY_LSHIFT;
-    domString.assign("ShiftLeft");
-  } else if ("rightShift" == code_str) {
-    code = ui::VKEY_RSHIFT;
-    domString.assign("ShiftRight");
-  } else if ("leftAlt" == code_str) {
-    code = ui::VKEY_LMENU;
-    domString.assign("AltLeft");
-  } else if ("rightAlt" == code_str) {
-    code = ui::VKEY_RMENU;
-    domString.assign("AltRight");
-  } else if ("numLock" == code_str) {
-    code = ui::VKEY_NUMLOCK;
-    domString.assign("NumLock");
-  } else if ("backspace" == code_str) {
-    code = ui::VKEY_BACK;
-    domString.assign("Backspace");
-  } else if ("escape" == code_str) {
-    code = ui::VKEY_ESCAPE;
-    domString.assign("Escape");
+    text = key_code = ui::VKEY_RETURN;
+  } else if ("rightArrow" == key_code_str) {
+    key_code = ui::VKEY_RIGHT;
+  } else if ("downArrow" == key_code_str) {
+    key_code = ui::VKEY_DOWN;
+  } else if ("leftArrow" == key_code_str) {
+    key_code = ui::VKEY_LEFT;
+  } else if ("upArrow" == key_code_str) {
+    key_code = ui::VKEY_UP;
+  } else if ("insert" == key_code_str) {
+    key_code = ui::VKEY_INSERT;
+  } else if ("delete" == key_code_str) {
+    key_code = ui::VKEY_DELETE;
+  } else if ("pageUp" == key_code_str) {
+    key_code = ui::VKEY_PRIOR;
+  } else if ("pageDown" == key_code_str) {
+    key_code = ui::VKEY_NEXT;
+  } else if ("home" == key_code_str) {
+    key_code = ui::VKEY_HOME;
+  } else if ("end" == key_code_str) {
+    key_code = ui::VKEY_END;
+  } else if ("printScreen" == key_code_str) {
+    key_code = ui::VKEY_SNAPSHOT;
+  } else if ("menu" == key_code_str) {
+    key_code = ui::VKEY_APPS;
+  } else if ("leftControl" == key_code_str) {
+    key_code = ui::VKEY_LCONTROL;
+  } else if ("rightControl" == key_code_str) {
+    key_code = ui::VKEY_RCONTROL;
+  } else if ("leftShift" == key_code_str) {
+    key_code = ui::VKEY_LSHIFT;
+  } else if ("rightShift" == key_code_str) {
+    key_code = ui::VKEY_RSHIFT;
+  } else if ("leftAlt" == key_code_str) {
+    key_code = ui::VKEY_LMENU;
+  } else if ("rightAlt" == key_code_str) {
+    key_code = ui::VKEY_RMENU;
+  } else if ("numLock" == key_code_str) {
+    key_code = ui::VKEY_NUMLOCK;
+  } else if ("backspace" == key_code_str) {
+    key_code = ui::VKEY_BACK;
+  } else if ("escape" == key_code_str) {
+    key_code = ui::VKEY_ESCAPE;
   } else {
     // Compare the input string with the function-key names defined by the
     // DOM spec (i.e. "F1",...,"F24"). If the input string is a function-key
     // name, set its key code.
     for (int i = 1; i <= 24; ++i) {
       std::string function_key_name = base::StringPrintf("F%d", i);
-      if (function_key_name == code_str) {
-        code = ui::VKEY_F1 + (i - 1);
-        domString = function_key_name;
+      if (function_key_name == key_code_str) {
+        key_code = ui::VKEY_F1 + (i - 1);
         break;
       }
     }
-    if (!code) {
+    if (!key_code) {
       WebString web_code_str =
-          WebString::fromUTF8(code_str.data(), code_str.size());
+          WebString::fromUTF8(key_code_str.data(), key_code_str.size());
       if (web_code_str.length() != 1u) {
         v8::Isolate* isolate = blink::mainThreadIsolate();
         isolate->ThrowException(v8::Exception::TypeError(
             gin::StringToV8(isolate, "Invalid web code.")));
         return;
       }
-      text = code = web_code_str.at(0);
-      needs_shift_key_modifier = NeedsShiftModifier(code);
-      if ((code & 0xFF) >= 'a' && (code & 0xFF) <= 'z')
-        code -= 'a' - 'A';
-      if ((code >= 'A' && code <= 'Z') || (code >= 'a' && code <= 'z')) {
-        domString.assign("Key");
-        domString.push_back(base::ToUpperASCII(code));
-      } else if (code >= '0' && code <= '9') {
-        domString.assign("Digit");
-        domString.push_back(code);
-      } else if (code == ' ') {
-        domString.assign("Space");
-      } else if (code == 9) {
-        domString.assign("Tab");
-      }
+      text = key_code = web_code_str.at(0);

[Habib Virji, 2015/06/24 14:32:12]

WebString is used to facilitate getting int value for the string.

+      needs_shift_key_modifier = NeedsShiftModifier(key_code);
+      if ((key_code & 0xFF) >= 'a' && (key_code & 0xFF) <= 'z')
+        key_code -= 'a' - 'A';
       generate_char = true;
     }
 
-    if ("(" == code_str) {
-      code = '9';
+    if ("(" == key_code_str) {
+      key_code = '9';
       needs_shift_key_modifier = true;
     }
   }
 
+  ui::KeyboardCode codex = ui::VKEY_UNKNOWN;
+  ui::DomCode dom_code = ui::UsLayoutKeyboardCodeToDomCode(
+      static_cast<ui::KeyboardCode>(key_code));
+  ui::DomKey dom_key;
+  base::char16 dom_key_char = 0;
+  if (!DomCodeToUsLayoutMeaning(dom_code, ui::EF_NONE, &dom_key, &dom_key_char,
+                                &codex)) {
+    dom_key = ui::DomKey::NONE;
+  }
+
+  int dom_key_int;
+  if (dom_key == ui::DomKey::CHARACTER)
+    dom_key_int = static_cast<int>(dom_key_char);
+  else
+    dom_key_int = DOM_KEY_PRINT_NON_DIFF + static_cast<int>(dom_key);
+
   // For one generated keyboard event, we need to generate a keyDown/keyUp
   // pair;
   // On Windows, we might also need to generate a char event to mimic the
   // Windows event flow; on other platforms we create a merged event and test
   // the event flow that that platform provides.
   WebKeyboardEvent event_down;
   event_down.type = WebInputEvent::RawKeyDown;
   event_down.modifiers = modifiers;
-  event_down.windowsKeyCode = code;
-  event_down.domCode = static_cast<int>(
-      ui::KeycodeConverter::CodeStringToDomCode(domString.c_str()));
+  event_down.windowsKeyCode = key_code;
+  event_down.domCode = static_cast<int>(dom_code);
+  event_down.domKey = dom_key_int;
 
   if (generate_char) {
     event_down.text[0] = text;
     event_down.unmodifiedText[0] = text;
   }
 
   event_down.setKeyIdentifierFromWindowsKeyCode();
 
   if (event_down.modifiers != 0)
     event_down.isSystemKey = IsSystemKeyEvent(event_down);
@@ skipping 17 matching lines @@
   // the command will be dispatched to the renderer just before dispatching
   // the keyboard event, and then it will be executed in the
   // RenderView::handleCurrentKeyboardEvent() method.
   // We just simulate the same behavior here.
   std::string edit_command;
   if (GetEditCommand(event_down, &edit_command))
     delegate_->SetEditCommand(edit_command, "");
 
   HandleInputEventOnViewOrPopup(event_down);
 
-  if (code == ui::VKEY_ESCAPE && !current_drag_data_.isNull()) {
+  if (key_code == ui::VKEY_ESCAPE && !current_drag_data_.isNull()) {
     WebMouseEvent event;
     InitMouseEvent(WebInputEvent::MouseDown,
                    pressed_button_,
                    last_mouse_pos_,
                    GetCurrentEventTimeSec(),
                    click_count_,
                    0,
                    &event);
     FinishDragAndDrop(event, blink::WebDragOperationNone);
   }
 
   delegate_->ClearEditCommand();
 
   if (generate_char) {
     WebKeyboardEvent event_char = event_up;
     event_char.type = WebInputEvent::Char;
     // keyIdentifier is an empty string, unless the Enter key was pressed.
     // This behavior is not standard (keyIdentifier itself is not even a
     // standard any more), but it matches the actual behavior in Blink.
-    if (code != ui::VKEY_RETURN)
+    if (key_code != ui::VKEY_RETURN)
       event_char.keyIdentifier[0] = '\0';
     HandleInputEventOnViewOrPopup(event_char);
   }
 
   HandleInputEventOnViewOrPopup(event_up);
 }
 
 void EventSender::EnableDOMUIEventLogging() {}
 
 void EventSender::FireKeyboardEventsToElement() {}
@@ skipping 1023 matching lines @@
 
 bool EventSender::HandleInputEventOnViewOrPopup(const WebInputEvent& event) {
   if (WebPagePopup* popup = view_->pagePopup()) {
     if (!WebInputEvent::isKeyboardEventType(event.type))
       return popup->handleInputEvent(event);
   }
   return view_->handleInputEvent(event);
 }
 
 }  // namespace test_runner