Implement sync of keyboard layout between Ozone and Wayland clients

components/exo/wayland/server.cc

 // Copyright 2015 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 "components/exo/wayland/server.h"
 
 #include <alpha-compositing-unstable-v1-server-protocol.h>
 #include <gaming-input-unstable-v1-server-protocol.h>
 #include <gaming-input-unstable-v2-server-protocol.h>
 #include <grp.h>
@@ skipping 67 matching lines @@
 #include "ui/gfx/buffer_format_util.h"
 #include "ui/gfx/buffer_types.h"
 #include "ui/views/widget/widget.h"
 #include "ui/views/widget/widget_observer.h"
 #include "ui/wm/core/coordinate_conversion.h"
 
 #if defined(USE_OZONE)
 #include <drm_fourcc.h>
 #include <linux-dmabuf-unstable-v1-server-protocol.h>
 #include <wayland-drm-server-protocol.h>
+#include "ui/base/ime/chromeos/ime_keyboard.h"

[reveman, 2017/06/09 16:50:13]

think we need another ifdef for this file. ozone can be used without chromeos.

[jclinton, 2017/06/09 20:24:22]

Done.

+#include "ui/base/ime/chromeos/input_method_manager.h"

[reveman, 2017/06/09 16:50:13]

ditto

[jclinton, 2017/06/09 20:24:22]

Done.

+#include "ui/events/ozone/layout/xkb/xkb_keyboard_layout_engine.h"
 #endif
 
 #if BUILDFLAG(USE_XKBCOMMON)
 #include <xkbcommon/xkbcommon.h>
 #include "ui/events/keycodes/scoped_xkb.h"  // nogncheck
 #endif
 
 DECLARE_UI_CLASS_PROPERTY_TYPE(wl_resource*);
 
 namespace exo {
@@ skipping 2632 matching lines @@
 const struct wl_pointer_interface pointer_implementation = {pointer_set_cursor,
                                                             pointer_release};
 
 #if BUILDFLAG(USE_XKBCOMMON)
 
 ////////////////////////////////////////////////////////////////////////////////
 // wl_keyboard_interface:
 
 // Keyboard delegate class that accepts events for surfaces owned by the same
 // client as a keyboard resource.
-class WaylandKeyboardDelegate : public KeyboardDelegate {
+class WaylandKeyboardDelegate
+    : public KeyboardDelegate
+#if defined(USE_OZONE)
+      , public chromeos::input_method::ImeKeyboard::Observer

[reveman, 2017/06/09 16:50:12]

ozone can be used without chromeos

[jclinton, 2017/06/09 20:24:22]

Done.

+#endif
+    {
  public:
   explicit WaylandKeyboardDelegate(wl_resource* keyboard_resource)
       : keyboard_resource_(keyboard_resource),
         xkb_context_(xkb_context_new(XKB_CONTEXT_NO_FLAGS)),
-        // TODO(reveman): Keep keymap synchronized with the keymap used by
-        // chromium and the host OS.
         xkb_keymap_(xkb_keymap_new_from_names(xkb_context_.get(),
                                               nullptr,
                                               XKB_KEYMAP_COMPILE_NO_FLAGS)),
         xkb_state_(xkb_state_new(xkb_keymap_.get())) {
     std::unique_ptr<char, base::FreeDeleter> keymap_string(
         xkb_keymap_get_as_string(xkb_keymap_.get(), XKB_KEYMAP_FORMAT_TEXT_V1));
     DCHECK(keymap_string.get());
     size_t keymap_size = strlen(keymap_string.get()) + 1;
     base::SharedMemory shared_keymap;
     bool rv = shared_keymap.CreateAndMapAnonymous(keymap_size);
     DCHECK(rv);
     memcpy(shared_keymap.memory(), keymap_string.get(), keymap_size);
     wl_keyboard_send_keymap(keyboard_resource_,
                             WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,
                             shared_keymap.handle().GetHandle(), keymap_size);
+#if defined(USE_OZONE)
+    chromeos::input_method::ImeKeyboard* keyboard =
+        chromeos::input_method::InputMethodManager::Get()->GetImeKeyboard();
+    if (keyboard) {
+      keyboard->AddObserver(this);
+      keyboard->ReapplyCurrentKeyboardLayout();

[reveman, 2017/06/09 16:50:13]

See my SendLayout() comment below. Can we call that after the ifdef instead of
calling ReapplyCurrentKeyboardLayout here?

[jclinton, 2017/06/09 20:24:22]

Done.

+    }
+  }
+  ~WaylandKeyboardDelegate() override {
+    chromeos::input_method::ImeKeyboard* keyboard =
+        chromeos::input_method::InputMethodManager::Get()->GetImeKeyboard();
+    if (keyboard)
+      keyboard->RemoveObserver(this);
+#endif
   }
 
   // Overridden from KeyboardDelegate:
   void OnKeyboardDestroying(Keyboard* keyboard) override { delete this; }
   bool CanAcceptKeyboardEventsForSurface(Surface* surface) const override {
     wl_resource* surface_resource = GetSurfaceResource(surface);
     // We can accept events for this surface if the client is the same as the
     // keyboard.
     return surface_resource &&
            wl_resource_get_client(surface_resource) == client();
@@ skipping 37 matching lines @@
     wl_keyboard_send_modifiers(
         keyboard_resource_, next_serial(),
         xkb_state_serialize_mods(xkb_state_.get(), XKB_STATE_MODS_DEPRESSED),
         xkb_state_serialize_mods(xkb_state_.get(), XKB_STATE_MODS_LOCKED),
         xkb_state_serialize_mods(xkb_state_.get(), XKB_STATE_MODS_LATCHED),
         xkb_state_serialize_layout(xkb_state_.get(),
                                    XKB_STATE_LAYOUT_EFFECTIVE));
     wl_client_flush(client());
   }
 
+#if defined(USE_OZONE)
+  // Overridden from input_method::ImeKeyboard::Observer:
+  void OnCapsLockChanged(bool enabled) override {}
+  void OnLayoutChanged(const std::string& layout_name) override {

[reveman, 2017/06/09 16:50:13]

This duplicates a lot of code in the ctor. Please move the common code into a
SendLayout() function that can be called from the ctor.

[jclinton, 2017/06/09 20:24:22]

Done.

+    std::string layout_id;
+    std::string layout_variant;
+    ui::XkbKeyboardLayoutEngine::ParseLayoutName(layout_name, &layout_id,
+                                                 &layout_variant);
+    xkb_rule_names names = {.rules = NULL,
+                            .model = "pc101",
+                            .layout = layout_id.c_str(),
+                            .variant = layout_variant.c_str(),
+                            .options = ""};
+    xkb_keymap_.reset(xkb_keymap_new_from_names(xkb_context_.get(), &names,
+                                                XKB_KEYMAP_COMPILE_NO_FLAGS));
+    xkb_state_.reset(xkb_state_new(xkb_keymap_.get()));
+    std::unique_ptr<char, base::FreeDeleter> keymap_string(
+        xkb_keymap_get_as_string(xkb_keymap_.get(), XKB_KEYMAP_FORMAT_TEXT_V1));
+    DCHECK(keymap_string.get());
+    size_t keymap_size = strlen(keymap_string.get()) + 1;
+    base::SharedMemory shared_keymap;
+    bool rv = shared_keymap.CreateAndMapAnonymous(keymap_size);
+    DCHECK(rv);
+    memcpy(shared_keymap.memory(), keymap_string.get(), keymap_size);
+    wl_keyboard_send_keymap(keyboard_resource_,
+                            WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,
+                            shared_keymap.handle().GetHandle(), keymap_size);
+  };

[reveman, 2017/06/09 16:50:12]

remove ";"

[jclinton, 2017/06/09 20:24:22]

Done.

+#endif
+
  private:
   // Returns the corresponding key given a dom code.
   uint32_t DomCodeToKey(ui::DomCode code) const {
     // This assumes KeycodeConverter has been built with evdev/xkb codes.
     xkb_keycode_t xkb_keycode = static_cast<xkb_keycode_t>(
         ui::KeycodeConverter::DomCodeToNativeKeycode(code));
 
     // Keycodes are offset by 8 in Xkb.
     DCHECK_GE(xkb_keycode, 8u);
     return xkb_keycode - 8;
@@ skipping 1219 matching lines @@
   DCHECK(event_loop);
   wl_event_loop_dispatch(event_loop, timeout.InMilliseconds());
 }
 
 void Server::Flush() {
   wl_display_flush_clients(wl_display_.get());
 }
 
 }  // namespace wayland
 }  // namespace exo