input-remapper/keymapper/presets.py

#!/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/>.


"""Helperfunctions to find device ids, names, and to load configs."""


import os
import subprocess

from keymapper.logger import logger
from keymapper.config import get_config, get_config_path


def get_xinput_list(type):
    """Run xinput and get the result as list.

    Parameters
    ----------
    type : string
        Ine of 'id' or 'name'
    """
    output = subprocess.check_output(['xinput', 'list', f'--{type}-only'])
    return [line for line in output.decode().split('\n') if line != '']


def find_devices():
    """Get a list of (id, name) for each input device."""
    # `xinput list`
    ids = get_xinput_list('id')
    names = get_xinput_list('name')

    # names contains duplicates and "Virtual"-somethings, filter those
    known_names = []
    result = []
    for (id, name) in zip(ids, names):
        if name not in known_names and not name.startswith('Virtual'):
            known_names.append(name)
            result.append((id, name))
    return result


def get_presets(device):
    """Get all configured presets for the device.

    Parameters
    ----------
    device : string
    """
    return os.listdir(get_config_path(device))


def create_preset(device, name=None):
    """Create an empty preset."""
    existing_names = get_presets(device)
    if name is None:
        name = 'new preset'

    # find a name that is not already taken
    i = 1
    while name in existing_names:
        i += 1
        name = f'new preset {i}'

    # trigger the creation of a new config file:
    get_config(device, name)
    return name


def get_mappings(device, preset):
    """Get all configured buttons of the preset.

    Parameters
    ----------
    device : string
    preset : string
    """
    pass


def find_newest_preset():
    """Get the device and present that was most recently modified."""
    print('find_newest_preset not yet implemented')
    return None, None