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>
+#if defined(OS_CHROMEOS)
+#include "ui/base/ime/chromeos/ime_keyboard.h"
+#include "ui/base/ime/chromeos/input_method_manager.h"
+#include "ui/events/ozone/layout/xkb/xkb_keyboard_layout_engine.h"
+#endif
 #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(OS_CHROMEOS)

[reveman, 2017/06/09 21:15:18]

#if defined(USE_OZONE) && defined(OS_CHROMEOS)

as chromeos can still be build without ozone afaik

[jclinton, 2017/06/09 22:17:59]

Done.

+      , public chromeos::input_method::ImeKeyboard::Observer
+#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);
+        xkb_context_(xkb_context_new(XKB_CONTEXT_NO_FLAGS)) {
+#if defined(OS_CHROMEOS)

[reveman, 2017/06/09 21:15:18]

#if defined(USE_OZONE) && defined(OS_CHROMEOS)

[jclinton, 2017/06/09 22:17:58]

Done.

+    chromeos::input_method::ImeKeyboard* keyboard =
+        chromeos::input_method::InputMethodManager::Get()->GetImeKeyboard();
+    if (keyboard)
+      keyboard->AddObserver(this);
+    std::string layout_id, layout_variant;
+    std::string layout_name = keyboard->GetCurrentKeyboardLayoutName();
+    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 = ""};

[reveman, 2017/06/09 21:15:18]

Please avoid duplication of above code. Maybe add a SendCurrentLayout function
that calls SendLayout.

[jclinton, 2017/06/09 22:17:58]

Done.

+    SendLayout(names);
+  }
+  ~WaylandKeyboardDelegate() override {
+    chromeos::input_method::ImeKeyboard* keyboard =
+        chromeos::input_method::InputMethodManager::Get()->GetImeKeyboard();
+    if (keyboard)
+      keyboard->RemoveObserver(this);
+#else

[reveman, 2017/06/09 21:15:18]

ifdef that spans multiple functions like this is confusing. please have one
ifdef in the ctor and one in the dtor instead

[jclinton, 2017/06/09 22:17:58]

Done.

+    SendLayout(nullptr);
+#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(OS_CHROMEOS)

[reveman, 2017/06/09 21:15:18]

#if defined(USE_OZONE) && defined(OS_CHROMEOS)

[jclinton, 2017/06/09 22:17:58]

Done.

+  // Overridden from input_method::ImeKeyboard::Observer:
+  void OnCapsLockChanged(bool enabled) override {}
+  void OnLayoutChanged(const std::string& layout_name) override {
+    std::string layout_id, 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 = ""};
+    SendLayout(names);
+  }
+#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 17 matching lines @@
     uint32_t xkb_modifiers = 0;
     for (auto modifier : modifiers) {
       if (modifier_flags & modifier.flag) {
         xkb_modifiers |=
             1 << xkb_keymap_mod_get_index(xkb_keymap_.get(), modifier.xkb_name);
       }
     }
     return xkb_modifiers;
   }
 
+  // Send the current keyboard layout to the Wayland client

[reveman, 2017/06/09 21:15:18]

End sentence with "." and remove Wayland, "to the client." is enough

[jclinton, 2017/06/09 22:17:58]

Done.

+  void SendLayout(const struct xkb_rule_names& names) {

[reveman, 2017/06/09 21:15:18]

"struct" is not needed in c++ code. and "const xkb_rule_names* names" as you
pass nullptr in some cases

[jclinton, 2017/06/09 22:17:58]

Done.

+    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);
+  }
+
   // The client who own this keyboard instance.
   wl_client* client() const {
     return wl_resource_get_client(keyboard_resource_);
   }
 
   // Returns the next serial to use for keyboard events.
   uint32_t next_serial() const {
     return wl_display_next_serial(wl_client_get_display(client()));
   }
 
@@ skipping 1182 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