rename SystemMapping to KeyboardLayout

bin/input-remapper-control

@@ -90,9 +90,9 @@ class InputRemapperControl:
             print(group.key)
 
     def list_key_names(self):
-        from inputremapper.configs.system_mapping import system_mapping
+        from inputremapper.configs.keyboard_layout import keyboard_layout
 
-        print("\n".join(system_mapping.list_names()))
+        print("\n".join(keyboard_layout.list_names()))
 
     def communicate(
         self,

bin/input-remapper-gtk

@@ -74,7 +74,7 @@ if __name__ == "__main__":
     #  log-level is set.
     # import input-remapper stuff after setting the log verbosity
     from inputremapper.gui.messages.message_broker import MessageBroker, MessageType
-    from inputremapper.configs.system_mapping import system_mapping
+    from inputremapper.configs.keyboard_layout import keyboard_layout
     from inputremapper.gui.data_manager import DataManager
     from inputremapper.gui.user_interface import UserInterface
     from inputremapper.gui.controller import Controller
@@ -105,7 +105,7 @@ if __name__ == "__main__":
         reader_client,
         daemon,
         global_uinputs,
-        system_mapping,
+        keyboard_layout,
     )
     controller = Controller(message_broker, data_manager)
     user_interface = UserInterface(message_broker, controller)

inputremapper/configs/input_config.py

@@ -31,7 +31,7 @@
 except ImportError:
     from pydantic import BaseModel, root_validator, validator
 
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.gui.messages.message_types import MessageType
 from inputremapper.logging.logger import logger
 from inputremapper.utils import get_evdev_constant_name
@@ -142,7 +142,7 @@ def _get_name(self) -> Optional[str]:
         # first try to find the name in xmodmap to not display wrong
         # names due to the keyboard layout
         if self.type == ecodes.EV_KEY:
-            key_name = system_mapping.get_name(self.code)
+            key_name = keyboard_layout.get_name(self.code)
 
         if key_name is None:
             # if no result, look in the linux combination constants. On a german

inputremapper/configs/system_mapping.py → inputremapper/configs/keyboard_layout.py

@@ -41,15 +41,15 @@
 LAZY_LOAD = None
 
 
-class SystemMapping:
+class KeyboardLayout:
     """Stores information about all available keycodes."""
 
     _mapping: Optional[dict] = LAZY_LOAD
     _xmodmap: Optional[List[Tuple[str, str]]] = LAZY_LOAD
     _case_insensitive_mapping: Optional[dict] = LAZY_LOAD
 
     def __getattribute__(self, wanted: str):
-        """To lazy load system_mapping info only when needed.
+        """To lazy load keyboard_layout info only when needed.
 
         For example, this helps to keep logs of input-remapper-control clear when it
         doesn't need it the information.
@@ -160,7 +160,7 @@ def _set(self, name: str, code: int):
 
     def get(self, name: str) -> int:
         """Return the code mapped to the key."""
-        # the correct casing should be shown when asking the system_mapping
+        # the correct casing should be shown when asking the keyboard_layout
         # for stuff. indexing case insensitive to support old presets.
         if name not in self._mapping:
             # only if not e.g. both "a" and "A" are in the mapping
@@ -216,4 +216,4 @@ def _find_legit_mappings(self) -> dict:
 
 # TODO DI
 # this mapping represents the xmodmap output, which stays constant
-system_mapping = SystemMapping()
+keyboard_layout = KeyboardLayout()

inputremapper/configs/mapping.py

@@ -62,7 +62,7 @@
     )
 
 from inputremapper.configs.input_config import InputCombination
-from inputremapper.configs.system_mapping import system_mapping, DISABLE_NAME
+from inputremapper.configs.keyboard_layout import keyboard_layout, DISABLE_NAME
 from inputremapper.configs.validation_errors import (
     OutputSymbolUnknownError,
     SymbolNotAvailableInTargetError,
@@ -288,13 +288,13 @@ def remove_combination_changed_callback(self):
 
     def get_output_type_code(self) -> Optional[Tuple[int, int]]:
         """Returns the output_type and output_code if set,
-        otherwise looks the output_symbol up in the system_mapping
+        otherwise looks the output_symbol up in the keyboard_layout
         return None for unknown symbols and macros
         """
         if self.output_code and self.output_type:
             return self.output_type, self.output_code
         if self.output_symbol and not is_this_a_macro(self.output_symbol):
-            return EV_KEY, system_mapping.get(self.output_symbol)
+            return EV_KEY, keyboard_layout.get(self.output_symbol)
         return None
 
     def get_output_name_constant(self) -> str:
@@ -387,7 +387,7 @@ def validate_symbol(cls, values):
             parse(symbol, mapping=mapping_mock, verbose=False)
             return values
 
-        code = system_mapping.get(symbol)
+        code = keyboard_layout.get(symbol)
         if code is None:
             raise OutputSymbolUnknownError(symbol)
 
@@ -452,7 +452,7 @@ def validate_output_integrity(cls, values):
             if type_ is not None or code is not None:
                 raise MacroButTypeOrCodeSetError()
 
-        if code is not None and code != system_mapping.get(symbol) or type_ != EV_KEY:
+        if code is not None and code != keyboard_layout.get(symbol) or type_ != EV_KEY:
             raise SymbolAndCodeMismatchError(symbol, code)
         return values
 

inputremapper/configs/migrations.py

@@ -51,7 +51,7 @@
 from inputremapper.configs.mapping import Mapping, UIMapping
 from inputremapper.configs.paths import PathUtils
 from inputremapper.configs.preset import Preset
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.injection.global_uinputs import GlobalUInputs
 from inputremapper.injection.macros.parse import is_this_a_macro
 from inputremapper.logging.logger import logger, VERSION
@@ -230,7 +230,7 @@ def _find_target(self, symbol):
             # capabilities = parse(symbol).get_capabilities()
             return None
 
-        capabilities[EV_KEY] = {system_mapping.get(symbol)}
+        capabilities[EV_KEY] = {keyboard_layout.get(symbol)}
 
         if len(capabilities[EV_REL]) > 0:
             return "mouse"

inputremapper/configs/validation_errors.py

@@ -31,7 +31,7 @@
 
 from evdev.ecodes import EV_KEY
 
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.injection.global_uinputs import GlobalUInputs
 
 
@@ -62,7 +62,7 @@ def __init__(self, analog_events):
 
 class SymbolNotAvailableInTargetError(ValueError):
     def __init__(self, symbol, target):
-        code = system_mapping.get(symbol)
+        code = keyboard_layout.get(symbol)
 
         fitting_targets = GlobalUInputs.find_fitting_default_uinputs(EV_KEY, code)
         fitting_targets_string = '", "'.join(fitting_targets)
@@ -92,8 +92,8 @@ class SymbolAndCodeMismatchError(ValueError):
     def __init__(self, symbol, code):
         super().__init__(
             "output_symbol and output_code mismatch: "
-            f"output macro is {symbol} -> {system_mapping.get(symbol)} "
-            f"but output_code is {code} -> {system_mapping.get_name(code)} "
+            f"output macro is {symbol} -> {keyboard_layout.get(symbol)} "
+            f"but output_code is {code} -> {keyboard_layout.get_name(code)} "
         )
 
 

inputremapper/daemon.py

@@ -44,7 +44,7 @@
 from inputremapper.injection.injector import Injector, InjectorState
 from inputremapper.configs.preset import Preset
 from inputremapper.configs.global_config import GlobalConfig
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.groups import groups
 from inputremapper.configs.paths import PathUtils
 from inputremapper.user import UserUtils
@@ -487,13 +487,13 @@ def start_injecting(self, group_key: str, preset_name: str) -> bool:
                 xmodmap = json.load(file)
                 logger.debug('Using keycodes from "%s"', xmodmap_path)
 
-                # this creates the system_mapping._xmodmap, which we need to do now
+                # this creates the keyboard_layout._xmodmap, which we need to do now
                 # otherwise it might be created later which will override the changes
                 # we do here.
-                # Do we really need to lazyload in the system_mapping?
+                # Do we really need to lazyload in the keyboard_layout?
                 # this kind of bug is stupid to track down
-                system_mapping.get_name(0)
-                system_mapping.update(xmodmap)
+                keyboard_layout.get_name(0)
+                keyboard_layout.update(xmodmap)
                 # the service now has process wide knowledge of xmodmap
                 # keys of the users session
         except FileNotFoundError:

inputremapper/gui/autocompletion.py

@@ -28,7 +28,7 @@
 from gi.repository import Gdk, Gtk, GLib, GObject
 
 from inputremapper.configs.mapping import MappingData
-from inputremapper.configs.system_mapping import system_mapping, DISABLE_NAME
+from inputremapper.configs.keyboard_layout import keyboard_layout, DISABLE_NAME
 from inputremapper.gui.components.editor import CodeEditor
 from inputremapper.gui.controller import Controller
 from inputremapper.gui.messages.message_broker import MessageBroker, MessageType
@@ -111,7 +111,7 @@ def propose_symbols(text_iter: Gtk.TextIter, codes: List[int]) -> List[Tuple[str
 
     incomplete_name = incomplete_name.lower()
 
-    names = list(system_mapping.list_names(codes=codes)) + [DISABLE_NAME]
+    names = list(keyboard_layout.list_names(codes=codes)) + [DISABLE_NAME]
 
     return [
         (name, name)

inputremapper/gui/components/editor.py

@@ -57,7 +57,7 @@
 from inputremapper.gui.utils import HandlerDisabled, Colors
 from inputremapper.injection.mapping_handlers.axis_transform import Transformation
 from inputremapper.input_event import InputEvent
-from inputremapper.configs.system_mapping import system_mapping, XKB_KEYCODE_OFFSET
+from inputremapper.configs.keyboard_layout import keyboard_layout, XKB_KEYCODE_OFFSET
 from inputremapper.utils import get_evdev_constant_name
 
 Capabilities = Dict[int, List]
@@ -384,9 +384,9 @@ def _display(self, event):
 
         if is_press and len(self._combination) > 0:
             names = [
-                system_mapping.get_name(code)
+                keyboard_layout.get_name(code)
                 for code in self._combination
-                if code is not None and system_mapping.get_name(code) is not None
+                if code is not None and keyboard_layout.get_name(code) is not None
             ]
             self._gui.set_text(" + ".join(names))
 

inputremapper/gui/data_manager.py

@@ -30,7 +30,7 @@
 from inputremapper.configs.mapping import UIMapping, MappingData
 from inputremapper.configs.paths import PathUtils
 from inputremapper.configs.preset import Preset
-from inputremapper.configs.system_mapping import SystemMapping
+from inputremapper.configs.keyboard_layout import KeyboardLayout
 from inputremapper.daemon import DaemonProxy
 from inputremapper.exceptions import DataManagementError
 from inputremapper.groups import _Group
@@ -73,13 +73,13 @@ def __init__(
         reader_client: ReaderClient,
         daemon: DaemonProxy,
         uinputs: GlobalUInputs,
-        system_mapping: SystemMapping,
+        keyboard_layout: KeyboardLayout,
     ):
         self.message_broker = message_broker
         self._reader_client = reader_client
         self._daemon = daemon
         self._uinputs = uinputs
-        self._system_mapping = system_mapping
+        self._keyboard_layout = keyboard_layout
         uinputs.prepare_all()
 
         self._config = config
@@ -454,7 +454,7 @@ def update_mapping(self, **kwargs):
             raise DataManagementError("Cannot modify Mapping: Mapping is not set")
 
         if symbol := kwargs.get("output_symbol"):
-            kwargs["output_symbol"] = self._system_mapping.correct_case(symbol)
+            kwargs["output_symbol"] = self._keyboard_layout.correct_case(symbol)
 
         combination = self.active_mapping.input_combination
         for key, value in kwargs.items():

inputremapper/gui/utils.py

@@ -145,9 +145,6 @@ def run_all_now(self):
                 logger.error(exception)
 
 
-debounce_manager = DebounceManager()
-
-
 def debounce(timeout):
     """Debounce a method call to improve performance.
 
@@ -176,6 +173,8 @@ def wrapped(self, *args, **kwargs):
 
     return decorator
 
+debounce_manager = DebounceManager()
+
 
 class HandlerDisabled:
     """Safely modify a widget without causing handlers to be called.

inputremapper/injection/macros/macro.py

@@ -54,7 +54,7 @@
     REL_HWHEEL,
 )
 
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.configs.validation_errors import (
     SymbolNotAvailableInTargetError,
     MacroParsingError,
@@ -728,7 +728,7 @@ def _type_check_symbol(self, keyname: Union[str, Variable]) -> Union[Variable, i
             return keyname
 
         symbol = str(keyname)
-        code = system_mapping.get(symbol)
+        code = keyboard_layout.get(symbol)
 
         if code is None:
             raise MacroParsingError(msg=f'Unknown key "{symbol}"')

inputremapper/injection/mapping_handlers/mapping_parser.py

@@ -27,7 +27,7 @@
 from inputremapper.configs.input_config import InputCombination, InputConfig
 from inputremapper.configs.mapping import Mapping
 from inputremapper.configs.preset import Preset
-from inputremapper.configs.system_mapping import DISABLE_CODE, DISABLE_NAME
+from inputremapper.configs.keyboard_layout import DISABLE_CODE, DISABLE_NAME
 from inputremapper.exceptions import MappingParsingError
 from inputremapper.injection.global_uinputs import GlobalUInputs
 from inputremapper.injection.macros.parse import is_this_a_macro

tests/integration/test_components.py

@@ -37,7 +37,7 @@
 from tests.lib.logger import logger
 
 from inputremapper.gui.controller import Controller
-from inputremapper.configs.system_mapping import XKB_KEYCODE_OFFSET
+from inputremapper.configs.keyboard_layout import XKB_KEYCODE_OFFSET
 from inputremapper.gui.utils import CTX_ERROR, CTX_WARNING, gtk_iteration
 from inputremapper.gui.messages.message_broker import (
     MessageBroker,

tests/integration/test_gui.py

@@ -65,7 +65,7 @@
 gi.require_version("GLib", "2.0")
 from gi.repository import Gtk, GLib, Gdk, GtkSource
 
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.configs.mapping import Mapping
 from inputremapper.configs.paths import PathUtils
 from inputremapper.configs.global_config import GlobalConfig
@@ -2156,9 +2156,9 @@ def test_autocomplete_key(self):
 
         complete_key_name = "Test_Foo_Bar"
 
-        system_mapping.clear()
-        system_mapping._set(complete_key_name, 1)
-        system_mapping._set("KEY_A", 30)  # we need this for the UIMapping to work
+        keyboard_layout.clear()
+        keyboard_layout._set(complete_key_name, 1)
+        keyboard_layout._set("KEY_A", 30)  # we need this for the UIMapping to work
 
         # it can autocomplete a combination inbetween other things
         incomplete = "qux_1\n +  + qux_2"

tests/lib/cleanup.py

@@ -82,7 +82,7 @@ def quick_cleanup(log=True):
     # Reminder: before patches are applied in test.py, no inputremapper module
     # may be imported. So tests.lib imports them just-in-time in functions instead.
     from inputremapper.injection.macros.macro import macro_variables
-    from inputremapper.configs.system_mapping import system_mapping
+    from inputremapper.configs.keyboard_layout import keyboard_layout
     from inputremapper.gui.utils import debounce_manager
     from inputremapper.injection.global_uinputs import GlobalUInputs
 
@@ -128,7 +128,7 @@ def quick_cleanup(log=True):
     if os.path.exists(tmp):
         shutil.rmtree(tmp)
 
-    system_mapping.populate()
+    keyboard_layout.populate()
 
     clear_write_history()
 

tests/unit/test_controller.py

@@ -26,7 +26,7 @@
 import gi
 from evdev.ecodes import EV_ABS, ABS_X, ABS_Y, ABS_RX
 
-from inputremapper.configs.system_mapping import system_mapping
+from inputremapper.configs.keyboard_layout import keyboard_layout
 from inputremapper.injection.injector import InjectorState
 
 gi.require_version("Gtk", "3.0")
@@ -76,7 +76,7 @@ def setUp(self) -> None:
             ReaderClient(self.message_broker, _Groups()),
             FakeDaemonProxy(),
             uinputs,
-            system_mapping,
+            keyboard_layout,
         )
         self.user_interface = MagicMock()
         self.controller = Controller(self.message_broker, self.data_manager)