1 // Copyright 2013 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef CHROME_BROWSER_UI_LIBGTK2UI_X11_INPUT_METHOD_CONTEXT_IMPL_GTK2_H_ 6 #define CHROME_BROWSER_UI_LIBGTK2UI_X11_INPUT_METHOD_CONTEXT_IMPL_GTK2_H_ 7 8 #include "base/containers/hash_tables.h" 9 #include "base/gtest_prod_util.h" 10 #include "base/strings/string16.h" 11 #include "ui/base/glib/glib_integers.h" 12 #include "ui/base/glib/glib_signal.h" 13 #include "ui/base/ime/linux/linux_input_method_context.h" 14 #include "ui/gfx/rect.h" 15 16 typedef struct _GtkIMContext GtkIMContext; 17 18 namespace libgtk2ui { 19 20 // An implementation of LinuxInputMethodContext which is based on X11 event loop 21 // and uses GtkIMContext(gtk-immodule) as a bridge from/to underlying IMEs. 22 class X11InputMethodContextImplGtk2 : public ui::LinuxInputMethodContext { 23 public: 24 explicit X11InputMethodContextImplGtk2( 25 ui::LinuxInputMethodContextDelegate* delegate); 26 virtual ~X11InputMethodContextImplGtk2(); 27 28 // Overriden from ui::LinuxInputMethodContext 29 virtual bool DispatchKeyEvent(const ui::KeyEvent& key_event) OVERRIDE; 30 virtual void Reset() OVERRIDE; 31 virtual base::i18n::TextDirection GetInputTextDirection() const OVERRIDE; 32 virtual void OnTextInputTypeChanged(ui::TextInputType text_input_type) 33 OVERRIDE; 34 virtual void OnCaretBoundsChanged(const gfx::Rect& caret_bounds) OVERRIDE; 35 36 private: 37 // Returns true if the hardware |keycode| is assigned to a modifier key. 38 bool IsKeycodeModifierKey(unsigned int keycode) const; 39 40 // GtkIMContext event handlers. They are shared among |gtk_context_simple_| 41 // and |gtk_multicontext_|. 42 CHROMEG_CALLBACK_1(X11InputMethodContextImplGtk2, void, OnCommit, 43 GtkIMContext*, gchar*); 44 CHROMEG_CALLBACK_0(X11InputMethodContextImplGtk2, void, OnPreeditChanged, 45 GtkIMContext*); 46 CHROMEG_CALLBACK_0(X11InputMethodContextImplGtk2, void, OnPreeditEnd, 47 GtkIMContext*); 48 CHROMEG_CALLBACK_0(X11InputMethodContextImplGtk2, void, OnPreeditStart, 49 GtkIMContext*); 50 51 // A set of callback functions. Must not be NULL. 52 ui::LinuxInputMethodContextDelegate* delegate_; 53 54 // IME's input context used for TEXT_INPUT_TYPE_NONE and 55 // TEXT_INPUT_TYPE_PASSWORD. 56 GtkIMContext* gtk_context_simple_; 57 // IME's input context used for the other text input types. 58 GtkIMContext* gtk_multicontext_; 59 60 // An alias to |gtk_context_simple_| or |gtk_multicontext_| depending on the 61 // text input type. Can be NULL when it's not focused. 62 GtkIMContext* gtk_context_; 63 64 // Last known caret bounds relative to the screen coordinates. 65 gfx::Rect last_caret_bounds_; 66 67 // A set of hardware keycodes of modifier keys. 68 base::hash_set<unsigned int> modifier_keycodes_; 69 70 // The helper class to trap GTK+'s "commit" signal for direct input key 71 // events. 72 // 73 // gtk_im_context_filter_keypress() emits "commit" signal in order to insert 74 // a character which is not actually processed by a IME. This behavior seems, 75 // in Javascript world, that a keydown event with keycode = VKEY_PROCESSKEY 76 // (= 229) is fired. So we have to trap such "commit" signal for direct input 77 // key events. This class helps to trap such events. 78 class GtkCommitSignalTrap { 79 public: 80 GtkCommitSignalTrap(); 81 82 // Enables the trap which monitors a direct input key event of |keyval|. 83 void StartTrap(guint keyval); 84 85 // Disables the trap. 86 void StopTrap(); 87 88 // Checks if the committed |text| has come from a direct input key event, 89 // and returns true in that case. Once it's trapped, IsSignalCaught() 90 // returns true. 91 // Must be called at most once between StartTrap() and StopTrap(). 92 bool Trap(const base::string16& text); 93 94 // Returns true if a direct input key event is detected. IsSignalCaught()95 bool IsSignalCaught() const { return is_signal_caught_; } 96 97 private: 98 bool is_trap_enabled_; 99 guint gdk_event_key_keyval_; 100 bool is_signal_caught_; 101 102 DISALLOW_COPY_AND_ASSIGN(GtkCommitSignalTrap); 103 }; 104 105 GtkCommitSignalTrap commit_signal_trap_; 106 107 FRIEND_TEST_ALL_PREFIXES(X11InputMethodContextImplGtk2FriendTest, 108 GtkCommitSignalTrap); 109 110 DISALLOW_COPY_AND_ASSIGN(X11InputMethodContextImplGtk2); 111 }; 112 113 } // namespace libgtk2ui 114 115 #endif // CHROME_BROWSER_UI_LIBGTK2UI_X11_INPUT_METHOD_CONTEXT_IMPL_GTK2_H_ 116