From a2c23e9419478cc49d06634732e626a55eec6d66 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Tue, 5 Mar 2024 16:59:30 +0000 Subject: Initial 'qmk test-c' functionality (#23038) --- lib/python/qmk/cli/__init__.py | 1 + lib/python/qmk/cli/test/__init__.py | 0 lib/python/qmk/cli/test/c.py | 47 +++++++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+) create mode 100644 lib/python/qmk/cli/test/__init__.py create mode 100644 lib/python/qmk/cli/test/c.py (limited to 'lib/python/qmk/cli') diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py index e4a8166349..6d05a5fc21 100644 --- a/lib/python/qmk/cli/__init__.py +++ b/lib/python/qmk/cli/__init__.py @@ -81,6 +81,7 @@ subcommands = [ 'qmk.cli.new.keymap', 'qmk.cli.painter', 'qmk.cli.pytest', + 'qmk.cli.test.c', 'qmk.cli.userspace.add', 'qmk.cli.userspace.compile', 'qmk.cli.userspace.doctor', diff --git a/lib/python/qmk/cli/test/__init__.py b/lib/python/qmk/cli/test/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/lib/python/qmk/cli/test/c.py b/lib/python/qmk/cli/test/c.py new file mode 100644 index 0000000000..7a4e20d5e6 --- /dev/null +++ b/lib/python/qmk/cli/test/c.py @@ -0,0 +1,47 @@ +import fnmatch +import re +from subprocess import DEVNULL + +from milc import cli + +from qmk.commands import find_make, get_make_parallel_args, build_environment + + +@cli.argument('-j', '--parallel', type=int, default=1, help="Set the number of parallel make jobs; 0 means unlimited.") +@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Set a variable to be passed to make. May be passed multiple times.") +@cli.argument('-c', '--clean', arg_only=True, action='store_true', help="Remove object files before compiling.") +@cli.argument('-l', '--list', arg_only=True, action='store_true', help='List available tests.') +@cli.argument('-t', '--test', arg_only=True, action='append', default=[], help="Test to run from the available list. Supports wildcard globs. May be passed multiple times.") +@cli.subcommand("QMK C Unit Tests.", hidden=False if cli.config.user.developer else True) +def test_c(cli): + """Run native unit tests. + """ + list_tests = cli.run([find_make(), 'list-tests', 'SILENT=true']) + available_tests = sorted(list_tests.stdout.strip().split()) + + if cli.args.list: + return print("\n".join(available_tests)) + + # expand any wildcards + filtered_tests = set() + for test in cli.args.test: + regex = re.compile(fnmatch.translate(test)) + filtered_tests |= set(filter(regex.match, available_tests)) + + for invalid in filtered_tests - set(available_tests): + cli.log.warning(f'Invalid test provided: {invalid}') + + # convert test names to build targets + targets = list(map(lambda x: f'test:{x}', filtered_tests or ['all'])) + + if cli.args.clean: + targets.insert(0, 'clean') + + # Add in the environment vars + for key, value in build_environment(cli.args.env).items(): + targets.append(f'{key}={value}') + + command = [find_make(), *get_make_parallel_args(cli.config.test_c.parallel), *targets] + + cli.log.info('Compiling tests with {fg_cyan}%s', ' '.join(command)) + return cli.run(command, capture_output=False, stdin=DEVNULL).returncode -- cgit v1.2.3 From c5225ab5009476c60a9cb27837615d4f29c9b19a Mon Sep 17 00:00:00 2001 From: Pablo Martínez <58857054+elpekenin@users.noreply.github.com> Date: Sun, 10 Mar 2024 01:29:09 +0100 Subject: [Feature] Some metadata on QGF/QFF files (#20101) --- lib/python/qmk/cli/painter/convert_graphics.py | 34 +++------ lib/python/qmk/cli/painter/make_font.py | 36 +++------ lib/python/qmk/painter.py | 102 +++++++++++++++++++++++++ lib/python/qmk/painter_qgf.py | 26 ++++++- 4 files changed, 146 insertions(+), 52 deletions(-) (limited to 'lib/python/qmk/cli') diff --git a/lib/python/qmk/cli/painter/convert_graphics.py b/lib/python/qmk/cli/painter/convert_graphics.py index 2519c49b25..553c26aa5d 100644 --- a/lib/python/qmk/cli/painter/convert_graphics.py +++ b/lib/python/qmk/cli/painter/convert_graphics.py @@ -1,10 +1,8 @@ """This script tests QGF functionality. """ -import re -import datetime from io import BytesIO from qmk.path import normpath -from qmk.painter import render_header, render_source, render_license, render_bytes, valid_formats +from qmk.painter import generate_subs, render_header, render_source, valid_formats from milc import cli from PIL import Image @@ -12,7 +10,7 @@ from PIL import Image @cli.argument('-v', '--verbose', arg_only=True, action='store_true', help='Turns on verbose output.') @cli.argument('-i', '--input', required=True, help='Specify input graphic file.') @cli.argument('-o', '--output', default='', help='Specify output directory. Defaults to same directory as input.') -@cli.argument('-f', '--format', required=True, help='Output format, valid types: %s' % (', '.join(valid_formats.keys()))) +@cli.argument('-f', '--format', required=True, help=f'Output format, valid types: {", ".join(valid_formats.keys())}') @cli.argument('-r', '--no-rle', arg_only=True, action='store_true', help='Disables the use of RLE when encoding images.') @cli.argument('-d', '--no-deltas', arg_only=True, action='store_true', help='Disables the use of delta frames when encoding animations.') @cli.argument('-w', '--raw', arg_only=True, action='store_true', help='Writes out the QGF file as raw data instead of c/h combo.') @@ -51,43 +49,31 @@ def painter_convert_graphics(cli): # Convert the image to QGF using PIL out_data = BytesIO() - input_img.save(out_data, "QGF", use_deltas=(not cli.args.no_deltas), use_rle=(not cli.args.no_rle), qmk_format=format, verbose=cli.args.verbose) + metadata = [] + input_img.save(out_data, "QGF", use_deltas=(not cli.args.no_deltas), use_rle=(not cli.args.no_rle), qmk_format=format, verbose=cli.args.verbose, metadata=metadata) out_bytes = out_data.getvalue() if cli.args.raw: - raw_file = cli.args.output / (cli.args.input.stem + ".qgf") + raw_file = cli.args.output / f"{cli.args.input.stem}.qgf" with open(raw_file, 'wb') as raw: raw.write(out_bytes) return # Work out the text substitutions for rendering the output data - subs = { - 'generated_type': 'image', - 'var_prefix': 'gfx', - 'generator_command': f'qmk painter-convert-graphics -i {cli.args.input.name} -f {cli.args.format}', - 'year': datetime.date.today().strftime("%Y"), - 'input_file': cli.args.input.name, - 'sane_name': re.sub(r"[^a-zA-Z0-9]", "_", cli.args.input.stem), - 'byte_count': len(out_bytes), - 'bytes_lines': render_bytes(out_bytes), - 'format': cli.args.format, - } - - # Render the license - subs.update({'license': render_license(subs)}) + args_str = " ".join((f"--{arg} {getattr(cli.args, arg.replace('-', '_'))}" for arg in ["input", "output", "format", "no-rle", "no-deltas"])) + command = f"qmk painter-convert-graphics {args_str}" + subs = generate_subs(cli, out_bytes, image_metadata=metadata, command=command) # Render and write the header file header_text = render_header(subs) - header_file = cli.args.output / (cli.args.input.stem + ".qgf.h") + header_file = cli.args.output / f"{cli.args.input.stem}.qgf.h" with open(header_file, 'w') as header: print(f"Writing {header_file}...") header.write(header_text) - header.close() # Render and write the source file source_text = render_source(subs) - source_file = cli.args.output / (cli.args.input.stem + ".qgf.c") + source_file = cli.args.output / f"{cli.args.input.stem}.qgf.c" with open(source_file, 'w') as source: print(f"Writing {source_file}...") source.write(source_text) - source.close() diff --git a/lib/python/qmk/cli/painter/make_font.py b/lib/python/qmk/cli/painter/make_font.py index c0189920d2..19db844931 100644 --- a/lib/python/qmk/cli/painter/make_font.py +++ b/lib/python/qmk/cli/painter/make_font.py @@ -1,12 +1,10 @@ """This script automates the conversion of font files into a format QMK firmware understands. """ -import re -import datetime from io import BytesIO from qmk.path import normpath -from qmk.painter_qff import QFFFont -from qmk.painter import render_header, render_source, render_license, render_bytes, valid_formats +from qmk.painter_qff import _generate_font_glyphs_list, QFFFont +from qmk.painter import generate_subs, render_header, render_source, valid_formats from milc import cli @@ -31,7 +29,7 @@ def painter_make_font_image(cli): @cli.argument('-o', '--output', default='', help='Specify output directory. Defaults to same directory as input.') @cli.argument('-n', '--no-ascii', arg_only=True, action='store_true', help='Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified.') @cli.argument('-u', '--unicode-glyphs', default='', help='Also generate the specified unicode glyphs.') -@cli.argument('-f', '--format', required=True, help='Output format, valid types: %s' % (', '.join(valid_formats.keys()))) +@cli.argument('-f', '--format', required=True, help=f'Output format, valid types: {", ".join(valid_formats.keys())}') @cli.argument('-r', '--no-rle', arg_only=True, action='store_true', help='Disable the use of RLE to minimise converted image size.') @cli.argument('-w', '--raw', arg_only=True, action='store_true', help='Writes out the QFF file as raw data instead of c/h combo.') @cli.subcommand('Converts an input font image to something QMK firmware understands') @@ -53,43 +51,31 @@ def painter_convert_font_image(cli): # Render out the data out_data = BytesIO() - font.save_to_qff(format, (False if cli.args.no_rle else True), out_data) + font.save_to_qff(format, not cli.args.no_rle, out_data) out_bytes = out_data.getvalue() if cli.args.raw: - raw_file = cli.args.output / (cli.args.input.stem + ".qff") + raw_file = cli.args.output / f"{cli.args.input.stem}.qff" with open(raw_file, 'wb') as raw: raw.write(out_bytes) return # Work out the text substitutions for rendering the output data - subs = { - 'generated_type': 'font', - 'var_prefix': 'font', - 'generator_command': f'qmk painter-convert-font-image -i {cli.args.input.name} -f {cli.args.format}', - 'year': datetime.date.today().strftime("%Y"), - 'input_file': cli.args.input.name, - 'sane_name': re.sub(r"[^a-zA-Z0-9]", "_", cli.args.input.stem), - 'byte_count': len(out_bytes), - 'bytes_lines': render_bytes(out_bytes), - 'format': cli.args.format, - } - - # Render the license - subs.update({'license': render_license(subs)}) + args_str = " ".join((f"--{arg} {getattr(cli.args, arg.replace('-', '_'))}" for arg in ["input", "output", "no-ascii", "unicode-glyphs", "format", "no-rle"])) + command = f"qmk painter-convert-font-image {args_str}" + metadata = {"glyphs": _generate_font_glyphs_list(not cli.args.no_ascii, cli.args.unicode_glyphs)} + subs = generate_subs(cli, out_bytes, font_metadata=metadata, command=command) # Render and write the header file header_text = render_header(subs) - header_file = cli.args.output / (cli.args.input.stem + ".qff.h") + header_file = cli.args.output / f"{cli.args.input.stem}.qff.h" with open(header_file, 'w') as header: print(f"Writing {header_file}...") header.write(header_text) - header.close() # Render and write the source file source_text = render_source(subs) - source_file = cli.args.output / (cli.args.input.stem + ".qff.c") + source_file = cli.args.output / f"{cli.args.input.stem}.qff.c" with open(source_file, 'w') as source: print(f"Writing {source_file}...") source.write(source_text) - source.close() diff --git a/lib/python/qmk/painter.py b/lib/python/qmk/painter.py index 381a996443..512a486ce8 100644 --- a/lib/python/qmk/painter.py +++ b/lib/python/qmk/painter.py @@ -1,5 +1,6 @@ """Functions that help us work with Quantum Painter's file formats. """ +import datetime import math import re from string import Template @@ -79,6 +80,105 @@ valid_formats = { } } + +def _render_text(values): + # FIXME: May need more chars with GIFs containing lots of frames (or longer durations) + return "|".join([f"{i:4d}" for i in values]) + + +def _render_numeration(metadata): + return _render_text(range(len(metadata))) + + +def _render_values(metadata, key): + return _render_text([i[key] for i in metadata]) + + +def _render_image_metadata(metadata): + size = metadata.pop(0) + + lines = [ + "// Image's metadata", + "// ----------------", + f"// Width: {size['width']}", + f"// Height: {size['height']}", + ] + + if len(metadata) == 1: + lines.append("// Single frame") + + else: + lines.extend([ + f"// Frame: {_render_numeration(metadata)}", + f"// Duration(ms): {_render_values(metadata, 'delay')}", + f"// Compression: {_render_values(metadata, 'compression')} >> See qp.h, painter_compression_t", + f"// Delta: {_render_values(metadata, 'delta')}", + ]) + + deltas = [] + for i, v in enumerate(metadata): + # Not a delta frame, go to next one + if not v["delta"]: + continue + + # Unpack rect's coords + l, t, r, b = v["delta_rect"] + + delta_px = (r - l) * (b - t) + px = size["width"] * size["height"] + + # FIXME: May need need more chars here too + deltas.append(f"// Frame {i:3d}: ({l:3d}, {t:3d}) - ({r:3d}, {b:3d}) >> {delta_px:4d}/{px:4d} pixels ({100*delta_px/px:.2f}%)") + + if deltas: + lines.append("// Areas on delta frames") + lines.extend(deltas) + + return "\n".join(lines) + + +def generate_subs(cli, out_bytes, *, font_metadata=None, image_metadata=None, command): + if font_metadata is not None and image_metadata is not None: + raise ValueError("Cant generate subs for font and image at the same time") + + subs = { + "year": datetime.date.today().strftime("%Y"), + "input_file": cli.args.input.name, + "sane_name": re.sub(r"[^a-zA-Z0-9]", "_", cli.args.input.stem), + "byte_count": len(out_bytes), + "bytes_lines": render_bytes(out_bytes), + "format": cli.args.format, + "generator_command": command, + } + + if font_metadata is not None: + subs.update({ + "generated_type": "font", + "var_prefix": "font", + # not using triple quotes to avoid extra indentation/weird formatted code + "metadata": "\n".join([ + "// Font's metadata", + "// ---------------", + f"// Glyphs: {', '.join([i for i in font_metadata['glyphs']])}", + ]), + }) + + elif image_metadata is not None: + subs.update({ + "generated_type": "image", + "var_prefix": "gfx", + "generator_command": command, + "metadata": _render_image_metadata(image_metadata), + }) + + else: + raise ValueError("Pass metadata for either an image or a font") + + subs.update({"license": render_license(subs)}) + + return subs + + license_template = """\ // Copyright ${year} QMK -- generated source code only, ${generated_type} retains original copyright // SPDX-License-Identifier: GPL-2.0-or-later @@ -110,6 +210,8 @@ def render_header(subs): source_file_template = """\ ${license} +${metadata} + #include const uint32_t ${var_prefix}_${sane_name}_length = ${byte_count}; diff --git a/lib/python/qmk/painter_qgf.py b/lib/python/qmk/painter_qgf.py index cc4697f1c6..67ef0dd233 100644 --- a/lib/python/qmk/painter_qgf.py +++ b/lib/python/qmk/painter_qgf.py @@ -327,8 +327,9 @@ def _compress_image(frame, last_frame, *, use_rle, use_deltas, format_, **_kwarg # Helper function to save each frame to the output file -def _write_frame(idx, frame, last_frame, *, fp, frame_offsets, **kwargs): - # Not an argument of the function as it would consume from **kwargs +def _write_frame(idx, frame, last_frame, *, fp, frame_offsets, metadata, **kwargs): + # Not an argument of the function as it would then not be part of kwargs + # This would cause an issue with `_compress_image(**kwargs)` missing an argument format_ = kwargs["format_"] # (potentially) Apply RLE and/or delta, and work out output image's information @@ -370,6 +371,21 @@ def _write_frame(idx, frame, last_frame, *, fp, frame_offsets, **kwargs): vprint(f'{f"Frame {idx:3d} delta":26s} {fp.tell():5d}d / {fp.tell():04X}h') delta_descriptor.write(fp) + # Store metadata, showed later in a comment in the generated file + frame_metadata = { + "compression": frame_descriptor.compression, + "delta": frame_descriptor.is_delta, + "delay": frame_descriptor.delay, + } + if frame_metadata["delta"]: + frame_metadata.update({"delta_rect": [ + delta_descriptor.left, + delta_descriptor.top, + delta_descriptor.right, + delta_descriptor.bottom, + ]}) + metadata.append(frame_metadata) + # Write out the data for this frame to the output data_descriptor = QGFFrameDataDescriptorV1() data_descriptor.data = image_data @@ -383,6 +399,10 @@ def _save(im, fp, _filename): # Work out from the parameters if we need to do anything special encoderinfo = im.encoderinfo.copy() + # Store image file in metadata structure + metadata = encoderinfo.get("metadata", []) + metadata.append({"width": im.width, "height": im.height}) + # Helper for prints, noop taking any args if not verbose global vprint verbose = encoderinfo.get("verbose", False) @@ -417,7 +437,7 @@ def _save(im, fp, _filename): frame_offsets.write(fp) # Iterate over each if the input frames, writing it to the output in the process - write_frame = functools.partial(_write_frame, format_=encoderinfo["qmk_format"], fp=fp, use_deltas=encoderinfo.get("use_deltas", True), use_rle=encoderinfo.get("use_rle", True), frame_offsets=frame_offsets) + write_frame = functools.partial(_write_frame, format_=encoderinfo["qmk_format"], fp=fp, use_deltas=encoderinfo.get("use_deltas", True), use_rle=encoderinfo.get("use_rle", True), frame_offsets=frame_offsets, metadata=metadata) for_all_frames(write_frame) # Go back and update the graphics descriptor now that we can determine the final file size -- cgit v1.2.3 From 9f4a9d5826dde903aa0dcec3264cbf192b5044da Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Sun, 10 Mar 2024 05:20:25 +0000 Subject: Enable 'keyboard.json' as a build target (#22891) --- .gitignore | 1 + builddefs/build_keyboard.mk | 40 +++++++++++++++++------- data/templates/keyboard/config.h | 20 ------------ data/templates/keyboard/info.json | 25 --------------- data/templates/keyboard/keyboard.json | 25 +++++++++++++++ data/templates/keyboard/rules.mk | 1 - keyboards/zvecr/zv48/f401/info.json | 5 --- keyboards/zvecr/zv48/f401/keyboard.json | 5 +++ keyboards/zvecr/zv48/f401/rules.mk | 3 -- lib/python/qmk/cli/generate/make_dependencies.py | 3 +- lib/python/qmk/cli/new/keyboard.py | 2 +- lib/python/qmk/info.py | 15 +++++++-- lib/python/qmk/keyboard.py | 10 +++--- lib/python/qmk/path.py | 3 +- 14 files changed, 83 insertions(+), 75 deletions(-) delete mode 100644 data/templates/keyboard/config.h delete mode 100644 data/templates/keyboard/info.json create mode 100644 data/templates/keyboard/keyboard.json delete mode 100644 data/templates/keyboard/rules.mk delete mode 100644 keyboards/zvecr/zv48/f401/info.json create mode 100644 keyboards/zvecr/zv48/f401/keyboard.json delete mode 100644 keyboards/zvecr/zv48/f401/rules.mk (limited to 'lib/python/qmk/cli') diff --git a/.gitignore b/.gitignore index ca9f00a733..35b128606d 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ quantum/version.h # DD config at wrong location /keyboards/**/keymaps/*/info.json +/keyboards/**/keymaps/*/keyboard.json # Old-style QMK Makefiles /keyboards/**/Makefile diff --git a/builddefs/build_keyboard.mk b/builddefs/build_keyboard.mk index f17171fe20..0b9ab8849f 100644 --- a/builddefs/build_keyboard.mk +++ b/builddefs/build_keyboard.mk @@ -119,7 +119,7 @@ MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP) MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP) MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP) -# Pull in rules from info.json +# Pull in rules from DD keyboard config INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/info_rules.mk) include $(INFO_RULES_MK) @@ -221,7 +221,7 @@ include $(BUILDDEFS_PATH)/converters.mk MCU_ORIG := $(MCU) include $(wildcard $(PLATFORM_PATH)/*/mcu_selection.mk) -# PLATFORM_KEY should be detected in info.json via key 'processor' (or rules.mk 'MCU') +# PLATFORM_KEY should be detected in DD keyboard config via key 'processor' (or rules.mk 'MCU') ifeq ($(PLATFORM_KEY),) $(call CATASTROPHIC_ERROR,Platform not defined) endif @@ -335,38 +335,54 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","") POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h endif -# Pull in stuff from info.json -INFO_JSON_FILES := +# Create dependencies on DD keyboard config - structure validated elsewhere +DD_CONFIG_FILES := ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","") - INFO_JSON_FILES += $(KEYBOARD_PATH_1)/info.json + DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/info.json endif ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","") - INFO_JSON_FILES += $(KEYBOARD_PATH_2)/info.json + DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/info.json endif ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","") - INFO_JSON_FILES += $(KEYBOARD_PATH_3)/info.json + DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/info.json endif ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","") - INFO_JSON_FILES += $(KEYBOARD_PATH_4)/info.json + DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/info.json endif ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","") - INFO_JSON_FILES += $(KEYBOARD_PATH_5)/info.json + DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/info.json +endif + +ifneq ("$(wildcard $(KEYBOARD_PATH_1)/keyboard.json)","") + DD_CONFIG_FILES += $(KEYBOARD_PATH_1)/keyboard.json +endif +ifneq ("$(wildcard $(KEYBOARD_PATH_2)/keyboard.json)","") + DD_CONFIG_FILES += $(KEYBOARD_PATH_2)/keyboard.json +endif +ifneq ("$(wildcard $(KEYBOARD_PATH_3)/keyboard.json)","") + DD_CONFIG_FILES += $(KEYBOARD_PATH_3)/keyboard.json +endif +ifneq ("$(wildcard $(KEYBOARD_PATH_4)/keyboard.json)","") + DD_CONFIG_FILES += $(KEYBOARD_PATH_4)/keyboard.json +endif +ifneq ("$(wildcard $(KEYBOARD_PATH_5)/keyboard.json)","") + DD_CONFIG_FILES += $(KEYBOARD_PATH_5)/keyboard.json endif CONFIG_H += $(INTERMEDIATE_OUTPUT)/src/info_config.h KEYBOARD_SRC += $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c -$(INTERMEDIATE_OUTPUT)/src/info_config.h: $(INFO_JSON_FILES) +$(INTERMEDIATE_OUTPUT)/src/info_config.h: $(DD_CONFIG_FILES) @$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD) $(eval CMD=$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/info_config.h) @$(BUILD_CMD) -$(INTERMEDIATE_OUTPUT)/src/default_keyboard.c: $(INFO_JSON_FILES) +$(INTERMEDIATE_OUTPUT)/src/default_keyboard.c: $(DD_CONFIG_FILES) @$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD) $(eval CMD=$(QMK_BIN) generate-keyboard-c --quiet --keyboard $(KEYBOARD) --output $(INTERMEDIATE_OUTPUT)/src/default_keyboard.c) @$(BUILD_CMD) -$(INTERMEDIATE_OUTPUT)/src/default_keyboard.h: $(INFO_JSON_FILES) +$(INTERMEDIATE_OUTPUT)/src/default_keyboard.h: $(DD_CONFIG_FILES) @$(SILENT) || printf "$(MSG_GENERATING) $@" | $(AWK_CMD) $(eval CMD=$(QMK_BIN) generate-keyboard-h --quiet --keyboard $(KEYBOARD) --include $(FOUND_KEYBOARD_H) --output $(INTERMEDIATE_OUTPUT)/src/default_keyboard.h) @$(BUILD_CMD) diff --git a/data/templates/keyboard/config.h b/data/templates/keyboard/config.h deleted file mode 100644 index b15c8d31f1..0000000000 --- a/data/templates/keyboard/config.h +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright %YEAR% %REAL_NAME% (@%USER_NAME%) -// SPDX-License-Identifier: GPL-2.0-or-later - -#pragma once - -/* - * Feature disable options - * These options are also useful to firmware size reduction. - */ - -/* disable debug print */ -//#define NO_DEBUG - -/* disable print */ -//#define NO_PRINT - -/* disable action features */ -//#define NO_ACTION_LAYER -//#define NO_ACTION_TAPPING -//#define NO_ACTION_ONESHOT diff --git a/data/templates/keyboard/info.json b/data/templates/keyboard/info.json deleted file mode 100644 index 65f935fb42..0000000000 --- a/data/templates/keyboard/info.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "keyboard_name": "%KEYBOARD%", - "maintainer": "%USER_NAME%", - "manufacturer": "%REAL_NAME%", - "processor": "%MCU%", - "bootloader": "%BOOTLOADER%", - "diode_direction": "COL2ROW", - "matrix_pins": { - "cols": ["C2"], - "rows": ["D1"] - }, - "usb": { - "vid": "0xFEED", - "pid": "0x0000", - "device_version": "1.0.0" - }, - "features": { - "bootmagic": true, - "command": false, - "console": false, - "extrakey": true, - "mousekey": true, - "nkro": true - } -} diff --git a/data/templates/keyboard/keyboard.json b/data/templates/keyboard/keyboard.json new file mode 100644 index 0000000000..65f935fb42 --- /dev/null +++ b/data/templates/keyboard/keyboard.json @@ -0,0 +1,25 @@ +{ + "keyboard_name": "%KEYBOARD%", + "maintainer": "%USER_NAME%", + "manufacturer": "%REAL_NAME%", + "processor": "%MCU%", + "bootloader": "%BOOTLOADER%", + "diode_direction": "COL2ROW", + "matrix_pins": { + "cols": ["C2"], + "rows": ["D1"] + }, + "usb": { + "vid": "0xFEED", + "pid": "0x0000", + "device_version": "1.0.0" + }, + "features": { + "bootmagic": true, + "command": false, + "console": false, + "extrakey": true, + "mousekey": true, + "nkro": true + } +} diff --git a/data/templates/keyboard/rules.mk b/data/templates/keyboard/rules.mk deleted file mode 100644 index 6e7633bfe0..0000000000 --- a/data/templates/keyboard/rules.mk +++ /dev/null @@ -1 +0,0 @@ -# This file intentionally left blank diff --git a/keyboards/zvecr/zv48/f401/info.json b/keyboards/zvecr/zv48/f401/info.json deleted file mode 100644 index acd7e83f77..0000000000 --- a/keyboards/zvecr/zv48/f401/info.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "processor": "STM32F401", - "bootloader": "stm32-dfu", - "board": "BLACKPILL_STM32_F401" -} diff --git a/keyboards/zvecr/zv48/f401/keyboard.json b/keyboards/zvecr/zv48/f401/keyboard.json new file mode 100644 index 0000000000..acd7e83f77 --- /dev/null +++ b/keyboards/zvecr/zv48/f401/keyboard.json @@ -0,0 +1,5 @@ +{ + "processor": "STM32F401", + "bootloader": "stm32-dfu", + "board": "BLACKPILL_STM32_F401" +} diff --git a/keyboards/zvecr/zv48/f401/rules.mk b/keyboards/zvecr/zv48/f401/rules.mk deleted file mode 100644 index 4df55cd220..0000000000 --- a/keyboards/zvecr/zv48/f401/rules.mk +++ /dev/null @@ -1,3 +0,0 @@ -# Disable unsupported hardware -AUDIO_SUPPORTED = no -BACKLIGHT_SUPPORTED = no diff --git a/lib/python/qmk/cli/generate/make_dependencies.py b/lib/python/qmk/cli/generate/make_dependencies.py index 9b695e907d..331132a20f 100755 --- a/lib/python/qmk/cli/generate/make_dependencies.py +++ b/lib/python/qmk/cli/generate/make_dependencies.py @@ -18,10 +18,11 @@ from qmk.path import normpath, FileType @cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.') @cli.subcommand('Generates the list of dependencies associated with a keyboard build and its generated files.', hidden=True) def generate_make_dependencies(cli): - """Generates the list of dependent info.json, rules.mk, and config.h files for a keyboard. + """Generates the list of dependent config files for a keyboard. """ interesting_files = [ 'info.json', + 'keyboard.json', 'rules.mk', 'post_rules.mk', 'config.h', diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py index cb50acf8bb..700afc96a6 100644 --- a/lib/python/qmk/cli/new/keyboard.py +++ b/lib/python/qmk/cli/new/keyboard.py @@ -251,7 +251,7 @@ def new_keyboard(cli): # merge in infos community_info = Path(COMMUNITY / f'{default_layout}/info.json') - augment_community_info(community_info, keyboard(kb_name) / community_info.name) + augment_community_info(community_info, keyboard(kb_name) / 'keyboard.json') cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{kb_name}{{fg_green}}.{{fg_reset}}') cli.log.info(f"Build Command: {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.") diff --git a/lib/python/qmk/info.py b/lib/python/qmk/info.py index 13588abdb8..2449284668 100644 --- a/lib/python/qmk/info.py +++ b/lib/python/qmk/info.py @@ -863,7 +863,17 @@ def unknown_processor_rules(info_data, rules): def merge_info_jsons(keyboard, info_data): """Return a merged copy of all the info.json files for a keyboard. """ - for info_file in find_info_json(keyboard): + config_files = find_info_json(keyboard) + + # keyboard.json can only exist at the deepest part of the tree + keyboard_json_count = 0 + for index, info_file in enumerate(config_files): + if Path(info_file).name == 'keyboard.json': + keyboard_json_count += 1 + if index != 0 or keyboard_json_count > 1: + _log_error(info_data, f'Invalid keyboard.json location detected: {info_file}.') + + for info_file in config_files: # Load and validate the JSON data new_info_data = json_load(info_file) @@ -921,7 +931,7 @@ def find_info_json(keyboard): base_path = Path('keyboards') keyboard_path = base_path / keyboard keyboard_parent = keyboard_path.parent - info_jsons = [keyboard_path / 'info.json'] + info_jsons = [keyboard_path / 'info.json', keyboard_path / 'keyboard.json'] # Add DEFAULT_FOLDER before parents, if present rules = rules_mk(keyboard) @@ -933,6 +943,7 @@ def find_info_json(keyboard): if keyboard_parent == base_path: break info_jsons.append(keyboard_parent / 'info.json') + info_jsons.append(keyboard_parent / 'keyboard.json') keyboard_parent = keyboard_parent.parent # Return a list of the info.json files that actually exist diff --git a/lib/python/qmk/keyboard.py b/lib/python/qmk/keyboard.py index b56505d649..0fcc2e868d 100644 --- a/lib/python/qmk/keyboard.py +++ b/lib/python/qmk/keyboard.py @@ -166,9 +166,9 @@ def keyboard_folder_or_all(keyboard): def _find_name(path): - """Determine the keyboard name by stripping off the base_path and rules.mk. + """Determine the keyboard name by stripping off the base_path and filename. """ - return path.replace(base_path, "").replace(os.path.sep + "rules.mk", "") + return path.replace(base_path, "").rsplit(os.path.sep, 1)[0] def keyboard_completer(prefix, action, parser, parsed_args): @@ -181,8 +181,10 @@ def list_keyboards(resolve_defaults=True): """Returns a list of all keyboards - optionally processing any DEFAULT_FOLDER. """ # We avoid pathlib here because this is performance critical code. - kb_wildcard = os.path.join(base_path, "**", "rules.mk") - paths = [path for path in glob(kb_wildcard, recursive=True) if os.path.sep + 'keymaps' + os.path.sep not in path] + paths = [] + for marker in ['rules.mk', 'keyboard.json']: + kb_wildcard = os.path.join(base_path, "**", marker) + paths += [path for path in glob(kb_wildcard, recursive=True) if os.path.sep + 'keymaps' + os.path.sep not in path] found = map(_find_name, paths) if resolve_defaults: diff --git a/lib/python/qmk/path.py b/lib/python/qmk/path.py index 74364ee04b..85a8f48c4f 100644 --- a/lib/python/qmk/path.py +++ b/lib/python/qmk/path.py @@ -15,8 +15,9 @@ def is_keyboard(keyboard_name): if keyboard_name: keyboard_path = QMK_FIRMWARE / 'keyboards' / keyboard_name rules_mk = keyboard_path / 'rules.mk' + keyboard_json = keyboard_path / 'keyboard.json' - return rules_mk.exists() + return rules_mk.exists() or keyboard_json.exists() def under_qmk_firmware(path=Path(os.environ['ORIG_CWD'])): -- cgit v1.2.3 From 6720e9c58c3a239ff0de4be1ff2ad075a0b2c248 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Thu, 14 Mar 2024 10:24:24 +0000 Subject: `qmk new-keyboard` - detach community layout when selecting "none of the above" (#20405) --- lib/python/qmk/cli/new/keyboard.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'lib/python/qmk/cli') diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py index 700afc96a6..37bf2923d6 100644 --- a/lib/python/qmk/cli/new/keyboard.py +++ b/lib/python/qmk/cli/new/keyboard.py @@ -74,6 +74,10 @@ def replace_placeholders(src, dest, tokens): dest.write_text(content) +def replace_string(src, token, value): + src.write_text(src.read_text().replace(token, value)) + + def augment_community_info(src, dest): """Splice in any additional data into info.json """ @@ -218,6 +222,11 @@ def new_keyboard(cli): else: bootloader = select_default_bootloader(mcu) + detach_layout = False + if default_layout == 'none of the above': + default_layout = "ortho_4x4" + detach_layout = True + tokens = { # Comment here is to force multiline formatting 'YEAR': str(date.today().year), 'KEYBOARD': kb_name, @@ -233,10 +242,6 @@ def new_keyboard(cli): for key, value in tokens.items(): cli.echo(f" {key.ljust(10)}: {value}") - # TODO: detach community layout and rename to just "LAYOUT" - if default_layout == 'none of the above': - default_layout = "ortho_4x4" - # begin with making the deepest folder in the tree keymaps_path = keyboard(kb_name) / 'keymaps/' keymaps_path.mkdir(parents=True) @@ -253,6 +258,11 @@ def new_keyboard(cli): community_info = Path(COMMUNITY / f'{default_layout}/info.json') augment_community_info(community_info, keyboard(kb_name) / 'keyboard.json') + # detach community layout and rename to just "LAYOUT" + if detach_layout: + replace_string(keyboard(kb_name) / 'keyboard.json', 'LAYOUT_ortho_4x4', 'LAYOUT') + replace_string(keymaps_path / 'default/keymap.c', 'LAYOUT_ortho_4x4', 'LAYOUT') + cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{kb_name}{{fg_green}}.{{fg_reset}}') cli.log.info(f"Build Command: {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.") cli.log.info(f'Project Location: {{fg_cyan}}{QMK_FIRMWARE}/{keyboard(kb_name)}{{fg_reset}},') -- cgit v1.2.3 From 54c1ae55bfb931a2b095aa97480cb49b3fccfd8f Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Wed, 1 May 2024 02:52:34 +0100 Subject: Align 'qmk lint' argument handling (#23297) --- lib/python/qmk/cli/lint.py | 35 +++++++++++++++-------------------- lib/python/qmk/keyboard.py | 2 ++ 2 files changed, 17 insertions(+), 20 deletions(-) (limited to 'lib/python/qmk/cli') diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py index 7ebb0cf9c4..ba0c3f274c 100644 --- a/lib/python/qmk/cli/lint.py +++ b/lib/python/qmk/cli/lint.py @@ -6,9 +6,9 @@ from milc import cli from qmk.decorators import automagic_keyboard, automagic_keymap from qmk.info import info_json -from qmk.keyboard import keyboard_completer, list_keyboards +from qmk.keyboard import keyboard_completer, keyboard_folder_or_all, is_all_keyboards, list_keyboards from qmk.keymap import locate_keymap, list_keymaps -from qmk.path import is_keyboard, keyboard +from qmk.path import keyboard from qmk.git import git_get_ignored_files from qmk.c_parse import c_source_files @@ -198,39 +198,34 @@ def keyboard_check(kb): @cli.argument('--strict', action='store_true', help='Treat warnings as errors') -@cli.argument('-kb', '--keyboard', completer=keyboard_completer, help='Comma separated list of keyboards to check') +@cli.argument('-kb', '--keyboard', action='append', type=keyboard_folder_or_all, completer=keyboard_completer, help='Keyboard to check. May be passed multiple times.') @cli.argument('-km', '--keymap', help='The keymap to check') -@cli.argument('--all-kb', action='store_true', arg_only=True, help='Check all keyboards') -@cli.argument('--all-km', action='store_true', arg_only=True, help='Check all keymaps') @cli.subcommand('Check keyboard and keymap for common mistakes.') @automagic_keyboard @automagic_keymap def lint(cli): """Check keyboard and keymap for common mistakes. """ - failed = [] - # Determine our keyboard list - if cli.args.all_kb: - if cli.args.keyboard: - cli.log.warning('Both --all-kb and --keyboard passed, --all-kb takes precedence.') - - keyboard_list = list_keyboards() - elif not cli.config.lint.keyboard: - cli.log.error('Missing required arguments: --keyboard or --all-kb') + if not cli.config.lint.keyboard: + cli.log.error('Missing required arguments: --keyboard') cli.print_help() return False + + if isinstance(cli.config.lint.keyboard, str): + # if provided via config - string not array + keyboard_list = [cli.config.lint.keyboard] + elif is_all_keyboards(cli.args.keyboard[0]): + keyboard_list = list_keyboards() else: - keyboard_list = cli.config.lint.keyboard.split(',') + keyboard_list = cli.config.lint.keyboard + + failed = [] # Lint each keyboard for kb in keyboard_list: - if not is_keyboard(kb): - cli.log.error('No such keyboard: %s', kb) - continue - # Determine keymaps to also check - if cli.args.all_km: + if cli.args.keymap == 'all': keymaps = list_keymaps(kb) elif cli.config.lint.keymap: keymaps = {cli.config.lint.keymap} diff --git a/lib/python/qmk/keyboard.py b/lib/python/qmk/keyboard.py index 0fcc2e868d..fcf5b5b158 100644 --- a/lib/python/qmk/keyboard.py +++ b/lib/python/qmk/keyboard.py @@ -99,6 +99,8 @@ def find_keyboard_from_dir(): keymap_index = len(current_path.parts) - current_path.parts.index('keymaps') - 1 current_path = current_path.parents[keymap_index] + current_path = resolve_keyboard(current_path) + if qmk.path.is_keyboard(current_path): return str(current_path) -- cgit v1.2.3