Merge lp:~alan-griffiths/miral/Keymap into lp:miral

[Alan Griffiths]

miral::Keymap - support for keyboard maps (either programatically Keymap::set_keymap(), or via config --keymap)

[Andreas Pokorny (andreas-pokorny)]

yes this looks reasonable

review: Approve

[Brandon Schaefer (brandontschaefer)]

lgtm

review: Approve

[lp:~alan-griffiths/miral/Keymap]

411. By Alan Griffiths on 2016-10-12

Mutex to permit multi-threaded operation

[Gerry Boland (gerboland)]

looks ok to me

review: Approve

=== modified file 'debian/libmiral1.symbols'
--- debian/libmiral1.symbols	2016-10-05 16:54:07 +0000
+++ debian/libmiral1.symbols	2016-10-12 10:30:39 +0000
@@ -264,3 +264,14 @@
  (c++)"vtable for miral::ActiveOutputsListener@MIRAL_0.1" 0.1.0
  (c++)"vtable for miral::CanonicalWindowManagerPolicy@MIRAL_0.1" 0.1.0
  (c++)"vtable for miral::WindowManagementPolicy@MIRAL_0.1" 0.1.0
+ (c++)"miral::Keymap::set_keymap(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::Keymap()@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::Keymap(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::Keymap(miral::Keymap const&)@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::Keymap()@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::~Keymap()@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::~Keymap()@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::operator=(miral::Keymap const&)@MIRAL_0.3" 0.3.0
+ (c++)"miral::Keymap::operator()(mir::Server&) const@MIRAL_0.3" 0.3.0

=== added file 'include/miral/keymap.h'
--- include/miral/keymap.h	1970-01-01 00:00:00 +0000
+++ include/miral/keymap.h	2016-10-12 10:30:39 +0000
@@ -0,0 +1,56 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Alan Griffiths <[e-mail]>
+ */
+
+#ifndef MIRAL_KEYMAP_H
+#define MIRAL_KEYMAP_H
+
+#include <memory>
+#include <string>
+
+namespace mir { class Server; }
+
+namespace miral
+{
+/// Load a keymap
+class Keymap
+{
+public:
+
+    /// Apply keymap from the config.
+    Keymap();
+
+    /// Specify a keymap.
+    /// Format is <language>[+<variant>]
+    /// e.g. "uk" or "us+dvorak"
+    explicit Keymap(std::string const& keymap);
+    ~Keymap();
+    Keymap(Keymap const& that);
+    auto operator=(Keymap const& rhs) -> Keymap&;
+
+    void operator()(mir::Server& server) const;
+
+    /// Specify a new keymap.
+    void set_keymap(std::string const& keymap);
+
+private:
+    struct Self;
+    std::shared_ptr<Self> self;
+};
+}
+
+#endif //MIRAL_KEYMAP_H

=== modified file 'miral-shell/shell_main.cpp'
--- miral-shell/shell_main.cpp	2016-09-28 10:38:36 +0000
+++ miral-shell/shell_main.cpp	2016-10-12 10:30:39 +0000
@@ -26,6 +26,7 @@
 #include <miral/append_event_filter.h>
 #include <miral/internal_client.h>
 #include <miral/cursor_theme.h>
+#include <miral/keymap.h>
 
 #include <linux/input.h>
 
@@ -68,6 +69,8 @@
             return true;
         };
 
+    Keymap config_keymap;
+
     return runner.run_with(
         {
             CursorTheme{"default"},
@@ -75,6 +78,7 @@
             display_configuration_options,
             launcher,
             outputs_monitor,
+            config_keymap,
             AppendEventFilter{quit_on_ctrl_alt_bksp},
             StartupInternalClient{"Intro", spinner}
         });

=== modified file 'miral/CMakeLists.txt'
--- miral/CMakeLists.txt	2016-09-28 13:16:14 +0000
+++ miral/CMakeLists.txt	2016-10-12 10:30:39 +0000
@@ -32,6 +32,7 @@
     application_info.cpp                ${CMAKE_SOURCE_DIR}/include/miral/application_info.h
     canonical_window_manager.cpp        ${CMAKE_SOURCE_DIR}/include/miral/canonical_window_manager.h
     cursor_theme.cpp                    ${CMAKE_SOURCE_DIR}/include/miral/cursor_theme.h
+    keymap.cpp                          ${CMAKE_SOURCE_DIR}/include/miral/keymap.h
     runner.cpp                          ${CMAKE_SOURCE_DIR}/include/miral/runner.h
     display_configuration_option.cpp    ${CMAKE_SOURCE_DIR}/include/miral/display_configuration_option.h
     output.cpp                          ${CMAKE_SOURCE_DIR}/include/miral/output.h

=== added file 'miral/keymap.cpp'
--- miral/keymap.cpp	1970-01-01 00:00:00 +0000
+++ miral/keymap.cpp	2016-10-12 10:30:39 +0000
@@ -0,0 +1,173 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Alan Griffiths <[e-mail]>
+ */
+
+#include "miral/keymap.h"
+
+#include <mir/input/input_device_observer.h>
+#include <mir/input/input_device_hub.h>
+#include <mir/input/device.h>
+#include <mir/options/option.h>
+#include <mir/server.h>
+#include <mir/version.h>
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 24, 1)
+#include <mir/input/keymap.h>
+#include <mir/input/keyboard_configuration.h>
+#endif
+
+#define MIR_LOG_COMPONENT "miral::Keymap"
+#include <mir/log.h>
+
+#include <algorithm>
+#include <mutex>
+#include <vector>
+
+namespace
+{
+char const* const keymap_option = "keymap";
+char const* const keymap_default = "us";
+}
+
+struct miral::Keymap::Self : mir::input::InputDeviceObserver
+{
+    Self(std::string const& keymap) : layout{}, variant{}
+    {
+        set_keymap(keymap);
+    }
+
+    void set_keymap(std::string const& keymap)
+    {
+        std::lock_guard<decltype(mutex)> lock{mutex};
+
+        auto const i = keymap.find('+');
+
+        layout = keymap.substr(0, i);
+
+        if (i != std::string::npos)
+            variant = keymap.substr(i + 1);
+
+        for (auto const& keyboard : keyboards)
+            apply_keymap(keyboard);
+    }
+
+    void device_added(std::shared_ptr<mir::input::Device> const& device) override
+    {
+        std::lock_guard<decltype(mutex)> lock{mutex};
+
+        if (mir::contains(device->capabilities(), mir::input::DeviceCapability::keyboard))
+            add_keyboard(device);
+    }
+
+    void device_changed(std::shared_ptr<mir::input::Device> const& device) override
+    {
+        std::lock_guard<decltype(mutex)> lock{mutex};
+
+        auto const keyboard = std::find(begin(keyboards), end(keyboards), device);
+
+        if (mir::contains(device->capabilities(), mir::input::DeviceCapability::keyboard))
+        {
+            if (keyboard == end(keyboards))
+                add_keyboard(device);
+        }
+        else
+        {
+            if (keyboard != end(keyboards))
+                keyboards.erase(keyboard);
+        }
+    }
+
+    void add_keyboard(std::shared_ptr<mir::input::Device> const& keyboard)
+    {
+        keyboards.push_back(keyboard);
+        apply_keymap(keyboard);
+    }
+
+#if MIR_SERVER_VERSION >= MIR_VERSION_NUMBER(0, 24, 1)
+    void apply_keymap(std::shared_ptr<mir::input::Device> const& keyboard)
+    {
+        auto const keyboard_config = keyboard->keyboard_configuration();
+        mir::input::Keymap keymap;
+
+        if (keyboard_config.is_set())
+        {
+            keymap = keyboard_config.value().device_keymap;
+        }
+
+        keymap.layout = layout;
+        keymap.variant = variant;
+        keyboard->apply_keyboard_configuration(std::move(keymap));
+    }
+#else
+    void apply_keymap(std::shared_ptr<mir::input::Device> const&)
+    {
+        mir::log_warning("Cannot apply keymap - not supported for Mir versions prior to 0.24.1");
+    }
+#endif
+
+    void device_removed(std::shared_ptr<mir::input::Device> const& device) override
+    {
+        std::lock_guard<decltype(mutex)> lock{mutex};
+
+        if (mir::contains(device->capabilities(), mir::input::DeviceCapability::keyboard))
+            keyboards.erase(std::find(begin(keyboards), end(keyboards), device));
+    }
+
+    void changes_complete() override
+    {
+    }
+
+    std::mutex mutable mutex;
+    std::string layout;
+    std::string variant;
+    std::vector<std::shared_ptr<mir::input::Device>> keyboards;
+};
+
+miral::Keymap::Keymap() :
+    self{std::make_shared<Self>(std::string{})}
+{
+}
+
+miral::Keymap::Keymap(std::string const& keymap) :
+    self{std::make_shared<Self>(keymap)}
+{
+}
+
+miral::Keymap::~Keymap() = default;
+
+miral::Keymap::Keymap(Keymap const&) = default;
+
+auto miral::Keymap::operator=(Keymap const& rhs) -> Keymap& = default;
+
+void miral::Keymap::operator()(mir::Server& server) const
+{
+    if (self->layout.empty())
+        server.add_configuration_option(keymap_option, "keymap <layout>[+<variant>], e,g, \"gb\" or \"cz+qwerty\"", keymap_default);
+
+    server.add_init_callback([this, &server]
+        {
+            if (self->layout.empty())
+                self->set_keymap(server.get_options()->get<std::string>(keymap_option));
+
+            server.the_input_device_hub()->add_observer(self);
+        });
+}
+
+void miral::Keymap::set_keymap(std::string const& keymap)
+{
+    self->set_keymap(keymap);
+}

=== modified file 'miral/symbols.map'
--- miral/symbols.map	2016-10-05 16:54:07 +0000
+++ miral/symbols.map	2016-10-12 10:30:39 +0000
@@ -304,6 +304,12 @@
    # We need to specify the overload of miral::WindowManagerTools::modify_window
   _ZN5miral18WindowManagerTools13modify_windowERKNS_6WindowERKNS_19WindowSpecificationE;
   extern "C++" {
+    miral::Keymap::?Keymap*;
+    miral::Keymap::Keymap*;
+    miral::Keymap::operator*;
+    miral::Keymap::set_keymap*;
     miral::WindowSpecification::userdata*;
+    typeinfo?for?miral::Keymap;
+    vtable?for?miral::Keymap;
   };
 } MIRAL_0.2;