Reland: [DomKey] Expose Korean special keys on Korean keyboard layout only

ui/events/keycodes/platform_key_map_win_unittest.cc

 // Copyright (c) 2016 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 "ui/events/keycodes/platform_key_map_win.h"
 
 #include "base/macros.h"
 #include "base/strings/string16.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/events/event_constants.h"
 #include "ui/events/keycodes/dom/dom_code.h"
 #include "ui/events/keycodes/dom/dom_key.h"
 #include "ui/events/keycodes/dom/keycode_converter.h"
 #include "ui/events/keycodes/dom_us_layout_data.h"
 
 namespace ui {
 
 namespace {
 
-const wchar_t* LAYOUT_US = L"00000409";
-const wchar_t* LAYOUT_FR = L"0000040c";
+enum Layout {
+  LAYOUT_US,
+  LAYOUT_FR,
+  LAYOUT_KR,
+};
+
+// |LoadKeyboardLayout()| ensures the locale to be loaded into the system
+// (Similar to temporarily adding a locale in Control Panel), otherwise
+// |ToUnicodeEx()| will fall-back to the default locale.
+// See MSDN LoadKeyboardLayout():
+// https://msdn.microsoft.com/en-us/library/windows/desktop/ms646305(v=vs.85).aspx
+// And language constants and strings:
+// https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693(v=vs.85).aspx
+HKL GetInputLocale(Layout layout) {
+  switch (layout) {
+  case LAYOUT_US:
+    return ::LoadKeyboardLayout(L"00000409", KLF_ACTIVATE);
+  case LAYOUT_FR:
+    return ::LoadKeyboardLayout(L"0000040c", KLF_ACTIVATE);
+  case LAYOUT_KR:
+    // |GetInputLocale(L"00000412", KLF_ACTIVATE)| returns the coct

[chongz, 2016/06/24 17:05:32]

Also tried:
  1. L"0412:E0010412"
  2. L"E0010412"
  3. L"04120412"
  4. L"00010412"
Which returns the default locale and won't pass this unit test. (But will pass
DrMemory test)

1) 2): https://msdn.microsoft.com/en-us/goglobal/bb895996.aspx

[Wez, 2016/06/24 17:54:57]

What is the 'coct Korean locale'?

Do you mean 'LoadKeyboardLayout' rather than 'GetInputLocale'?

As noted on the bug, have you tried passing the fully qualified layout Id to
LoadKeyboardLayout (i.e. E0010412)?

[chongz, 2016/06/24 18:07:27]

Sorry for the typo... Yes it should be 'LoadKeyboardLayout()' and 'correct
Korean locale' (i.e. (HKL)0x04120412).

By 'fully qualified layout Id (E0010412)' do you mean 2) mentioned in the first
comment? If so yes I've tried it and it returns default locale. (i.e.
LoadKeyboardLayout(L"E0010412", KLF_ACTIVATE) => (HKL)0x04090409, which is
en-US)

[chongz, 2016/06/24 18:45:55]

Sure I'll wait for his comments.
Actually it won't fail because we are only testing non-printable keys on Korean.
i.e. We check the value of HKL (lowest byte == 0x12 LANG_KOREAN) and do the
mapping VKEY->DomKey.
Note: "ToUnicodeEx(layout)" returns empty string in this case.

However 'LoadKeyboardLayout()' is required for French tests because we need
'ToUnicodeEx(layout)' for printable keys.

+    // Korean locale, but it will fail on DrMemory tests.
+    // See https://crbug.com/612736#c6
+    // However we could bypass it since we are only testing non-printable keys
+    // on Korean locale.
+    // (This issue only happens on Korean and Japanese).
+    return reinterpret_cast<HKL>(0x04120412);
+  default:
+    return 0;
+  }
+}
 
 struct TestKey {
   // Have to use KeyboardCode instead of DomCode because we don't know the
   // physical keyboard layout for try bots.
   KeyboardCode key_code;
   const char* normal;
   const char* shift;
   const char* capslock;
   const char* altgr;
   const char* shift_capslock;
@@ skipping 61 matching lines @@
                               KeyboardCode key_code,
                               int flags) {
     return keymap.DomKeyFromNativeImpl(dom_code, key_code, flags);
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(PlatformKeyMapTest);
 };
 
 TEST_F(PlatformKeyMapTest, USLayout) {
-  HKL layout = ::LoadKeyboardLayout(LAYOUT_US, 0);
+  HKL layout = GetInputLocale(LAYOUT_US);
   PlatformKeyMap keymap(layout);
 
   const TestKey kUSLayoutTestCases[] = {
       //       n    s    c    a    sc   sa   ac
       {VKEY_0, "0", ")", "0", "0", ")", ")", "0"},
       {VKEY_1, "1", "!", "1", "1", "!", "!", "1"},
       {VKEY_2, "2", "@", "2", "2", "@", "@", "2"},
       {VKEY_3, "3", "#", "3", "3", "#", "#", "3"},
       {VKEY_4, "4", "$", "4", "4", "$", "$", "4"},
       {VKEY_5, "5", "%", "5", "5", "%", "%", "5"},
@@ skipping 28 matching lines @@
       {VKEY_Y, "y", "Y", "Y", "y", "y", "Y", "Y"},
       {VKEY_Z, "z", "Z", "Z", "z", "z", "Z", "Z"},
   };
 
   for (const auto& test_case : kUSLayoutTestCases) {
     CheckDomCodeToKeyString("USLayout", keymap, test_case, layout);
   }
 }
 
 TEST_F(PlatformKeyMapTest, FRLayout) {
-  HKL layout = ::LoadKeyboardLayout(LAYOUT_FR, 0);
+  HKL layout = GetInputLocale(LAYOUT_FR);
   PlatformKeyMap keymap(layout);
 
   const TestKey kFRLayoutTestCases[] = {
       //       n     s    c    a       sc    sa   ac
       {VKEY_0, "à",  "0", "0", "@",    "à",  "0", "@"},
       {VKEY_1, "&",  "1", "1", "&",    "&",  "1", "1"},
       {VKEY_2, "é",  "2", "2", "Dead", "é",  "2", "Dead"},
       {VKEY_3, "\"", "3", "3", "#",    "\"", "3", "#"},
       {VKEY_4, "\'", "4", "4", "{",    "\'", "4", "{"},
       {VKEY_5, "(",  "5", "5", "[",    "(",  "5", "["},
@@ skipping 28 matching lines @@
       {VKEY_Y, "y",  "Y", "Y", "y",    "y",  "Y", "Y"},
       {VKEY_Z, "z",  "Z", "Z", "z",    "z",  "Z", "Z"},
   };
 
   for (const auto& test_case : kFRLayoutTestCases) {
     CheckDomCodeToKeyString("FRLayout", keymap, test_case, layout);
   }
 }
 
 TEST_F(PlatformKeyMapTest, NumPad) {
-  HKL layout = ::LoadKeyboardLayout(LAYOUT_US, 0);
+  HKL layout = GetInputLocale(LAYOUT_US);
   PlatformKeyMap keymap(layout);
 
   const struct TestCase {
     KeyboardCode key_code;
     DomKey key;
   } kNumPadTestCases[] = {
       {VKEY_NUMPAD0, DomKey::FromCharacter('0')},
       {VKEY_NUMPAD1, DomKey::FromCharacter('1')},
       {VKEY_NUMPAD2, DomKey::FromCharacter('2')},
       {VKEY_NUMPAD3, DomKey::FromCharacter('3')},
@@ skipping 31 matching lines @@
               DomKeyFromNativeImpl(keymap, dom_code, key_code, EF_CONTROL_DOWN))
         << key_code;
     EXPECT_EQ(test_case.key,
               DomKeyFromNativeImpl(keymap, dom_code, key_code,
                                    EF_ALTGR_DOWN | EF_CONTROL_DOWN))
         << key_code;
   }
 }
 
 TEST_F(PlatformKeyMapTest, NonPrintableKey) {
-  HKL layout = ::LoadKeyboardLayout(LAYOUT_US, 0);
+  HKL layout = GetInputLocale(LAYOUT_US);
   PlatformKeyMap keymap(layout);
 
   for (const auto& test_case : kNonPrintableCodeMap) {
     // Not available on |LAYOUT_US|.
     if (test_case.dom_code == DomCode::PAUSE ||
         test_case.dom_code == DomCode::LANG2 ||
         test_case.dom_code == DomCode::NON_CONVERT)
       continue;
 
     int scan_code =
@@ skipping 16 matching lines @@
         test_case.dom_key,
         DomKeyFromNativeImpl(keymap, DomCode::NONE, key_code, EF_CONTROL_DOWN))
         << key_code << ", " << scan_code;
     EXPECT_EQ(test_case.dom_key,
               DomKeyFromNativeImpl(keymap, DomCode::NONE, key_code,
                                    EF_ALTGR_DOWN | EF_CONTROL_DOWN))
         << key_code << ", " << scan_code;
   }
 }
 
+TEST_F(PlatformKeyMapTest, KoreanSpecificKeys) {
+  const struct TestCase {
+    KeyboardCode key_code;
+    DomKey key;
+  } kKoreanTestCases[] = {
+      {VKEY_HANGUL, DomKey::HANGUL_MODE}, {VKEY_HANJA, DomKey::HANJA_MODE},
+  };
+
+  // US English should not return values for these keys.
+  HKL us_layout = GetInputLocale(LAYOUT_US);
+  PlatformKeyMap us_keymap(us_layout);
+  for (const auto& test_case : kKoreanTestCases) {
+    EXPECT_EQ(DomKey::NONE, DomKeyFromNativeImpl(us_keymap, DomCode::NONE,
+                                                 test_case.key_code, EF_NONE))
+        << test_case.key_code;
+  }
+
+  // Korean layout should return specific DomKey.
+  HKL ko_layout = GetInputLocale(LAYOUT_KR);
+  PlatformKeyMap ko_keymap(ko_layout);
+  for (const auto& test_case : kKoreanTestCases) {
+    EXPECT_EQ(test_case.key, DomKeyFromNativeImpl(ko_keymap, DomCode::NONE,
+                                                  test_case.key_code, EF_NONE))
+        << test_case.key_code;
+  }
+}
+
 }  // namespace ui