mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-04 07:12:33 +01:00 
			
		
		
		
	* macros in json keymaps * add advanced macro support to json * add a note about escaping macro strings * add simple examples * format json * add support for language specific keymap extras * switch to dictionaries instead of inline text for macros * use SS_TAP on the innermost tap keycode * add the new macro format to the schema * document the macro limit * add the json keyword for syntax highlighting * fix format that vscode screwed up * Update feature_macros.md * add tests for macros * change ding to beep * add json support for SENDSTRING_BELL * update doc based on feedback from sigprof * document host_layout * remove unused var * improve carriage return handling * support tab characters as well * Update docs/feature_macros.md Co-authored-by: Nick Brassel <nick@tzarc.org> * escape backslash characters * format * flake8 * Update quantum/quantum_keycodes.h Co-authored-by: Nick Brassel <nick@tzarc.org>
		
			
				
	
	
		
			49 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Python
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			49 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Python
		
	
	
		
			Executable File
		
	
	
	
	
"""Generate a keymap.c from a configurator export.
 | 
						|
"""
 | 
						|
import json
 | 
						|
 | 
						|
from argcomplete.completers import FilesCompleter
 | 
						|
from milc import cli
 | 
						|
 | 
						|
import qmk.keymap
 | 
						|
import qmk.path
 | 
						|
 | 
						|
 | 
						|
@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.c from a QMK Configurator export.')
 | 
						|
def json2c(cli):
 | 
						|
    """Generate a keymap.c from a configurator export.
 | 
						|
 | 
						|
    This command uses the `qmk.keymap` module to generate a keymap.c from a configurator export. The generated keymap is written to stdout, or to a file if -o is provided.
 | 
						|
    """
 | 
						|
 | 
						|
    try:
 | 
						|
        # Parse the configurator from json file (or stdin)
 | 
						|
        user_keymap = json.load(cli.args.filename)
 | 
						|
 | 
						|
    except json.decoder.JSONDecodeError as ex:
 | 
						|
        cli.log.error('The JSON input does not appear to be valid.')
 | 
						|
        cli.log.error(ex)
 | 
						|
        return False
 | 
						|
 | 
						|
    # Environment processing
 | 
						|
    if cli.args.output and cli.args.output.name == '-':
 | 
						|
        cli.args.output = None
 | 
						|
 | 
						|
    # Generate the keymap
 | 
						|
    keymap_c = qmk.keymap.generate_c(user_keymap)
 | 
						|
 | 
						|
    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(keymap_c)
 | 
						|
 | 
						|
        if not cli.args.quiet:
 | 
						|
            cli.log.info('Wrote keymap to %s.', cli.args.output)
 | 
						|
 | 
						|
    else:
 | 
						|
        print(keymap_c)
 |