qmk_firmware/lib/python/qmk/keymap.py

"""Functions that help you work with QMK keymaps.
"""
import sys
from pathlib import Path
from subprocess import DEVNULL

import argcomplete
from milc import cli
from pygments.lexers.c_cpp import CLexer
from pygments.token import Token
from pygments import lex

import qmk.path
from qmk.constants import QMK_FIRMWARE, QMK_USERSPACE, HAS_QMK_USERSPACE
from qmk.keyboard import find_keyboard_from_dir, keyboard_folder, keyboard_aliases
from qmk.errors import CppError
from qmk.info import info_json

# The `keymap.c` template to use when a keyboard doesn't have its own
DEFAULT_KEYMAP_C = """#include QMK_KEYBOARD_H
#if __has_include("keymap.h")
#    include "keymap.h"
#endif
__INCLUDES__

/* THIS FILE WAS GENERATED!
 *
 * This file was generated by qmk json2c. You may or may not want to
 * edit it directly.
 */

__KEYMAP_GOES_HERE__
__ENCODER_MAP_GOES_HERE__
__DIP_SWITCH_MAP_GOES_HERE__
__MACRO_OUTPUT_GOES_HERE__

#ifdef OTHER_KEYMAP_C
#    include OTHER_KEYMAP_C
#endif // OTHER_KEYMAP_C
"""


def _generate_keymap_table(keymap_json):
    lines = ['const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {']
    for layer_num, layer in enumerate(keymap_json['layers']):
        if layer_num != 0:
            lines[-1] = lines[-1] + ','
        layer = map(_strip_any, layer)
        layer_keys = ', '.join(layer)
        lines.append('    [%s] = %s(%s)' % (layer_num, keymap_json['layout'], layer_keys))
    lines.append('};')
    return lines


def _generate_encodermap_table(keymap_json):
    lines = [
        '#if defined(ENCODER_ENABLE) && defined(ENCODER_MAP_ENABLE)',
        'const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {',
    ]
    for layer_num, layer in enumerate(keymap_json['encoders']):
        if layer_num != 0:
            lines[-1] = lines[-1] + ','
        encoder_keycode_txt = ', '.join([f'ENCODER_CCW_CW({_strip_any(e["ccw"])}, {_strip_any(e["cw"])})' for e in layer])
        lines.append('    [%s] = {%s}' % (layer_num, encoder_keycode_txt))
    lines.extend(['};', '#endif // defined(ENCODER_ENABLE) && defined(ENCODER_MAP_ENABLE)'])
    return lines


def _generate_dipswitchmap_table(keymap_json):
    lines = [
        '#if defined(DIP_SWITCH_ENABLE) && defined(DIP_SWITCH_MAP_ENABLE)',
        'const uint16_t PROGMEM dip_switch_map[NUM_DIP_SWITCHES][NUM_DIP_STATES] = {',
    ]
    for index, switch in enumerate(keymap_json['dip_switches']):
        if index != 0:
            lines[-1] = lines[-1] + ','
        lines.append(f'    DIP_SWITCH_OFF_ON({_strip_any(switch["off"])}, {_strip_any(switch["on"])})')
    lines.extend(['};', '#endif // defined(DIP_SWITCH_ENABLE) && defined(DIP_SWITCH_MAP_ENABLE)'])
    return lines


def _generate_macros_function(keymap_json):
    macro_txt = [
        'bool process_record_user(uint16_t keycode, keyrecord_t *record) {',
        '    if (record->event.pressed) {',
        '        switch (keycode) {',
    ]

    for i, macro_array in enumerate(keymap_json['macros']):
        macro = []

        for macro_fragment in macro_array:
            if isinstance(macro_fragment, str):
                macro_fragment = macro_fragment.replace('\\', '\\\\')
                macro_fragment = macro_fragment.replace('\r\n', r'\n')
                macro_fragment = macro_fragment.replace('\n', r'\n')
                macro_fragment = macro_fragment.replace('\r', r'\n')
                macro_fragment = macro_fragment.replace('\t', r'\t')
                macro_fragment = macro_fragment.replace('"', r'\"')

                macro.append(f'"{macro_fragment}"')

            elif isinstance(macro_fragment, dict):
                newstring = []

                if macro_fragment['action'] == 'delay':
                    newstring.append(f"SS_DELAY({macro_fragment['duration']})")

                elif macro_fragment['action'] == 'beep':
                    newstring.append(r'"\a"')

                elif macro_fragment['action'] == 'tap' and len(macro_fragment['keycodes']) > 1:
                    last_keycode = macro_fragment['keycodes'].pop()

                    for keycode in macro_fragment['keycodes']:
                        newstring.append(f'SS_DOWN(X_{keycode})')

                    newstring.append(f'SS_TAP(X_{last_keycode})')

                    for keycode in reversed(macro_fragment['keycodes']):
                        newstring.append(f'SS_UP(X_{keycode})')

                else:
                    for keycode in macro_fragment['keycodes']:
                        newstring.append(f"SS_{macro_fragment['action'].upper()}(X_{keycode})")

                macro.append(''.join(newstring))

        new_macro = "".join(macro)
        new_macro = new_macro.replace('""', '')
        macro_txt.append(f'            case QK_MACRO_{i}:')
        macro_txt.append(f'                SEND_STRING({new_macro});')
        macro_txt.append('                return false;')

    macro_txt.append('        }')
    macro_txt.append('    }')
    macro_txt.append('\n    return true;')
    macro_txt.append('};')
    macro_txt.append('')
    return macro_txt


def _strip_any(keycode):
    """Remove ANY() from a keycode.
    """
    if keycode.startswith('ANY(') and keycode.endswith(')'):
        keycode = keycode[4:-1]

    return keycode


def find_keymap_from_dir(*args):
    """Returns `(keymap_name, source)` for the directory provided (or cwd if not specified).
    """
    def _impl_find_keymap_from_dir(relative_path):
        if relative_path and len(relative_path.parts) > 1:
            # If we're in `qmk_firmware/keyboards` and `keymaps` is in our path, try to find the keyboard name.
            if relative_path.parts[0] == 'keyboards' and 'keymaps' in relative_path.parts:
                current_path = Path('/'.join(relative_path.parts[1:]))  # Strip 'keyboards' from the front

                if 'keymaps' in current_path.parts and current_path.name != 'keymaps':
                    while current_path.parent.name != 'keymaps':
                        current_path = current_path.parent

                    return current_path.name, 'keymap_directory'

            # If we're in `qmk_firmware/layouts` guess the name from the community keymap they're in
            elif relative_path.parts[0] == 'layouts' and is_keymap_dir(relative_path):
                return relative_path.name, 'layouts_directory'

            # If we're in `qmk_firmware/users` guess the name from the userspace they're in
            elif relative_path.parts[0] == 'users':
                # Guess the keymap name based on which userspace they're in
                return relative_path.parts[1], 'users_directory'
        return None, None

    if HAS_QMK_USERSPACE:
        name, source = _impl_find_keymap_from_dir(qmk.path.under_qmk_userspace(*args))
        if name and source:
            return name, source

    name, source = _impl_find_keymap_from_dir(qmk.path.under_qmk_firmware(*args))
    if name and source:
        return name, source

    return (None, None)


def keymap_completer(prefix, action, parser, parsed_args):
    """Returns a list of keymaps for tab completion.
    """
    try:
        if parsed_args.keyboard:
            return list_keymaps(parsed_args.keyboard)

        keyboard = find_keyboard_from_dir()

        if keyboard:
            return list_keymaps(keyboard)

    except Exception as e:
        argcomplete.warn(f'Error: {e.__class__.__name__}: {str(e)}')
        return []

    return []


def is_keymap_dir(keymap, c=True, json=True, additional_files=None):
    """Return True if Path object `keymap` has a keymap file inside.

    Args:
        keymap
            A Path() object for the keymap directory you want to check.

        c
            When true include `keymap.c` keymaps.

        json
            When true include `keymap.json` keymaps.

        additional_files
            A sequence of additional filenames to check against to determine if a directory is a keymap. All files must exist for a match to happen. For example, if you want to match a C keymap with both a `config.h` and `rules.mk` file: `is_keymap_dir(keymap_dir, json=False, additional_files=['config.h', 'rules.mk'])`
    """
    files = []

    if c:
        files.append('keymap.c')

    if json:
        files.append('keymap.json')

    for file in files:
        if (keymap / file).is_file():
            if additional_files:
                for additional_file in additional_files:
                    if not (keymap / additional_file).is_file():
                        return False

            return True


def generate_json(keymap, keyboard, layout, layers, macros=None):
    """Returns a `keymap.json` for the specified keyboard, layout, and layers.

    Args:
        keymap
            A name for this keymap.

        keyboard
            The name of the keyboard.

        layout
            The LAYOUT macro this keymap uses.

        layers
            An array of arrays describing the keymap. Each item in the inner array should be a string that is a valid QMK keycode.

        macros
            A sequence of strings containing macros to implement for this keyboard.
    """
    new_keymap = {'keyboard': keyboard}
    new_keymap['keymap'] = keymap
    new_keymap['layout'] = layout
    new_keymap['layers'] = layers
    if macros:
        new_keymap['macros'] = macros

    return new_keymap


def generate_c(keymap_json):
    """Returns a `keymap.c`.

    `keymap_json` is a dictionary with the following keys:

        keyboard
            The name of the keyboard

        layout
            The LAYOUT macro this keymap uses.

        layers
            An array of arrays describing the keymap. Each item in the inner array should be a string that is a valid QMK keycode.

        macros
            A sequence of strings containing macros to implement for this keyboard.
    """
    new_keymap = DEFAULT_KEYMAP_C

    keymap = ''
    if 'layers' in keymap_json and keymap_json['layers'] is not None:
        layer_txt = _generate_keymap_table(keymap_json)
        keymap = '\n'.join(layer_txt)
    new_keymap = new_keymap.replace('__KEYMAP_GOES_HERE__', keymap)

    encodermap = ''
    if 'encoders' in keymap_json and keymap_json['encoders'] is not None:
        encoder_txt = _generate_encodermap_table(keymap_json)
        encodermap = '\n'.join(encoder_txt)
    new_keymap = new_keymap.replace('__ENCODER_MAP_GOES_HERE__', encodermap)

    dipswitchmap = ''
    if 'dip_switches' in keymap_json and keymap_json['dip_switches'] is not None:
        dip_txt = _generate_dipswitchmap_table(keymap_json)
        dipswitchmap = '\n'.join(dip_txt)
    new_keymap = new_keymap.replace('__DIP_SWITCH_MAP_GOES_HERE__', dipswitchmap)

    macros = ''
    if 'macros' in keymap_json and keymap_json['macros'] is not None:
        macro_txt = _generate_macros_function(keymap_json)
        macros = '\n'.join(macro_txt)
    new_keymap = new_keymap.replace('__MACRO_OUTPUT_GOES_HERE__', macros)

    hostlang = ''
    if 'host_language' in keymap_json and keymap_json['host_language'] is not None:
        hostlang = f'#include "keymap_{keymap_json["host_language"]}.h"\n#include "sendstring_{keymap_json["host_language"]}.h"\n'
    new_keymap = new_keymap.replace('__INCLUDES__', hostlang)

    return new_keymap


def locate_keymap(keyboard, keymap, force_layout=None):
    """Returns the path to a keymap for a specific keyboard.
    """
    if not qmk.path.is_keyboard(keyboard):
        raise KeyError('Invalid keyboard: ' + repr(keyboard))

    # Check the keyboard folder first, last match wins
    keymap_path = ''

    search_conf = {QMK_FIRMWARE: [keyboard_folder(keyboard)]}
    if HAS_QMK_USERSPACE:
        # When we've got userspace, check there _last_ as we want them to override anything in the main repo.
        # We also want to search for any aliases as QMK's folder structure may have changed, with an alias, but the user
        # hasn't updated their keymap location yet.
        search_conf[QMK_USERSPACE] = list(set([keyboard_folder(keyboard), *keyboard_aliases(keyboard)]))

    for search_dir, keyboard_dirs in search_conf.items():
        for keyboard_dir in keyboard_dirs:
            checked_dirs = ''
            for folder_name in keyboard_dir.split('/'):
                if checked_dirs:
                    checked_dirs = '/'.join((checked_dirs, folder_name))
                else:
                    checked_dirs = folder_name

                keymap_dir = Path(search_dir) / Path('keyboards') / checked_dirs / 'keymaps'

                if (keymap_dir / keymap / 'keymap.c').exists():
                    keymap_path = keymap_dir / keymap / 'keymap.c'
                if (keymap_dir / keymap / 'keymap.json').exists():
                    keymap_path = keymap_dir / keymap / 'keymap.json'

        if keymap_path:
            return keymap_path

    # Check community layouts as a fallback
    info = info_json(keyboard, force_layout=force_layout)

    community_parents = list(Path('layouts').glob('*/'))
    if HAS_QMK_USERSPACE and (Path(QMK_USERSPACE) / "layouts").exists():
        community_parents.append(Path(QMK_USERSPACE) / "layouts")

    for community_parent in community_parents:
        for layout in info.get("community_layouts", []):
            community_layout = community_parent / layout / keymap
            if community_layout.exists():
                if (community_layout / 'keymap.json').exists():
                    return community_layout / 'keymap.json'
                if (community_layout / 'keymap.c').exists():
                    return community_layout / 'keymap.c'


def is_keymap_target(keyboard, keymap):
    if keymap == 'all':
        return True

    if locate_keymap(keyboard, keymap):
        return True

    return False


def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=False, include_userspace=True):
    """List the available keymaps for a keyboard.

    Args:
        keyboard
            The keyboards full name with vendor and revision if necessary, example: clueboard/66/rev3

        c
            When true include `keymap.c` keymaps.

        json
            When true include `keymap.json` keymaps.

        additional_files
            A sequence of additional filenames to check against to determine if a directory is a keymap. All files must exist for a match to happen. For example, if you want to match a C keymap with both a `config.h` and `rules.mk` file: `is_keymap_dir(keymap_dir, json=False, additional_files=['config.h', 'rules.mk'])`

        fullpath
            When set to True the full path of the keymap relative to the `qmk_firmware` root will be provided.

        include_userspace
            When set to True, also search userspace for available keymaps

    Returns:
        a sorted list of valid keymap names.
    """
    names = set()

    has_userspace = HAS_QMK_USERSPACE and include_userspace

    # walk up the directory tree until keyboards_dir
    # and collect all directories' name with keymap.c file in it
    for search_dir in [QMK_FIRMWARE, QMK_USERSPACE] if has_userspace else [QMK_FIRMWARE]:
        keyboards_dir = search_dir / Path('keyboards')
        kb_path = keyboards_dir / keyboard

        while kb_path != keyboards_dir:
            keymaps_dir = kb_path / "keymaps"
            if keymaps_dir.is_dir():
                for keymap in keymaps_dir.iterdir():
                    if is_keymap_dir(keymap, c, json, additional_files):
                        keymap = keymap if fullpath else keymap.name
                        names.add(keymap)

            kb_path = kb_path.parent

    # Check community layouts as a fallback
    info = info_json(keyboard)

    community_parents = list(Path('layouts').glob('*/'))
    if has_userspace and (Path(QMK_USERSPACE) / "layouts").exists():
        community_parents.append(Path(QMK_USERSPACE) / "layouts")

    for community_parent in community_parents:
        for layout in info.get("community_layouts", []):
            cl_path = community_parent / layout
            if cl_path.is_dir():
                for keymap in cl_path.iterdir():
                    if is_keymap_dir(keymap, c, json, additional_files):
                        keymap = keymap if fullpath else keymap.name
                        names.add(keymap)

    return sorted(names)


def _c_preprocess(path, stdin=DEVNULL):
    """ Run a file through the C pre-processor

    Args:
        path: path of the keymap.c file (set None to use stdin)
        stdin: stdin pipe (e.g. sys.stdin)

    Returns:
        the stdout of the pre-processor
    """
    cmd = ['cpp', str(path)] if path else ['cpp']
    pre_processed_keymap = cli.run(cmd, stdin=stdin)
    if 'fatal error' in pre_processed_keymap.stderr:
        for line in pre_processed_keymap.stderr.split('\n'):
            if 'fatal error' in line:
                raise (CppError(line))
    return pre_processed_keymap.stdout


def _get_layers(keymap):  # noqa C901 : until someone has a good idea how to simplify/split up this code
    """ Find the layers in a keymap.c file.

    Args:
        keymap: the content of the keymap.c file

    Returns:
        a dictionary containing the parsed keymap
    """
    layers = list()
    opening_braces = '({['
    closing_braces = ')}]'
    keymap_certainty = brace_depth = 0
    is_keymap = is_layer = is_adv_kc = False
    layer = dict(name=False, layout=False, keycodes=list())
    for line in lex(keymap, CLexer()):
        if line[0] is Token.Name:
            if is_keymap:
                # If we are inside the keymap array
                # we know the keymap's name and the layout macro will come,
                # followed by the keycodes
                if not layer['name']:
                    if line[1].startswith('LAYOUT') or line[1].startswith('KEYMAP'):
                        # This can happen if the keymap array only has one layer,
                        # for macropads and such
                        layer['name'] = '0'
                        layer['layout'] = line[1]
                    else:
                        layer['name'] = line[1]
                elif not layer['layout']:
                    layer['layout'] = line[1]
                elif is_layer:
                    # If we are inside a layout macro,
                    # collect all keycodes
                    if line[1] == '_______':
                        kc = 'KC_TRNS'
                    elif line[1] == 'XXXXXXX':
                        kc = 'KC_NO'
                    else:
                        kc = line[1]
                    if is_adv_kc:
                        # If we are inside an advanced keycode
                        # collect everything and hope the user
                        # knew what he/she was doing
                        layer['keycodes'][-1] += kc
                    else:
                        layer['keycodes'].append(kc)

        # The keymaps array's signature:
        # const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]
        #
        # Only if we've found all 6 keywords in this specific order
        # can we know for sure that we are inside the keymaps array
            elif line[1] == 'PROGMEM' and keymap_certainty == 2:
                keymap_certainty = 3
            elif line[1] == 'keymaps' and keymap_certainty == 3:
                keymap_certainty = 4
            elif line[1] == 'MATRIX_ROWS' and keymap_certainty == 4:
                keymap_certainty = 5
            elif line[1] == 'MATRIX_COLS' and keymap_certainty == 5:
                keymap_certainty = 6
        elif line[0] is Token.Keyword:
            if line[1] == 'const' and keymap_certainty == 0:
                keymap_certainty = 1
        elif line[0] is Token.Keyword.Type:
            if line[1] == 'uint16_t' and keymap_certainty == 1:
                keymap_certainty = 2
        elif line[0] is Token.Punctuation:
            if line[1] in opening_braces:
                brace_depth += 1
                if is_keymap:
                    if is_layer:
                        # We found the beginning of a non-basic keycode
                        is_adv_kc = True
                        layer['keycodes'][-1] += line[1]
                    elif line[1] == '(' and brace_depth == 2:
                        # We found the beginning of a layer
                        is_layer = True
                elif line[1] == '{' and keymap_certainty == 6:
                    # We found the beginning of the keymaps array
                    is_keymap = True
            elif line[1] in closing_braces:
                brace_depth -= 1
                if is_keymap:
                    if is_adv_kc:
                        layer['keycodes'][-1] += line[1]
                        if brace_depth == 2:
                            # We found the end of a non-basic keycode
                            is_adv_kc = False
                    elif line[1] == ')' and brace_depth == 1:
                        # We found the end of a layer
                        is_layer = False
                        layers.append(layer)
                        layer = dict(name=False, layout=False, keycodes=list())
                    elif line[1] == '}' and brace_depth == 0:
                        # We found the end of the keymaps array
                        is_keymap = False
                        keymap_certainty = 0
            elif is_adv_kc:
                # Advanced keycodes can contain other punctuation
                # e.g.: MT(MOD_LCTL | MOD_LSFT, KC_ESC)
                layer['keycodes'][-1] += line[1]

        elif line[0] is Token.Literal.Number.Integer and is_keymap and not is_adv_kc:
            # If the pre-processor finds the 'meaning' of the layer names,
            # they will be numbers
            if not layer['name']:
                layer['name'] = line[1]

        else:
            # We only care about
            # operators and such if we
            # are inside an advanced keycode
            # e.g.: MT(MOD_LCTL | MOD_LSFT, KC_ESC)
            if is_adv_kc:
                layer['keycodes'][-1] += line[1]

    return layers


def parse_keymap_c(keymap_file, use_cpp=True):
    """ Parse a keymap.c file.

    Currently only cares about the keymaps array.

    Args:
        keymap_file: path of the keymap.c file (or '-' to use stdin)

        use_cpp: if True, pre-process the file with the C pre-processor

    Returns:
        a dictionary containing the parsed keymap
    """
    if not isinstance(keymap_file, (Path, str)) or keymap_file == '-':
        if use_cpp:
            keymap_file = _c_preprocess(None, sys.stdin)
        else:
            keymap_file = sys.stdin.read()
    else:
        if use_cpp:
            keymap_file = _c_preprocess(keymap_file)
        else:
            keymap_file = keymap_file.read_text(encoding='utf-8')

    keymap = dict()
    keymap['layers'] = _get_layers(keymap_file)
    return keymap


def c2json(keyboard, keymap, keymap_file, use_cpp=True):
    """ Convert keymap.c to keymap.json

    Args:
        keyboard: The name of the keyboard

        keymap: The name of the keymap

        layout: The LAYOUT macro this keymap uses.

        keymap_file: path of the keymap.c file

        use_cpp: if True, pre-process the file with the C pre-processor

    Returns:
        a dictionary in keymap.json format
    """
    keymap_json = parse_keymap_c(keymap_file, use_cpp)

    dirty_layers = keymap_json.pop('layers', None)
    keymap_json['layers'] = list()
    for layer in dirty_layers:
        layer.pop('name')
        layout = layer.pop('layout')
        if not keymap_json.get('layout', False):
            keymap_json['layout'] = layout
        keymap_json['layers'].append(layer.pop('keycodes'))

    keymap_json['keyboard'] = keyboard
    keymap_json['keymap'] = keymap
    return keymap_json