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

content/shell/renderer/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 "content/shell/renderer/test_runner/event_sender.h"
 
 #include "base/basictypes.h"
 #include "base/logging.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
@@ skipping 1261 matching lines @@
   // 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 text = 0;
   bool needs_shift_key_modifier = false;
   std::string domString;

[Wez, 2015/04/21 02:25:58]

Looks like this should be domCode, to match naming of domKey. Similarly, "code"
above should become "keyCode", unfortunately.

[Habib Virji, 2015/04/29 16:05:18]

Done.

+  std::string domKey;
 
   if ("\n" == 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;
@@ skipping 21 matching lines @@
     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");
+    domKey.assign("MediaApps");
   } else if ("leftControl" == code_str) {
     code = ui::VKEY_LCONTROL;
     domString.assign("ControlLeft");
+    domKey.assign("Control");
   } else if ("rightControl" == code_str) {
     code = ui::VKEY_RCONTROL;
     domString.assign("ControlRight");
+    domKey.assign("Control");
   } else if ("leftShift" == code_str) {
     code = ui::VKEY_LSHIFT;
     domString.assign("ShiftLeft");
+    domKey.assign("Shift");
   } else if ("rightShift" == code_str) {
     code = ui::VKEY_RSHIFT;
     domString.assign("ShiftRight");
+    domKey.assign("Shift");
   } else if ("leftAlt" == code_str) {
     code = ui::VKEY_LMENU;
     domString.assign("AltLeft");
+    domKey.assign("Alt");
   } else if ("rightAlt" == code_str) {
     code = ui::VKEY_RMENU;
     domString.assign("AltRight");
+    domKey.assign("AltGraph");
   } 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");
   } else {
@@ skipping 40 matching lines @@
   // 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()));
+  if (domKey.empty())
+      domKey = domString;

[Wez, 2015/04/21 02:25:58]

This looks wrong; DOM |code| and |key| are different things; you can't just
assign a |code| value as the |key|.

[Habib Virji, 2015/04/29 16:05:18]

Agreed but for some keys such as Enter, ArrowRight/Down/Left/Up, Insert,
PageUp/Down, Delete. Home, End, PrintScreen they share same value. In case
domKey is empty, then domCode is assigned, the aim is to cover for above shared
keys. 

[Wez, 2015/05/07 00:23:22]

It doesn't make sense in general, though, since the two differ, e.g. if you
inject an event for Digit0 then |key| should be '0'.

The EventSender seems to be designed to support only basic Windows VKEY events,
and to implicitly assume a US English layout - I'd suggest we take one of two
approaches here:

0. Convert the supplied string into the VKEY we want to generate, using the
existing code in this function.
1. Use the DomCode<->VKEY mapping table we have for US English to go from that
to the DOM |code|.
2. Use the DomCode<->DomKey+character mapping table we have for US English to
populate the DOM |key| field.

Step #0 could go away in future, if we had the EventSender just accept a DOM
|code| string directly, but we can do that as a separate stage, if we want,
since it'll require updating a load of tests.

[Habib Virji, 2015/05/19 16:16:28]

I agree with the point you are making and it appears to be bit an effort. Have
started looking into using DomCode, Vkey mapping and then using DomCode to
DomKey. It will require more few days fixing all the tests. It will ease if I
can land this CL and carry on with fixing event_sender as a separate CL. Will
that be okay? Can also remove the event_sender and implement in other CL.

+  event_down.domKey = static_cast<int>(
+      ui::KeycodeConverter::KeyStringToDomKey(domKey.c_str()));

[Wez, 2015/05/07 00:23:22]

This handles the DomKey enum values, but those only cover non-printable DOM
|key| values - what about printable/character DOM |key| values?

e.g. If the caller chooses to inject code=Digit0 then the DomKey value will be
DomKey::CHARACTER and the event needs to store the character code for the DOM
|key| string separately - see:
https://code.google.com/p/chromium/codesearch#chromium/src/ui/events/keycodes...

Not sure if you can get away with (ab)using |m_text| in the WebKeyboardEvent, or
will need to add a new member to store the character code, unfortunately.

[Habib Virji, 2015/05/19 16:16:28]

This is already handled in unmodifiedText:
https://code.google.com/p/chromium/codesearch#chromium/src/content/browser/re...

So the changes will also set this value corectly. 

 
   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 1069 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 content