[Mac] Produce correct DomKey when Ctrl/Shift/Command is down

content/browser/renderer_host/input/web_input_event_builders_mac_unittest.mm

 // Copyright 2015 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/browser/renderer_host/input/web_input_event_builders_mac.h"
 
 #include <Carbon/Carbon.h>
 #import <Cocoa/Cocoa.h>
 #include <stddef.h>
 
@@ skipping 28 matching lines @@
     {56, 1 << 1, NSShiftKeyMask},      // Left Shift
     {60, 1 << 2, NSShiftKeyMask},      // Right Shift
     {55, 1 << 3, NSCommandKeyMask},    // Left Command
     {54, 1 << 4, NSCommandKeyMask},    // Right Command
     {58, 1 << 5, NSAlternateKeyMask},  // Left Alt
     {61, 1 << 6, NSAlternateKeyMask},  // Right Alt
     {59, 1 << 0, NSControlKeyMask},    // Left Control
     {62, 1 << 13, NSControlKeyMask},   // Right Control
 };
 
-NSEvent* BuildFakeKeyEvent(NSUInteger key_code,
-                           unichar character,
-                           NSUInteger modifier_flags,
-                           NSEventType event_type) {
+NSEvent* BuildFakeKeyEventWithModifiedCharacter(
+    NSUInteger key_code,
+    unichar character,
+    unichar character_ignoring_modifiers,
+    NSUInteger modifier_flags,
+    NSEventType event_type) {
   NSString* string = [NSString stringWithCharacters:&character length:1];
+  NSString* string_ignoring_modifiers =
+      [NSString stringWithCharacters:&character_ignoring_modifiers length:1];
   return [NSEvent keyEventWithType:event_type
                           location:NSZeroPoint
                      modifierFlags:modifier_flags
                          timestamp:0.0
                       windowNumber:0
                            context:nil
                         characters:string
-       charactersIgnoringModifiers:string
+       charactersIgnoringModifiers:string_ignoring_modifiers
                          isARepeat:NO
                            keyCode:key_code];
 }
 
+NSEvent* BuildFakeKeyEvent(NSUInteger key_code,
+                           unichar character,
+                           NSUInteger modifier_flags,
+                           NSEventType event_type) {
+  return BuildFakeKeyEventWithModifiedCharacter(key_code, character, character,
+                                                modifier_flags, event_type);
+}
+
 }  // namespace
 
 // Test that arrow keys don't have numpad modifier set.
 TEST(WebInputEventBuilderMacTest, ArrowKeyNumPad) {
   // Left
   NSEvent* mac_event = BuildFakeKeyEvent(0x7B, NSLeftArrowFunctionKey,
                                          NSNumericPadKeyMask, NSKeyDown);
   WebKeyboardEvent web_event = WebKeyboardEventBuilder::Build(mac_event);
   EXPECT_EQ(0, web_event.modifiers);
   EXPECT_EQ(ui::DomCode::ARROW_LEFT,
@@ skipping 23 matching lines @@
                                 NSKeyDown);
   web_event = WebKeyboardEventBuilder::Build(mac_event);
   EXPECT_EQ(0, web_event.modifiers);
   EXPECT_EQ(ui::DomCode::ARROW_UP, static_cast<ui::DomCode>(web_event.domCode));
   EXPECT_EQ(ui::DomKey::ARROW_UP, web_event.domKey);
 }
 
 // Test that control sequence generate the correct vkey code.
 TEST(WebInputEventBuilderMacTest, ControlSequence) {
   // Ctrl-[ generates escape.
-  NSEvent* mac_event =
-      BuildFakeKeyEvent(0x21, 0x1b, NSControlKeyMask, NSKeyDown);
+  NSEvent* mac_event = BuildFakeKeyEventWithModifiedCharacter(
+      0x21, 0x1b, '[', NSControlKeyMask, NSKeyDown);
   WebKeyboardEvent web_event = WebKeyboardEventBuilder::Build(mac_event);
   EXPECT_EQ(ui::VKEY_OEM_4, web_event.windowsKeyCode);
   EXPECT_EQ(ui::DomCode::BRACKET_LEFT,
             static_cast<ui::DomCode>(web_event.domCode));
-  EXPECT_EQ(ui::DomKey::FromCharacter(0x1b), web_event.domKey);
+  EXPECT_EQ(ui::DomKey::FromCharacter('['), web_event.domKey);
 }
 
 // Test that numpad keys get mapped correctly.
 TEST(WebInputEventBuilderMacTest, NumPadMapping) {
   KeyMappingEntry table[] = {
       {65, '.', ui::VKEY_DECIMAL, ui::DomCode::NUMPAD_DECIMAL,
        ui::DomKey::FromCharacter('.')},
       {67, '*', ui::VKEY_MULTIPLY, ui::DomCode::NUMPAD_MULTIPLY,
        ui::DomKey::FromCharacter('*')},
       {69, '+', ui::VKEY_ADD, ui::DomCode::NUMPAD_ADD,
@@ skipping 113 matching lines @@
   webEvent = WebKeyboardEventBuilder::Build(macEvent);
   EXPECT_TRUE(webEvent.isSystemKey);
 
   // Cmd + <some other modifier> + <any letter other then B and I> should be
   // treated as system event.
   macEvent = BuildFakeKeyEvent(kVK_ANSI_S, 'S',
                                NSCommandKeyMask | NSShiftKeyMask, NSKeyDown);
   webEvent = WebKeyboardEventBuilder::Build(macEvent);
   EXPECT_TRUE(webEvent.isSystemKey);
 }
+
+// Test conversion from key combination with Control to DomKey.
+// TODO(chongz): Move DomKey tests for all platforms into one place.
+// http://crbug.com/587589
+TEST(WebInputEventBuilderMacTest, DomKeyWithControlKey) {
+  struct DomKeyTestCase {
+    int mac_key_code;
+    unichar character;
+    unichar shift_character;
+    ui::DomKey ctrl_dom_key;
+    ui::DomKey ctrl_shift_dom_key;
+  } table[] = {{kVK_ANSI_A, 'a', 'A', ui::DomKey::FromCharacter('a'),
+                ui::DomKey::FromCharacter('A')},
+               {kVK_ANSI_B, 'b', 'B', ui::DomKey::FromCharacter('b'),
+                ui::DomKey::FromCharacter('B')},
+               {kVK_ANSI_C, 'c', 'C', ui::DomKey::FromCharacter('c'),
+                ui::DomKey::FromCharacter('C')},
+               {kVK_ANSI_D, 'd', 'D', ui::DomKey::FromCharacter('d'),
+                ui::DomKey::FromCharacter('D')},
+               {kVK_ANSI_E, 'e', 'E', ui::DomKey::FromCharacter('e'),
+                ui::DomKey::FromCharacter('E')},
+               {kVK_ANSI_F, 'f', 'F', ui::DomKey::FromCharacter('f'),
+                ui::DomKey::FromCharacter('F')},
+               {kVK_ANSI_G, 'g', 'G', ui::DomKey::FromCharacter('g'),
+                ui::DomKey::FromCharacter('G')},
+               {kVK_ANSI_H, 'h', 'H', ui::DomKey::FromCharacter('h'),
+                ui::DomKey::FromCharacter('H')},
+               {kVK_ANSI_I, 'i', 'I', ui::DomKey::FromCharacter('i'),
+                ui::DomKey::FromCharacter('I')},
+               {kVK_ANSI_J, 'j', 'J', ui::DomKey::FromCharacter('j'),
+                ui::DomKey::FromCharacter('J')},
+               {kVK_ANSI_K, 'k', 'K', ui::DomKey::FromCharacter('k'),
+                ui::DomKey::FromCharacter('K')},
+               {kVK_ANSI_L, 'l', 'L', ui::DomKey::FromCharacter('l'),
+                ui::DomKey::FromCharacter('L')},
+               {kVK_ANSI_M, 'm', 'M', ui::DomKey::FromCharacter('m'),
+                ui::DomKey::FromCharacter('M')},
+               {kVK_ANSI_N, 'n', 'N', ui::DomKey::FromCharacter('n'),
+                ui::DomKey::FromCharacter('N')},
+               {kVK_ANSI_O, 'o', 'O', ui::DomKey::FromCharacter('o'),
+                ui::DomKey::FromCharacter('O')},
+               {kVK_ANSI_P, 'p', 'P', ui::DomKey::FromCharacter('p'),
+                ui::DomKey::FromCharacter('P')},
+               {kVK_ANSI_Q, 'q', 'Q', ui::DomKey::FromCharacter('q'),
+                ui::DomKey::FromCharacter('Q')},
+               {kVK_ANSI_R, 'r', 'R', ui::DomKey::FromCharacter('r'),
+                ui::DomKey::FromCharacter('R')},
+               {kVK_ANSI_S, 's', 'S', ui::DomKey::FromCharacter('s'),
+                ui::DomKey::FromCharacter('S')},
+               {kVK_ANSI_T, 't', 'T', ui::DomKey::FromCharacter('t'),
+                ui::DomKey::FromCharacter('T')},
+               {kVK_ANSI_U, 'u', 'U', ui::DomKey::FromCharacter('u'),
+                ui::DomKey::FromCharacter('U')},
+               {kVK_ANSI_V, 'v', 'V', ui::DomKey::FromCharacter('v'),
+                ui::DomKey::FromCharacter('V')},
+               {kVK_ANSI_W, 'w', 'W', ui::DomKey::FromCharacter('w'),
+                ui::DomKey::FromCharacter('W')},
+               {kVK_ANSI_X, 'x', 'X', ui::DomKey::FromCharacter('x'),
+                ui::DomKey::FromCharacter('X')},
+               {kVK_ANSI_Y, 'y', 'Y', ui::DomKey::FromCharacter('y'),
+                ui::DomKey::FromCharacter('Y')},
+               {kVK_ANSI_Z, 'z', 'Z', ui::DomKey::FromCharacter('z'),
+                ui::DomKey::FromCharacter('Z')}};
+
+  for (size_t i = 0; i < arraysize(table); ++i) {
+    // Tests ctrl_dom_key
+    NSEvent* mac_event = BuildFakeKeyEventWithModifiedCharacter(
+        table[i].mac_key_code, table[i].character & 0x1F, table[i].character,
+        NSControlKeyMask, NSKeyDown);
+    WebKeyboardEvent web_event = WebKeyboardEventBuilder::Build(mac_event);
+    EXPECT_EQ(table[i].ctrl_dom_key, web_event.domKey);
+    // Tests ctrl_shift_dom_key
+    mac_event = BuildFakeKeyEventWithModifiedCharacter(
+        table[i].mac_key_code, table[i].character & 0x1F,
+        table[i].shift_character, NSControlKeyMask | NSShiftKeyMask, NSKeyDown);
+    web_event = WebKeyboardEventBuilder::Build(mac_event);
+    EXPECT_EQ(table[i].ctrl_shift_dom_key, web_event.domKey);
+  }
+}