aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/generate/keymap_h.py
blob: a3aaa405c0fb8996efb93425220ee5d2ad0bde32 (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
from argcomplete.completers import FilesCompleter

from milc import cli

import qmk.path
from qmk.commands import dump_lines
from qmk.commands import parse_configurator_json
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE


def _generate_keycodes_function(keymap_json):
    """Generates keymap level keycodes.
    """
    lines = []
    lines.append('enum keymap_keycodes {')

    for index, item in enumerate(keymap_json.get('keycodes', [])):
        key = item["key"]
        if index == 0:
            lines.append(f'  {key} = QK_USER_0,')
        else:
            lines.append(f'  {key},')

    lines.append('};')

    for item in keymap_json.get('keycodes', []):
        key = item["key"]
        for alias in item.get("aliases", []):
            lines.append(f'#define {alias} {key}')

    return lines


@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
@cli.argument('filename', type=qmk.path.FileType('r'), arg_only=True, completer=FilesCompleter('.json'), help='Configurator JSON file')
@cli.subcommand('Creates a keymap.h from a QMK Configurator export.')
def generate_keymap_h(cli):
    """Creates a keymap.h from a QMK Configurator export
    """
    if cli.args.output and cli.args.output.name == '-':
        cli.args.output = None

    keymap_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '// clang-format off']

    keymap_json = parse_configurator_json(cli.args.filename)

    if 'keycodes' in keymap_json and keymap_json['keycodes'] is not None:
        keymap_h_lines += _generate_keycodes_function(keymap_json)

    dump_lines(cli.args.output, keymap_h_lines, cli.args.quiet)