Add support for wlroots-based Wayland compositors like Sway

MANIFEST.in

@@ -20,6 +20,7 @@ include plover/gui_qt/resources/*.qrc
 include plover/gui_qt/resources/*.svg
 include plover/messages/*/LC_MESSAGES/*.po
 include plover/messages/plover.pot
+include plover/oslayer/wayland/*.xml
 include plover_build_utils/*.sh
 include pyproject.toml
 include pytest.ini

news.d/feature/1461.linux.md

@@ -0,0 +1 @@
+Add support for wlroots-based Wayland compositors like Sway, and other compositors that implement the `virtual_keyboard_unstable_v1` and `input_method_unstable_v2` protocols.

plover/oslayer/config.py

@@ -21,6 +21,16 @@
 else:
     PLATFORM = None
 
+if PLATFORM in {'linux', 'bsd'}:
+    if os.environ.get('WAYLAND_DISPLAY', None):
+        DISPLAY_SERVER = 'wayland'
+    else:
+        DISPLAY_SERVER = 'xorg'
+elif PLATFORM in {'win', 'mac'}:
+    DISPLAY_SERVER = PLATFORM
+else:
+    DISPLAY_SERVER = None
+
 # If the program's working directory has a plover.cfg file then run in
 # "portable mode", i.e. store all data in the same directory. This allows
 # keeping all Plover files in a portable drive.

plover/oslayer/keyboardcontrol.py

@@ -16,16 +16,18 @@
 
 """
 
-from plover.oslayer.config import PLATFORM
+from plover.oslayer.config import DISPLAY_SERVER
 
 KEYBOARDCONTROL_NOT_FOUND_FOR_OS = \
-        "No keyboard control module was found for platform: %s" % PLATFORM
+        "No keyboard control module was found for platform: %s" % DISPLAY_SERVER
 
-if PLATFORM in {'linux', 'bsd'}:
+if DISPLAY_SERVER == 'xorg':
     from plover.oslayer import xkeyboardcontrol as keyboardcontrol
-elif PLATFORM == 'win':
+elif DISPLAY_SERVER == 'wayland':
+    from plover.oslayer import waykeyboardcontrol as keyboardcontrol
+elif DISPLAY_SERVER == 'win':
     from plover.oslayer import winkeyboardcontrol as keyboardcontrol
-elif PLATFORM == 'mac':
+elif DISPLAY_SERVER == 'mac':
     from plover.oslayer import osxkeyboardcontrol as keyboardcontrol
 else:
     raise Exception(KEYBOARDCONTROL_NOT_FOUND_FOR_OS)