Use rewriting to make ChromeOS keyboard F<number> keys produce extended keycodes.

chrome/browser/ui/ash/event_rewriter_unittest.cc

 // Copyright (c) 2012 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 "chrome/browser/ui/ash/event_rewriter.h"
 
 #include "base/basictypes.h"
 #include "base/command_line.h"
 #include "base/stringprintf.h"
 #include "chrome/browser/api/prefs/pref_member.h"
@@ skipping 99 matching lines @@
         keycode_backspace_(XKeysymToKeycode(display_, XK_BackSpace)),
         keycode_up_(XKeysymToKeycode(display_, XK_Up)),
         keycode_down_(XKeysymToKeycode(display_, XK_Down)),
         keycode_left_(XKeysymToKeycode(display_, XK_Left)),
         keycode_right_(XKeysymToKeycode(display_, XK_Right)),
         keycode_prior_(XKeysymToKeycode(display_, XK_Prior)),
         keycode_next_(XKeysymToKeycode(display_, XK_Next)),
         keycode_home_(XKeysymToKeycode(display_, XK_Home)),
         keycode_end_(XKeysymToKeycode(display_, XK_End)),
         keycode_launch7_(XKeysymToKeycode(display_, XF86XK_Launch7)),
+        keycode_f1_(XKeysymToKeycode(display_, XK_F1)),
+        keycode_f2_(XKeysymToKeycode(display_, XK_F2)),
+        keycode_f3_(XKeysymToKeycode(display_, XK_F3)),
+        keycode_f4_(XKeysymToKeycode(display_, XK_F4)),
+        keycode_f5_(XKeysymToKeycode(display_, XK_F5)),
+        keycode_f6_(XKeysymToKeycode(display_, XK_F6)),
+        keycode_f7_(XKeysymToKeycode(display_, XK_F7)),
+        keycode_f8_(XKeysymToKeycode(display_, XK_F8)),
+        keycode_f9_(XKeysymToKeycode(display_, XK_F9)),
+        keycode_f10_(XKeysymToKeycode(display_, XK_F10)),
+        keycode_f11_(XKeysymToKeycode(display_, XK_F11)),
+        keycode_f12_(XKeysymToKeycode(display_, XK_F12)),
+        keycode_browser_back_(XKeysymToKeycode(display_, XF86XK_Back)),

[Yusuke Sato, 2012/11/26 07:28:19]

Using XF86XK keysyms probably has the same issue as
https://code.google.com/p/chromium/issues/detail?id=158585 .

[danakj, 2012/11/26 17:50:38]

Oh darn :( Okay, I'll make this work for now, and point to the bug.

+        keycode_browser_forward_(XKeysymToKeycode(display_, XF86XK_Forward)),
+        keycode_browser_refresh_(XKeysymToKeycode(display_, XF86XK_Reload)),
+        keycode_media_launch_app1_(XKeysymToKeycode(display_, XF86XK_LaunchA)),
+        keycode_media_launch_app2_(XKeysymToKeycode(display_, XF86XK_LaunchB)),
+        keycode_brightness_down_(XKeysymToKeycode(
+            display_, XF86XK_MonBrightnessDown)),
+        keycode_brightness_up_(XKeysymToKeycode(
+            display_, XF86XK_MonBrightnessUp)),
+        keycode_volume_mute_(XKeysymToKeycode(display_, XF86XK_AudioMute)),
+        keycode_volume_down_(XKeysymToKeycode(
+            display_, XF86XK_AudioLowerVolume)),
+        keycode_volume_up_(XKeysymToKeycode(
+            display_, XF86XK_AudioRaiseVolume)),
+        keycode_power_(XKeysymToKeycode(display_, XF86XK_PowerOff)),
+        keycode_1_(XKeysymToKeycode(display_, XK_1)),
+        keycode_2_(XKeysymToKeycode(display_, XK_2)),
+        keycode_3_(XKeysymToKeycode(display_, XK_3)),
+        keycode_4_(XKeysymToKeycode(display_, XK_4)),
+        keycode_5_(XKeysymToKeycode(display_, XK_5)),
+        keycode_6_(XKeysymToKeycode(display_, XK_6)),
+        keycode_7_(XKeysymToKeycode(display_, XK_7)),
+        keycode_8_(XKeysymToKeycode(display_, XK_8)),
+        keycode_9_(XKeysymToKeycode(display_, XK_9)),
+        keycode_0_(XKeysymToKeycode(display_, XK_0)),
+        keycode_minus_(XKeysymToKeycode(display_, XK_minus)),
+        keycode_equal_(XKeysymToKeycode(display_, XK_equal)),
         input_method_manager_mock_(NULL) {
   }
   virtual ~EventRewriterTest() {}
 
   virtual void SetUp() {
     // Mocking user manager because the real one needs to be called on UI thread
     EXPECT_CALL(*user_manager_mock_.user_manager(), IsLoggedInAsGuest())
         .WillRepeatedly(testing::Return(false));
     input_method_manager_mock_ =
         new chromeos::input_method::MockInputMethodManager;
@@ skipping 46 matching lines @@
   const KeyCode keycode_backspace_;
   const KeyCode keycode_up_;
   const KeyCode keycode_down_;
   const KeyCode keycode_left_;
   const KeyCode keycode_right_;
   const KeyCode keycode_prior_;
   const KeyCode keycode_next_;
   const KeyCode keycode_home_;
   const KeyCode keycode_end_;
   const KeyCode keycode_launch7_;  // F16
+  const KeyCode keycode_f1_;
+  const KeyCode keycode_f2_;
+  const KeyCode keycode_f3_;
+  const KeyCode keycode_f4_;
+  const KeyCode keycode_f5_;
+  const KeyCode keycode_f6_;
+  const KeyCode keycode_f7_;
+  const KeyCode keycode_f8_;
+  const KeyCode keycode_f9_;
+  const KeyCode keycode_f10_;
+  const KeyCode keycode_f11_;
+  const KeyCode keycode_f12_;
+  const KeyCode keycode_browser_back_;
+  const KeyCode keycode_browser_forward_;
+  const KeyCode keycode_browser_refresh_;
+  const KeyCode keycode_media_launch_app1_;
+  const KeyCode keycode_media_launch_app2_;
+  const KeyCode keycode_brightness_down_;
+  const KeyCode keycode_brightness_up_;
+  const KeyCode keycode_volume_mute_;
+  const KeyCode keycode_volume_down_;
+  const KeyCode keycode_volume_up_;
+  const KeyCode keycode_power_;
+  const KeyCode keycode_1_;
+  const KeyCode keycode_2_;
+  const KeyCode keycode_3_;
+  const KeyCode keycode_4_;
+  const KeyCode keycode_5_;
+  const KeyCode keycode_6_;
+  const KeyCode keycode_7_;
+  const KeyCode keycode_8_;
+  const KeyCode keycode_9_;
+  const KeyCode keycode_0_;
+  const KeyCode keycode_minus_;
+  const KeyCode keycode_equal_;
   chromeos::ScopedMockUserManagerEnabler user_manager_mock_;
   chromeos::input_method::MockInputMethodManager* input_method_manager_mock_;
 };
 
 }  // namespace
 #else
 class EventRewriterTest : public testing::Test {
  public:
   EventRewriterTest() {}
   virtual ~EventRewriterTest() {}
@@ skipping 1786 matching lines @@
                                       ControlMask,
                                       KeyPress),
             GetRewrittenEventAsString(&rewriter,
                                       ui::VKEY_RIGHT,
                                       0,
                                       ui::ET_KEY_PRESSED,
                                       keycode_right_,
                                       Mod4Mask | ControlMask));
 }
 
+TEST_F(EventRewriterTest, TestRewriteFunctionKeys) {
+  TestingPrefService prefs;
+  chromeos::Preferences::RegisterUserPrefs(&prefs);
+  EventRewriter rewriter;
+  rewriter.set_pref_service_for_testing(&prefs);
+
+  // When --has-chromeos-keyboard is not enabled, F<numbers> are not rewritten.
+
+  struct {
+    ui::KeyboardCode input;
+    KeyCode input_native;
+    ui::KeyboardCode output;
+    KeyCode output_native;
+  } default_tests[] = {
+    { ui::VKEY_F1, keycode_f1_, ui::VKEY_F1, keycode_f1_, },
+    { ui::VKEY_F2, keycode_f2_, ui::VKEY_F2, keycode_f2_, },
+    { ui::VKEY_F3, keycode_f3_, ui::VKEY_F3, keycode_f3_, },
+    { ui::VKEY_F4, keycode_f4_, ui::VKEY_F4, keycode_f4_, },
+    { ui::VKEY_F5, keycode_f5_, ui::VKEY_F5, keycode_f5_, },
+    { ui::VKEY_F6, keycode_f6_, ui::VKEY_F6, keycode_f6_, },
+    { ui::VKEY_F7, keycode_f7_, ui::VKEY_F7, keycode_f7_, },
+    { ui::VKEY_F8, keycode_f8_, ui::VKEY_F8, keycode_f8_, },
+    { ui::VKEY_F9, keycode_f9_, ui::VKEY_F9, keycode_f9_, },
+    { ui::VKEY_F10, keycode_f10_, ui::VKEY_F10, keycode_f10_, },
+    { ui::VKEY_F11, keycode_f11_, ui::VKEY_F11, keycode_f11_, },
+    { ui::VKEY_F12, keycode_f12_, ui::VKEY_F12, keycode_f12_, },
+    { ui::VKEY_1, keycode_1_, ui::VKEY_1, keycode_1_, },
+    { ui::VKEY_2, keycode_2_, ui::VKEY_2, keycode_2_, },
+    { ui::VKEY_3, keycode_3_, ui::VKEY_3, keycode_3_, },
+    { ui::VKEY_4, keycode_4_, ui::VKEY_4, keycode_4_, },
+    { ui::VKEY_5, keycode_5_, ui::VKEY_5, keycode_5_, },
+    { ui::VKEY_6, keycode_6_, ui::VKEY_6, keycode_6_, },
+    { ui::VKEY_7, keycode_7_, ui::VKEY_7, keycode_7_, },
+    { ui::VKEY_8, keycode_8_, ui::VKEY_8, keycode_8_, },
+    { ui::VKEY_9, keycode_9_, ui::VKEY_9, keycode_9_, },
+    { ui::VKEY_0, keycode_0_, ui::VKEY_0, keycode_0_, },
+    { ui::VKEY_OEM_MINUS, keycode_minus_, ui::VKEY_OEM_MINUS, keycode_minus_, },
+    { ui::VKEY_OEM_PLUS, keycode_equal_, ui::VKEY_OEM_PLUS, keycode_equal_, },
+  };
+
+  for (size_t i = 0; i < ARRAYSIZE_UNSAFE(default_tests); ++i) {
+    EXPECT_EQ(GetExpectedResultAsString(default_tests[i].output,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        default_tests[i].output_native,
+                                        0U,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        default_tests[i].input,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        default_tests[i].input_native,
+                                        0));
+
+    // Search key as a modifier does not change the outcome.
+    EXPECT_EQ(GetExpectedResultAsString(default_tests[i].output,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        default_tests[i].output_native,
+                                        Mod4Mask,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        default_tests[i].input,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        default_tests[i].input_native,
+                                        Mod4Mask));
+  }
+
+  // When --has-chromeos-keyboard is enabled, F<number> keys do special stuff.
+  const CommandLine original_cl(*CommandLine::ForCurrentProcess());
+  CommandLine::ForCurrentProcess()->AppendSwitchASCII(
+      switches::kHasChromeOSKeyboard, "");
+
+  struct {
+    ui::KeyboardCode input;
+    KeyCode input_native;
+    ui::KeyboardCode output;
+    KeyCode output_native;
+  } chromeos_tests[] = {
+    { // F1 -> Back
+      ui::VKEY_F1, keycode_f1_,
+      ui::VKEY_BROWSER_BACK, keycode_browser_back_
+    },
+    { // F2 -> Forward
+      ui::VKEY_F2, keycode_f2_,
+      ui::VKEY_BROWSER_FORWARD, keycode_browser_forward_
+    },
+    { // F3 -> Refresh
+      ui::VKEY_F3, keycode_f3_,
+      ui::VKEY_BROWSER_REFRESH, keycode_browser_refresh_
+    },
+    { // F4 -> Launch App 2
+      ui::VKEY_F4, keycode_f4_,
+      ui::VKEY_MEDIA_LAUNCH_APP2, keycode_media_launch_app2_
+    },
+    { // F5 -> Launch App 1
+      ui::VKEY_F5, keycode_f5_,
+      ui::VKEY_MEDIA_LAUNCH_APP1, keycode_media_launch_app1_
+    },
+    { // F6 -> Brightness down
+      ui::VKEY_F6, keycode_f6_,
+      ui::VKEY_BRIGHTNESS_DOWN, keycode_brightness_down_
+    },
+    { // F7 -> Brightness up
+      ui::VKEY_F7, keycode_f7_,
+      ui::VKEY_BRIGHTNESS_UP, keycode_brightness_up_
+    },
+    { // F8 -> Volume Mute
+      ui::VKEY_F8, keycode_f8_,
+      ui::VKEY_VOLUME_MUTE, keycode_volume_mute_
+    },
+    { // F9 -> Volume Down
+      ui::VKEY_F9, keycode_f9_,
+      ui::VKEY_VOLUME_DOWN, keycode_volume_down_
+    },
+    { // F10 -> Volume Up
+      ui::VKEY_F10, keycode_f10_,
+      ui::VKEY_VOLUME_UP, keycode_volume_up_
+    },
+    { // F11 -> Power
+      ui::VKEY_F11, keycode_f11_,
+      ui::VKEY_POWER, keycode_power_
+    },
+    { // F12 -> F12
+      ui::VKEY_F12, keycode_f12_,
+      ui::VKEY_F12, keycode_f12_,
+    },
+    // The number row should not be rewritten.
+    { ui::VKEY_1, keycode_1_, ui::VKEY_1, keycode_1_, },
+    { ui::VKEY_2, keycode_2_, ui::VKEY_2, keycode_2_, },
+    { ui::VKEY_3, keycode_3_, ui::VKEY_3, keycode_3_, },
+    { ui::VKEY_4, keycode_4_, ui::VKEY_4, keycode_4_, },
+    { ui::VKEY_5, keycode_5_, ui::VKEY_5, keycode_5_, },
+    { ui::VKEY_6, keycode_6_, ui::VKEY_6, keycode_6_, },
+    { ui::VKEY_7, keycode_7_, ui::VKEY_7, keycode_7_, },
+    { ui::VKEY_8, keycode_8_, ui::VKEY_8, keycode_8_, },
+    { ui::VKEY_9, keycode_9_, ui::VKEY_9, keycode_9_, },
+    { ui::VKEY_0, keycode_0_, ui::VKEY_0, keycode_0_, },
+    { ui::VKEY_OEM_MINUS, keycode_minus_, ui::VKEY_OEM_MINUS, keycode_minus_, },
+    { ui::VKEY_OEM_PLUS, keycode_equal_, ui::VKEY_OEM_PLUS, keycode_equal_, },
+  };
+
+  for (size_t i = 0; i < ARRAYSIZE_UNSAFE(chromeos_tests); ++i) {
+    EXPECT_EQ(GetExpectedResultAsString(chromeos_tests[i].output,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        chromeos_tests[i].output_native,
+                                        0U,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        chromeos_tests[i].input,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        chromeos_tests[i].input_native,
+                                        0));
+
+    // Search key as a modifier does not change the outcome.
+    EXPECT_EQ(GetExpectedResultAsString(chromeos_tests[i].output,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        chromeos_tests[i].output_native,
+                                        Mod4Mask,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        chromeos_tests[i].input,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        chromeos_tests[i].input_native,
+                                        Mod4Mask));
+  }
+
+  // Make Search key act like a Function key for accessing extended key
+  // bindings. Now Search key as a modifier will make the number row
+  // act like the F<number> row.
+  BooleanPrefMember search_key_as_function_key;
+  search_key_as_function_key.Init(prefs::kLanguageSearchKeyActsAsFunctionKey,
+                                  &prefs, NULL);
+  search_key_as_function_key.SetValue(true);
+
+  // Without a Search key modifier, the results should be the same as before.
+  for (size_t i = 0; i < ARRAYSIZE_UNSAFE(chromeos_tests); ++i) {
+    EXPECT_EQ(GetExpectedResultAsString(chromeos_tests[i].output,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        chromeos_tests[i].output_native,
+                                        0U,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        chromeos_tests[i].input,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        chromeos_tests[i].input_native,
+                                        0));
+  }
+
+  struct {
+    ui::KeyboardCode input;
+    KeyCode input_native;
+    ui::KeyboardCode output;
+    KeyCode output_native;
+  } search_key_tests[] = {
+    // The number row should be rewritten as the F<number> row.
+    { ui::VKEY_1, keycode_1_, ui::VKEY_F1, keycode_f1_, },
+    { ui::VKEY_2, keycode_2_, ui::VKEY_F2, keycode_f2_, },
+    { ui::VKEY_3, keycode_3_, ui::VKEY_F3, keycode_f3_, },
+    { ui::VKEY_4, keycode_4_, ui::VKEY_F4, keycode_f4_, },
+    { ui::VKEY_5, keycode_5_, ui::VKEY_F5, keycode_f5_, },
+    { ui::VKEY_6, keycode_6_, ui::VKEY_F6, keycode_f6_, },
+    { ui::VKEY_7, keycode_7_, ui::VKEY_F7, keycode_f7_, },
+    { ui::VKEY_8, keycode_8_, ui::VKEY_F8, keycode_f8_, },
+    { ui::VKEY_9, keycode_9_, ui::VKEY_F9, keycode_f9_, },
+    { ui::VKEY_0, keycode_0_, ui::VKEY_F10, keycode_f10_, },
+    { ui::VKEY_OEM_MINUS, keycode_minus_, ui::VKEY_F11, keycode_f11_, },
+    { ui::VKEY_OEM_PLUS, keycode_equal_, ui::VKEY_F12, keycode_f12_, },
+  };
+
+  // But with a Search key as a modifier, we should have new rewrite rules now.
+  for (size_t i = 0; i < ARRAYSIZE_UNSAFE(search_key_tests); ++i) {
+    EXPECT_EQ(GetExpectedResultAsString(search_key_tests[i].output,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        search_key_tests[i].output_native,
+                                        0,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        search_key_tests[i].input,
+                                        0,
+                                        ui::ET_KEY_PRESSED,
+                                        search_key_tests[i].input_native,
+                                        Mod4Mask));
+
+    // Other modifiers should be preserved.
+    EXPECT_EQ(GetExpectedResultAsString(search_key_tests[i].output,
+                                        ui::EF_ALT_DOWN,
+                                        ui::ET_KEY_PRESSED,
+                                        search_key_tests[i].output_native,
+                                        Mod1Mask,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        search_key_tests[i].input,
+                                        ui::EF_ALT_DOWN,
+                                        ui::ET_KEY_PRESSED,
+                                        search_key_tests[i].input_native,
+                                        Mod4Mask | Mod1Mask));
+
+    EXPECT_EQ(GetExpectedResultAsString(search_key_tests[i].output,
+                                        ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN,
+                                        ui::ET_KEY_PRESSED,
+                                        search_key_tests[i].output_native,
+                                        ControlMask | Mod1Mask,
+                                        KeyPress),
+              GetRewrittenEventAsString(&rewriter,
+                                        search_key_tests[i].input,
+                                        ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN,
+                                        ui::ET_KEY_PRESSED,
+                                        search_key_tests[i].input_native,
+                                        Mod4Mask | ControlMask | Mod1Mask));
+  }
+
+  *CommandLine::ForCurrentProcess() = original_cl;
+}
+
 TEST_F(EventRewriterTest, TestRewriteBackspaceAndArrowKeysWithSearchRemapped) {
   // Remap Search to Control.
   TestingPrefService prefs;
   chromeos::Preferences::RegisterUserPrefs(&prefs);
   IntegerPrefMember search;
   search.Init(prefs::kLanguageRemapSearchKeyTo, &prefs, NULL);
   search.SetValue(chromeos::input_method::kControlKey);
 
   EventRewriter rewriter;
   rewriter.set_pref_service_for_testing(&prefs);
@@ skipping 58 matching lines @@
   // flag in the event is True.
   EXPECT_EQ(GetExpectedResultAsString(ui::VKEY_CONTROL,
                                       ui::EF_CONTROL_DOWN,
                                       ui::ET_KEY_PRESSED,
                                       keycode_control_l_,
                                       0U,
                                       KeyPress),
             rewritten_event);
 }
 #endif  // OS_CHROMEOS