mkbd65/qmk-firmware
Watch
1
0
Fork
You've already forked qmk-firmware
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Preprocessor guards, OS detection hooks.

Browse source
This commit is contained in:
Nick Brassel 2025-01-22 17:00:06 +11:00
commit fe3eac28ba
No known key found for this signature in database
3 changed files with 67 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

87
lib/python/qmk/cli/generate/community_modules.py
View file

@ -1,3 +1,4 @@
import contextlib
from argcomplete.completers import FilesCompleter
from milc import cli
@ -16,20 +17,30 @@ class ModuleAPI(AttrDict):
MODULE_API_LIST = [
ModuleAPI(ret_type='void', name='keyboard_pre_init', args='void', call_params='', ret_val=None),
ModuleAPI(ret_type='void', name='keyboard_post_init', args='void', call_params='', ret_val=None),
ModuleAPI(ret_type='bool', name='pre_process_record', args='uint16_t keycode, keyrecord_t *record', call_params='keycode, record', ret_val='true'),
ModuleAPI(ret_type='bool', name='process_record', args='uint16_t keycode, keyrecord_t *record', call_params='keycode, record', ret_val='true'),
ModuleAPI(ret_type='void', name='post_process_record', args='uint16_t keycode, keyrecord_t *record', call_params='keycode, record', ret_val=None),
ModuleAPI(ret_type='void', name='housekeeping_task', args='void', call_params='', ret_val=None),
ModuleAPI(ret_type='void', name='suspend_power_down', args='void', call_params='', ret_val=None),
ModuleAPI(ret_type='void', name='suspend_wakeup_init', args='void', call_params='', ret_val=None),
ModuleAPI(ret_type='bool', name='shutdown', args='bool jump_to_bootloader', call_params='jump_to_bootloader', ret_val='true'),
ModuleAPI(ret_type='void', name='keyboard_pre_init', args='void', call_params='', ret_val=None, guard=None),
ModuleAPI(ret_type='void', name='keyboard_post_init', args='void', call_params='', ret_val=None, guard=None),
ModuleAPI(ret_type='bool', name='pre_process_record', args='uint16_t keycode, keyrecord_t *record', call_params='keycode, record', ret_val='true', guard=None),
ModuleAPI(ret_type='bool', name='process_record', args='uint16_t keycode, keyrecord_t *record', call_params='keycode, record', ret_val='true', guard=None),
ModuleAPI(ret_type='void', name='post_process_record', args='uint16_t keycode, keyrecord_t *record', call_params='keycode, record', ret_val=None, guard=None),
ModuleAPI(ret_type='void', name='housekeeping_task', args='void', call_params='', ret_val=None, guard=None),
ModuleAPI(ret_type='void', name='suspend_power_down', args='void', call_params='', ret_val=None, guard=None),
ModuleAPI(ret_type='void', name='suspend_wakeup_init', args='void', call_params='', ret_val=None, guard=None),
ModuleAPI(ret_type='bool', name='shutdown', args='bool jump_to_bootloader', call_params='jump_to_bootloader', ret_val='true', guard=None),
ModuleAPI(ret_type='bool', name='process_detected_host_os', args='os_variant_t os', call_params='os', ret_val='true', guard="defined(OS_DETECTION_ENABLE)"),
]
MODULE_API_VERSION = '20250122'
@contextlib.contextmanager
def api_guard(lines, api):
if api.guard:
lines.append(f'#if {api.guard}')
yield
if api.guard:
lines.append(f'#endif // {api.guard}')
@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')
@ -48,22 +59,31 @@ def generate_community_modules_h(cli):
'#include <stdbool.h>',
'',
f'#define COMMUNITY_MODULES_API_VERSION {MODULE_API_VERSION}',
f'#define ASSERT_COMMUNITY_MODULES_API_VERSION(x) _Static_assert((x) <= COMMUNITY_MODULES_API_VERSION, "Modules API mismatch, module requires higher version of QMK with API >= {MODULE_API_VERSION}.")',
f'#define ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(x) _Static_assert((x) <= COMMUNITY_MODULES_API_VERSION, "Community module requires higher version of QMK modules API -- needs: " #x ", current: {MODULE_API_VERSION}.")',
'',
'#ifdef OS_DETECTION_ENABLE',
'#include "os_detection.h"',
'#endif // OS_DETECTION_ENABLE',
'',
'typedef struct keyrecord_t keyrecord_t;',
]
keymap_json = parse_configurator_json(cli.args.filename)
if keymap_json and 'modules' in keymap_json:
for module in keymap_json['modules']:
lines.append('')
lines.append(f'// From module: {module}')
for api in MODULE_API_LIST:
lines.append(f'{api.ret_type} {api.name}_{module}({api.args});')
with api_guard(lines, api):
lines.append(f'{api.ret_type} {api.name}_{module}({api.args});')
lines.append('')
lines.append(f'// Parent implementation')
lines.append('// Core wrapper')
for api in MODULE_API_LIST:
lines.append(f'{api.ret_type} {api.name}_modules({api.args});')
with api_guard(lines, api):
lines.append(f'{api.ret_type} {api.name}_modules({api.args});')
dump_lines(cli.args.output, lines, cli.args.quiet, remove_repeated_newlines=True)
@ -77,29 +97,40 @@ def generate_community_modules_c(cli):
if cli.args.output and cli.args.output.name == '-':
cli.args.output = None
lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '', '#include "community_modules.h"']
lines = [
GPL2_HEADER_C_LIKE,
GENERATED_HEADER_C_LIKE,
'',
'#include "community_modules.h"',
]
keymap_json = parse_configurator_json(cli.args.filename)
if keymap_json and 'modules' in keymap_json:
for module in keymap_json['modules']:
lines.append('')
for api in MODULE_API_LIST:
lines.append('')
lines.append(f'__attribute__((weak)) {api.ret_type} {api.name}_{module}({api.args}) {{')
if api.ret_val:
lines.append(f' return {api.ret_val};')
lines.append('}')
with api_guard(lines, api):
lines.append(f'__attribute__((weak)) {api.ret_type} {api.name}_{module}({api.args}) {{')
if api.ret_val:
lines.append(f' return {api.ret_val};')
lines.append('}')
for api in MODULE_API_LIST:
lines.append('')
lines.append(f'{api.ret_type} {api.name}_modules({api.args}) {{')
if api.ret_type == 'bool':
lines.append(' return true')
for module in keymap_json['modules']:
with api_guard(lines, api):
lines.append(f'{api.ret_type} {api.name}_modules({api.args}) {{')
if api.ret_type == 'bool':
lines.append(f' && {api.name}_{module}({api.call_params})')
else:
lines.append(f' {api.name}_{module}({api.call_params});')
if api.ret_type == 'bool':
lines.append(' ;')
lines.append('}')
lines.append(' return true')
for module in keymap_json['modules']:
if api.ret_type == 'bool':
lines.append(f' && {api.name}_{module}({api.call_params})')
else:
lines.append(f' {api.name}_{module}({api.call_params});')
if api.ret_type == 'bool':
lines.append(' ;')
lines.append('}')
dump_lines(cli.args.output, lines, cli.args.quiet, remove_repeated_newlines=True)