Merge lp:~andreas-pokorny/mir/example-configure-input-devices into lp:mir

[Andreas Pokorny]

Add program options to mir_demo_server for input devices

touchpad and mouse cursor and scroll speeds can be configured separately.

Extend examples to provide a few settings that affect input devices.

To test this properly on touchpads, this MP is essential: lp:~andreas-pokorny/mir/fix-missing-pointer-flag-at-touchpads

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3106
http://jenkins.qa.ubuntu.com/job/mir-ci/5576/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/4905
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3812/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4848
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/805/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1730
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1730/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4849
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4849/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/7427
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/25226
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/807/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/5576/rebuild

review: Needs Fixing (continuous-integration)

[Cemil Azizoglu (cemil-azizoglu)]

Looks good.

Nits:

1. s/touch pad/touchpad
90 + "Disable touch pad while typing on keyboard configuration [true, false]",

2. s/scrolll/scroll
+ "Select scrolll mode for touchpads: [{two-finger, edge}]",

3. s/accleration/acceleration
mouse_cursor_accleration_bias_opt;
mouse_cursor_accleration_bias;

4.
174 +void me::InputDeviceConfig::device_added(std::shared_ptr<mi::Device> const& device)

A more compact implementation would be

if (contains(device->capabilities(), mi::DeviceCapability::pointer))
{
    mi::PointerConfiguration pointer_config( device->pointer_configuration().value() );
    pointer_config.cursor_acceleration_bias = touchpad_cursor_accleration_bias;
    pointer_config.vertical_scroll_scale = touchpad_scroll_speed_scale;
    pointer_config.horizontal_scroll_scale = touchpad_scroll_speed_scale;
    device->apply_pointer_configuration(pointer_config);

    if (contains(device->capabilities(), mi::DeviceCapability::touchpad)))
    {
        mi::TouchpadConfiguration touch_config( device->touchpad_configuration().value() );
        touch_config.disable_while_typing = disable_while_typing;
        touch_config.click_mode = click_mode;
        touch_config.scroll_mode = scroll_mode;
        device->apply_touchpad_configuration(touch_config);
    }
}

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3107
http://jenkins.qa.ubuntu.com/job/mir-ci/5667/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/5028
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3934
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4975
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-wily-touch/931/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1819
        deb: http://jenkins.qa.ubuntu.com/job/mir-wily-amd64-ci/1819/artifact/work/output/*zip*/output.zip
    None: http://jenkins.qa.ubuntu.com/job/mir-wily-i386-ci/928/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4975
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4975/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/7522
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/25505
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-wily-armhf/932/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/5667/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3108
http://jenkins.qa.ubuntu.com/job/mir-ci/5676/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-vivid-i386-build/5042
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-vivid-amd64-build/3948
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-vivid-touch/4989
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-xenial-touch/9/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-xenial-amd64-ci/6
        deb: http://jenkins.qa.ubuntu.com/job/mir-xenial-amd64-ci/6/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-xenial-i386-ci/6
        deb: http://jenkins.qa.ubuntu.com/job/mir-xenial-i386-ci/6/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4989
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-vivid-armhf/4989/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-touch/7533
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/25529
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-xenial-armhf/7/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-ci/5676/rebuild

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

Looks good.

Nit:

+ "Scales mice scroll events, use negative values for natural scrolling",
+ "Scales touchpad scroll events, use negative values for natural scrolling",

Should be "Scale..." for consistency (e.g. "Disable touchpad...", "Select scroll...")

review: Approve

[Alan Griffiths (alan-griffiths)]

OK

review: Approve

=== modified file 'examples/CMakeLists.txt'
--- examples/CMakeLists.txt	2015-10-20 03:30:00 +0000
+++ examples/CMakeLists.txt	2015-11-26 08:55:29 +0000
@@ -21,6 +21,7 @@
   server_example_basic_window_manager.h
   server_example_canonical_window_manager.cpp
   server_example_display_configuration_policy.cpp
+  server_example_input_device_config.cpp
   server_example_input_event_filter.cpp
   server_example_log_options.cpp
   server_example_input_filter.cpp

=== modified file 'examples/server_example.cpp'
--- examples/server_example.cpp	2015-10-07 16:39:31 +0000
+++ examples/server_example.cpp	2015-11-26 08:55:29 +0000
@@ -25,6 +25,7 @@
 #include "server_example_custom_compositor.h"
 #include "server_example_test_client.h"
 #include "server_example_cursor_images.h"
+#include "server_example_input_device_config.h"
 
 #include "mir/server.h"
 #include "mir/main_loop.h"
@@ -92,6 +93,7 @@
     me::add_glog_options_to(server);
     me::add_window_manager_option_to(server);
     me::add_custom_compositor_option_to(server);
+    me::add_input_device_configuration_options_to(server);
     add_launcher_option_to(server);
     add_timeout_option_to(server);
     me::add_x_cursor_images(server);

=== added file 'examples/server_example_input_device_config.cpp'
--- examples/server_example_input_device_config.cpp	1970-01-01 00:00:00 +0000
+++ examples/server_example_input_device_config.cpp	2015-11-26 08:55:29 +0000
@@ -0,0 +1,162 @@
+/*
+ * Copyright © 2015 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: Andreas Pokorny <[e-mail]>
+ */
+
+#include "server_example_input_device_config.h"
+
+#include "mir/input/device_capability.h"
+#include "mir/input/pointer_configuration.h"
+#include "mir/input/touchpad_configuration.h"
+#include "mir/input/input_device_hub.h"
+#include "mir/input/device.h"
+#include "mir/options/option.h"
+#include "mir/server.h"
+
+namespace me = mir::examples;
+namespace mi = mir::input;
+
+///\example server_example_input_device_config.cpp
+/// Demonstrate input device configuration
+
+char const* const me::disable_while_typing_opt = "disable-while-typing";
+char const* const me::mouse_cursor_acceleration_bias_opt = "mouse-cursor-acceleration-bias";
+char const* const me::mouse_scroll_speed_scale_opt = "mouse-scroll-speed-scale";
+char const* const me::touchpad_cursor_acceleration_bias_opt = "touchpad-cursor-acceleration-bias";
+char const* const me::touchpad_scroll_speed_scale_opt = "touchpad-scroll-speed-scale";
+char const* const me::touchpad_scroll_mode_opt = "touchpad-scroll-mode";
+
+char const* const touchpad_scroll_mode_two_finger = "two-finger";
+char const* const touchpad_scroll_mode_edge = "edge";
+
+char const* const me::touchpad_click_mode_opt= "touchpad-click-mode";
+
+char const* const touchpad_click_mode_area = "area";
+char const* const touchpad_click_mode_finger_count = "finger-count";
+
+void me::add_input_device_configuration_options_to(mir::Server& server)
+{
+    // Add choice of monitor configuration
+    server.add_configuration_option(disable_while_typing_opt,
+                                    "Disable touchpad while typing on keyboard configuration [true, false]",
+                                    false);
+    server.add_configuration_option(mouse_cursor_acceleration_bias_opt,
+                                    "Bias to the acceleration curve within the range [-1.0, 1.0] for mice",
+                                    0.0);
+    server.add_configuration_option(mouse_scroll_speed_scale_opt,
+                                    "Scales mice scroll events, use negative values for natural scrolling",
+                                    1.0);
+    server.add_configuration_option(touchpad_cursor_acceleration_bias_opt,
+                                    "Bias to the acceleration curve within the range [-1.0, 1.0] for touchpads",
+                                    0.0);
+    server.add_configuration_option(touchpad_scroll_speed_scale_opt,
+                                    "Scales touchpad scroll events, use negative values for natural scrolling",
+                                    -1.0);
+
+    server.add_configuration_option(touchpad_scroll_mode_opt,
+                                    "Select scroll mode for touchpads: [{two-finger, edge}]",
+                                    touchpad_scroll_mode_two_finger);
+
+    server.add_configuration_option(touchpad_click_mode_opt,
+                                    "Select click mode for touchpads: [{area, finger-count}]",
+                                    touchpad_click_mode_finger_count);
+
+    auto clamp_to_range = [](double val)
+    {
+        if (val < -1.0)
+            val = -1.0;
+        else if (val > 1.0)
+            val = 1.0;
+        return val;
+    };
+
+    // TODO the configuration api allows a combination of values. We might want to expose that in the command line api too.
+    auto convert_to_scroll_mode = [](std::string const& val)
+    {
+        if (val == touchpad_scroll_mode_edge)
+            return mir_touchpad_scroll_mode_edge_scroll;
+        if (val == touchpad_scroll_mode_two_finger)
+            return mir_touchpad_scroll_mode_two_finger_scroll;
+        return mir_touchpad_scroll_mode_none;
+    };
+
+    auto convert_to_click_mode = [](std::string const& val)
+    {
+        if (val == touchpad_click_mode_finger_count)
+            return mir_touchpad_click_mode_finger_count;
+        if (val == touchpad_click_mode_area)
+            return mir_touchpad_click_mode_area_to_click;
+        return mir_touchpad_click_mode_none;
+    };
+
+    server.add_init_callback([&]()
+        {
+            auto const options = server.get_options();
+            auto const input_config = std::make_shared<me::InputDeviceConfig>(
+                options->get<bool>(disable_while_typing_opt),
+                clamp_to_range(options->get<double>(mouse_cursor_acceleration_bias_opt)),
+                options->get<double>(mouse_scroll_speed_scale_opt),
+                clamp_to_range(options->get<double>(touchpad_cursor_acceleration_bias_opt)),
+                options->get<double>(touchpad_scroll_speed_scale_opt),
+                convert_to_click_mode(options->get<std::string>(touchpad_click_mode_opt)),
+                convert_to_scroll_mode(options->get<std::string>(touchpad_scroll_mode_opt))
+                );
+            server.the_input_device_hub()->add_observer(input_config);
+        });
+}
+
+///\example server_example_input_device_config.cpp
+/// Demonstrate how to implement an InputDeviceObserver that identifies and configures input devices.
+
+me::InputDeviceConfig::InputDeviceConfig(bool disable_while_typing,
+                                         double mouse_cursor_acceleration_bias,
+                                         double mouse_scroll_speed_scale,
+                                         double touchpad_scroll_speed_scale,
+                                         double touchpad_cursor_acceleration_bias,
+                                         MirTouchpadClickModes click_mode,
+                                         MirTouchpadClickModes scroll_mode)
+    : disable_while_typing(disable_while_typing), mouse_cursor_acceleration_bias(mouse_cursor_acceleration_bias),
+      mouse_scroll_speed_scale(mouse_scroll_speed_scale),
+      touchpad_cursor_acceleration_bias(touchpad_cursor_acceleration_bias),
+      touchpad_scroll_speed_scale(touchpad_scroll_speed_scale), click_mode(click_mode), scroll_mode(scroll_mode)
+{
+}
+
+void me::InputDeviceConfig::device_added(std::shared_ptr<mi::Device> const& device)
+{
+    if (contains(device->capabilities(), mi::DeviceCapability::touchpad))
+    {
+        mi::PointerConfiguration pointer_config( device->pointer_configuration().value() );
+        pointer_config.cursor_acceleration_bias = touchpad_cursor_acceleration_bias;
+        pointer_config.vertical_scroll_scale  = touchpad_scroll_speed_scale;
+        pointer_config.horizontal_scroll_scale = touchpad_scroll_speed_scale;
+        device->apply_pointer_configuration(pointer_config);
+
+        mi::TouchpadConfiguration touch_config( device->touchpad_configuration().value() );
+        touch_config.disable_while_typing = disable_while_typing;
+        touch_config.click_mode = click_mode;
+        touch_config.scroll_mode = scroll_mode;
+        device->apply_touchpad_configuration(touch_config);
+    }
+    else if (contains(device->capabilities(), mi::DeviceCapability::pointer))
+    {
+        mi::PointerConfiguration pointer_config( device->pointer_configuration().value() );
+        pointer_config.cursor_acceleration_bias = mouse_cursor_acceleration_bias;
+        pointer_config.vertical_scroll_scale  = mouse_scroll_speed_scale;
+        pointer_config.horizontal_scroll_scale = mouse_scroll_speed_scale;
+        device->apply_pointer_configuration(pointer_config);
+    }
+}

=== added file 'examples/server_example_input_device_config.h'
--- examples/server_example_input_device_config.h	1970-01-01 00:00:00 +0000
+++ examples/server_example_input_device_config.h	2015-11-26 08:55:29 +0000
@@ -0,0 +1,73 @@
+/*
+ * Copyright © 2015 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: Andreas Pokorny <[e-mail]>
+ */
+
+#ifndef MIR_EXAMPLES_INPUT_DEVICE_CONFIG_H_
+#define MIR_EXAMPLES_INPUT_DEVICE_CONFIG_H_
+
+#include "mir/input/input_device_observer.h"
+#include "mir_toolkit/mir_input_device.h"
+
+namespace mir
+{
+class Server;
+
+namespace input
+{
+class Device;
+}
+
+namespace examples
+{
+extern char const* const disable_while_typing_opt;
+extern char const* const mouse_cursor_acceleration_bias_opt;
+extern char const* const mouse_scroll_speed_scale_opt;
+extern char const* const touchpad_cursor_acceleration_bias_opt;
+extern char const* const touchpad_scroll_speed_scale_opt;
+extern char const* const touchpad_click_mode_opt;
+extern char const* const touchpad_scroll_mode_opt;
+
+void add_input_device_configuration_options_to(Server& server);
+
+class InputDeviceConfig : public mir::input::InputDeviceObserver
+{
+public:
+    InputDeviceConfig(bool disable_while_typing,
+                      double mouse_cursor_acceleration_bias,
+                      double mouse_scroll_speed_scale,
+                      double touchpad_scroll_speed_scale,
+                      double touchpad_cursor_acceleration_bias,
+                      MirTouchpadClickModes click_mode,
+                      MirTouchpadScrollModes scroll_mode);
+    void device_added(std::shared_ptr<input::Device> const& device) override;
+    void device_changed(std::shared_ptr<input::Device> const&) override {};
+    void device_removed(std::shared_ptr<input::Device> const&) override {};
+    void changes_complete() override {}
+private:
+    bool disable_while_typing;
+    double mouse_cursor_acceleration_bias;
+    double mouse_scroll_speed_scale;
+    double touchpad_cursor_acceleration_bias;
+    double touchpad_scroll_speed_scale;
+    MirTouchpadClickModes click_mode;
+    MirTouchpadScrollModes scroll_mode;
+};
+
+}
+}
+
+#endif

=== modified file 'include/server/mir/server.h'
--- include/server/mir/server.h	2015-11-16 23:36:29 +0000
+++ include/server/mir/server.h	2015-11-26 08:55:29 +0000
@@ -128,6 +128,14 @@
     void add_configuration_option(
         std::string const& option,
         std::string const& description,
+        double default_value);
+
+    /// Add user configuration option(s) to Mir's option handling.
+    /// These will be resolved during initialisation from the command line,
+    /// environment variables, a config file or the supplied default.
+    void add_configuration_option(
+        std::string const& option,
+        std::string const& description,
         std::string const& default_value);
 
     /// Add user configuration option(s) to Mir's option handling.

=== modified file 'src/server/server.cpp'
--- src/server/server.cpp	2015-11-16 23:36:29 +0000
+++ src/server/server.cpp	2015-11-26 08:55:29 +0000
@@ -508,6 +508,27 @@
 void mir::Server::add_configuration_option(
     std::string const& option,
     std::string const& description,
+    double default_)
+{
+    verify_setting_allowed(self->server_config);
+    namespace po = boost::program_options;
+
+    auto const& existing = self->add_configuration_options;
+
+    auto const option_adder = [=](options::DefaultConfiguration& config)
+        {
+            existing(config);
+
+            config.add_options()
+            (option.c_str(), po::value<double>()->default_value(default_), description.c_str());
+        };
+
+    self->set_add_configuration_options(option_adder);
+}
+
+void mir::Server::add_configuration_option(
+    std::string const& option,
+    std::string const& description,
     std::string const& default_)
 {
     verify_setting_allowed(self->server_config);