src/chrome/browser/ui/libgtk2ui/x11_input_method_context_impl_gtk2.h

   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 void OnTextInputTypeChanged(ui::TextInputType text_input_type)
  32       OVERRIDE;
  33   virtual void OnCaretBoundsChanged(const gfx::Rect& caret_bounds) OVERRIDE;
  34
  35  private:
  36   // Returns true if the hardware |keycode| is assigned to a modifier key.
  37   bool IsKeycodeModifierKey(unsigned int keycode) const;
  38
  39   // GtkIMContext event handlers.  They are shared among |gtk_context_simple_|
  40   // and |gtk_multicontext_|.
  41   CHROMEG_CALLBACK_1(X11InputMethodContextImplGtk2, void, OnCommit,
  42                      GtkIMContext*, gchar*);
  43   CHROMEG_CALLBACK_0(X11InputMethodContextImplGtk2, void, OnPreeditChanged,
  44                      GtkIMContext*);
  45   CHROMEG_CALLBACK_0(X11InputMethodContextImplGtk2, void, OnPreeditEnd,
  46                      GtkIMContext*);
  47   CHROMEG_CALLBACK_0(X11InputMethodContextImplGtk2, void, OnPreeditStart,
  48                      GtkIMContext*);
  49
  50   // A set of callback functions.  Must not be NULL.
  51   ui::LinuxInputMethodContextDelegate* delegate_;
  52
  53   // IME's input context used for TEXT_INPUT_TYPE_NONE and
  54   // TEXT_INPUT_TYPE_PASSWORD.
  55   GtkIMContext* gtk_context_simple_;
  56   // IME's input context used for the other text input types.
  57   GtkIMContext* gtk_multicontext_;
  58
  59   // An alias to |gtk_context_simple_| or |gtk_multicontext_| depending on the
  60   // text input type.  Can be NULL when it's not focused.
  61   GtkIMContext* gtk_context_;
  62
  63   // Last known caret bounds relative to the screen coordinates.
  64   gfx::Rect last_caret_bounds_;
  65
  66   // A set of hardware keycodes of modifier keys.
  67   base::hash_set<unsigned int> modifier_keycodes_;
  68
  69   // The helper class to trap GTK+'s "commit" signal for direct input key
  70   // events.
  71   //
  72   // gtk_im_context_filter_keypress() emits "commit" signal in order to insert
  73   // a character which is not actually processed by a IME.  This behavior seems,
  74   // in Javascript world, that a keydown event with keycode = VKEY_PROCESSKEY
  75   // (= 229) is fired.  So we have to trap such "commit" signal for direct input
  76   // key events.  This class helps to trap such events.
  77   class GtkCommitSignalTrap {
  78    public:
  79     GtkCommitSignalTrap();
  80
  81     // Enables the trap which monitors a direct input key event of |keyval|.
  82     void StartTrap(guint keyval);
  83
  84     // Disables the trap.
  85     void StopTrap();
  86
  87     // Checks if the committed |text| has come from a direct input key event,
  88     // and returns true in that case.  Once it's trapped, IsSignalCaught()
  89     // returns true.
  90     // Must be called at most once between StartTrap() and StopTrap().
  91     bool Trap(const base::string16& text);
  92
  93     // Returns true if a direct input key event is detected.
  94     bool IsSignalCaught() const { return is_signal_caught_; }
  95
  96    private:
  97     bool is_trap_enabled_;
  98     guint gdk_event_key_keyval_;
  99     bool is_signal_caught_;
 100
 101     DISALLOW_COPY_AND_ASSIGN(GtkCommitSignalTrap);
 102   };
 103
 104   GtkCommitSignalTrap commit_signal_trap_;
 105
 106   FRIEND_TEST_ALL_PREFIXES(X11InputMethodContextImplGtk2FriendTest,
 107                            GtkCommitSignalTrap);
 108
 109   DISALLOW_COPY_AND_ASSIGN(X11InputMethodContextImplGtk2);
 110 };
 111
 112 }  // namespace libgtk2ui
 113
 114 #endif  // CHROME_BROWSER_UI_LIBGTK2UI_X11_INPUT_METHOD_CONTEXT_IMPL_GTK2_H_