mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-17 07:03:23 +00:00
67 lines
2.7 KiB
Python
67 lines
2.7 KiB
Python
"""Generate a keymap.json from a keymap.c file.
|
|
"""
|
|
import json
|
|
|
|
from argcomplete.completers import FilesCompleter
|
|
from milc import cli
|
|
|
|
import qmk.keymap
|
|
import qmk.path
|
|
from qmk.json_encoders import InfoJSONEncoder
|
|
from qmk.keyboard import keyboard_completer, keyboard_folder
|
|
from qmk.errors import CppError
|
|
|
|
|
|
@cli.argument('--no-cpp', arg_only=True, action='store_false', help='Do not use \'cpp\' on keymap.c')
|
|
@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('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='The keyboard\'s name')
|
|
@cli.argument('-km', '--keymap', arg_only=True, required=True, help='The keymap\'s name')
|
|
@cli.argument('filename', arg_only=True, completer=FilesCompleter('.c'), help='keymap.c file')
|
|
@cli.subcommand('Creates a keymap.json from a keymap.c file.')
|
|
def c2json(cli):
|
|
"""Generate a keymap.json from a keymap.c file.
|
|
|
|
This command uses the `qmk.keymap` module to generate a keymap.json from a keymap.c file. The generated keymap is written to stdout, or to a file if -o is provided.
|
|
"""
|
|
if cli.args.filename != '-':
|
|
cli.args.filename = qmk.path.normpath(cli.args.filename)
|
|
|
|
# Error checking
|
|
if not cli.args.filename.exists():
|
|
cli.log.error('C file does not exist!')
|
|
cli.print_usage()
|
|
return False
|
|
|
|
# Environment processing
|
|
if cli.args.output == ('-'):
|
|
cli.args.output = None
|
|
|
|
# Parse the keymap.c
|
|
try:
|
|
keymap_json = qmk.keymap.c2json(cli.args.keyboard, cli.args.keymap, cli.args.filename, use_cpp=cli.args.no_cpp)
|
|
except CppError as e:
|
|
if cli.config.general.verbose:
|
|
cli.log.debug('The C pre-processor ran into a fatal error: %s', e)
|
|
cli.log.error('Something went wrong. Try to use --no-cpp.\nUse the CLI in verbose mode to find out more.')
|
|
return False
|
|
|
|
# Generate the keymap.json
|
|
try:
|
|
keymap_json = qmk.keymap.generate_json(keymap_json['keymap'], keymap_json['keyboard'], keymap_json['layout'], keymap_json['layers'])
|
|
except KeyError:
|
|
cli.log.error('Something went wrong. Try to use --no-cpp.')
|
|
return False
|
|
|
|
if cli.args.output:
|
|
cli.args.output.parent.mkdir(parents=True, exist_ok=True)
|
|
if cli.args.output.exists():
|
|
cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
|
|
cli.args.output.write_text(json.dumps(keymap_json, cls=InfoJSONEncoder))
|
|
|
|
if not cli.args.quiet:
|
|
cli.log.info('Wrote keymap to %s.', cli.args.output)
|
|
|
|
else:
|
|
print(json.dumps(keymap_json))
|