[DomKey] Support Japanese (JIS) layout special keys

ui/events/keycodes/platform_key_map_win.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 <utility>
 
 #include "base/lazy_instance.h"
 #include "base/logging.h"
@@ skipping 191 matching lines @@
   WORD primary_language = PRIMARYLANGID(language);
   if (primary_language == LANG_KOREAN) {
     switch (key_code) {
       case VKEY_HANGUL:
         return DomKey::HANGUL_MODE;
       case VKEY_HANJA:
         return DomKey::HANJA_MODE;
       default:
         return DomKey::NONE;
     }
+  } else if (primary_language == LANG_JAPANESE) {
+    switch (key_code) {
+      case VKEY_KANA:
+        return DomKey::KANA_MODE;

[chongz, 2016/07/06 22:50:34]

|VKEY_KANA| is not used with modern Japanese keyboard (they use |VKEY_ATTN|
instead), but we want to match FF and IE to support it.

https://hg.mozilla.org/integration/mozilla-inbound/rev/b5fddca814e0#l1.146

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

When you say "modern keyboard" do you mean modern Japanese layouts have switched
to VKEY_ATTN?

Suggest merging this with the VKEY_ATTN switch case, so it's more obvious that
the two values generate the same output.

You might add a comment saying that some Japanese layouts used VKEY_KANA for
KANA_MODE, while others use VKEY_ATTN, so we map them both for compatibility.

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

Actually FireFox says so but I cannot find more info about VK_KANA. However at
least my keyboard is producing VK_ATTN on Win 10, and I cannot figure out how to
produce VK_KANA using it.
Done.

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

That's really unfortunate. It sounds like the Firefox rationale was that it
exists and when they injected it into IE it had generated KanaMode, so we should
make sure our comment reflects that, e.g:

"VKEY_KANA isn't generated by any modern layouts but is a listed value that
third-party apps might synthesize, so we handle it anyway."

+      case VKEY_KANJI:
+        return DomKey::KANJI_MODE;
+      case VKEY_OEM_ATTN:
+        return DomKey::ALPHANUMERIC;
+      case VKEY_OEM_FINISH:
+        return DomKey::KATAKANA;
+      case VKEY_OEM_COPY:
+        return DomKey::HIRAGANA;
+      case VKEY_DBE_SBCSCHAR:
+        return DomKey::HANKAKU;
+      case VKEY_DBE_DBCSCHAR:
+        return DomKey::ZENKAKU;
+      case VKEY_OEM_BACKTAB:
+        return DomKey::ROMAJI;
+      case VKEY_ATTN:
+        return DomKey::KANA_MODE;

[chongz, 2016/07/06 22:50:34]

On other layouts |VKEY_ATTN| will be mapped to |DomKey::ATTN|.

+      default:
+        return DomKey::NONE;
+    }
   }
-  // TODO(chongz): Handle Japanese keyboard layout keys 0xF0..0xF5, VKEY_KANA,
-  // VKEY_KANJI.
-  // https://crbug.com/612694
   return DomKey::NONE;
 }
 
 DomKey NonPrintableKeyboardCodeToDomKey(KeyboardCode key_code, HKL layout) {
-  // 1. Most |key_codes| have the same meaning regardless of |layout|.
+  // 1. Check if |key_code| has a |layout|-specific meaning.
+  const DomKey key = LanguageSpecificOemKeyboardCodeToDomKey(key_code, layout);
+  if (key != DomKey::NONE)
+    return key;

[chongz, 2016/07/06 22:50:34]

Do language mapping first so JIS could map |VKEY_ATTN| to |DomKey::KANA_MODE|.

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

Acknowledged.

+
+  // 2. Most |key_codes| have the same meaning regardless of |layout|.
   const NonPrintableKeyEntry* result = std::lower_bound(
       std::begin(kNonPrintableKeyMap), std::end(kNonPrintableKeyMap), key_code,
       [](const NonPrintableKeyEntry& entry, KeyboardCode needle) {
         return entry.key_code < needle;
       });
   if (result != std::end(kNonPrintableKeyMap) && result->key_code == key_code)
     return result->dom_key;
-  // 2. Look up a |layout|-specific meaning for |key_code|.
-  return LanguageSpecificOemKeyboardCodeToDomKey(key_code, layout);
+
+  return DomKey::NONE;
 }
 
 void CleanupKeyMapTls(void* data) {
   PlatformKeyMap* key_map = reinterpret_cast<PlatformKeyMap*>(data);
   delete key_map;
 }
 
 struct PlatformKeyMapInstanceTlsTraits
     : public base::DefaultLazyInstanceTraits<base::ThreadLocalStorage::Slot> {
   static base::ThreadLocalStorage::Slot* New(void* instance) {
@@ skipping 33 matching lines @@
       flags & (EF_SHIFT_DOWN | EF_CAPS_LOCK_ON),
       EF_NONE,
   };
 
   for (auto try_flags : flags_to_try) {
     const auto& it = printable_keycode_to_key_.find(
         std::make_pair(static_cast<int>(key_code), try_flags));
     if (it != printable_keycode_to_key_.end()) {
       key = it->second;
       if (key != DomKey::NONE)
-        break;
+        return key;
     }
   }
 
-  return key;
+  // Return DomKey::UNIDENTIFIED to prevent US layout fall-back.
+  return DomKey::UNIDENTIFIED;

[chongz, 2016/07/06 22:50:34]

|KeyEvent::ApplyLayout()| will do the fall-back mapping |DomCode->DomKey| if the
key is |DomKey::NONE|.

We want to avoid that so |KanaMode| key could produce "Unidentified" on
non-Japanese layout. (DomCode is still "KanaMode")

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

Acknowledged.

 }
 
 // static
 DomKey PlatformKeyMap::DomKeyFromKeyboardCode(KeyboardCode key_code,
                                               int flags) {
   // Use TLS because KeyboardLayout is per thread.
   // However currently PlatformKeyMap will only be used by the host application,
   // which is just one process and one thread.
   base::ThreadLocalStorage::Slot* platform_key_map_tls =
       g_platform_key_map_tls_lazy.Pointer();
@@ skipping 64 matching lines @@
         }
       } else {
         // TODO(chongz): Handle rv <= -2 and rv >= 2.
       }
     }
   }
   ::SetKeyboardState(keyboard_state_to_restore);
 }
 
 }  // namespace ui