|
|
|
#!/usr/bin/python3
|
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# key-mapper - GUI for device specific keyboard mappings
|
|
|
|
# Copyright (C) 2020 sezanzeb <proxima@hip70890b.de>
|
|
|
|
#
|
|
|
|
# This file is part of key-mapper.
|
|
|
|
#
|
|
|
|
# key-mapper 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.
|
|
|
|
#
|
|
|
|
# key-mapper 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 key-mapper. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
|
|
|
|
"""Contains and manages mappings."""
|
|
|
|
|
|
|
|
|
|
|
|
import os
|
|
|
|
import json
|
|
|
|
import shutil
|
|
|
|
|
|
|
|
from keymapper.logger import logger
|
|
|
|
from keymapper.paths import get_config_path
|
|
|
|
|
|
|
|
|
|
|
|
class Mapping:
|
|
|
|
"""Contains and manages mappings.
|
|
|
|
|
|
|
|
The keycode is always unique, multiple keycodes may map to the same
|
|
|
|
character.
|
|
|
|
"""
|
|
|
|
def __init__(self):
|
|
|
|
self._mapping = {}
|
|
|
|
self.changed = False
|
|
|
|
|
|
|
|
def __iter__(self):
|
|
|
|
"""Iterate over tuples of unique keycodes and their character."""
|
|
|
|
return iter(sorted(self._mapping.items()))
|
|
|
|
|
|
|
|
def __len__(self):
|
|
|
|
return len(self._mapping)
|
|
|
|
|
|
|
|
def change(self, previous_keycode, new_keycode, character):
|
|
|
|
"""Replace the mapping of a keycode with a different one.
|
|
|
|
|
|
|
|
Return True on success.
|
|
|
|
|
|
|
|
Parameters
|
|
|
|
----------
|
|
|
|
previous_keycode : int or None
|
|
|
|
If None, will not remove any previous mapping. If you recently
|
|
|
|
used 10 for new_keycode and want to overwrite that with 11,
|
|
|
|
provide 5 here.
|
|
|
|
new_keycode : int
|
|
|
|
The source keycode, what the mouse would report without any
|
|
|
|
modification.
|
|
|
|
character : string or string[]
|
|
|
|
A single character known to xkb, Examples: KP_1, Shift_L, a, B.
|
|
|
|
Can also be an array, which is used for reading the xkbmap output
|
|
|
|
completely.
|
|
|
|
"""
|
|
|
|
try:
|
|
|
|
new_keycode = int(new_keycode)
|
|
|
|
if previous_keycode is not None:
|
|
|
|
previous_keycode = int(previous_keycode)
|
|
|
|
except ValueError:
|
|
|
|
logger.error('Can only use numbers as keycodes')
|
|
|
|
return False
|
|
|
|
|
|
|
|
if new_keycode and character:
|
|
|
|
if isinstance(character, list):
|
|
|
|
character = [c.lower() for c in character]
|
|
|
|
else:
|
|
|
|
character = character.lower()
|
|
|
|
self._mapping[new_keycode] = character
|
|
|
|
if new_keycode != previous_keycode:
|
|
|
|
# clear previous mapping of that code, because the line
|
|
|
|
# representing that one will now represent a different one.
|
|
|
|
self.clear(previous_keycode)
|
|
|
|
self.changed = True
|
|
|
|
return True
|
|
|
|
|
|
|
|
return False
|
|
|
|
|
|
|
|
def clear(self, keycode):
|
|
|
|
"""Remove a keycode from the mapping.
|
|
|
|
|
|
|
|
Parameters
|
|
|
|
----------
|
|
|
|
keycode : int
|
|
|
|
"""
|
|
|
|
if self._mapping.get(keycode) is not None:
|
|
|
|
del self._mapping[keycode]
|
|
|
|
self.changed = True
|
|
|
|
|
|
|
|
def empty(self):
|
|
|
|
"""Remove all mappings."""
|
|
|
|
self._mapping = {}
|
|
|
|
self.changed = True
|
|
|
|
|
|
|
|
def load(self, device, preset):
|
|
|
|
"""Load a dumped JSON from home to overwrite the mappings."""
|
|
|
|
# TODO test
|
|
|
|
path = get_config_path(device, preset)
|
|
|
|
logger.info('Loading preset from %s', path)
|
|
|
|
|
|
|
|
if not os.path.exists(path):
|
|
|
|
logger.error('Tried to load non-existing preset %s', path)
|
|
|
|
return
|
|
|
|
|
|
|
|
with open(path, 'r') as f:
|
|
|
|
mapping = json.load(f)
|
|
|
|
for keycode, character in mapping.items():
|
|
|
|
try:
|
|
|
|
keycode = int(keycode)
|
|
|
|
except ValueError:
|
|
|
|
logger.error('Found non-int keycode: %s', keycode)
|
|
|
|
continue
|
|
|
|
self._mapping[keycode] = character
|
|
|
|
|
|
|
|
self.changed = False
|
|
|
|
|
|
|
|
def save(self, device, preset):
|
|
|
|
"""Dump as JSON into home."""
|
|
|
|
# TODO test
|
|
|
|
path = get_config_path(device, preset)
|
|
|
|
logger.info('Saving preset to %s', path)
|
|
|
|
|
|
|
|
if not os.path.exists(path):
|
|
|
|
logger.debug('Creating "%s"', path)
|
|
|
|
os.makedirs(os.path.dirname(path), exist_ok=True)
|
|
|
|
os.mknod(path)
|
|
|
|
# if this is done with sudo rights, give the file to the user
|
|
|
|
shutil.chown(path, os.getlogin())
|
|
|
|
|
|
|
|
with open(path, 'w') as f:
|
|
|
|
json.dump(self._mapping, f)
|
|
|
|
|
|
|
|
self.changed = False
|
|
|
|
|
|
|
|
def get_keycode(self, character):
|
|
|
|
"""Get the keycode for that character."""
|
|
|
|
character = character.lower()
|
|
|
|
for keycode, mapping in self._mapping.items():
|
|
|
|
# note, that stored mappings are already lowercase
|
|
|
|
if isinstance(mapping, list):
|
|
|
|
if character in [c for c in mapping]:
|
|
|
|
return keycode
|
|
|
|
elif mapping == character:
|
|
|
|
return int(keycode)
|
|
|
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
def get_character(self, keycode):
|
|
|
|
"""Read the character that is mapped to this keycode.
|
|
|
|
|
|
|
|
Parameters
|
|
|
|
----------
|
|
|
|
keycode : int
|
|
|
|
"""
|
|
|
|
return self._mapping.get(keycode)
|
|
|
|
|
|
|
|
|
|
|
|
# one mapping object for the whole application that holds all
|
|
|
|
# customizations
|
|
|
|
custom_mapping = Mapping()
|
|
|
|
|
|
|
|
# one mapping that represents the xmodmap output
|
|
|
|
system_mapping = Mapping()
|