Generate keymap dd keycodes to header (#20273)

builddefs/build_keyboard.mk

@@ -212,7 +212,12 @@ $(INTERMEDIATE_OUTPUT)/src/config.h: $(KEYMAP_JSON)
 	$(eval CMD=$(QMK_BIN) generate-config-h --quiet --output $(KEYMAP_H) $(KEYMAP_JSON))
 	@$(BUILD_CMD)
 
-generated-files: $(INTERMEDIATE_OUTPUT)/src/config.h $(INTERMEDIATE_OUTPUT)/src/keymap.c
+$(INTERMEDIATE_OUTPUT)/src/keymap.h: $(KEYMAP_JSON)
+	@$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD)
+	$(eval CMD=$(QMK_BIN) generate-keymap-h --quiet --output $(INTERMEDIATE_OUTPUT)/src/keymap.h $(KEYMAP_JSON))
+	@$(BUILD_CMD)
+
+generated-files: $(INTERMEDIATE_OUTPUT)/src/config.h $(INTERMEDIATE_OUTPUT)/src/keymap.c $(INTERMEDIATE_OUTPUT)/src/keymap.h
 
 endif
 

lib/python/qmk/cli/__init__.py

@@ -58,6 +58,7 @@ subcommands = [
     'qmk.cli.generate.keyboard_h',
     'qmk.cli.generate.keycodes',
     'qmk.cli.generate.keycodes_tests',
+    'qmk.cli.generate.keymap_h',
     'qmk.cli.generate.make_dependencies',
     'qmk.cli.generate.rgb_breathe_table',
     'qmk.cli.generate.rules_mk',

lib/python/qmk/cli/generate/keymap_h.py

@@ -0,0 +1,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)

lib/python/qmk/keymap.py

@@ -19,6 +19,9 @@ 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!
@@ -26,8 +29,6 @@ __INCLUDES__
  * This file was generated by qmk json2c. You may or may not want to
  * edit it directly.
  */
-__KEYCODE_OUTPUT_GOES_HERE__
-
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 __KEYMAP_GOES_HERE__
 };
@@ -125,29 +126,6 @@ def _generate_macros_function(keymap_json):
     return macro_txt
 
 
-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
-
-
 def template_json(keyboard):
     """Returns a `keymap.json` template for a keyboard.
 
@@ -350,12 +328,6 @@ def generate_c(keymap_json):
         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)
 
-    keycodes = ''
-    if 'keycodes' in keymap_json and keymap_json['keycodes'] is not None:
-        keycodes_txt = _generate_keycodes_function(keymap_json)
-        keycodes = '\n'.join(keycodes_txt)
-    new_keymap = new_keymap.replace('__KEYCODE_OUTPUT_GOES_HERE__', keycodes)
-
     return new_keymap