-
-
Notifications
You must be signed in to change notification settings - Fork 38.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
272 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
35 changes: 1 addition & 34 deletions
35
lib/python/qmk/cli/xap/docs.py → lib/python/qmk/cli/xap/generate_docs.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| """This script generates the XAP protocol generated source to be compiled into QMK. | ||
| """ | ||
| import hjson | ||
| import datetime | ||
|
|
||
| from milc import cli | ||
| from qmk.path import normpath | ||
| from qmk.xap import latest_xap_defs | ||
|
|
||
|
|
||
| this_year = datetime.date.today().year | ||
| gpl_header = f'''\ | ||
| /* Copyright {this_year} QMK | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| ''' | ||
|
|
||
| generated = '''\ | ||
| /******************************************************************************* | ||
| 88888888888 888 d8b .d888 d8b 888 d8b | ||
| 888 888 Y8P d88P" Y8P 888 Y8P | ||
| 888 888 888 888 | ||
| 888 88888b. 888 .d8888b 888888 888 888 .d88b. 888 .d8888b | ||
| 888 888 "88b 888 88K 888 888 888 d8P Y8b 888 88K | ||
| 888 888 888 888 "Y8888b. 888 888 888 88888888 888 "Y8888b. | ||
| 888 888 888 888 X88 888 888 888 Y8b. 888 X88 | ||
| 888 888 888 888 88888P' 888 888 888 "Y8888 888 88888P' | ||
| 888 888 | ||
| 888 888 | ||
| 888 888 | ||
| .d88b. .d88b. 88888b. .d88b. 888d888 8888b. 888888 .d88b. .d88888 | ||
| d88P"88b d8P Y8b 888 "88b d8P Y8b 888P" "88b 888 d8P Y8b d88" 888 | ||
| 888 888 88888888 888 888 88888888 888 .d888888 888 88888888 888 888 | ||
| Y88b 888 Y8b. 888 888 Y8b. 888 888 888 Y88b. Y8b. Y88b 888 | ||
| "Y88888 "Y8888 888 888 "Y8888 888 "Y888888 "Y888 "Y8888 "Y88888 | ||
| 888 | ||
| Y8b d88P | ||
| "Y88P" | ||
| *******************************************************************************/ | ||
| ''' | ||
|
|
||
|
|
||
| def _append_defines(lines, route_container, name_stack=[]): | ||
| name_stack.append(route_container['define'].upper()) | ||
| for route_id in route_container['routes']: | ||
| route = route_container['routes'][route_id] | ||
| name_stack.append(route['define'].upper()) | ||
| name_stack_str = ('_'.join(name_stack)).upper() | ||
| if route['type'] == 'router': | ||
| lines.append(f'#define {name_stack_str} {route_id}') | ||
| lines.append('') | ||
| _append_defines(lines, route, name_stack[:-1]) | ||
| lines.append('') | ||
| elif route['type'] == 'command': | ||
| lines.append(f'#define {name_stack_str} {route_id}') | ||
| name_stack.pop() | ||
| name_stack.pop() | ||
|
|
||
|
|
||
| def _append_routing_table(lines, route, name_stack=[]): | ||
| name_stack.append(route['define'].upper()) | ||
| name_stack_str = ('_'.join(name_stack)).lower() | ||
| lines.append(f'static const xap_route_t {name_stack_str}_routes[] = {{') | ||
| for child_id in route['routes']: | ||
| child = route['routes'][child_id] | ||
| name_stack.append(child['define'].upper()) | ||
| name_stack_str = ('_'.join(name_stack)).upper() | ||
| is_secure = 1 if ('secure' in child and child['secure'] == 'true') else 0 | ||
| if child['type'] == 'router': | ||
| lines.append(f' [{name_stack_str}] = {{ .flags = {{ .type = XAP_ROUTE, .is_secure = {is_secure} }}, .child_routes = {name_stack_str.lower()}_routes, .child_routes_len = sizeof({name_stack_str.lower()}_routes)/sizeof({name_stack_str.lower()}_routes[0]) }},') | ||
| elif child['type'] == 'command': | ||
| lines.append(f' [{name_stack_str}] = {{ .flags = {{ .type = XAP_EXECUTE, .is_secure = {is_secure} }}, .handler = &{name_stack_str.lower()}_handler }},') | ||
| name_stack.pop() | ||
| lines.append('};') | ||
| lines.append('') | ||
| name_stack.pop() | ||
|
|
||
|
|
||
| def _append_routing_tables(lines, route_container, name_stack=[]): | ||
| name_stack.append(route_container['define'].upper()) | ||
| for route_id in route_container['routes']: | ||
| route = route_container['routes'][route_id] | ||
| name_stack.append(route['define'].upper()) | ||
| name_stack_str = ('_'.join(name_stack)).upper() | ||
| if route['type'] == 'router': | ||
| _append_routing_tables(lines, route, name_stack[:-1]) | ||
| lines.append('') | ||
| elif route['type'] == 'command': | ||
| lines.append(f'extern bool {name_stack_str.lower()}_handler(xap_token_t token, const uint8_t *data, size_t data_len);') | ||
| lines.append('') | ||
| name_stack.pop() | ||
| name_stack.pop() | ||
| _append_routing_table(lines, route_container, name_stack) | ||
|
|
||
|
|
||
| @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to') | ||
| @cli.subcommand('Generates the XAP protocol include.') | ||
| def xap_generate_qmk_inc(cli): | ||
| """Generates the XAP protocol inline codegen file, generated during normal build. | ||
| """ | ||
| xap_defs = latest_xap_defs() | ||
|
|
||
| xap_generated_inl_lines = [gpl_header, generated] | ||
|
|
||
| # Append the routing tables | ||
| _append_routing_tables(xap_generated_inl_lines, xap_defs) | ||
|
|
||
| xap_generated_inl = '\n'.join(xap_generated_inl_lines) | ||
|
|
||
| if cli.args.output: | ||
| if cli.args.output.name == '-': | ||
| print(xap_generated_inl) | ||
| else: | ||
| cli.args.output.parent.mkdir(parents=True, exist_ok=True) | ||
| if cli.args.output.exists(): | ||
| cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak')) | ||
| cli.args.output.write_text(xap_generated_inl) | ||
|
|
||
|
|
||
| @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to') | ||
| @cli.subcommand('Generates the XAP protocol include.') | ||
| def xap_generate_qmk_h(cli): | ||
| """Generates the XAP protocol header file, generated during normal build. | ||
| """ | ||
| xap_defs = latest_xap_defs() | ||
|
|
||
| xap_generated_inl_lines = [gpl_header, generated] | ||
|
|
||
| # Append the route and command defines | ||
| _append_defines(xap_generated_inl_lines, xap_defs) | ||
|
|
||
| xap_generated_inl = '\n'.join(xap_generated_inl_lines) | ||
|
|
||
| if cli.args.output: | ||
| if cli.args.output.name == '-': | ||
| print(xap_generated_inl) | ||
| else: | ||
| cli.args.output.parent.mkdir(parents=True, exist_ok=True) | ||
| if cli.args.output.exists(): | ||
| cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak')) | ||
| cli.args.output.write_text(xap_generated_inl) |
Oops, something went wrong.