summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/generate
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/generate')
-rw-r--r--lib/python/qmk/cli/generate/autocorrect_data.py289
-rwxr-xr-xlib/python/qmk/cli/generate/config_h.py130
-rwxr-xr-xlib/python/qmk/cli/generate/keyboard_h.py69
-rwxr-xr-xlib/python/qmk/cli/generate/layouts.py90
4 files changed, 395 insertions, 183 deletions
diff --git a/lib/python/qmk/cli/generate/autocorrect_data.py b/lib/python/qmk/cli/generate/autocorrect_data.py
new file mode 100644
index 0000000000..00ab6180ab
--- /dev/null
+++ b/lib/python/qmk/cli/generate/autocorrect_data.py
@@ -0,0 +1,289 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Python program to make autocorrect_data.h.
+This program reads from a prepared dictionary file and generates a C source file
+"autocorrect_data.h" with a serialized trie embedded as an array. Run this
+program and pass it as the first argument like:
+$ qmk generate-autocorrect-data autocorrect_dict.txt
+Each line of the dict file defines one typo and its correction with the syntax
+"typo -> correction". Blank lines or lines starting with '#' are ignored.
+Example:
+ :thier -> their
+ fitler -> filter
+ lenght -> length
+ ouput -> output
+ widht -> width
+For full documentation, see QMK Docs
+"""
+
+import sys
+import textwrap
+from typing import Any, Dict, Iterator, List, Tuple
+
+from milc import cli
+
+import qmk.path
+from qmk.keyboard import keyboard_completer, keyboard_folder
+from qmk.keymap import keymap_completer, locate_keymap
+
+KC_A = 4
+KC_SPC = 0x2c
+KC_QUOT = 0x34
+
+TYPO_CHARS = dict([
+ ("'", KC_QUOT),
+ (':', KC_SPC), # "Word break" character.
+] + [(chr(c), c + KC_A - ord('a')) for c in range(ord('a'),
+ ord('z') + 1)]) # Characters a-z.
+
+
+def parse_file(file_name: str) -> List[Tuple[str, str]]:
+ """Parses autocorrections dictionary file.
+ Each line of the file defines one typo and its correction with the syntax
+ "typo -> correction". Blank lines or lines starting with '#' are ignored. The
+ function validates that typos only have characters a-z and that typos are not
+ substrings of other typos, otherwise the longer typo would never trigger.
+ Args:
+ file_name: String, path of the autocorrections dictionary.
+ Returns:
+ List of (typo, correction) tuples.
+ """
+
+ try:
+ from english_words import english_words_lower_alpha_set as correct_words
+ except ImportError:
+ cli.echo('Autocorrection will falsely trigger when a typo is a substring of a correctly spelled word.')
+ cli.echo('To check for this, install the english_words package and rerun this script:')
+ cli.echo(' {fg_cyan}python3 -m pip install english_words')
+ # Use a minimal word list as a fallback.
+ correct_words = ('information', 'available', 'international', 'language', 'loosest', 'reference', 'wealthier', 'entertainment', 'association', 'provides', 'technology', 'statehood')
+
+ autocorrections = []
+ typos = set()
+ for line_number, typo, correction in parse_file_lines(file_name):
+ if typo in typos:
+ cli.log.warning('{fg_red}Error:%d:{fg_reset} Ignoring duplicate typo: "{fg_cyan}%s{fg_reset}"', line_number, typo)
+ continue
+
+ # Check that `typo` is valid.
+ if not (all([c in TYPO_CHARS for c in typo])):
+ cli.log.error('{fg_red}Error:%d:{fg_reset} Typo "{fg_cyan}%s{fg_reset}" has characters other than a-z, \' and :.', line_number, typo)
+ sys.exit(1)
+ for other_typo in typos:
+ if typo in other_typo or other_typo in typo:
+ cli.log.error('{fg_red}Error:%d:{fg_reset} Typos may not be substrings of one another, otherwise the longer typo would never trigger: "{fg_cyan}%s{fg_reset}" vs. "{fg_cyan}%s{fg_reset}".', line_number, typo, other_typo)
+ sys.exit(1)
+ if len(typo) < 5:
+ cli.log.warning('{fg_yellow}Warning:%d:{fg_reset} It is suggested that typos are at least 5 characters long to avoid false triggers: "{fg_cyan}%s{fg_reset}"', line_number, typo)
+ if len(typo) > 127:
+ cli.log.error('{fg_red}Error:%d:{fg_reset} Typo exceeds 127 chars: "{fg_cyan}%s{fg_reset}"', line_number, typo)
+ sys.exit(1)
+
+ check_typo_against_dictionary(typo, line_number, correct_words)
+
+ autocorrections.append((typo, correction))
+ typos.add(typo)
+
+ return autocorrections
+
+
+def make_trie(autocorrections: List[Tuple[str, str]]) -> Dict[str, Any]:
+ """Makes a trie from the the typos, writing in reverse.
+ Args:
+ autocorrections: List of (typo, correction) tuples.
+ Returns:
+ Dict of dict, representing the trie.
+ """
+ trie = {}
+ for typo, correction in autocorrections:
+ node = trie
+ for letter in typo[::-1]:
+ node = node.setdefault(letter, {})
+ node['LEAF'] = (typo, correction)
+
+ return trie
+
+
+def parse_file_lines(file_name: str) -> Iterator[Tuple[int, str, str]]:
+ """Parses lines read from `file_name` into typo-correction pairs."""
+
+ line_number = 0
+ for line in open(file_name, 'rt'):
+ line_number += 1
+ line = line.strip()
+ if line and line[0] != '#':
+ # Parse syntax "typo -> correction", using strip to ignore indenting.
+ tokens = [token.strip() for token in line.split('->', 1)]
+ if len(tokens) != 2 or not tokens[0]:
+ print(f'Error:{line_number}: Invalid syntax: "{line}"')
+ sys.exit(1)
+
+ typo, correction = tokens
+ typo = typo.lower() # Force typos to lowercase.
+ typo = typo.replace(' ', ':')
+
+ yield line_number, typo, correction
+
+
+def check_typo_against_dictionary(typo: str, line_number: int, correct_words) -> None:
+ """Checks `typo` against English dictionary words."""
+
+ if typo.startswith(':') and typo.endswith(':'):
+ if typo[1:-1] in correct_words:
+ cli.log.warning('{fg_yellow}Warning:%d:{fg_reset} Typo "{fg_cyan}%s{fg_reset}" is a correctly spelled dictionary word.', line_number, typo)
+ elif typo.startswith(':') and not typo.endswith(':'):
+ for word in correct_words:
+ if word.startswith(typo[1:]):
+ cli.log.warning('{fg_yellow}Warning:%d: {fg_reset}Typo "{fg_cyan}%s{fg_reset}" would falsely trigger on correctly spelled word "{fg_cyan}%s{fg_reset}".', line_number, typo, word)
+ elif not typo.startswith(':') and typo.endswith(':'):
+ for word in correct_words:
+ if word.endswith(typo[:-1]):
+ cli.log.warning('{fg_yellow}Warning:%d:{fg_reset} Typo "{fg_cyan}%s{fg_reset}" would falsely trigger on correctly spelled word "{fg_cyan}%s{fg_reset}".', line_number, typo, word)
+ elif not typo.startswith(':') and not typo.endswith(':'):
+ for word in correct_words:
+ if typo in word:
+ cli.log.warning('{fg_yellow}Warning:%d:{fg_reset} Typo "{fg_cyan}%s{fg_reset}" would falsely trigger on correctly spelled word "{fg_cyan}%s{fg_reset}".', line_number, typo, word)
+
+
+def serialize_trie(autocorrections: List[Tuple[str, str]], trie: Dict[str, Any]) -> List[int]:
+ """Serializes trie and correction data in a form readable by the C code.
+ Args:
+ autocorrections: List of (typo, correction) tuples.
+ trie: Dict of dicts.
+ Returns:
+ List of ints in the range 0-255.
+ """
+ table = []
+
+ # Traverse trie in depth first order.
+ def traverse(trie_node):
+ if 'LEAF' in trie_node: # Handle a leaf trie node.
+ typo, correction = trie_node['LEAF']
+ word_boundary_ending = typo[-1] == ':'
+ typo = typo.strip(':')
+ i = 0 # Make the autocorrection data for this entry and serialize it.
+ while i < min(len(typo), len(correction)) and typo[i] == correction[i]:
+ i += 1
+ backspaces = len(typo) - i - 1 + word_boundary_ending
+ assert 0 <= backspaces <= 63
+ correction = correction[i:]
+ bs_count = [backspaces + 128]
+ data = bs_count + list(bytes(correction, 'ascii')) + [0]
+
+ entry = {'data': data, 'links': [], 'byte_offset': 0}
+ table.append(entry)
+ elif len(trie_node) == 1: # Handle trie node with a single child.
+ c, trie_node = next(iter(trie_node.items()))
+ entry = {'chars': c, 'byte_offset': 0}
+
+ # It's common for a trie to have long chains of single-child nodes. We
+ # find the whole chain so that we can serialize it more efficiently.
+ while len(trie_node) == 1 and 'LEAF' not in trie_node:
+ c, trie_node = next(iter(trie_node.items()))
+ entry['chars'] += c
+
+ table.append(entry)
+ entry['links'] = [traverse(trie_node)]
+ else: # Handle trie node with multiple children.
+ entry = {'chars': ''.join(sorted(trie_node.keys())), 'byte_offset': 0}
+ table.append(entry)
+ entry['links'] = [traverse(trie_node[c]) for c in entry['chars']]
+ return entry
+
+ traverse(trie)
+
+ def serialize(e: Dict[str, Any]) -> List[int]:
+ if not e['links']: # Handle a leaf table entry.
+ return e['data']
+ elif len(e['links']) == 1: # Handle a chain table entry.
+ return [TYPO_CHARS[c] for c in e['chars']] + [0] # + encode_link(e['links'][0]))
+ else: # Handle a branch table entry.
+ data = []
+ for c, link in zip(e['chars'], e['links']):
+ data += [TYPO_CHARS[c] | (0 if data else 64)] + encode_link(link)
+ return data + [0]
+
+ byte_offset = 0
+ for e in table: # To encode links, first compute byte offset of each entry.
+ e['byte_offset'] = byte_offset
+ byte_offset += len(serialize(e))
+ assert 0 <= byte_offset <= 0xffff
+
+ return [b for e in table for b in serialize(e)] # Serialize final table.
+
+
+def encode_link(link: Dict[str, Any]) -> List[int]:
+ """Encodes a node link as two bytes."""
+ byte_offset = link['byte_offset']
+ if not (0 <= byte_offset <= 0xffff):
+ cli.log.error('{fg_red}Error:{fg_reset} The autocorrection table is too large, a node link exceeds 64KB limit. Try reducing the autocorrection dict to fewer entries.')
+ sys.exit(1)
+ return [byte_offset & 255, byte_offset >> 8]
+
+
+def write_generated_code(autocorrections: List[Tuple[str, str]], data: List[int], file_name: str) -> None:
+ """Writes autocorrection data as generated C code to `file_name`.
+ Args:
+ autocorrections: List of (typo, correction) tuples.
+ data: List of ints in 0-255, the serialized trie.
+ file_name: String, path of the output C file.
+ """
+ assert all(0 <= b <= 255 for b in data)
+
+ def typo_len(e: Tuple[str, str]) -> int:
+ return len(e[0])
+
+ min_typo = min(autocorrections, key=typo_len)[0]
+ max_typo = max(autocorrections, key=typo_len)[0]
+ generated_code = ''.join([
+ '// Generated code.\n\n', f'// Autocorrection dictionary ({len(autocorrections)} entries):\n', ''.join(sorted(f'// {typo:<{len(max_typo)}} -> {correction}\n' for typo, correction in autocorrections)),
+ f'\n#define AUTOCORRECT_MIN_LENGTH {len(min_typo)} // "{min_typo}"\n', f'#define AUTOCORRECT_MAX_LENGTH {len(max_typo)} // "{max_typo}"\n\n', f'#define DICTIONARY_SIZE {len(data)}\n\n',
+ textwrap.fill('static const uint8_t autocorrect_data[DICTIONARY_SIZE] PROGMEM = {%s};' % (', '.join(map(str, data))), width=120, subsequent_indent=' '), '\n\n'
+ ])
+
+ with open(file_name, 'wt') as f:
+ f.write(generated_code)
+
+
+@cli.argument('filename', default='autocorrect_dict.txt', help='The autocorrection database file')
+@cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
+@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
+@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
+@cli.subcommand('Generate the autocorrection data file from a dictionary file.')
+def generate_autocorrect_data(cli):
+ autocorrections = parse_file(cli.args.filename)
+ trie = make_trie(autocorrections)
+ data = serialize_trie(autocorrections, trie)
+ # Environment processing
+ if cli.args.output == '-':
+ cli.args.output = None
+
+ if cli.args.output:
+ cli.args.output.parent.mkdir(parents=True, exist_ok=True)
+ cli.log.info('Creating autocorrect database at {fg_cyan}%s', cli.args.output)
+ write_generated_code(autocorrections, data, cli.args.output)
+
+ else:
+ current_keyboard = cli.args.keyboard or cli.config.user.keyboard or cli.config.generate_autocorrect_data.keyboard
+ current_keymap = cli.args.keymap or cli.config.user.keymap or cli.config.generate_autocorrect_data.keymap
+
+ if current_keyboard and current_keymap:
+ filename = locate_keymap(current_keyboard, current_keymap).parent / 'autocorrect_data.h'
+ cli.log.info('Creating autocorrect database at {fg_cyan}%s', filename)
+ write_generated_code(autocorrections, data, filename)
+
+ else:
+ write_generated_code(autocorrections, data, 'autocorrect_data.h')
+
+ cli.log.info('Processed %d autocorrection entries to table with %d bytes.', len(autocorrections), len(data))
diff --git a/lib/python/qmk/cli/generate/config_h.py b/lib/python/qmk/cli/generate/config_h.py
index a26dcdf7d7..3752174841 100755
--- a/lib/python/qmk/cli/generate/config_h.py
+++ b/lib/python/qmk/cli/generate/config_h.py
@@ -13,6 +13,14 @@ from qmk.path import normpath
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
+def generate_define(define, value=None):
+ value = f' {value}' if value is not None else ''
+ return f"""
+#ifndef {define}
+# define {define}{value}
+#endif // {define}"""
+
+
def direct_pins(direct_pins, postfix):
"""Return the config.h lines that set the direct pins.
"""
@@ -22,11 +30,7 @@ def direct_pins(direct_pins, postfix):
cols = ','.join(map(str, [col or 'NO_PIN' for col in row]))
rows.append('{' + cols + '}')
- return f"""
-#ifndef DIRECT_PINS{postfix}
-# define DIRECT_PINS{postfix} {{ {", ".join(rows)} }}
-#endif // DIRECT_PINS{postfix}
-"""
+ return generate_define(f'DIRECT_PINS{postfix}', f'{{ {", ".join(rows)} }}')
def pin_array(define, pins, postfix):
@@ -34,11 +38,7 @@ def pin_array(define, pins, postfix):
"""
pin_array = ', '.join(map(str, [pin or 'NO_PIN' for pin in pins]))
- return f"""
-#ifndef {define}_PINS{postfix}
-# define {define}_PINS{postfix} {{ {pin_array} }}
-#endif // {define}_PINS{postfix}
-"""
+ return generate_define(f'{define}_PINS{postfix}', f'{{ {pin_array} }}')
def matrix_pins(matrix_pins, postfix=''):
@@ -62,18 +62,8 @@ def generate_matrix_size(kb_info_json, config_h_lines):
"""Add the matrix size to the config.h.
"""
if 'matrix_pins' in kb_info_json:
- col_count = kb_info_json['matrix_size']['cols']
- row_count = kb_info_json['matrix_size']['rows']
-
- config_h_lines.append(f"""
-#ifndef MATRIX_COLS
-# define MATRIX_COLS {col_count}
-#endif // MATRIX_COLS
-
-#ifndef MATRIX_ROWS
-# define MATRIX_ROWS {row_count}
-#endif // MATRIX_ROWS
-""")
+ config_h_lines.append(generate_define('MATRIX_COLS', kb_info_json['matrix_size']['cols']))
+ config_h_lines.append(generate_define('MATRIX_ROWS', kb_info_json['matrix_size']['rows']))
def generate_config_items(kb_info_json, config_h_lines):
@@ -95,43 +85,23 @@ def generate_config_items(kb_info_json, config_h_lines):
continue
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}')
+ config_h_lines.append(generate_define(config_key, f'{{ {", ".join(["{" + ",".join(list(map(str, x))) + "}" for x in config_value])} }}'))
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))} }}')
- config_h_lines.append(f'#endif // {config_key}')
+ config_h_lines.append(generate_define(config_key, f'{{ {", ".join(map(str, config_value))} }}'))
elif key_type == 'bool':
if config_value:
- config_h_lines.append('')
- config_h_lines.append(f'#ifndef {config_key}')
- config_h_lines.append(f'# define {config_key}')
- config_h_lines.append(f'#endif // {config_key}')
+ config_h_lines.append(generate_define(config_key))
elif key_type == 'mapping':
for key, value in config_value.items():
- config_h_lines.append('')
- config_h_lines.append(f'#ifndef {key}')
- config_h_lines.append(f'# define {key} {value}')
- config_h_lines.append(f'#endif // {key}')
+ config_h_lines.append(generate_define(key, value))
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}')
+ escaped_str = config_value.replace('\\', '\\\\').replace('"', '\\"')
+ config_h_lines.append(generate_define(config_key, f'"{escaped_str}"'))
elif key_type == 'bcd_version':
(major, minor, revision) = config_value.split('.')
- config_h_lines.append('')
- config_h_lines.append(f'#ifndef {config_key}')
- config_h_lines.append(f'# define {config_key} 0x{major.zfill(2)}{minor}{revision}')
- config_h_lines.append(f'#endif // {config_key}')
+ config_h_lines.append(generate_define(config_key, f'0x{major.zfill(2)}{minor}{revision}'))
else:
- 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}')
+ config_h_lines.append(generate_define(config_key, config_value))
def generate_encoder_config(encoder_json, config_h_lines, postfix=''):
@@ -144,24 +114,15 @@ def generate_encoder_config(encoder_json, config_h_lines, postfix=''):
b_pads.append(encoder["pin_b"])
resolutions.append(encoder.get("resolution", None))
- config_h_lines.append(f'#ifndef ENCODERS_PAD_A{postfix}')
- config_h_lines.append(f'# define ENCODERS_PAD_A{postfix} {{ { ", ".join(a_pads) } }}')
- config_h_lines.append(f'#endif // ENCODERS_PAD_A{postfix}')
-
- config_h_lines.append(f'#ifndef ENCODERS_PAD_B{postfix}')
- config_h_lines.append(f'# define ENCODERS_PAD_B{postfix} {{ { ", ".join(b_pads) } }}')
- config_h_lines.append(f'#endif // ENCODERS_PAD_B{postfix}')
+ config_h_lines.append(generate_define(f'ENCODERS_PAD_A{postfix}', f'{{ {", ".join(a_pads)} }}'))
+ config_h_lines.append(generate_define(f'ENCODERS_PAD_B{postfix}', f'{{ {", ".join(b_pads)} }}'))
if None in resolutions:
cli.log.debug("Unable to generate ENCODER_RESOLUTION configuration")
elif len(set(resolutions)) == 1:
- config_h_lines.append(f'#ifndef ENCODER_RESOLUTION{postfix}')
- config_h_lines.append(f'# define ENCODER_RESOLUTION{postfix} { resolutions[0] }')
- config_h_lines.append(f'#endif // ENCODER_RESOLUTION{postfix}')
+ config_h_lines.append(generate_define(f'ENCODER_RESOLUTION{postfix}', resolutions[0]))
else:
- config_h_lines.append(f'#ifndef ENCODER_RESOLUTIONS{postfix}')
- config_h_lines.append(f'# define ENCODER_RESOLUTIONS{postfix} {{ { ", ".join(map(str,resolutions)) } }}')
- config_h_lines.append(f'#endif // ENCODER_RESOLUTIONS{postfix}')
+ config_h_lines.append(generate_define(f'ENCODER_RESOLUTIONS{postfix}', f'{{ {", ".join(map(str,resolutions))} }}'))
def generate_split_config(kb_info_json, config_h_lines):
@@ -170,35 +131,23 @@ def generate_split_config(kb_info_json, config_h_lines):
if kb_info_json['split']['primary'] in ('left', 'right'):
config_h_lines.append('')
config_h_lines.append('#ifndef MASTER_LEFT')
- config_h_lines.append('# ifndef MASTER_RIGHT')
+ config_h_lines.append('# ifndef MASTER_RIGHT')
if kb_info_json['split']['primary'] == 'left':
- config_h_lines.append('# define MASTER_LEFT')
+ config_h_lines.append('# define MASTER_LEFT')
elif kb_info_json['split']['primary'] == 'right':
- config_h_lines.append('# define MASTER_RIGHT')
- config_h_lines.append('# endif // MASTER_RIGHT')
+ config_h_lines.append('# define MASTER_RIGHT')
+ config_h_lines.append('# endif // MASTER_RIGHT')
config_h_lines.append('#endif // MASTER_LEFT')
elif kb_info_json['split']['primary'] == 'pin':
- config_h_lines.append('')
- config_h_lines.append('#ifndef SPLIT_HAND_PIN')
- config_h_lines.append('# define SPLIT_HAND_PIN')
- config_h_lines.append('#endif // SPLIT_HAND_PIN')
+ config_h_lines.append(generate_define('SPLIT_HAND_PIN'))
elif kb_info_json['split']['primary'] == 'matrix_grid':
- config_h_lines.append('')
- config_h_lines.append('#ifndef SPLIT_HAND_MATRIX_GRID')
- config_h_lines.append('# define SPLIT_HAND_MATRIX_GRID {%s}' % (','.join(kb_info_json["split"]["matrix_grid"],)))
- config_h_lines.append('#endif // SPLIT_HAND_MATRIX_GRID')
+ config_h_lines.append(generate_define('SPLIT_HAND_MATRIX_GRID', f'{{ {",".join(kb_info_json["split"]["matrix_grid"])} }}'))
elif kb_info_json['split']['primary'] == 'eeprom':
- config_h_lines.append('')
- config_h_lines.append('#ifndef EE_HANDS')
- config_h_lines.append('# define EE_HANDS')
- config_h_lines.append('#endif // EE_HANDS')
+ config_h_lines.append(generate_define('EE_HANDS'))
if 'protocol' in kb_info_json['split'].get('transport', {}):
if kb_info_json['split']['transport']['protocol'] == 'i2c':
- config_h_lines.append('')
- config_h_lines.append('#ifndef USE_I2C')
- config_h_lines.append('# define USE_I2C')
- config_h_lines.append('#endif // USE_I2C')
+ config_h_lines.append(generate_define('USE_I2C'))
if 'right' in kb_info_json['split'].get('matrix_pins', {}):
config_h_lines.append(matrix_pins(kb_info_json['split']['matrix_pins']['right'], '_RIGHT'))
@@ -207,6 +156,12 @@ def generate_split_config(kb_info_json, config_h_lines):
generate_encoder_config(kb_info_json['split']['encoder']['right'], config_h_lines, '_RIGHT')
+def generate_led_animations_config(led_feature_json, config_h_lines, prefix):
+ for animation in led_feature_json.get('animations', {}):
+ if led_feature_json['animations'][animation]:
+ config_h_lines.append(generate_define(f'{prefix}{animation.upper()}'))
+
+
@cli.argument('-o', '--output', arg_only=True, type=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('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='Keyboard to generate config.h for.')
@@ -237,5 +192,14 @@ def generate_config_h(cli):
if 'split' in kb_info_json:
generate_split_config(kb_info_json, config_h_lines)
+ if 'led_matrix' in kb_info_json:
+ generate_led_animations_config(kb_info_json['led_matrix'], config_h_lines, 'ENABLE_LED_MATRIX_')
+
+ if 'rgb_matrix' in kb_info_json:
+ generate_led_animations_config(kb_info_json['rgb_matrix'], config_h_lines, 'ENABLE_RGB_MATRIX_')
+
+ if 'rgblight' in kb_info_json:
+ generate_led_animations_config(kb_info_json['rgblight'], config_h_lines, 'RGBLIGHT_EFFECT_')
+
# Show the results
dump_lines(cli.args.output, config_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/generate/keyboard_h.py b/lib/python/qmk/cli/generate/keyboard_h.py
index 54ddb4cffd..910bd6a08d 100755
--- a/lib/python/qmk/cli/generate/keyboard_h.py
+++ b/lib/python/qmk/cli/generate/keyboard_h.py
@@ -1,33 +1,72 @@
"""Used by the make system to generate keyboard.h from info.json.
"""
+from pathlib import Path
+
from milc import cli
+from qmk.path import normpath
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
+from qmk.constants import COL_LETTERS, ROW_LETTERS, GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
-def would_populate_layout_h(keyboard):
- """Detect if a given keyboard is doing data driven layouts
+def _generate_layouts(keyboard):
+ """Generates the layouts.h file.
"""
# Build the info.json file
kb_info_json = info_json(keyboard)
+ if 'matrix_size' not in kb_info_json:
+ cli.log.error(f'{keyboard}: Invalid matrix config.')
+ return []
+
+ col_num = kb_info_json['matrix_size']['cols']
+ row_num = kb_info_json['matrix_size']['rows']
+
+ lines = []
for layout_name in kb_info_json['layouts']:
if kb_info_json['layouts'][layout_name]['c_macro']:
continue
if 'matrix' not in kb_info_json['layouts'][layout_name]['layout'][0]:
- cli.log.debug('%s/%s: No matrix data!', keyboard, layout_name)
+ cli.log.debug(f'{keyboard}/{layout_name}: No matrix data!')
continue
- return True
+ layout_keys = []
+ layout_matrix = [['KC_NO' for i in range(col_num)] for i in range(row_num)]
+
+ for i, key in enumerate(kb_info_json['layouts'][layout_name]['layout']):
+ row = key['matrix'][0]
+ col = key['matrix'][1]
+ identifier = 'k%s%s' % (ROW_LETTERS[row], COL_LETTERS[col])
- return False
+ try:
+ layout_matrix[row][col] = identifier
+ layout_keys.append(identifier)
+ except IndexError:
+ key_name = key.get('label', identifier)
+ cli.log.error(f'Matrix data out of bounds for layout {layout_name} at index {i} ({key_name}): [{row}, {col}]')
+ return []
+ lines.append('')
+ lines.append('#define %s(%s) {\\' % (layout_name, ', '.join(layout_keys)))
+ rows = ', \\\n'.join(['\t {' + ', '.join(row) + '}' for row in layout_matrix])
+ rows += ' \\'
+ lines.append(rows)
+ lines.append('}')
+
+ for alias, target in kb_info_json.get('layout_aliases', {}).items():
+ lines.append('')
+ lines.append(f'#ifndef {alias}')
+ lines.append(f'# define {alias} {target}')
+ lines.append('#endif')
+
+ return lines
+
+
+@cli.argument('-i', '--include', nargs='?', arg_only=True, help='Optional file to include')
@cli.argument('-o', '--output', arg_only=True, type=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('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='Keyboard to generate keyboard.h for.')
@@ -35,13 +74,23 @@ def would_populate_layout_h(keyboard):
def generate_keyboard_h(cli):
"""Generates the keyboard.h file.
"""
- has_layout_h = would_populate_layout_h(cli.args.keyboard)
+ keyboard_h = cli.args.include
+ dd_layouts = _generate_layouts(cli.args.keyboard)
+ valid_config = dd_layouts or keyboard_h
# Build the layouts.h file.
keyboard_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '#include "quantum.h"']
- if not has_layout_h:
- keyboard_h_lines.append('#error("<keyboard>.h is only optional for data driven keyboards - kb.h == bad times")')
+ keyboard_h_lines.append('')
+ keyboard_h_lines.append('// Layout content')
+ if dd_layouts:
+ keyboard_h_lines.extend(dd_layouts)
+ if keyboard_h:
+ keyboard_h_lines.append(f'#include "{Path(keyboard_h).name}"')
+
+ # Protect against poorly configured keyboards
+ if not valid_config:
+ keyboard_h_lines.append('#error("<keyboard>.h is required unless your keyboard uses data-driven configuration. Please rename your keyboard\'s header file to <keyboard>.h")')
# Show the results
dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/generate/layouts.py b/lib/python/qmk/cli/generate/layouts.py
deleted file mode 100755
index 193633baf6..0000000000
--- a/lib/python/qmk/cli/generate/layouts.py
+++ /dev/null
@@ -1,90 +0,0 @@
-"""Used by the make system to generate layouts.h from info.json.
-"""
-from milc import cli
-
-from qmk.constants import COL_LETTERS, ROW_LETTERS, GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
-from qmk.decorators import automagic_keyboard, automagic_keymap
-from qmk.info import info_json
-from qmk.keyboard import keyboard_completer, keyboard_folder
-from qmk.path import is_keyboard, normpath
-from qmk.commands import dump_lines
-
-usb_properties = {
- 'vid': 'VENDOR_ID',
- 'pid': 'PRODUCT_ID',
- 'device_ver': 'DEVICE_VER',
-}
-
-
-@cli.argument('-o', '--output', arg_only=True, type=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('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate config.h for.')
-@cli.subcommand('Used by the make system to generate layouts.h from info.json', hidden=True)
-@automagic_keyboard
-@automagic_keymap
-def generate_layouts(cli):
- """Generates the layouts.h file.
- """
- # Determine our keyboard(s)
- if not cli.config.generate_layouts.keyboard:
- cli.log.error('Missing parameter: --keyboard')
- cli.subcommands['info'].print_help()
- return False
-
- if not is_keyboard(cli.config.generate_layouts.keyboard):
- cli.log.error('Invalid keyboard: "%s"', cli.config.generate_layouts.keyboard)
- return False
-
- # Build the info.json file
- kb_info_json = info_json(cli.config.generate_layouts.keyboard)
-
- # Build the layouts.h file.
- layouts_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
-
- if 'matrix_size' not in kb_info_json:
- cli.log.error('%s: Invalid matrix config.', cli.config.generate_layouts.keyboard)
- return False
-
- col_num = kb_info_json['matrix_size']['cols']
- row_num = kb_info_json['matrix_size']['rows']
-
- for layout_name in kb_info_json['layouts']:
- if kb_info_json['layouts'][layout_name]['c_macro']:
- continue
-
- if 'matrix' not in kb_info_json['layouts'][layout_name]['layout'][0]:
- cli.log.debug('%s/%s: No matrix data!', cli.config.generate_layouts.keyboard, layout_name)
- continue
-
- layout_keys = []
- layout_matrix = [['KC_NO' for i in range(col_num)] for i in range(row_num)]
-
- for i, key in enumerate(kb_info_json['layouts'][layout_name]['layout']):
- row = key['matrix'][0]
- col = key['matrix'][1]
- identifier = 'k%s%s' % (ROW_LETTERS[row], COL_LETTERS[col])
-
- try:
- layout_matrix[row][col] = identifier
- layout_keys.append(identifier)
- except IndexError:
- key_name = key.get('label', identifier)
- cli.log.error('Matrix data out of bounds for layout %s at index %s (%s): %s, %s', layout_name, i, key_name, row, col)
- return False
-
- layouts_h_lines.append('')
- layouts_h_lines.append('#define %s(%s) {\\' % (layout_name, ', '.join(layout_keys)))
-
- rows = ', \\\n'.join(['\t {' + ', '.join(row) + '}' for row in layout_matrix])
- rows += ' \\'
- layouts_h_lines.append(rows)
- layouts_h_lines.append('}')
-
- for alias, target in kb_info_json.get('layout_aliases', {}).items():
- layouts_h_lines.append('')
- layouts_h_lines.append(f'#ifndef {alias}')
- layouts_h_lines.append(f'# define {alias} {target}')
- layouts_h_lines.append('#endif')
-
- # Show the results
- dump_lines(cli.args.output, layouts_h_lines, cli.args.quiet)