Handle X11 Mod3Mask for Caps Lock remapping.

chrome/browser/chromeos/events/event_rewriter_unittest.cc

 // Copyright 2014 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/chromeos/events/event_rewriter.h"
 
 #include <X11/keysym.h>
 #include <X11/XF86keysym.h>
 #include <X11/Xlib.h>
 #undef Bool
@@ skipping 853 matching lines @@
   search.SetValue(chromeos::input_method::kCapsLockKey);
 
   chromeos::input_method::FakeImeKeyboard ime_keyboard;
   EventRewriter rewriter;
   rewriter.set_pref_service_for_testing(&prefs);
   rewriter.set_ime_keyboard_for_testing(&ime_keyboard);
   EXPECT_FALSE(ime_keyboard.caps_lock_is_enabled_);
 
   // Press Search.
   EXPECT_EQ(
-      GetExpectedResultAsString(
-          ui::VKEY_CAPITAL, ui::EF_CAPS_LOCK_DOWN, ui::ET_KEY_PRESSED),
+      GetExpectedResultAsString(ui::VKEY_CAPITAL,
+                                ui::EF_CAPS_LOCK_DOWN | ui::EF_MOD3_DOWN,
+                                ui::ET_KEY_PRESSED),
       GetRewrittenEventAsString(
           &rewriter, ui::VKEY_LWIN, ui::EF_COMMAND_DOWN, ui::ET_KEY_PRESSED));
   // Confirm that the Caps Lock status is changed.
   EXPECT_TRUE(ime_keyboard.caps_lock_is_enabled_);
 
   // Release Search.
   EXPECT_EQ(GetExpectedResultAsString(
                 ui::VKEY_CAPITAL, ui::EF_NONE, ui::ET_KEY_RELEASED),
             GetRewrittenEventAsString(
                 &rewriter, ui::VKEY_LWIN, ui::EF_NONE, ui::ET_KEY_RELEASED));
   // Confirm that the Caps Lock status is not changed.
   EXPECT_TRUE(ime_keyboard.caps_lock_is_enabled_);
 
   // Press Search.
   EXPECT_EQ(
-      GetExpectedResultAsString(
-          ui::VKEY_CAPITAL, ui::EF_CAPS_LOCK_DOWN, ui::ET_KEY_PRESSED),
+      GetExpectedResultAsString(ui::VKEY_CAPITAL,
+                                ui::EF_CAPS_LOCK_DOWN | ui::EF_MOD3_DOWN,
+                                ui::ET_KEY_PRESSED),
       GetRewrittenEventAsString(&rewriter,
                                 ui::VKEY_LWIN,
                                 ui::EF_COMMAND_DOWN | ui::EF_CAPS_LOCK_DOWN,
                                 ui::ET_KEY_PRESSED));
   // Confirm that the Caps Lock status is changed.
   EXPECT_FALSE(ime_keyboard.caps_lock_is_enabled_);
 
   // Release Search.
   EXPECT_EQ(GetExpectedResultAsString(
                 ui::VKEY_CAPITAL, ui::EF_NONE, ui::ET_KEY_RELEASED),
             GetRewrittenEventAsString(
                 &rewriter, ui::VKEY_LWIN, ui::EF_NONE, ui::ET_KEY_RELEASED));
   // Confirm that the Caps Lock status is not changed.
   EXPECT_FALSE(ime_keyboard.caps_lock_is_enabled_);
 
   // Press Caps Lock (on an external keyboard).
-  EXPECT_EQ(GetExpectedResultAsString(
-                ui::VKEY_CAPITAL, ui::EF_CAPS_LOCK_DOWN, ui::ET_KEY_PRESSED),
+  EXPECT_EQ(GetExpectedResultAsString(ui::VKEY_CAPITAL,
+                                      ui::EF_CAPS_LOCK_DOWN | ui::EF_MOD3_DOWN,
+                                      ui::ET_KEY_PRESSED),
             GetRewrittenEventAsString(&rewriter,
                                       ui::VKEY_CAPITAL,
-                                      ui::EF_CAPS_LOCK_DOWN,
+                                      ui::EF_CAPS_LOCK_DOWN | ui::EF_MOD3_DOWN,
                                       ui::ET_KEY_PRESSED));
 
   // Confirm that calling RewriteForTesting() does not change the state of
   // |ime_keyboard|. In this case, X Window system itself should change the
   // Caps Lock state, not ash::EventRewriter.
   EXPECT_FALSE(ime_keyboard.caps_lock_is_enabled_);
 
   // Release Caps Lock (on an external keyboard).
   EXPECT_EQ(GetExpectedResultAsString(
                 ui::VKEY_CAPITAL, ui::EF_NONE, ui::ET_KEY_RELEASED),
             GetRewrittenEventAsString(
                 &rewriter, ui::VKEY_CAPITAL, ui::EF_NONE, ui::ET_KEY_RELEASED));
   EXPECT_FALSE(ime_keyboard.caps_lock_is_enabled_);
 }
 
 TEST_F(EventRewriterTest, TestRewriteCapsLock) {
   TestingPrefServiceSyncable prefs;
   chromeos::Preferences::RegisterProfilePrefs(prefs.registry());
 
   chromeos::input_method::FakeImeKeyboard ime_keyboard;
   EventRewriter rewriter;
   rewriter.set_pref_service_for_testing(&prefs);
   rewriter.set_ime_keyboard_for_testing(&ime_keyboard);
   EXPECT_FALSE(ime_keyboard.caps_lock_is_enabled_);
 
   // On Chrome OS, CapsLock is mapped to F16 with Mod3Mask.
-  EXPECT_EQ(GetExpectedResultAsString(
-                ui::VKEY_CAPITAL, ui::EF_CAPS_LOCK_DOWN, ui::ET_KEY_PRESSED),
+  EXPECT_EQ(GetExpectedResultAsString(ui::VKEY_CAPITAL,
+                                      ui::EF_CAPS_LOCK_DOWN | ui::EF_MOD3_DOWN,
+                                      ui::ET_KEY_PRESSED),
             GetRewrittenEventAsString(
-                &rewriter, ui::VKEY_F16, ui::EF_NONE, ui::ET_KEY_PRESSED));
+                &rewriter, ui::VKEY_F16, ui::EF_MOD3_DOWN, ui::ET_KEY_PRESSED));
   EXPECT_TRUE(ime_keyboard.caps_lock_is_enabled_);
 }
 
 TEST_F(EventRewriterTest, TestRewriteDiamondKey) {
   TestingPrefServiceSyncable prefs;
   chromeos::Preferences::RegisterProfilePrefs(prefs.registry());
 
   chromeos::input_method::FakeImeKeyboard ime_keyboard;
   EventRewriter rewriter;
   rewriter.set_pref_service_for_testing(&prefs);
@@ skipping 50 matching lines @@
 
   diamond.SetValue(chromeos::input_method::kAltKey);
 
   EXPECT_EQ(GetExpectedResultAsString(
                 ui::VKEY_MENU, ui::EF_ALT_DOWN, ui::ET_KEY_PRESSED),
             GetRewrittenEventAsString(
                 &rewriter, ui::VKEY_F15, ui::EF_NONE, ui::ET_KEY_PRESSED));
 
   diamond.SetValue(chromeos::input_method::kCapsLockKey);
 
-  EXPECT_EQ(GetExpectedResultAsString(
-                ui::VKEY_CAPITAL, ui::EF_CAPS_LOCK_DOWN, ui::ET_KEY_PRESSED),
+  EXPECT_EQ(GetExpectedResultAsString(ui::VKEY_CAPITAL,
+                                      ui::EF_CAPS_LOCK_DOWN | ui::EF_MOD3_DOWN,
+                                      ui::ET_KEY_PRESSED),
             GetRewrittenEventAsString(
                 &rewriter, ui::VKEY_F15, ui::EF_NONE, ui::ET_KEY_PRESSED));
 
   *CommandLine::ForCurrentProcess() = original_cl;
 }
 
 TEST_F(EventRewriterTest, TestRewriteCapsLockToControl) {
   // Remap CapsLock to Control.
   TestingPrefServiceSyncable prefs;
   chromeos::Preferences::RegisterProfilePrefs(prefs.registry());
   IntegerPrefMember control;
   control.Init(prefs::kLanguageRemapCapsLockKeyTo, &prefs);
   control.SetValue(chromeos::input_method::kControlKey);
 
   EventRewriter rewriter;
   rewriter.set_pref_service_for_testing(&prefs);
 
   // Press CapsLock+a. Confirm that Mod3Mask is rewritten to ControlMask.
   // On Chrome OS, CapsLock works as a Mod3 modifier.
   EXPECT_EQ(
       GetExpectedResultAsString(
           ui::VKEY_A, ui::EF_CONTROL_DOWN, ui::ET_KEY_PRESSED),
       GetRewrittenEventAsString(
-          &rewriter, ui::VKEY_A, ui::EF_CAPS_LOCK_DOWN, ui::ET_KEY_PRESSED));
+          &rewriter, ui::VKEY_A, ui::EF_MOD3_DOWN, ui::ET_KEY_PRESSED));
 
   // Press Control+CapsLock+a. Confirm that Mod3Mask is rewritten to ControlMask
   EXPECT_EQ(
       GetExpectedResultAsString(
           ui::VKEY_A, ui::EF_CONTROL_DOWN, ui::ET_KEY_PRESSED),
       GetRewrittenEventAsString(
           &rewriter, ui::VKEY_A, ui::EF_CONTROL_DOWN, ui::ET_KEY_PRESSED));
 
   // Press Alt+CapsLock+a. Confirm that Mod3Mask is rewritten to ControlMask.
   EXPECT_EQ(GetExpectedResultAsString(ui::VKEY_A,
                                       ui::EF_ALT_DOWN | ui::EF_CONTROL_DOWN,
                                       ui::ET_KEY_PRESSED),
             GetRewrittenEventAsString(&rewriter,
                                       ui::VKEY_A,
-                                      ui::EF_ALT_DOWN | ui::EF_CAPS_LOCK_DOWN,
+                                      ui::EF_ALT_DOWN | ui::EF_MOD3_DOWN,
                                       ui::ET_KEY_PRESSED));
 }
 
 TEST_F(EventRewriterTest, TestRewriteCapsLockMod3InUse) {
   // Remap CapsLock to Control.
   TestingPrefServiceSyncable prefs;
   chromeos::Preferences::RegisterProfilePrefs(prefs.registry());
   IntegerPrefMember control;
   control.Init(prefs::kLanguageRemapCapsLockKeyTo, &prefs);
   control.SetValue(chromeos::input_method::kControlKey);
@@ skipping 470 matching lines @@
     ui::ScopedXI2Event xev;
     xev.InitGenericButtonEvent(
         11, ui::ET_MOUSE_RELEASED, gfx::Point(), kLeftAndAltFlag);
     ui::MouseEvent release(xev);
     int flags = RewriteMouseEvent(&rewriter, release);
     EXPECT_TRUE(ui::EF_RIGHT_MOUSE_BUTTON & flags);
   }
 }
 
 }  // namespace chromeos