Add determining keyboard layout from Wayland

.github/workflows/ci.yml

@@ -273,6 +273,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/dist.txt', 'reqs/test.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
 
@@ -439,6 +443,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/dist.txt', 'reqs/test.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
 
@@ -493,6 +501,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/dist.txt', 'reqs/test.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
 
@@ -547,6 +559,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/dist.txt', 'reqs/test.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
 
@@ -601,6 +617,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/dist.txt', 'reqs/test.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
 
@@ -656,7 +676,7 @@ jobs:
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/dist.txt', 'reqs/dist_extra_gui_qt.txt', 'reqs/test.txt') }}
 
       - name: Install system dependencies
-        run: apt_get_install cmake libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0
+        run: apt_get_install cmake libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0 libxkbcommon-dev
 
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/dist_extra_gui_qt.txt -r reqs/test.txt        
@@ -718,6 +738,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/packaging.txt', 'reqs/setup.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/packaging.txt -r reqs/setup.txt        
 
@@ -805,6 +829,10 @@ jobs:
           path: .cache
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/code_quality.txt') }}
 
+      # Required to install xkbcommon Python package.
+      - name: Install system dependencies
+        run: apt_get_install libxkbcommon-dev
+
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/code_quality.txt        
 
@@ -862,7 +890,7 @@ jobs:
           key: 0_${{ steps.set_cache.outputs.cache_name }}_${{ hashFiles('reqs/constraints.txt', 'reqs/build.txt', 'reqs/setup.txt', 'reqs/dist_*.txt', 'linux/appimage/deps.sh') }}
 
       - name: Install system dependencies
-        run: apt_get_install cmake libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0
+        run: apt_get_install cmake libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0 libxkbcommon-dev
 
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt        

.github/workflows/ci/workflow_template.yml

@@ -144,10 +144,17 @@ jobs:
         run: setup_osx_python '<@ j.python @>'
 
       <% endif %>
-      <% if j.type in ['build', 'test_gui_qt'] and j.os == 'Linux' %>
+      <% if j.os == 'Linux' %>
+      <% if j.type in ['build', 'test_gui_qt'] %>
+      - name: Install system dependencies
+        run: apt_get_install cmake libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0 libxkbcommon-dev
+
+      <% else %>
+      # Required to install xkbcommon Python package.
       - name: Install system dependencies
-        run: apt_get_install cmake libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0
+        run: apt_get_install libxkbcommon-dev
 
+      <% endif %>
       <% endif %>
       <% if j.type != 'notarize' %>
       - name: Setup Python environment

linux/README.md

@@ -8,5 +8,6 @@ distribution corresponding packages):
 - Treal support: `libusb` (1.0) and `libudev` are needed by
   the [`hidapi` package](https://pypi.org/project/hidapi/).
 - log / notifications support: `libdbus` is needed.
+- Uinput support: `libxkbcommon` is needed by the [`xkbcommon` package](https://pypi.org/project/xkbcommon)
 
 For the rest of the steps, follow the [developer guide](../doc/developer_guide.md).

news.d/feature/1807.linux.md

@@ -0,0 +1 @@
+Support determining keyboard layout from Wayland with the `wayland-auto` layout.

plover/config.py

@@ -428,7 +428,7 @@ def _set(self, section, option, value):
             ),
             choice_option(
                 "keyboard_layout",
-                ("qwerty", "qwertz", "colemak", "colemak-dh", "dvorak"),
+                ("qwerty", "qwertz", "colemak", "colemak-dh", "dvorak", "wayland-auto"),
                 OUTPUT_CONFIG_SECTION,
             ),
             # Logging.

plover/gui_qt/config_window.py

@@ -521,6 +521,7 @@ def __init__(self, engine):
                                 "colemak": "colemak",
                                 "colemak-dh": "colemak-dh",
                                 "dvorak": "dvorak",
+                                "wayland-auto": "wayland-auto",
                             },
                         ),
                         _(