[DomKey] Support Japanese (JIS) layout special keys

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 {
 
 enum Layout {
   LAYOUT_US,
   LAYOUT_FR,
   LAYOUT_KR,
+  LAYOUT_JP,
 };
 
 // |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:
       // |LoadKeyboardLayout(L"00000412", KLF_ACTIVATE)| returns the correct
       // 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);
+    case LAYOUT_JP:
+      return reinterpret_cast<HKL>(0x04110411);

[Wez, 2016/07/07 18:25:51]

LoadKeyboardLayout doesn't work here?

[chongz, 2016/07/07 22:18:09]

Yes |LoadKeyboardLayout()| won't pass DrMemory test for Japanese and Korean. 

I haven't started looking how to add DrMemory test suppression, but it should be
fine as is since we are not using |ToUnicodeEx()|.

[Wez, 2016/07/08 23:34:07]

OK, what I was missing is that we just pull the "primary language" out of this
value, without calling any Windows APIs (since we don't look at any printable
keys), so it's OK not to have the layouts actually loaded.

     default:
       return 0;
   }
 }
 
 struct TestKey {
   KeyboardCode key_code;
   const char* normal;
   const char* shift;
   const char* capslock;
@@ skipping 50 matching lines @@
     EXPECT_STREQ(test_case.altgr_capslock,
                  KeycodeConverter::DomKeyToKeyString(
                      keymap.DomKeyFromKeyboardCodeImpl(
                          key_code, EF_ALTGR_DOWN | EF_CAPS_LOCK_ON))
                      .c_str())
         << label;
   }
 
   DomKey DomKeyFromKeyboardCodeImpl(const PlatformKeyMap& keymap,
                                     KeyboardCode key_code,
                                     int flags) {

[Wez, 2016/07/07 18:25:51]

What's the point of this "helper"? It just seems to convert between
function-call and method-call syntax..?

[chongz, 2016/07/07 22:18:09]

Because |PlatformKeyMap::DomKeyFromKeyboardCodeImpl| is private and I cannot
access it in "TEST_F(PlatformKeyMapTest, ECT) {...}".

Added a comment:
// Need this helper function to access private methods of |PlatformKeyMap|.

[Wez, 2016/07/08 23:34:07]

Acknowledged.

     return keymap.DomKeyFromKeyboardCodeImpl(key_code, flags);
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(PlatformKeyMapTest);
 };
 
 TEST_F(PlatformKeyMapTest, USLayout) {
   HKL layout = GetInputLocale(LAYOUT_US);
   PlatformKeyMap keymap(layout);
@@ skipping 184 matching lines @@
     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, DomKeyFromKeyboardCodeImpl(
-                                us_keymap, test_case.key_code, EF_NONE))
+    EXPECT_EQ(DomKey::UNIDENTIFIED, DomKeyFromKeyboardCodeImpl(
+                                        us_keymap, 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, DomKeyFromKeyboardCodeImpl(
                                  ko_keymap, test_case.key_code, EF_NONE))
         << test_case.key_code;
   }
 }
 
+TEST_F(PlatformKeyMapTest, JapaneseSpecificKeys) {
+  const struct TestCase {
+    KeyboardCode key_code;
+    DomKey jp_key;
+    DomKey us_key;
+  } kJapaneseTestCases[] = {
+      {VKEY_KANA, DomKey::KANA_MODE, DomKey::UNIDENTIFIED},
+      {VKEY_KANJI, DomKey::KANJI_MODE, DomKey::UNIDENTIFIED},
+      {VKEY_OEM_ATTN, DomKey::ALPHANUMERIC, DomKey::UNIDENTIFIED},
+      {VKEY_OEM_FINISH, DomKey::KATAKANA, DomKey::UNIDENTIFIED},
+      {VKEY_OEM_COPY, DomKey::HIRAGANA, DomKey::UNIDENTIFIED},
+      {VKEY_DBE_SBCSCHAR, DomKey::HANKAKU, DomKey::UNIDENTIFIED},
+      {VKEY_DBE_DBCSCHAR, DomKey::ZENKAKU, DomKey::UNIDENTIFIED},
+      {VKEY_OEM_BACKTAB, DomKey::ROMAJI, DomKey::UNIDENTIFIED},
+      {VKEY_ATTN, DomKey::KANA_MODE, DomKey::ATTN},
+  };
+
+  // US English should not return values for these keys.
+  HKL us_layout = GetInputLocale(LAYOUT_US);
+  PlatformKeyMap us_keymap(us_layout);

[Wez, 2016/07/07 18:25:51]

nit: Here and elsewhere, I think it's OK to pass the result of GetInputLocale()
directly to the PlatformKeyMap constructor.

[chongz, 2016/07/07 22:18:09]

Done. Except one place for DomCode=>Key testing.

+  for (const auto& test_case : kJapaneseTestCases) {

[Wez, 2016/07/07 18:25:51]

Suggest folding these two loops into one, for clarity - create the two layouts
and then loop over the cases, doing two EXPECT_EQ()s in each iteration, one for
us, one for Japanese.

[chongz, 2016/07/07 22:18:09]

Done.

+    EXPECT_EQ(test_case.us_key, DomKeyFromKeyboardCodeImpl(
+                                    us_keymap, test_case.key_code, EF_NONE))
+        << test_case.key_code;
+  }
+
+  // Japanese layout should return specific DomKey.
+  HKL jp_layout = GetInputLocale(LAYOUT_JP);
+  PlatformKeyMap ko_keymap(jp_layout);

[Wez, 2016/07/07 18:25:51]

jp_keymap?

[chongz, 2016/07/07 22:18:09]

Done.

+  for (const auto& test_case : kJapaneseTestCases) {
+    EXPECT_EQ(test_case.jp_key, DomKeyFromKeyboardCodeImpl(
+                                    ko_keymap, test_case.key_code, EF_NONE))
+        << test_case.key_code;
+  }
+}
+
 }  // namespace ui