keyboard stuff
auri.ee
1"""Compile a QMK Firmware.
2
3You can compile a keymap already in the repo or using a QMK Configurator export.
4"""
5from argcomplete.completers import FilesCompleter
6
7from milc import cli
8
9import qmk.path
10from qmk.decorators import automagic_keyboard, automagic_keymap
11from qmk.commands import build_environment
12from qmk.keyboard import keyboard_completer, keyboard_folder_or_all, is_all_keyboards
13from qmk.keymap import keymap_completer, locate_keymap
14from qmk.build_targets import KeyboardKeymapBuildTarget, JsonKeymapBuildTarget
15
16
17@cli.argument('filename', nargs='?', arg_only=True, type=qmk.path.FileType('r'), completer=FilesCompleter('.json'), help='The configurator export to compile')
18@cli.argument('-kb', '--keyboard', type=keyboard_folder_or_all, completer=keyboard_completer, help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
19@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
20@cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually build, just show the make command to be run.")
21@cli.argument('-j', '--parallel', type=int, default=1, help="Set the number of parallel make jobs; 0 means unlimited.")
22@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Set a variable to be passed to make. May be passed multiple times.")
23@cli.argument('-c', '--clean', arg_only=True, action='store_true', help="Remove object files before compiling.")
24@cli.argument('-t', '--target', type=str, default=None, help="Intended alternative build target, such as `production` in `make planck/rev4:default:production`.")
25@cli.argument('--compiledb', arg_only=True, action='store_true', help="Generates the clang compile_commands.json file during build. Implies --clean.")
26@cli.subcommand('Compile a QMK Firmware.')
27@automagic_keyboard
28@automagic_keymap
29def compile(cli):
30 """Compile a QMK Firmware.
31
32 If a Configurator export is supplied this command will create a new keymap, overwriting an existing keymap if one exists.
33
34 If a keyboard and keymap are provided this command will build a firmware based on that.
35 """
36
37 # If we've received `-kb all`, reroute it to mass-compile.
38 if is_all_keyboards(cli.args.keyboard):
39 from .mass_compile import mass_compile
40 cli.args.builds = []
41 cli.args.filter = []
42 cli.config.mass_compile.keymap = cli.config.compile.keymap
43 cli.config.mass_compile.parallel = cli.config.compile.parallel
44 cli.args.no_temp = False
45 return mass_compile(cli)
46
47 # If we've received `-km all`, reroute it to mass-compile.
48 if cli.args.keymap == 'all':
49 from .mass_compile import mass_compile
50 cli.args.builds = [f'{cli.config.compile.keyboard}:all']
51 cli.args.filter = []
52 cli.config.mass_compile.keymap = None
53 cli.config.mass_compile.parallel = cli.config.compile.parallel
54 cli.args.no_temp = False
55 return mass_compile(cli)
56
57 # Build the environment vars
58 envs = build_environment(cli.args.env)
59
60 # Handler for the build target
61 target = None
62
63 if cli.args.filename:
64 # if we were given a filename, assume we have a json build target
65 target = JsonKeymapBuildTarget(cli.args.filename)
66
67 elif cli.config.compile.keyboard and cli.config.compile.keymap:
68 # if we got a keyboard and keymap, attempt to find it
69 if not locate_keymap(cli.config.compile.keyboard, cli.config.compile.keymap):
70 cli.log.error('Invalid keymap argument.')
71 cli.print_help()
72 return False
73
74 # If we got here, then we have a valid keyboard and keymap for a build target
75 target = KeyboardKeymapBuildTarget(cli.config.compile.keyboard, cli.config.compile.keymap)
76
77 if not target:
78 cli.log.error('You must supply a configurator export, both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')
79 cli.print_help()
80 return False
81
82 target.configure(parallel=cli.config.compile.parallel, clean=cli.args.clean, compiledb=cli.args.compiledb)
83 return target.compile(cli.args.target, dry_run=cli.args.dry_run, **envs)