IME (input method editor) support for Aura, part 3 of 3: Use ui::InputMethod in ash.

ui/aura/desktop_host_linux.cc

 // Copyright (c) 2011 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 "ui/aura/desktop_host.h"
 
 #include <X11/cursorfont.h>
 #include <X11/Xlib.h>
 
 // Get rid of a macro from Xlib.h that conflicts with Aura's RootWindow class.
 #undef RootWindow
 
 #include <algorithm>
 
+#include "base/event_types.h"
 #include "base/message_loop.h"
 #include "base/message_pump_x.h"
 #include "ui/aura/cursor.h"
 #include "ui/aura/desktop.h"
 #include "ui/aura/event.h"
+#include "ui/base/ime/input_method_delegate.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/base/touch/touch_factory.h"
 #include "ui/base/x/x11_util.h"
 #include "ui/gfx/compositor/layer.h"
 
 #include <X11/cursorfont.h>
 #include <X11/extensions/XInput2.h>
 #include <X11/Xlib.h>
 
+#if defined(HAVE_IBUS)
+#include "ui/base/ime/input_method_ibus.h"
+#else
+#include "ui/base/ime/mock_input_method.h"
+#endif
+
 using std::max;
 using std::min;
 
 namespace aura {
 
 namespace {
 
 // Returns X font cursor shape from an Aura cursor.
 int CursorShapeFromNative(gfx::NativeCursor native_cursor) {
   switch (native_cursor) {
@@ skipping 135 matching lines @@
       } else {
         // This isn't an event we want so free its cookie data.
         XFreeEventData(display, &next_event.xcookie);
       }
     }
     break;
   }
   return num_coalesed;
 }
 
-// We emulate Windows' WM_KEYDOWN and WM_CHAR messages.  WM_CHAR events are only
-// generated for certain keys; see
-// http://msdn.microsoft.com/en-us/library/windows/desktop/ms646268.aspx.
-bool ShouldSendCharEventForKeyboardCode(ui::KeyboardCode keycode) {
-  if ((keycode >= ui::VKEY_0 && keycode <= ui::VKEY_9) ||
-      (keycode >= ui::VKEY_A && keycode <= ui::VKEY_Z) ||
-      (keycode >= ui::VKEY_NUMPAD0 && keycode <= ui::VKEY_NUMPAD9)) {
-    return true;
-  }
-
-  switch (keycode) {
-    case ui::VKEY_BACK:
-    case ui::VKEY_RETURN:
-    case ui::VKEY_ESCAPE:
-    case ui::VKEY_SPACE:
-    case ui::VKEY_TAB:
-    // In addition to the keys listed at MSDN, we include other
-    // graphic-character and numpad keys.
-    case ui::VKEY_MULTIPLY:
-    case ui::VKEY_ADD:
-    case ui::VKEY_SUBTRACT:
-    case ui::VKEY_DECIMAL:
-    case ui::VKEY_DIVIDE:
-    case ui::VKEY_OEM_1:
-    case ui::VKEY_OEM_2:
-    case ui::VKEY_OEM_3:
-    case ui::VKEY_OEM_4:
-    case ui::VKEY_OEM_5:
-    case ui::VKEY_OEM_6:
-    case ui::VKEY_OEM_7:
-    case ui::VKEY_OEM_102:
-    case ui::VKEY_OEM_PLUS:
-    case ui::VKEY_OEM_COMMA:
-    case ui::VKEY_OEM_MINUS:
-    case ui::VKEY_OEM_PERIOD:
-      return true;
-    default:
-      return false;
-  }
-}
-
-class DesktopHostLinux : public DesktopHost {
+class DesktopHostLinux : public DesktopHost,
+                         public ui::internal::InputMethodDelegate {
  public:
   explicit DesktopHostLinux(const gfx::Rect& bounds);
   virtual ~DesktopHostLinux();
 
  private:
   // base::MessageLoop::Dispatcher Override.
   virtual DispatchStatus Dispatch(XEvent* xev) OVERRIDE;
 
   // DesktopHost Overrides.
   virtual void SetDesktop(Desktop* desktop) OVERRIDE;
   virtual gfx::AcceleratedWidget GetAcceleratedWidget() OVERRIDE;
   virtual void Show() OVERRIDE;
   virtual void ToggleFullScreen() OVERRIDE;
   virtual gfx::Size GetSize() const OVERRIDE;
   virtual void SetSize(const gfx::Size& size) OVERRIDE;
   virtual gfx::Point GetLocationOnNativeScreen() const OVERRIDE;
   virtual void SetCursor(gfx::NativeCursor cursor_type) OVERRIDE;
   virtual gfx::Point QueryMouseLocation() OVERRIDE;
   virtual void PostNativeEvent(const base::NativeEvent& event) OVERRIDE;
+  virtual ui::InputMethod* GetInputMethod() OVERRIDE;
+
+  // ui::internal::InputMethodDelegate Override.
+  virtual void DispatchKeyEventPostIME(const base::NativeEvent& event) OVERRIDE;
+  virtual void DispatchFabricatedKeyEventPostIME(
+      ui::EventType type, ui::KeyboardCode key_code, int flags) OVERRIDE;
 
   // Returns true if there's an X window manager present... in most cases.  Some
   // window managers (notably, ion3) don't implement enough of ICCCM for us to
   // detect that they're there.
   bool IsWindowManagerPresent();
 
   Desktop* desktop_;
 
   // The display and the native X window hosting the desktop.
   Display* xdisplay_;
   ::Window xwindow_;
 
   // The native root window.
   ::Window root_window_;
 
+  // The input method for the desktop.
+#if defined(HAVE_IBUS)
+  ui::InputMethodIBus input_method_;
+#else
+  ui::MockInputMethod input_method_;
+#endif
+
   // Current Aura cursor.
   gfx::NativeCursor current_cursor_;
 
   // The bounds of |xwindow_|.
   gfx::Rect bounds_;
 
   DISALLOW_COPY_AND_ASSIGN(DesktopHostLinux);
 };
 
 DesktopHostLinux::DesktopHostLinux(const gfx::Rect& bounds)
     : desktop_(NULL),
       xdisplay_(base::MessagePumpX::GetDefaultXDisplay()),
       xwindow_(0),
       root_window_(DefaultRootWindow(xdisplay_)),
+      ALLOW_THIS_IN_INITIALIZER_LIST(input_method_(this)),
       current_cursor_(aura::kCursorNull),
       bounds_(bounds) {
   xwindow_ = XCreateSimpleWindow(xdisplay_, root_window_,
                                  bounds.x(), bounds.y(),
                                  bounds.width(), bounds.height(),
                                  0, 0, 0);
 
-  long event_mask = ButtonPressMask | ButtonReleaseMask |
+  long event_mask = ButtonPressMask | ButtonReleaseMask | FocusChangeMask |
                     KeyPressMask | KeyReleaseMask |
                     ExposureMask | VisibilityChangeMask |
                     StructureNotifyMask | PropertyChangeMask |
                     PointerMotionMask;
   XSelectInput(xdisplay_, xwindow_, event_mask);
   XSelectInput(xdisplay_, root_window_, StructureNotifyMask);
   XFlush(xdisplay_);
 
   // TODO(sadrul): reenable once 103981 is fixed.
 #if defined(TOUCH_UI)
   if (base::MessagePumpForUI::HasXInput2())
     ui::TouchFactory::GetInstance()->SetupXI2ForXWindow(xwindow_);
 #endif
+
+  input_method_.Init(xwindow_);
 }
 
 DesktopHostLinux::~DesktopHostLinux() {
   XDestroyWindow(xdisplay_, xwindow_);
 
   // Clears XCursorCache.
   ui::GetXCursor(ui::kCursorClearXCursorCache);
 }
 
 base::MessagePumpDispatcher::DispatchStatus DesktopHostLinux::Dispatch(
     XEvent* xev) {
   DLOG(WARNING) << "DispatchEvent:" << xev->type;
 
   bool handled = false;
   switch (xev->type) {
     case Expose:
       desktop_->Draw();
       handled = true;
       break;
-    case KeyPress: {
-      KeyEvent keydown_event(xev, false);
-      handled = desktop_->DispatchKeyEvent(&keydown_event);
-      if (ShouldSendCharEventForKeyboardCode(keydown_event.key_code())) {
-        KeyEvent char_event(xev, true);
-        handled |= desktop_->DispatchKeyEvent(&char_event);
-      }
-      break;
-    }
+    case KeyPress:
     case KeyRelease: {
-      KeyEvent keyup_event(xev, false);
-      handled = desktop_->DispatchKeyEvent(&keyup_event);
-      break;
+      input_method_.DispatchKeyEvent(xev);
+      handled = true;
     }
     case ButtonPress:
     case ButtonRelease: {
       MouseEvent mouseev(xev);
       handled = desktop_->DispatchMouseEvent(&mouseev);
       break;
     }
     case ConfigureNotify: {
       if (xev->xconfigure.window == root_window_) {
         desktop_->OnNativeScreenResized(
@@ skipping 57 matching lines @@
           break;
         default:
           NOTREACHED();
       }
 
       // If we coalesced an event we need to free its cookie.
       if (num_coalesced > 0)
         XFreeEventData(xev->xgeneric.display, &last_event.xcookie);
       break;
     }
+    case FocusIn: {
+      input_method_.OnFocus();
+      break;
+    }
+    case FocusOut: {
+      input_method_.OnBlur();
+      break;
+    }
     case MapNotify: {
       // If there's no window manager running, we need to assign the X input
       // focus to our host window.
       if (!IsWindowManagerPresent())
         XSetInputFocus(xdisplay_, xwindow_, RevertToNone, CurrentTime);
       handled = true;
       break;
     }
     case MotionNotify: {
       // Discard all but the most recent motion event that targets the same
@@ skipping 120 matching lines @@
   DLOG(WARNING) << "PostEvent:" << xevent.type << ", status=" << status;
 }
 
 bool DesktopHostLinux::IsWindowManagerPresent() {
   // Per ICCCM 2.8, "Manager Selections", window managers should take ownership
   // of WM_Sn selections (where n is a screen number).
   ::Atom wm_s0_atom = XInternAtom(xdisplay_, "WM_S0", False);
   return XGetSelectionOwner(xdisplay_, wm_s0_atom) != None;
 }
 
+ui::InputMethod* DesktopHostLinux::GetInputMethod() {
+  return &input_method_;
+}
+
+void DesktopHostLinux::DispatchKeyEventPostIME(const base::NativeEvent& event) {
+  KeyEvent aura_event(event, false /* is_char */);
+  desktop_->DispatchKeyEvent(&aura_event);
+  // We don't send a Char event here since the input method takes care of it.
+}
+
+void DesktopHostLinux::DispatchFabricatedKeyEventPostIME(
+    ui::EventType type, ui::KeyboardCode key_code, int flags) {
+  // Dispatch a ui::VKEY_PROCESSKEY event etc. generated by |input_method_|.
+  KeyEvent aura_event(type, key_code, flags);
+  desktop_->DispatchKeyEvent(&aura_event);
+}
+
 }  // namespace
 
 // static
 DesktopHost* DesktopHost::Create(const gfx::Rect& bounds) {
   return new DesktopHostLinux(bounds);
 }
 
 // static
 gfx::Size DesktopHost::GetNativeScreenSize() {
   ::Display* xdisplay = base::MessagePumpX::GetDefaultXDisplay();
   return gfx::Size(DisplayWidth(xdisplay, 0), DisplayHeight(xdisplay, 0));
 }
 
 }  // namespace aura