summaryrefslogtreecommitdiff
path: root/kvmd/keyboard/keysym.py
blob: 89919e5c437536b4a8ff5415ccf049198de7e7a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# ========================================================================== #
#                                                                            #
#    KVMD - The main Pi-KVM daemon.                                          #
#                                                                            #
#    Copyright (C) 2020  Maxim Devaev <[email protected]>                    #
#                                                                            #
#    This program 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.                                     #
#                                                                            #
#    This program 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 <https://www.gnu.org/licenses/>.  #
#                                                                            #
# ========================================================================== #


import dataclasses
import pkgutil
import functools

from typing import Dict

import Xlib.keysymdef

from ..logging import get_logger

from .mappings import At1Key
from .mappings import X11_TO_AT1
from .mappings import AT1_TO_WEB


# =====
@dataclasses.dataclass(frozen=True)
class SymmapWebKey:
    name: str
    shift: bool
    altgr: bool
    ctrl: bool


def build_symmap(path: str) -> Dict[int, SymmapWebKey]:
    # https://github.com/qemu/qemu/blob/95a9457fd44ad97c518858a4e1586a5498f9773c/ui/keymaps.c
    logger = get_logger()

    symmap: Dict[int, SymmapWebKey] = {}
    for (src, items) in [
        ("<builtin>", list(X11_TO_AT1.items())),
        (path, list(_read_keyboard_layout(path).items())),
    ]:
        for (code, key) in items:
            if (web_name := AT1_TO_WEB.get(key.code)) is not None:
                if (
                    (web_name in ["ShiftLeft", "ShiftRight"] and key.shift)  # pylint: disable=too-many-boolean-expressions
                    or (web_name in ["AltLeft", "AltRight"] and key.altgr)
                    or (web_name in ["ControlLeft", "ControlRight"] and key.ctrl)
                ):
                    logger.error("Invalid modifier key at mapping %s: %s / %s", src, web_name, key)
                    continue
                symmap[code] = SymmapWebKey(
                    name=web_name,
                    shift=key.shift,
                    altgr=key.altgr,
                    ctrl=key.ctrl,
                )
    return symmap


# =====
@functools.lru_cache()
def _get_keysyms() -> Dict[str, int]:
    keysyms: Dict[str, int] = {}
    for (loader, module_name, _) in pkgutil.walk_packages(Xlib.keysymdef.__path__):
        module = loader.find_module(module_name).load_module(module_name)
        for keysym_name in dir(module):
            if keysym_name.startswith("XK_"):
                short_name = keysym_name[3:]
                if short_name.startswith("XF86_"):
                    short_name = "XF86" + short_name[5:]
                # assert short_name not in keysyms, short_name
                keysyms[short_name] = int(getattr(module, keysym_name))
    return keysyms


def _resolve_keysym(name: str) -> int:
    code = _get_keysyms().get(name)
    if code is not None:
        return code
    if len(name) == 5 and name[0] == "U":  # Try unicode Uxxxx
        try:
            return int(name[1:], 16)
        except ValueError:
            pass
    return 0


def _read_keyboard_layout(path: str) -> Dict[int, At1Key]:  # Keysym to evdev (at1)
    logger = get_logger(0)
    logger.info("Reading keyboard layout %s ...", path)

    with open(path) as layout_file:
        lines = list(map(str.strip, layout_file.read().split("\n")))

    layout: Dict[int, At1Key] = {}
    for (lineno, line) in enumerate(lines):
        if len(line) == 0 or line.startswith(("#", "map ", "include ")):
            continue

        parts = line.split()
        if len(parts) >= 2:
            if (code := _resolve_keysym(parts[0])) != 0:
                try:
                    layout[code] = At1Key(
                        code=int(parts[1], 16),
                        shift=("shift" in parts[2:]),
                        altgr=("altgr" in parts[2:]),
                        ctrl=("ctrl" in parts[2:]),
                    )
                except ValueError as err:
                    logger.error("Syntax error at %s:%d: %s", path, lineno, err)
    return layout