Merge lp:~ermshiperete/onboard/keyman into lp:onboard

[Eberhard Beilharz]

Add support for Keyman keyboards

This change will allow to show OSK for Keyman keyboards in addition to previously supported ones. See https://keyman.com for more information about Keyman.

Add support for Keyman keyboards

This change will allow to show OSK for Keyman keyboards in addition to previously supported ones. See https://keyman.com for more information about Keyman.

Unmerged revisions

2296. By Eberhard Beilharz <email address hidden> on 2022-01-27

Add support for Keyman keyboards

This change will allow to show OSK for Keyman keyboards in addition
to previously supported ones.

=== added file 'Onboard/Keyman.py'
--- Onboard/Keyman.py	1970-01-01 00:00:00 +0000
+++ Onboard/Keyman.py	2022-01-27 19:28:30 +0000
@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+
+# Copyright © 2018 Daniel Glassey <[e-mail]>
+#
+# This file is part of Onboard.
+#
+# Onboard is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# Onboard 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/>.
+
+"""
+Monitoring keyman keyboard
+"""
+
+from __future__ import division, print_function, unicode_literals
+
+try:
+    import dbus
+except ImportError:
+    pass
+
+from Onboard.utils import Modifiers
+
+from Onboard.Version import require_gi_versions
+require_gi_versions()
+from gi.repository       import GObject
+from lxml import etree
+
+
+class KeymanDBus(GObject.GObject):
+    """
+    Keyman D-bus control and signal handling.
+    """
+    __gsignals__ = {
+        str('keyman-changed'): (GObject.SIGNAL_RUN_FIRST, GObject.TYPE_NONE, ())
+    }
+
+    KEYMAN_SCHEMA_ID = "com.Keyman"
+
+    KM_DBUS_NAME  = "com.Keyman"
+    KM_DBUS_PATH  = "/com/Keyman/IBus"
+    KM_DBUS_IFACE = "com.Keyman"
+    KM_DBUS_PROP_LDML  = "LDMLFile"
+    KM_DBUS_PROP_NAME  = "Name"
+
+    def __init__(self):
+        GObject.GObject.__init__(self)
+        self.key_labels = None
+        self.name = "None"
+        self._name_callbacks = []
+
+        if not "dbus" in globals():
+            raise ImportError("python-dbus unavailable")
+
+        # connect to session bus
+        try:
+            self._bus = dbus.SessionBus()
+        except dbus.exceptions.DBusException:
+            raise RuntimeError("D-Bus session bus unavailable")
+        self._bus.add_signal_receiver(self._on_name_owner_changed,
+                                      "NameOwnerChanged",
+                                      dbus.BUS_DAEMON_IFACE,
+                                      arg0=self.KM_DBUS_NAME)
+        # Initial state
+        proxy = self._bus.get_object(dbus.BUS_DAEMON_NAME, dbus.BUS_DAEMON_PATH)
+        result = proxy.NameHasOwner(self.KM_DBUS_NAME, dbus_interface=dbus.BUS_DAEMON_IFACE)
+        self._set_connection(bool(result))
+
+    def _set_connection(self, active):
+        ''' Update interface object, state and notify listeners '''
+        if active:
+            proxy = self._bus.get_object(self.KM_DBUS_NAME, self.KM_DBUS_PATH)
+            self._iface = dbus.Interface(proxy, dbus.PROPERTIES_IFACE)
+            self._iface.connect_to_signal("PropertiesChanged",
+                                          self._on_name_prop_changed)
+            self._LDMLFile = self._iface.Get(self.KM_DBUS_IFACE, self.KM_DBUS_PROP_LDML)
+            self.name = self._iface.Get(self.KM_DBUS_IFACE, self.KM_DBUS_PROP_NAME)
+
+            if self._LDMLFile and self.name != "None":
+                self.key_labels = KeymanLabels()
+                self.key_labels.parse_labels(self._LDMLFile)
+            else:
+                self.key_labels = None
+        else:
+            self._iface = None
+            self.name = "None"
+            self._LDMLFile = None
+            self.key_labels = None
+
+    def _on_name_owner_changed(self, name, old, new):
+        '''
+        The daemon has de/registered the name.
+        Called when ibus-kmfl un/loads a keyboard
+        '''
+        active = old == ""
+        self._set_connection(active)
+
+    def _on_name_prop_changed(self, iface, changed_props, invalidated_props):
+        ''' The Keyboard name has changed.'''
+        if self.KM_DBUS_PROP_NAME in changed_props:
+            self.name = changed_props.get(self.KM_DBUS_PROP_NAME)
+            self._LDMLFile = self._iface.Get(self.KM_DBUS_IFACE, self.KM_DBUS_PROP_LDML)
+            if self._LDMLFile and self.name != "None":
+                self.key_labels = KeymanLabels()
+                self.key_labels.parse_labels(self._LDMLFile)
+            else:
+                self.key_labels = None
+
+            # notify listeners
+            for callback in self._name_callbacks:
+                callback(self.name)
+
+    def on_keyboard_changed(self, keyboardid):
+        self.emit("keyman-changed", keyboardid)
+
+    ##########
+    # Public
+    ##########
+
+    def state_notify_add(self, callback):
+        """ Convenience function to subscribes to all notifications """
+        self.name_notify_add(callback)
+
+    def name_notify_add(self, callback):
+        self._name_callbacks.append(callback)
+
+    def is_active(self):
+        return bool(self._iface)
+
+
+class KeymanLabels():
+    keymankeys = {}
+    # keymanlabels is a dict of modmask : label (and also has "code" : keycode?)
+    # keymankeys is a dict of keycode : keymanlabels
+
+    def parse_labels(self, ldmlfile):
+        tree = etree.parse(ldmlfile)
+        root = tree.getroot()
+        keymaps = tree.findall('keyMap')
+
+        for keymap in keymaps:
+            if keymap.attrib:
+                # if there is more than one modifier set split it here
+                # because will need to duplicate the label set
+                keyman_modifiers = self.convert_ldml_modifiers_to_onboard(keymap.attrib['modifiers'])
+            else:
+                keyman_modifiers = (0,)
+            maps = keymap.findall('map')
+            for map in maps:
+                for keymanmodifier in keyman_modifiers:
+                    iso = "A" + map.attrib['iso']
+                    if iso == "AA03":
+                        iso = "SPCE"
+                    elif iso == "AE00":
+                        iso = "TLDE"
+                    elif iso == "AB00":
+                        iso = "LSGT"
+                    elif iso == "AC12":
+                        iso = "BKSL"
+                    if not iso in self.keymankeys:
+                        self.keymankeys[iso] = { keymanmodifier : map.attrib['to'] }
+                    else:
+                        self.keymankeys[iso][keymanmodifier] = map.attrib['to']
+
+    def labels_from_id(self, id):
+        if id in self.keymankeys:
+            return self.keymankeys[id]
+        else:
+            print("unknown key id: ", id)
+            return {}
+
+    def convert_ldml_modifiers_to_onboard(self, modifiers):
+        list_modifiers = modifiers.split(" ")
+        keyman_modifiers = ()
+        for modifier in list_modifiers:
+            keymanmod = 0
+            keys = modifier.split("+")
+            for key in keys:
+                if "shift" == key:
+                    keymanmod |= Modifiers.SHIFT
+                if "altR" == key:
+                    keymanmod |= Modifiers.ALTGR
+                if "ctrlR" == key:
+                    keymanmod |= Modifiers.MOD3
+                if "ctrlL" == key:
+                    keymanmod |= Modifiers.CTRL
+                if "ctrl" == key:
+                    keymanmod |= Modifiers.CTRL
+                if "altL" == key:
+                    keymanmod |= Modifiers.ALT
+                if "alt" == key:
+                    keymanmod |= Modifiers.ALT
+            keyman_modifiers = keyman_modifiers + (keymanmod,)
+        return keyman_modifiers
 
=== modified file 'Onboard/LayoutLoaderSVG.py'
--- Onboard/LayoutLoaderSVG.py	2017-04-17 23:53:19 +0000
+++ Onboard/LayoutLoaderSVG.py	2022-01-27 19:28:30 +0000
@@ -38,7 +38,7 @@
 from Onboard.utils           import (modifiers, Rect,
                                      toprettyxml, Version, open_utf8,
                                      permute_mask, LABEL_MODIFIERS,
-                                     unicode_str, XDGDirs)
+                                     KEYMAN_LABEL_MODIFIERS, unicode_str, XDGDirs)
 
 # Layout items that can be created dynamically via the 'class' XML attribute.
 from Onboard.WordSuggestions import WordListPanel  # noqa: flake8
@@ -86,9 +86,11 @@
 
     # precalc mask permutations
     _label_modifier_masks = permute_mask(LABEL_MODIFIERS)
+    _keyman_label_modifier_masks = permute_mask(KEYMAN_LABEL_MODIFIERS)
 
     def __init__(self):
         self._vk = None
+        self._keyman_labels = None
         self._svg_cache = {}
         self._format = None   # format of the currently loading layout
         self._layout_filename = ""
@@ -97,14 +99,14 @@
         self._layout_regex = re.compile("([^\(]+) (?: \( ([^\)]*) \) )?",
                                         re.VERBOSE)
 
-    def load(self, vk, layout_filename, color_scheme):
+    def load(self, vk, keyman_labels, layout_filename, color_scheme):
         """ Load layout root file. """
         self._system_layout, self._system_variant = \
             self._get_system_keyboard_layout(vk)
         _logger.info("current system keyboard layout(variant): '{}'"
                      .format(self._get_system_layout_string()))
 
-        layout = self._load(vk, layout_filename, color_scheme,
+        layout = self._load(vk, keyman_labels, layout_filename, color_scheme,
                             os.path.dirname(layout_filename))
         if layout:
             # purge attributes only used during loading
@@ -122,10 +124,10 @@
 
         return layout
 
-    def _load(self, vk, layout_filename, color_scheme,
-              root_layout_dir, parent_item=None):
+    def _load(self, vk, keyman_labels, layout_filename, color_scheme, root_layout_dir, parent_item = None):
         """ Load or include layout file at any depth level. """
         self._vk = vk
+        self._keyman_labels = keyman_labels
         self._layout_filename = layout_filename
         self._color_scheme = color_scheme
         self._root_layout_dir = root_layout_dir
@@ -254,6 +256,7 @@
             filepath = config.find_layout_filename(filename, "layout include")
             _logger.info("Including layout '{}'".format(filename))
             incl_root = LayoutLoaderSVG()._load(self._vk,
+                                                self._keyman_labels,
                                                 filepath,
                                                 self._color_scheme,
                                                 self._root_layout_dir,
@@ -632,7 +635,13 @@
         # Get labels from keyboard mapping first.
         if key.type == KeyCommon.KEYCODE_TYPE and \
            key.id not in ["BKSP"]:
-            if self._vk:  # xkb keyboard found?
+            if self._keyman_labels: # using Keyman keyboard
+                # load the labels from self._keyman_labels
+                vkmodmasks = self._label_modifier_masks
+                if sys.version_info.major == 2:
+                    vkmodmasks = [long(m) for m in vkmodmasks]
+                labels = self._keyman_labels.labels_from_id(key.id)
+            elif self._vk: # xkb keyboard found?
                 vkmodmasks = self._label_modifier_masks
                 if sys.version_info.major == 2:
                     vkmodmasks = [int(m) for m in vkmodmasks]
@@ -666,7 +675,7 @@
         # override with per-keysym labels
         keysym_rules = self._get_keysym_rules(key)
         if key.type == KeyCommon.KEYCODE_TYPE:
-            if self._vk:  # xkb keyboard found?
+            if not self._keyman_labels and self._vk: # xkb keyboard found but no keyman one?
                 vkmodmasks = self._label_modifier_masks
                 try:
                     if sys.version_info.major == 2:
 
=== modified file 'Onboard/OnboardGtk.py'
--- Onboard/OnboardGtk.py	2017-02-14 21:42:14 +0000
+++ Onboard/OnboardGtk.py	2022-01-27 19:28:30 +0000
@@ -30,6 +30,7 @@
 import time
 import signal
 import os.path
+from lxml import etree
 
 from Onboard.Version import require_gi_versions
 require_gi_versions()
@@ -47,12 +48,13 @@
 from Onboard.KbdWindow       import KbdWindow, KbdPlugWindow
 from Onboard.Keyboard        import Keyboard
 from Onboard.KeyboardWidget  import KeyboardWidget
+from Onboard.Keyman          import KeymanDBus
 from Onboard.Indicator       import Indicator
 from Onboard.LayoutLoaderSVG import LayoutLoaderSVG
 from Onboard.Appearance      import ColorScheme
 from Onboard.IconPalette     import IconPalette
 from Onboard.Exceptions      import LayoutFileError
-from Onboard.utils           import unicode_str
+from Onboard.utils           import unicode_str, Modifiers
 from Onboard.Timer           import CallOnce, Timer
 from Onboard.WindowUtils     import show_confirmation_dialog
 import Onboard.osk as osk
@@ -74,6 +76,8 @@
     """
 
     keyboard = None
+    keymandbus = None
+    _keyman_labels = None
 
     def __init__(self):
 
@@ -99,12 +103,14 @@
             except dbus.exceptions.DBusException:
                 err_msg = "D-Bus session bus unavailable"
                 bus = None
+            self.keymandbus = KeymanDBus()
 
         if not bus:
             _logger.warning(err_msg + "  " +
                             "Onboard will start with reduced functionality. "
                             "Single-instance check, "
-                            "D-Bus service and "
+                            "Keyman support, "
+                            "D-Bus service and  "
                             "hover click are disabled.")
 
         # Yield to GNOME Shell's keyboard before any other D-Bus activity
@@ -282,6 +288,9 @@
         self.do_connect(self.keymap, "state-changed", self.cb_state_changed)
         # group changes
         Gdk.event_handler_set(cb_any_event, self)
+        # Keyman keyboard changes
+        if self.keymandbus:
+            self.keymandbus.name_notify_add(self.cb_keyman_changed)
 
         # connect config notifications here to keep config from holding
         # references to keyboard objects.
@@ -553,6 +562,12 @@
         """ keyboard map change """
         self.reload_layout_delayed()
 
+    def cb_keyman_changed(self, name):
+        """ keyman keyboard change """
+        _logger.debug("keyman changed to {}".format(name))
+        self._keyman_labels = self.keymandbus.key_labels
+        self.reload_layout_delayed()
+
     def cb_state_changed(self, keymap):
         """ keyboard modifier state change """
         mod_mask = keymap.get_modifier_state()
@@ -672,7 +687,7 @@
         self.reload_layout(force_update = True)
         self.keyboard_widget.update_transparency()
 
-    def reload_layout_delayed(self):
+    def reload_layout_delayed(self, force_update=False):
         """
         Delay reloading the layout on keyboard map or group changes
         This is mainly for LP #1313176 when Caps-lock is set up as
@@ -689,14 +704,19 @@
         Checks if the X keyboard layout has changed and
         (re)loads Onboards layout accordingly.
         """
-        keyboard_state = (None, None)
+        keyboard_state = (None, None, None)
 
         vk = self.get_vk()
         if vk:
             try:
                 vk.reload() # reload keyboard names
+                group = vk.get_current_group_name()
+                if self.keymandbus:
+                    self._keyman_labels = self.keymandbus.key_labels
+
                 keyboard_state = (vk.get_layout_as_string(),
-                                  vk.get_current_group_name())
+                                  vk.get_current_group_name(),
+                                  self.keymandbus.name if self.keymandbus else None)
             except osk.error:
                 self.reset_vk()
                 force_update = True
@@ -704,6 +724,13 @@
                                 "keyboard information failed")
 
         if self.keyboard_state != keyboard_state or force_update:
+            if self.keymandbus:
+                _logger.debug("Reloading layout. Layout: {}; Group: {}; Keyman: {}"
+                    .format(vk.get_layout_as_string(), vk.get_current_group_name(), self.keymandbus.name))
+            else:
+                _logger.debug("Reloading layout. Layout: {}; Group: {}"
+                    .format(vk.get_layout_as_string(), vk.get_current_group_name()))
+
             self.keyboard_state = keyboard_state
 
             layout_filename = config.layout_filename
@@ -731,7 +758,7 @@
 
         color_scheme = ColorScheme.load(color_scheme_filename) \
                        if color_scheme_filename else None
-        layout = LayoutLoaderSVG().load(vk, layout_filename, color_scheme)
+        layout = LayoutLoaderSVG().load(vk, self._keyman_labels, layout_filename, color_scheme)
 
         self.keyboard.set_layout(layout, color_scheme, vk)
 
 
=== modified file 'Onboard/utils.py'
--- Onboard/utils.py	2017-02-19 20:06:09 +0000
+++ Onboard/utils.py	2022-01-27 19:28:30 +0000
@@ -58,6 +58,15 @@
                   Modifiers.NUMLK | \
                   Modifiers.ALTGR
 
+# Keyman uses more modifiers inc MOD3(RCTRL)
+KEYMAN_LABEL_MODIFIERS = Modifiers.SHIFT | \
+                         Modifiers.CAPS | \
+                         Modifiers.CTRL | \
+                         Modifiers.ALT | \
+                         Modifiers.NUMLK | \
+                         Modifiers.MOD3 | \
+                         Modifiers.ALTGR
+
 modifiers = {"shift":1,
              "caps":2,
              "control":4,
 
=== modified file 'setup.py'
--- setup.py	2017-05-14 14:36:31 +0000
+++ setup.py	2022-01-27 19:28:30 +0000
@@ -231,7 +231,7 @@
                                "-Wsign-compare",
                                "-Wdeclaration-after-statement",
                                "-Werror=declaration-after-statement",
-                               "-Wlogical-op"],
+                               "-fPIC" ],
 
                            **pkgconfig('gdk-3.0', 'x11', 'xi', 'xtst', 'xkbfile',
                                        'dconf', 'libcanberra', 'hunspell',