diff options
Diffstat (limited to 'lib/python/qmk/cli/generate')
| -rwxr-xr-x | lib/python/qmk/cli/generate/api.py | 28 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/generate/config_h.py | 24 | ||||
| -rw-r--r-- | lib/python/qmk/cli/generate/docs.py | 7 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/generate/keyboard_c.py | 75 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/generate/rules_mk.py | 14 | 
5 files changed, 121 insertions, 27 deletions
| diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py index 285bd90eb5..0596b3f22b 100755 --- a/lib/python/qmk/cli/generate/api.py +++ b/lib/python/qmk/cli/generate/api.py @@ -1,7 +1,7 @@  """This script automates the generation of the QMK API data.  """  from pathlib import Path -from shutil import copyfile +import shutil  import json  from milc import cli @@ -12,28 +12,42 @@ from qmk.json_encoders import InfoJSONEncoder  from qmk.json_schema import json_load  from qmk.keyboard import find_readme, list_keyboards +TEMPLATE_PATH = Path('data/templates/api/') +BUILD_API_PATH = Path('.build/api_data/') +  @cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't write the data to disk.") [email protected]('-f', '--filter', arg_only=True, action='append', default=[], help="Filter the list of keyboards based on partial name matches the supplied value. May be passed multiple times.")  @cli.subcommand('Creates a new keymap for the keyboard of your choosing', hidden=False if cli.config.user.developer else True)  def generate_api(cli):      """Generates the QMK API data.      """ -    api_data_dir = Path('api_data') -    v1_dir = api_data_dir / 'v1' +    if BUILD_API_PATH.exists(): +        shutil.rmtree(BUILD_API_PATH) + +    shutil.copytree(TEMPLATE_PATH, BUILD_API_PATH) + +    v1_dir = BUILD_API_PATH / 'v1'      keyboard_all_file = v1_dir / 'keyboards.json'  # A massive JSON containing everything      keyboard_list_file = v1_dir / 'keyboard_list.json'  # A simple list of keyboard targets      keyboard_aliases_file = v1_dir / 'keyboard_aliases.json'  # A list of historical keyboard names and their new name      keyboard_metadata_file = v1_dir / 'keyboard_metadata.json'  # All the data configurator/via needs for initialization      usb_file = v1_dir / 'usb.json'  # A mapping of USB VID/PID -> keyboard target -    if not api_data_dir.exists(): -        api_data_dir.mkdir() +    # Filter down when required +    keyboard_list = list_keyboards() +    if cli.args.filter: +        kb_list = [] +        for keyboard_name in keyboard_list: +            if any(i in keyboard_name for i in cli.args.filter): +                kb_list.append(keyboard_name) +        keyboard_list = kb_list      kb_all = {}      usb_list = {}      # Generate and write keyboard specific JSON files -    for keyboard_name in list_keyboards(): +    for keyboard_name in keyboard_list:          kb_all[keyboard_name] = info_json(keyboard_name)          keyboard_dir = v1_dir / 'keyboards' / keyboard_name          keyboard_info = keyboard_dir / 'info.json' @@ -47,7 +61,7 @@ def generate_api(cli):              cli.log.debug('Wrote file %s', keyboard_info)              if keyboard_readme_src: -                copyfile(keyboard_readme_src, keyboard_readme) +                shutil.copyfile(keyboard_readme_src, keyboard_readme)                  cli.log.debug('Copied %s -> %s', keyboard_readme_src, keyboard_readme)          if 'usb' in kb_all[keyboard_name]: diff --git a/lib/python/qmk/cli/generate/config_h.py b/lib/python/qmk/cli/generate/config_h.py index fdc76b23d4..893892c479 100755 --- a/lib/python/qmk/cli/generate/config_h.py +++ b/lib/python/qmk/cli/generate/config_h.py @@ -5,10 +5,9 @@ from pathlib import Path  from dotty_dict import dotty  from milc import cli -from qmk.info import info_json -from qmk.json_schema import json_load, validate +from qmk.info import info_json, keymap_json_config +from qmk.json_schema import json_load  from qmk.keyboard import keyboard_completer, keyboard_folder -from qmk.keymap import locate_keymap  from qmk.commands import dump_lines  from qmk.path import normpath  from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE @@ -84,7 +83,7 @@ def generate_config_items(kb_info_json, config_h_lines):      for config_key, info_dict in info_config_map.items():          info_key = info_dict['info_key'] -        key_type = info_dict.get('value_type', 'str') +        key_type = info_dict.get('value_type', 'raw')          to_config = info_dict.get('to_config', True)          if not to_config: @@ -95,7 +94,12 @@ def generate_config_items(kb_info_json, config_h_lines):          except KeyError:              continue -        if key_type.startswith('array'): +        if key_type.startswith('array.array'): +            config_h_lines.append('') +            config_h_lines.append(f'#ifndef {config_key}') +            config_h_lines.append(f'#   define {config_key} {{ {", ".join(["{" + ",".join(list(map(str, x))) + "}" for x in config_value])} }}') +            config_h_lines.append(f'#endif // {config_key}') +        elif key_type.startswith('array'):              config_h_lines.append('')              config_h_lines.append(f'#ifndef {config_key}')              config_h_lines.append(f'#   define {config_key} {{ {", ".join(map(str, config_value))} }}') @@ -112,6 +116,11 @@ def generate_config_items(kb_info_json, config_h_lines):                  config_h_lines.append(f'#ifndef {key}')                  config_h_lines.append(f'#   define {key} {value}')                  config_h_lines.append(f'#endif // {key}') +        elif key_type == 'str': +            config_h_lines.append('') +            config_h_lines.append(f'#ifndef {config_key}') +            config_h_lines.append(f'#   define {config_key} "{config_value}"') +            config_h_lines.append(f'#endif // {config_key}')          elif key_type == 'bcd_version':              (major, minor, revision) = config_value.split('.')              config_h_lines.append('') @@ -175,10 +184,7 @@ def generate_config_h(cli):      """      # Determine our keyboard/keymap      if cli.args.keymap: -        km = locate_keymap(cli.args.keyboard, cli.args.keymap) -        km_json = json_load(km) -        validate(km_json, 'qmk.keymap.v1') -        kb_info_json = dotty(km_json.get('config', {})) +        kb_info_json = dotty(keymap_json_config(cli.args.keyboard, cli.args.keymap))      else:          kb_info_json = dotty(info_json(cli.args.keyboard)) diff --git a/lib/python/qmk/cli/generate/docs.py b/lib/python/qmk/cli/generate/docs.py index 74112d834d..eb3099e138 100644 --- a/lib/python/qmk/cli/generate/docs.py +++ b/lib/python/qmk/cli/generate/docs.py @@ -10,6 +10,7 @@ DOCS_PATH = Path('docs/')  BUILD_PATH = Path('.build/')  BUILD_DOCS_PATH = BUILD_PATH / 'docs'  DOXYGEN_PATH = BUILD_PATH / 'doxygen' +MOXYGEN_PATH = BUILD_DOCS_PATH / 'internals'  @cli.subcommand('Build QMK documentation.', hidden=False if cli.config.user.developer else True) @@ -34,10 +35,10 @@ def generate_docs(cli):          'stdin': DEVNULL,      } -    cli.log.info('Generating internal docs...') +    cli.log.info('Generating docs...')      # Generate internal docs      cli.run(['doxygen', 'Doxyfile'], **args) -    cli.run(['moxygen', '-q', '-g', '-o', BUILD_DOCS_PATH / 'internals_%s.md', DOXYGEN_PATH / 'xml'], **args) +    cli.run(['moxygen', '-q', '-g', '-o', MOXYGEN_PATH / '%s.md', DOXYGEN_PATH / 'xml'], **args) -    cli.log.info('Successfully generated internal docs to %s.', BUILD_DOCS_PATH) +    cli.log.info('Successfully generated docs to %s.', BUILD_DOCS_PATH) diff --git a/lib/python/qmk/cli/generate/keyboard_c.py b/lib/python/qmk/cli/generate/keyboard_c.py new file mode 100755 index 0000000000..a9b742f323 --- /dev/null +++ b/lib/python/qmk/cli/generate/keyboard_c.py @@ -0,0 +1,75 @@ +"""Used by the make system to generate keyboard.c from info.json. +""" +from milc import cli + +from qmk.info import info_json +from qmk.commands import dump_lines +from qmk.keyboard import keyboard_completer, keyboard_folder +from qmk.path import normpath +from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE + + +def _gen_led_config(info_data): +    """Convert info.json content to g_led_config +    """ +    cols = info_data['matrix_size']['cols'] +    rows = info_data['matrix_size']['rows'] + +    config_type = None +    if 'layout' in info_data.get('rgb_matrix', {}): +        config_type = 'rgb_matrix' +    elif 'layout' in info_data.get('led_matrix', {}): +        config_type = 'led_matrix' + +    lines = [] +    if not config_type: +        return lines + +    matrix = [['NO_LED'] * cols for i in range(rows)] +    pos = [] +    flags = [] + +    led_config = info_data[config_type]['layout'] +    for index, item in enumerate(led_config, start=0): +        if 'matrix' in item: +            (x, y) = item['matrix'] +            matrix[x][y] = str(index) +        pos.append(f'{{ {item.get("x", 0)},{item.get("y", 0)} }}') +        flags.append(str(item.get('flags', 0))) + +    if config_type == 'rgb_matrix': +        lines.append('#ifdef RGB_MATRIX_ENABLE') +        lines.append('#include "rgb_matrix.h"') +    elif config_type == 'led_matrix': +        lines.append('#ifdef LED_MATRIX_ENABLE') +        lines.append('#include "led_matrix.h"') + +    lines.append('__attribute__ ((weak)) led_config_t g_led_config = {') +    lines.append('  {') +    for line in matrix: +        lines.append(f'    {{ {",".join(line)} }},') +    lines.append('  },') +    lines.append(f'  {{ {",".join(pos)} }},') +    lines.append(f'  {{ {",".join(flags)} }},') +    lines.append('};') +    lines.append('#endif') + +    return lines + + [email protected]('-o', '--output', arg_only=True, type=normpath, help='File to write to') [email protected]('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages") [email protected]('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='Keyboard to generate keyboard.c for.') [email protected]('Used by the make system to generate keyboard.c from info.json', hidden=True) +def generate_keyboard_c(cli): +    """Generates the keyboard.h file. +    """ +    kb_info_json = info_json(cli.args.keyboard) + +    # Build the layouts.h file. +    keyboard_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#include QMK_KEYBOARD_H', ''] + +    keyboard_h_lines.extend(_gen_led_config(kb_info_json)) + +    # Show the results +    dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet) diff --git a/lib/python/qmk/cli/generate/rules_mk.py b/lib/python/qmk/cli/generate/rules_mk.py index 29a1130f99..9623d00fb5 100755 --- a/lib/python/qmk/cli/generate/rules_mk.py +++ b/lib/python/qmk/cli/generate/rules_mk.py @@ -5,10 +5,9 @@ from pathlib import Path  from dotty_dict import dotty  from milc import cli -from qmk.info import info_json -from qmk.json_schema import json_load, validate +from qmk.info import info_json, keymap_json_config +from qmk.json_schema import json_load  from qmk.keyboard import keyboard_completer, keyboard_folder -from qmk.keymap import locate_keymap  from qmk.commands import dump_lines  from qmk.path import normpath  from qmk.constants import GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE @@ -21,7 +20,7 @@ def process_mapping_rule(kb_info_json, rules_key, info_dict):          return None      info_key = info_dict['info_key'] -    key_type = info_dict.get('value_type', 'str') +    key_type = info_dict.get('value_type', 'raw')      try:          rules_value = kb_info_json[info_key] @@ -34,6 +33,8 @@ def process_mapping_rule(kb_info_json, rules_key, info_dict):          return f'{rules_key} ?= {"yes" if rules_value else "no"}'      elif key_type == 'mapping':          return '\n'.join([f'{key} ?= {value}' for key, value in rules_value.items()]) +    elif key_type == 'str': +        return f'{rules_key} ?= "{rules_value}"'      return f'{rules_key} ?= {rules_value}' @@ -49,10 +50,7 @@ def generate_rules_mk(cli):      """      # Determine our keyboard/keymap      if cli.args.keymap: -        km = locate_keymap(cli.args.keyboard, cli.args.keymap) -        km_json = json_load(km) -        validate(km_json, 'qmk.keymap.v1') -        kb_info_json = dotty(km_json.get('config', {})) +        kb_info_json = dotty(keymap_json_config(cli.args.keyboard, cli.args.keymap))      else:          kb_info_json = dotty(info_json(cli.args.keyboard)) | 
