Merge lp:~andreas-pokorny/mir/fix-1588237 into lp:mir

[Andreas Pokorny]

Fix behavior of numlock and related modifier keys (LP: #1588237)

Corrects the tracking of modifiers that can be toggled. The input device state event now transfers the state of the toggled modifiers via double entries in the scan code array. Finally this change adds some missing wiring to forward the input device state event to the client side XkbMapper.

Three small changes that add all missing pieces to fix client side key mapping.
First of all the modifier tracking for toggling modifiers had to be fixed. Then those modifiers need special treatment to transfer them from the server to the upcoming focused client. The client needs that status to feed that back into xkb. This is done via scan codes - with that we also handle the case that the client keymap configuration remapped that toggling modifier.

When and where is that relevant?
If we do all scan code to key mapping in the server this change is not really necessary. The server keeps the key state separate from the currently focused window. So the modifier state stays correct when input focus is switched between surfaces. Because of Xmir/X11 we still have to support client side key mapping. So clients have to be informed about modifier state beyond the list of depressed keys.

Note on testing:
In mir/miral the default is to do server side key mapping only.
But his can be easily changed:
Add
  xkb_mapper->set_keymap_for_all_devices(mir::input::Keymap{});
to the constructor of android_input_receiver.cpp

Launch "gedit -s" twice, and change num lock or caps lock in one gedit then type in the other.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3534
https://mir-jenkins.ubuntu.com/job/mir-ci/1236/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/1438/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/1490
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1481
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/1481
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1452
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1452/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1452/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1452
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1452/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1452
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1452/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/1452/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1236/rebuild

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3535
https://mir-jenkins.ubuntu.com/job/mir-ci/1240/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/1442/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/1494
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/1485
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/1485
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1456
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=vivid+overlay/1456/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1456
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial/1456/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1456
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/1456/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1456
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/1456/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial/1456/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/1240/rebuild

review: Needs Fixing (continuous-integration)

[Alexandros Frantzis (afrantzis)]

[ FAILED ] TestClientInput.reestablishes_num_lock_state_in_client_with_surface_keymap (1450 ms)

review: Needs Fixing

[Andreas Pokorny (andreas-pokorny)]

still working on gtk and now also systemd to make a fix.. so putting that down for a week or so

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3537
https://mir-jenkins.ubuntu.com/job/mir-ci/2877/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3793/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3872
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3862
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3862
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3862
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3820
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3820/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3820
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3820/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3820/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3820
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3820/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3820
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3820/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3820/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2877/rebuild

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3538
https://mir-jenkins.ubuntu.com/job/mir-ci/2878/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3795/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3874
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3864
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3864
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3864
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3822
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3822/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3822/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3822
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3822/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3822
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3822/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3822
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3822/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3822
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3822/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2878/rebuild

review: Needs Fixing (continuous-integration)

[Andreas Pokorny (andreas-pokorny)]

Ok still the same ordering problem.. the device state event occurs to soon and lacks the pressed keys..

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3540
https://mir-jenkins.ubuntu.com/job/mir-ci/2898/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3830/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3909
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3899
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3899
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3899
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3857
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3857/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3857
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3857/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3857/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3857
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3857/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3857
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3857/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3857
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3857/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2898/rebuild

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3541
https://mir-jenkins.ubuntu.com/job/mir-ci/2899/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/3831/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3910
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3900
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3900
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3900
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3858
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3858/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3858
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3858/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3858
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3858/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3858
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3858/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3858
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3858/artifact/output/*zip*/output.zip
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3858/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2899/rebuild

review: Needs Fixing (continuous-integration)

[Andreas Pokorny (andreas-pokorny)]

NestedInput.* and in the last one there were two ClientLatency.* failures.

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3542
https://mir-jenkins.ubuntu.com/job/mir-ci/2945/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/3902
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/3981
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/3971
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/3971
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/3971
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3929
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=zesty/3929/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3929
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/3929/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3929
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=zesty/3929/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3929
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/3929/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3929
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/3929/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3929
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/3929/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2945/rebuild

review: Approve (continuous-integration)

[Alexandros Frantzis (afrantzis)]

Looks good.

review: Approve

=== modified file 'src/client/input/android/android_input_receiver.cpp'
--- src/client/input/android/android_input_receiver.cpp	2017-01-18 02:29:37 +0000
+++ src/client/input/android/android_input_receiver.cpp	2017-02-06 09:42:51 +0000
@@ -103,12 +103,28 @@
 
 static void map_key_event(std::shared_ptr<mircv::XKBMapper> const& xkb_mapper, MirEvent &ev)
 {
-    // TODO: As XKBMapper is used to track modifier state we need to use a seperate instance
-    // of XKBMapper per device id (or modify XKBMapper semantics)
-    if (mir_event_get_type(&ev) != mir_event_type_input)
-        return;
-
-    xkb_mapper->map_event(ev);
+    auto const type = mir_event_get_type(&ev);
+    if (type == mir_event_type_input)
+    {
+        xkb_mapper->map_event(ev);
+    }
+    else if (type == mir_event_type_input_device_state)
+    {
+        auto device_state = mir_event_get_input_device_state_event(&ev);
+        std::vector<uint32_t> keys;
+
+        for (size_t index = 0, end_index = mir_input_device_state_event_device_count(device_state);
+             index != end_index; ++index)
+        {
+            auto device_id = mir_input_device_state_event_device_id(device_state, index);
+            auto key_count = mir_input_device_state_event_device_pressed_keys_count(device_state, index);
+            for (decltype(key_count) i = 0; i != key_count; ++i)
+                keys.push_back(
+                    mir_input_device_state_event_device_pressed_keys_for_index(device_state, index, i));
+
+            xkb_mapper->set_key_state(device_id, keys);
+        }
+    }
 }
 
 }

=== modified file 'src/client/input/xkb_mapper.cpp'
--- src/client/input/xkb_mapper.cpp	2017-01-18 02:29:37 +0000
+++ src/client/input/xkb_mapper.cpp	2017-02-06 09:42:51 +0000
@@ -25,6 +25,7 @@
 
 #include <sstream>
 #include <boost/throw_exception.hpp>
+#include <unordered_set>
 
 namespace mi = mir::input;
 namespace mev = mir::events;
@@ -59,10 +60,18 @@
     case XKB_KEY_Super_R: return mir_input_event_modifier_meta_right;
     case XKB_KEY_Caps_Lock: return mir_input_event_modifier_caps_lock;
     case XKB_KEY_Scroll_Lock: return mir_input_event_modifier_scroll_lock;
+    case XKB_KEY_Num_Lock: return mir_input_event_modifier_num_lock;
     default: return MirInputEventModifiers{0};
     }
 }
 
+bool is_toggle_modifier(MirInputEventModifiers key)
+{
+    return key == mir_input_event_modifier_caps_lock ||
+        key == mir_input_event_modifier_scroll_lock ||
+        key == mir_input_event_modifier_num_lock;
+}
+
 MirInputEventModifiers expand_modifiers(MirInputEventModifiers modifiers)
 {
     if (modifiers == 0)
@@ -167,7 +176,7 @@
         MirInputEventModifiers new_modifier = 0;
         for (auto const& mapping_state : device_mapping)
         {
-            new_modifier |= mapping_state.second->modifier_state;
+            new_modifier |= mapping_state.second->modifiers();
         }
 
         modifier_state = new_modifier;
@@ -284,6 +293,16 @@
     return mir_input_event_modifier_none;
 }
 
+MirInputEventModifiers mircv::XKBMapper::device_modifiers(MirInputDeviceId id) const
+{
+    std::lock_guard<std::mutex> lg(guard);
+
+    auto it = device_mapping.find(id);
+    if (it == end(device_mapping))
+        return mir_input_event_modifier_none;
+    return expand_modifiers(it->second->modifiers());
+}
+
 mircv::XKBMapper::XkbMappingState::XkbMappingState(std::shared_ptr<xkb_keymap> const& keymap)
     : keymap{keymap}, state{make_unique_state(this->keymap.get())}
 {
@@ -293,8 +312,20 @@
 {
     state = make_unique_state(keymap.get());
     modifier_state = mir_input_event_modifier_none;
+    std::unordered_set<uint32_t> pressed_codes;
     for (uint32_t scan_code : key_state)
-        update_state(to_xkb_scan_code(scan_code), mir_keyboard_action_down, nullptr);
+    {
+        bool already_pressed = pressed_codes.count(scan_code) > 0;
+
+        update_state(to_xkb_scan_code(scan_code),
+                     (already_pressed) ? mir_keyboard_action_up : mir_keyboard_action_down,
+                     nullptr);
+
+        if (already_pressed)
+            pressed_codes.erase(scan_code);
+        else
+            pressed_codes.insert(scan_code);
+    }
 }
 
 bool mircv::XKBMapper::XkbMappingState::update_and_map(MirEvent& event, mircv::XKBMapper::ComposeState* compose_state)
@@ -322,17 +353,26 @@
     if (action == mir_keyboard_action_up)
     {
         xkb_state_update_key(state.get(), scan_code, XKB_KEY_UP);
-        modifier_state = modifier_state & ~mod_change;
+        // TODO get the modifier state from xkbcommon and apply it
+        // for all other modifiers manually track them here:
+        release_modifier(mod_change);
     }
     else if (action == mir_keyboard_action_down)
     {
         xkb_state_update_key(state.get(), scan_code, XKB_KEY_DOWN);
-        modifier_state = modifier_state | mod_change;
+        // TODO get the modifier state from xkbcommon and apply it
+        // for all other modifiers manually track them here:
+        press_modifier(mod_change);
     }
 
     return key_sym;
 }
 
+MirInputEventModifiers mircv::XKBMapper::XkbMappingState::modifiers() const
+{
+    return modifier_state;
+}
+
 mircv::XKBMapper::ComposeState* mircv::XKBMapper::get_compose_state(MirInputDeviceId id)
 {
     auto dev_compose_state = device_composing.find(id);
@@ -410,3 +450,18 @@
 
     return mapped_key;
 }
+
+
+void mircv::XKBMapper::XkbMappingState::press_modifier(MirInputEventModifiers mod)
+{
+    if (is_toggle_modifier(mod))
+        modifier_state ^= mod;
+    else
+        modifier_state |= mod;
+}
+
+void mircv::XKBMapper::XkbMappingState::release_modifier(MirInputEventModifiers mod)
+{
+    if (!is_toggle_modifier(mod))
+        modifier_state &= ~mod;
+}

=== modified file 'src/include/common/mir/input/key_mapper.h'
--- src/include/common/mir/input/key_mapper.h	2017-01-18 02:29:37 +0000
+++ src/include/common/mir/input/key_mapper.h	2017-02-06 09:42:51 +0000
@@ -88,6 +88,7 @@
      */
     virtual void map_event(MirEvent& event) = 0;
     virtual MirInputEventModifiers modifiers() const = 0;
+    virtual MirInputEventModifiers device_modifiers(MirInputDeviceId id) const = 0;
 
 protected:
     KeyMapper(KeyMapper const&) = delete;

=== modified file 'src/include/common/mir/input/xkb_mapper.h'
--- src/include/common/mir/input/xkb_mapper.h	2017-01-18 02:29:37 +0000
+++ src/include/common/mir/input/xkb_mapper.h	2017-02-06 09:42:51 +0000
@@ -63,6 +63,7 @@
     void clear_all_keymaps() override;
     void map_event(MirEvent& event) override;
     MirInputEventModifiers modifiers() const override;
+    MirInputEventModifiers device_modifiers(MirInputDeviceId di) const override;
 
 protected:
     XKBMapper(XKBMapper const&) = delete;
@@ -89,8 +90,14 @@
     {
         explicit XkbMappingState(std::shared_ptr<xkb_keymap> const& keymap);
         void set_key_state(std::vector<uint32_t> const& key_state);
+
         bool update_and_map(MirEvent& event, ComposeState* compose_state);
         xkb_keysym_t update_state(uint32_t scan_code, MirKeyboardAction direction, ComposeState* compose_state);
+        MirInputEventModifiers modifiers() const;
+    private:
+        void press_modifier(MirInputEventModifiers mod);
+        void release_modifier(MirInputEventModifiers mod);
+
         std::shared_ptr<xkb_keymap> const keymap;
         XKBStatePtr state;
         MirInputEventModifiers modifier_state{0};

=== modified file 'src/server/input/seat_input_device_tracker.cpp'
--- src/server/input/seat_input_device_tracker.cpp	2017-01-18 02:29:37 +0000
+++ src/server/input/seat_input_device_tracker.cpp	2017-02-06 09:42:51 +0000
@@ -31,6 +31,7 @@
 #include "input_modifier_utils.h"
 
 #include <boost/throw_exception.hpp>
+#include <linux/input.h>
 
 #include <stdexcept>
 #include <algorithm>
@@ -115,7 +116,7 @@
         if (stored_data == end(device_data))
             return true;
 
-        return !stored_data->second.allowed_scan_code_action(mir_input_event_get_keyboard_event(event));
+        return !stored_data->second.allowed_scan_code_action(mir_input_event_get_keyboard_event(event));;
     }
     return false;
 }
@@ -251,8 +252,44 @@
     std::vector<mev::InputDeviceState> devices;
     devices.reserve(device_data.size());
     for (auto const& item : device_data)
+    {
         devices.push_back({item.first, item.second.scan_codes, item.second.buttons});
-
+        auto lock_state = key_mapper->device_modifiers(item.first);
+
+        bool caps_lock_active = (lock_state & mir_input_event_modifier_caps_lock);
+        bool scroll_lock_active = (lock_state & mir_input_event_modifier_scroll_lock);
+        bool num_lock_active = (lock_state & mir_input_event_modifier_num_lock);
+
+        bool contains_caps_lock_pressed = false;
+        bool contains_scroll_lock_pressed = false;
+        bool contains_num_lock_pressed = false;
+
+        for (uint32_t scan_code : item.second.scan_codes)
+        {
+            if (scan_code == KEY_CAPSLOCK)
+                contains_caps_lock_pressed = true;
+            else if (scan_code == KEY_SCROLLLOCK)
+                contains_scroll_lock_pressed = true;
+            else if (scan_code == KEY_NUMLOCK)
+                contains_num_lock_pressed = true;
+        }
+
+        if (caps_lock_active && !contains_caps_lock_pressed)
+        {
+            devices.back().pressed_keys.push_back(KEY_CAPSLOCK);
+            devices.back().pressed_keys.push_back(KEY_CAPSLOCK);
+        }
+        if (num_lock_active && !contains_num_lock_pressed)
+        {
+            devices.back().pressed_keys.push_back(KEY_NUMLOCK);
+            devices.back().pressed_keys.push_back(KEY_NUMLOCK);
+        }
+        if (scroll_lock_active && !contains_scroll_lock_pressed)
+        {
+            devices.back().pressed_keys.push_back(KEY_SCROLLLOCK);
+            devices.back().pressed_keys.push_back(KEY_SCROLLLOCK);
+        }
+    }
     auto out_ev = mev::make_event(
         clock->now().time_since_epoch(),
         buttons,

=== modified file 'tests/acceptance-tests/test_client_input.cpp'
--- tests/acceptance-tests/test_client_input.cpp	2017-02-06 03:54:54 +0000
+++ tests/acceptance-tests/test_client_input.cpp	2017-02-06 09:42:51 +0000
@@ -18,7 +18,10 @@
 
 #include "mir/input/input_device_info.h"
 #include "mir/input/event_filter.h"
+#include "mir/input/keymap.h"
 #include "mir/input/composite_event_filter.h"
+#include "mir/scene/session.h"
+#include "mir/scene/surface.h"
 #include "mir/input/mir_touchpad_config.h"
 #include "mir/input/mir_input_config.h"
 
@@ -45,6 +48,7 @@
 #include <linux/input.h>
 
 #include <condition_variable>
+#include <unordered_map>
 #include <chrono>
 #include <atomic>
 #include <mutex>
@@ -98,12 +102,52 @@
 {
 }
 
+struct SurfaceTrackingShell : mir::shell::ShellWrapper
+{
+    SurfaceTrackingShell(
+        std::shared_ptr<mir::shell::Shell> wrapped_shell)
+        : ShellWrapper{wrapped_shell}, wrapped_shell{wrapped_shell}
+    {}
+
+    mir::frontend::SurfaceId create_surface(
+        std::shared_ptr<mir::scene::Session> const& session,
+        mir::scene::SurfaceCreationParameters const& params,
+        std::shared_ptr<mir::frontend::EventSink> const& sink) override
+    {
+        auto surface_id = wrapped_shell->create_surface(session, params, sink);
+
+        tracked_surfaces[session->name()] =  TrackedSurface{session, surface_id};
+
+        return surface_id;
+    }
+
+    std::shared_ptr<mir::scene::Surface> get_surface(std::string const& session_name)
+    {
+        if (end(tracked_surfaces) == tracked_surfaces.find(session_name))
+            return nullptr;
+        TrackedSurface & tracked_surface = tracked_surfaces[session_name];
+        auto session = tracked_surface.session.lock();
+        if (!session)
+            return nullptr;
+        return session->surface(tracked_surface.surface);
+    }
+
+    struct TrackedSurface
+    {
+        std::weak_ptr<mir::scene::Session> session;
+        mir::frontend::SurfaceId surface;
+    };
+    std::unordered_map<std::string, TrackedSurface> tracked_surfaces;
+    std::shared_ptr<mir::shell::Shell> wrapped_shell;
+};
+
 struct Client
 {
     MirWindow* window{nullptr};
 
     MOCK_METHOD1(handle_input, void(MirEvent const*));
     MOCK_METHOD1(handle_keymap, void(MirEvent const*));
+    MOCK_METHOD1(handle_input_device_state, void(MirEvent const*));
 
     Client(std::string const& con, std::string const& name)
     {
@@ -146,7 +190,12 @@
             mir_window_focus_state_focused == value)
             focused = true;
 
-        if (exposed && focused)
+        test_and_raise();
+    }
+
+    void test_and_raise()
+    {
+        if (exposed && focused && input_device_state_received)
             ready_to_accept_events.raise();
     }
 
@@ -164,6 +213,12 @@
             client->handle_input(ev);
         if (type == mir_event_type_keymap)
             client->handle_keymap(ev);
+        if (type == mir_event_type_input_device_state)
+        {
+            client->input_device_state_received = true;
+            client->test_and_raise();
+            client->handle_input_device_state(ev);
+        }
     }
     ~Client()
     {
@@ -181,6 +236,7 @@
     mir::test::Signal all_events_received;
     bool exposed = false;
     bool focused = false;
+    bool input_device_state_received = false;
 };
 
 struct DeviceCounter : mi::InputDeviceObserver
@@ -216,7 +272,8 @@
             [this](std::shared_ptr<mir::shell::Shell> const& wrapped)
             {
                 shell = std::make_shared<mtf::PlacementApplyingShell>(wrapped, input_regions, positions);
-                return shell;
+                surfaces = std::make_shared<SurfaceTrackingShell>(shell);
+                return surfaces;
             });
         server.override_the_session_authorizer([this] { return mt::fake_shared(stub_authorizer); });
 
@@ -225,7 +282,13 @@
         positions[first] = geom::Rectangle{{0,0}, {surface_width, surface_height}};
     }
 
+    std::shared_ptr<mir::scene::Surface> get_surface(std::string const& name)
+    {
+        return surfaces->get_surface(name);
+    }
+
     std::shared_ptr<mtf::PlacementApplyingShell> shell;
+    std::shared_ptr<SurfaceTrackingShell> surfaces;
     std::string const keyboard_name = "keyboard";
     std::string const keyboard_unique_id = "keyboard-uid";
     std::string const mouse_name = "mouse";
@@ -939,6 +1002,81 @@
     mir_input_config_release(config);
 }
 
+TEST_F(TestClientInput, num_lock_is_off_on_startup)
+{
+    Client a_client(new_connection(), first);
+
+    EXPECT_CALL(a_client, handle_input(mt::KeyOfSymbol(XKB_KEY_KP_Left)))
+        .WillOnce(mt::WakeUp(&a_client.all_events_received));
+
+    fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_KP4));
+    a_client.all_events_received.wait_for(10s);
+}
+
+TEST_F(TestClientInput, keeps_num_lock_state_after_focus_change)
+{
+    Client first_client(new_connection(), first);
+
+    {
+        Client second_client(new_connection(), second);
+        EXPECT_CALL(second_client, handle_input(mt::KeyDownEvent()));
+        EXPECT_CALL(second_client, handle_input(mt::KeyUpEvent()))
+            .WillOnce(mt::WakeUp(&second_client.all_events_received));
+
+        fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_NUMLOCK));
+        fake_keyboard->emit_event(mis::a_key_up_event().of_scancode(KEY_NUMLOCK));
+
+        second_client.all_events_received.wait_for(10s);
+    }
+
+    EXPECT_CALL(first_client, handle_input(mt::KeyOfSymbol(XKB_KEY_KP_4)))
+        .WillOnce(mt::WakeUp(&first_client.all_events_received));
+    fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_KP4));
+    first_client.all_events_received.wait_for(10s);
+}
+
+TEST_F(TestClientInput, reestablishes_num_lock_state_in_client_with_surface_keymap)
+{
+    Client a_client_with_keymap(new_connection(), first);
+
+    mir::test::Signal keymap_received;
+    mir::test::Signal device_state_received;
+
+    EXPECT_CALL(a_client_with_keymap, handle_keymap(_))
+        .WillOnce(mt::WakeUp(&keymap_received));
+    EXPECT_CALL(a_client_with_keymap,
+                handle_input_device_state(
+                    mt::DeviceStateWithPressedKeys(std::vector<uint32_t>{KEY_NUMLOCK, KEY_NUMLOCK})))
+        .WillOnce(mt::WakeUp(&device_state_received));
+
+    get_surface(first)->set_keymap(MirInputDeviceId{0}, "pc105", "de", "", "");
+    keymap_received.wait_for(4s);
+
+    {
+        Client a_client(new_connection(), second);
+
+        EXPECT_CALL(a_client, handle_input(mt::KeyDownEvent()));
+        EXPECT_CALL(a_client, handle_input(mt::KeyUpEvent()));
+        EXPECT_CALL(a_client, handle_input(AllOf(mt::KeyDownEvent(),mt::KeyOfSymbol(XKB_KEY_KP_4))));
+        EXPECT_CALL(a_client, handle_input(AllOf(mt::KeyUpEvent(),mt::KeyOfSymbol(XKB_KEY_KP_4))))
+            .WillOnce(mt::WakeUp(&a_client.all_events_received));
+
+        fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_NUMLOCK));
+        fake_keyboard->emit_event(mis::a_key_up_event().of_scancode(KEY_NUMLOCK));
+        fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_KP4));
+        fake_keyboard->emit_event(mis::a_key_up_event().of_scancode(KEY_KP4));
+
+        a_client.all_events_received.wait_for(10s);
+    }
+    device_state_received.wait_for(4s);
+    EXPECT_CALL(a_client_with_keymap, handle_input(mt::KeyOfSymbol(XKB_KEY_KP_4)))
+        .WillOnce(mt::WakeUp(&a_client_with_keymap.all_events_received));
+
+    fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_KP4));
+
+    a_client_with_keymap.all_events_received.wait_for(10s);
+}
+
 TEST_F(TestClientInput, initial_mouse_configuration_can_be_querried)
 {
     wait_for_input_devices();

=== modified file 'tests/include/mir/test/doubles/mock_key_mapper.h'
--- tests/include/mir/test/doubles/mock_key_mapper.h	2017-01-18 02:29:37 +0000
+++ tests/include/mir/test/doubles/mock_key_mapper.h	2017-02-06 09:42:51 +0000
@@ -41,6 +41,7 @@
     MOCK_METHOD0(clear_all_keymaps, void());
     MOCK_METHOD1(map_event, void(MirEvent& event));
     MOCK_CONST_METHOD0(modifiers, MirInputEventModifiers());
+    MOCK_CONST_METHOD1(device_modifiers, MirInputEventModifiers(MirInputDeviceId));
 };