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

chrome/browser/ui/ash/event_rewriter.h

 // 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.
 
 #ifndef CHROME_BROWSER_UI_ASH_EVENT_REWRITER_H_
 #define CHROME_BROWSER_UI_ASH_EVENT_REWRITER_H_
 
 #include <map>
 #include <string>
 
 #include "ash/event_rewriter_delegate.h"
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
+#include "base/hash_tables.h"
 #include "ui/aura/root_window_observer.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 
 #if defined(OS_CHROMEOS)
 #include "chrome/browser/chromeos/device_hierarchy_observer.h"
 #endif
 
 class PrefService;
 
 namespace aura {
@@ skipping 11 matching lines @@
 class EventRewriter : public ash::EventRewriterDelegate,
                       public aura::RootWindowObserver
 #if defined(OS_CHROMEOS)
                     , public chromeos::DeviceHierarchyObserver
 #endif
 {
  public:
   enum DeviceType {
     kDeviceUnknown = 0,
     kDeviceAppleKeyboard,
+    kDeviceChromeOSKeyboard,
   };
 
   EventRewriter();
   virtual ~EventRewriter();
 
   // Calls DeviceAddedInternal.
   DeviceType DeviceAddedForTesting(int device_id,
                                    const std::string& device_name);
   // Calls Rewrite.
   void RewriteForTesting(ui::KeyEvent* event);
 
   const std::map<int, DeviceType>& device_id_to_type_for_testing() const {
     return device_id_to_type_;
   }
   void set_last_device_id_for_testing(int device_id) {
     last_device_id_ = device_id;
   }
   void set_pref_service_for_testing(const PrefService* pref_service) {
     pref_service_ = pref_service;
   }
 #if defined(OS_CHROMEOS)
   void set_xkeyboard_for_testing(chromeos::input_method::XKeyboard* xkeyboard) {
     xkeyboard_ = xkeyboard;
   }
+  void set_force_chromeos_keyboard_for_testing(bool chromeos_keyboard) {
+    force_chromeos_keyboard_for_testing_ = chromeos_keyboard;
+  }
 #endif
 
   // Gets DeviceType from the |device_name|.
   static DeviceType GetDeviceType(const std::string& device_name);
 
  private:
   // ash::EventRewriterDelegate overrides:
   virtual ash::EventRewriterDelegate::Action RewriteOrFilterKeyEvent(
       ui::KeyEvent* event) OVERRIDE;
   virtual ash::EventRewriterDelegate::Action RewriteOrFilterLocatedEvent(
       ui::LocatedEvent* event) OVERRIDE;
 
   // aura::RootWindowObserver overrides:
   virtual void OnKeyboardMappingChanged(const aura::RootWindow* root) OVERRIDE;
 
 #if defined(OS_CHROMEOS)
   // chromeos::DeviceHierarchyObserver overrides:
   virtual void DeviceHierarchyChanged() OVERRIDE {}
   virtual void DeviceAdded(int device_id) OVERRIDE;
   virtual void DeviceRemoved(int device_id) OVERRIDE;
   virtual void DeviceKeyPressedOrReleased(int device_id) OVERRIDE;
 
+  bool EventSourceIsChromeOSKeyboard() const;
+
   // Updates |*_xkeycode_| in response to a keyboard map change.
   void RefreshKeycodes();
   // Converts an X key symbol like XK_Control_L to a key code.
   unsigned char NativeKeySymToNativeKeycode(unsigned long keysym);
+
+  // We don't want to include Xlib.h here since it has polluting macros, so
+  // define these locally.
+  typedef unsigned long KeySym;

[Daniel Erat, 2012/11/29 04:54:23]

this approach seems fine to me, although i'd probably move these outside of any
namespaces so they match the ones coming from Xlib

[danakj, 2012/11/30 03:07:40]

Ah, okay. I was worried about "already defined" conflicts, but I see that
doesn't happen for typedefs. Moved them.

[danakj, 2012/11/30 03:49:13]

Actually, it did cause compiler errors, so I moved it back into the class.

+  typedef unsigned char KeyCode;
+
+  struct KeyboardRemapping {
+    KeySym input_keysym;
+    unsigned int input_mods;
+    unsigned int input_native_mods;
+    KeySym output_keysym;
+    ui::KeyboardCode output_keycode;
+  };
+
+  // Given a set of KeyboardRemapping structs, it finds a matching struct
+  // if possible, and returns the remapped event values.

[Daniel Erat, 2012/11/29 04:54:23]

nit: s/returns/updates/, also add "Returns true if the event was rewritten."
(ditto for ByKeyCode below)

[danakj, 2012/11/30 03:07:40]

Done.

+  bool RewriteWithKeyboardRemappingsByKeySym(
+      const KeyboardRemapping* remappings,
+      size_t num_remappings,
+      KeySym keysym,
+      unsigned int native_mods,
+      unsigned int mods,
+      KeySym* remapped_native_keysym,
+      unsigned int* remapped_native_mods,
+      ui::KeyboardCode* remapped_keycode,
+      unsigned int* remapped_mods);
+
+  // Given a set of KeyboardRemapping structs, it finds a matching struct
+  // if possible, and returns the remapped event values. This function converts
+  // the KeySym in the KeyboardRemapping struct into the KeyCode before matching
+  // to allow any KeyCode on the same physical key as the given KeySym to match.
+  bool RewriteWithKeyboardRemappingsByKeyCode(
+      const KeyboardRemapping* remappings,
+      size_t num_remappings,
+      KeyCode keycode,
+      unsigned int native_mods,
+      unsigned int mods,
+      KeySym* remapped_native_keysym,
+      unsigned int* remapped_native_mods,
+      ui::KeyboardCode* remapped_keycode,
+      unsigned int* remapped_mods);
 #endif
 
   // Rewrites the |event| by applying all RewriteXXX functions as needed.
   void Rewrite(ui::KeyEvent* event);
 
   // Rewrites a modifier key press/release following the current user
   // preferences.
   bool RewriteModifiers(ui::KeyEvent* event);
 
   // Rewrites Fn key press/release to Control. In some cases, Fn key is not
@@ skipping 13 matching lines @@
   //  * Ctrl+Alt+Down -> End
   // When the Search key acts as a function key, it instead maps:
   //  * Search+Backspace -> Delete
   //  * Search+Up -> Prior (aka PageUp)
   //  * Search+Down -> Next (aka PageDown)
   //  * Search+Left -> Home
   //  * Search+right -> End
   // Returns true when the |event| is rewritten.
   bool RewriteBackspaceAndArrowKeys(ui::KeyEvent* event);
 
+  // When the Search key acts as a function key, it remaps Search+1
+  // through Search+= to F1 through F12. Returns true when the |event| is
+  // rewritten.
+  bool RewriteFunctionKeys(ui::KeyEvent* event);
+
   // Rewrites the located |event|.
   void RewriteLocatedEvent(ui::LocatedEvent* event);
 
   // Overwrites |event| with the keycodes and flags.
   void OverwriteEvent(ui::KeyEvent* event,
                       unsigned int new_native_keycode,
                       unsigned int new_native_state,
                       ui::KeyboardCode new_keycode,
                       int new_flags);
 
   // Checks the type of the |device_name|, and inserts a new entry to
   // |device_id_to_type_|.
   DeviceType DeviceAddedInternal(int device_id, const std::string& device_name);
 
   // Returns true if |last_device_id_| is Apple's.
   bool IsAppleKeyboard() const;
 
   // Remaps |original_flags| to |remapped_flags| and |original_native_modifiers|
   // to |remapped_native_modifiers| following the current user prefs.
   void GetRemappedModifierMasks(int original_flags,
                                 unsigned int original_native_modifiers,
                                 int* remapped_flags,
                                 unsigned int* remapped_native_modifiers) const;
 
   std::map<int, DeviceType> device_id_to_type_;
   int last_device_id_;
 
 #if defined(OS_CHROMEOS)
-  // X keycodes corresponding to various keysyms.
-  unsigned int control_l_xkeycode_;
-  unsigned int control_r_xkeycode_;
-  unsigned int alt_l_xkeycode_;
-  unsigned int alt_r_xkeycode_;
-  unsigned int meta_l_xkeycode_;
-  unsigned int meta_r_xkeycode_;
-  unsigned int windows_l_xkeycode_;
-  unsigned int caps_lock_xkeycode_;
-  unsigned int void_symbol_xkeycode_;
-  unsigned int delete_xkeycode_;
-  unsigned int home_xkeycode_;
-  unsigned int end_xkeycode_;
-  unsigned int prior_xkeycode_;
-  unsigned int next_xkeycode_;
-  unsigned int kp_0_xkeycode_;
-  unsigned int kp_1_xkeycode_;
-  unsigned int kp_2_xkeycode_;
-  unsigned int kp_3_xkeycode_;
-  unsigned int kp_4_xkeycode_;
-  unsigned int kp_5_xkeycode_;
-  unsigned int kp_6_xkeycode_;
-  unsigned int kp_7_xkeycode_;
-  unsigned int kp_8_xkeycode_;
-  unsigned int kp_9_xkeycode_;
-  unsigned int kp_decimal_xkeycode_;
+  bool force_chromeos_keyboard_for_testing_;
+
+  // A mapping from X11 KeySym keys to KeyCode values.
+  base::hash_map<unsigned long, unsigned long> keysym_to_keycode_map_;
 
   chromeos::input_method::XKeyboard* xkeyboard_;  // for testing.
 #endif
 
   const PrefService* pref_service_;  // for testing.
 
   DISALLOW_COPY_AND_ASSIGN(EventRewriter);
 };
 
 #endif  // CHROME_BROWSER_UI_ASH_EVENT_REWRITER_H_