gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-04-30 11:01:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Jinja2 cleanup.

Browse Source
This commit is contained in:
Nick Brassel 2023-01-06 13:49:37 +11:00
parent 2017ffa59a
commit 03c47d295e
No known key found for this signature in database
4 changed files with 95 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
data/templates/xap/firmware/xap_generated.h.j2
View File

@ -3,6 +3,7 @@
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
#include <stdbool.h>
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Versions and identifiers // Versions and identifiers
@ -15,119 +16,119 @@
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Response flag definitions // Response flag definitions
{% for bit,data in xap.response_flags.bits | dictsort -%} {% for bit,data in xap.response_flags.bits | dictsort %}
#define {{ xap.response_flags.define_prefix }}_{{ data.define | to_snake | upper }} (UINT32_C(1) << ({{ bit }})) #define {{ xap.response_flags.define_prefix }}_{{ data.define | to_snake | upper }} (UINT32_C(1) << ({{ bit }}))
{% endfor -%} {% endfor %}
#define {{ xap.response_flags.define_prefix }}_FAILED 0x00 #define {{ xap.response_flags.define_prefix }}_FAILED 0x00
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Broadcast message definitions // Broadcast message definitions
{% for message_id,data in xap.broadcast_messages.messages | dictsort -%} {% for message_id,data in xap.broadcast_messages.messages | dictsort %}
#define {{ xap.broadcast_messages.define_prefix }}_{{ data.define | to_snake | upper }} {{ message_id }} #define {{ xap.broadcast_messages.define_prefix }}_{{ data.define | to_snake | upper }} {{ message_id }}
{% if 'return_type' in data -%} {% if 'return_type' in data %}
void {{ xap.broadcast_messages.define_prefix | lower }}_{{ data.define | to_snake | lower }}({{ data.return_type | type_to_c('value') }}); void {{ xap.broadcast_messages.define_prefix | lower }}_{{ data.define | to_snake | lower }}({{ data.return_type | type_to_c('value') }});
{% else -%} {% else %}
void {{ xap.broadcast_messages.define_prefix | lower }}_{{ data.define | to_snake | lower }}(const void *data, size_t length); void {{ xap.broadcast_messages.define_prefix | lower }}_{{ data.define | to_snake | lower }}(const void *data, size_t length);
{% endif %} {% endif %}
{% endfor -%} {% endfor %}
#define XAP_BROADCAST_TOKEN 0xFFFF #define XAP_BROADCAST_TOKEN 0xFFFF
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Type definitions // Type definitions
{% for name,data in xap.type_definitions | dictsort -%} {% for name,data in xap.type_definitions | dictsort %}
{% if data.type != 'struct' -%} {% if data.type != 'struct' %}
typedef {{ data.type | type_to_c('xap_'+(name|to_snake|lower)+'_t') }}; typedef {{ data.type | type_to_c('xap_'+(name|to_snake|lower)+'_t') }};
{% endif -%} {% endif %}
{% endfor %} {% endfor %}
{%- for name,data in xap.type_definitions | dictsort %} {% for name,data in xap.type_definitions | dictsort %}
{% if data.type == 'struct' -%} {% if data.type == 'struct' %}
typedef struct { typedef struct {
{%- for member in data.struct_members %} {% for member in data.struct_members %}
{{ member.type | type_to_c(member.name) }}; {{ member.type | type_to_c(member.name) }};
{%- endfor %} {% endfor %}
} __attribute__((__packed__)) xap_{{ name | to_snake | lower }}_t{{ data.type | type_to_c_after }}; } __attribute__((__packed__)) xap_{{ name | to_snake | lower }}_t{{ data.type | type_to_c_after }};
_Static_assert(sizeof(xap_{{ name | to_snake | lower }}_t) == {{ data.struct_length }}, "xap_{{ name | to_snake | lower }}_t needs to be {{ data.struct_length }} bytes in size"); _Static_assert(sizeof(xap_{{ name | to_snake | lower }}_t) == {{ data.struct_length }}, "xap_{{ name | to_snake | lower }}_t needs to be {{ data.struct_length }} bytes in size");
{%- endif -%} {% endif %}
{% endfor %} {% endfor %}
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Route definitions // Route definitions
{% macro export_route_types(prefix, container) -%} {% macro export_route_types(prefix, container) %}
{%- if 'routes' in container -%} {% if 'routes' in container %}
{% for route, data in container.routes | dictsort -%} {% for route, data in container.routes | dictsort %}
{%- set this_prefix_uc = (prefix + '_' + data.define) | upper -%} {% set this_prefix_uc = (prefix + '_' + data.define) | upper %}
{%- set this_prefix_lc = this_prefix_uc | lower -%} {% set this_prefix_lc = this_prefix_uc | lower %}
{% if 'request_struct_members' in data -%} {% if 'request_struct_members' in data %}
typedef struct { typedef struct {
{%- for member in data.request_struct_members %} {% for member in data.request_struct_members %}
{{ member.type | type_to_c(member.name|lower) }}; {{ member.type | type_to_c(member.name|lower) }};
{%- endfor %} {% endfor %}
} __attribute__((__packed__)) {{ this_prefix_lc | to_snake | lower }}_arg_t; } __attribute__((__packed__)) {{ this_prefix_lc | to_snake | lower }}_arg_t;
_Static_assert(sizeof({{ this_prefix_lc | to_snake | lower }}_arg_t) == {{ data.request_struct_length }}, "{{ this_prefix_lc | to_snake | lower }}_arg_t needs to be {{ data.request_struct_length }} bytes in size"); _Static_assert(sizeof({{ this_prefix_lc | to_snake | lower }}_arg_t) == {{ data.request_struct_length }}, "{{ this_prefix_lc | to_snake | lower }}_arg_t needs to be {{ data.request_struct_length }} bytes in size");
{% elif 'request_type' in data -%} {% elif 'request_type' in data %}
typedef {{ data.request_type | type_to_c(this_prefix_lc+'_arg_t') }}; typedef {{ data.request_type | type_to_c(this_prefix_lc+'_arg_t') }};
{%- endif -%} {% endif %}
{%- if 'return_struct_members' in data -%} {% if 'return_struct_members' in data %}
typedef struct { typedef struct {
{%- for member in data.return_struct_members %} {% for member in data.return_struct_members %}
{{ member.type | type_to_c(member.name|lower) }}; {{ member.type | type_to_c(member.name|lower) }};
{%- endfor %} {% endfor %}
} __attribute__((__packed__)) {{ this_prefix_lc | to_snake | lower }}_t; } __attribute__((__packed__)) {{ this_prefix_lc | to_snake | lower }}_t;
_Static_assert(sizeof({{ this_prefix_lc | to_snake | lower }}_t) == {{ data.return_struct_length }}, "{{ this_prefix_lc | to_snake | lower }}_t needs to be {{ data.return_struct_length }} bytes in size"); _Static_assert(sizeof({{ this_prefix_lc | to_snake | lower }}_t) == {{ data.return_struct_length }}, "{{ this_prefix_lc | to_snake | lower }}_t needs to be {{ data.return_struct_length }} bytes in size");
{%- elif 'return_type' in data -%} {% elif 'return_type' in data %}
{%- if '[' in data.return_type %} {% if '[' in data.return_type %}
typedef struct __attribute__((__packed__)) { {{ data.return_type | type_to_c('x') }}; } {{ this_prefix_lc }}_t; typedef struct __attribute__((__packed__)) { {{ data.return_type | type_to_c('x') }}; } {{ this_prefix_lc }}_t;
{%- else -%} {% else %}
typedef {{ data.return_type | type_to_c(this_prefix_lc+'_t') }}; typedef {{ data.return_type | type_to_c(this_prefix_lc+'_t') }};
{%- endif -%} {% endif %}
{%- endif %} {% endif %}
{{ export_route_types(this_prefix_lc, data) }} {{ export_route_types(this_prefix_lc, data) }}
{% endfor -%} {% endfor %}
{%- endif -%} {% endif %}
{%- endmacro -%} {% endmacro %}
{{ export_route_types('xap_route', xap) }} {{ export_route_types('xap_route', xap) }}
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Capabilities IDs // Capabilities IDs
{% macro export_route_ids(prefix, container) -%} {% macro export_route_ids(prefix, container) %}
{%- if 'routes' in container -%} {% if 'routes' in container %}
{% for route, data in container.routes | dictsort -%} {% for route, data in container.routes | dictsort %}
{%- set this_prefix_uc = (prefix + '_' + data.define) | upper -%} {% set this_prefix_uc = (prefix + '_' + data.define) | upper %}
{%- set this_prefix_lc = this_prefix_uc | lower -%} {% set this_prefix_lc = this_prefix_uc | lower %}
#define {{ this_prefix_uc }} {{ route }} #define {{ this_prefix_uc }} {{ route }}
{{ export_route_ids(this_prefix_uc, data) }} {{ export_route_ids(this_prefix_uc, data) }}
{%- endfor -%} {% endfor %}
{%- endif -%} {% endif %}
{%- endmacro -%} {% endmacro %}
{{ export_route_ids('XAP_ROUTE', xap) }} {{ export_route_ids('XAP_ROUTE', xap) }}
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Capabilities Masks // Capabilities Masks
{% macro export_route_masks(prefix, container, preprocessor_condition) -%} {% macro export_route_masks(prefix, container, preprocessor_condition) %}
{%- if 'routes' in container -%} {% if 'routes' in container %}
{% for route, data in container.routes | dictsort -%} {% for route, data in container.routes | dictsort %}
{%- set this_prefix_uc = (prefix + '_' + data.define) | upper -%} {% set this_prefix_uc = (prefix + '_' + data.define) | upper %}
{%- set this_prefix_lc = this_prefix_uc | lower -%} {% set this_prefix_lc = this_prefix_uc | lower %}
{% if 'enable_if_preprocessor' in data %} {% if 'enable_if_preprocessor' in data %}
{% if preprocessor_condition == 'TRUE' %} {% if preprocessor_condition == 'TRUE' %}
{%- set condition = "(" + data.enable_if_preprocessor + ")" -%} {% set condition = "(" + data.enable_if_preprocessor + ")" %}
{% else %} {% else %}
{%- set condition = "(" + preprocessor_condition + " && (" + data.enable_if_preprocessor + "))" -%} {% set condition = "(" + preprocessor_condition + " && (" + data.enable_if_preprocessor + "))" %}
{% endif %} {% endif %}
{% else %} {% else %}
{%- set condition = preprocessor_condition -%} {% set condition = preprocessor_condition %}
{% endif %} {% endif %}
{% if condition == 'TRUE' %} {% if condition == 'TRUE' %}
#define {{ this_prefix_uc }}_MASK (UINT32_C(1) << ({{ this_prefix_uc }})) #define {{ this_prefix_uc }}_MASK (UINT32_C(1) << ({{ this_prefix_uc }}))
@ -139,28 +140,28 @@ typedef {{ data.return_type | type_to_c(this_prefix_lc+'_t') }};
#endif // ({{ condition }}) #endif // ({{ condition }})
{% endif %} {% endif %}
{{ export_route_masks(this_prefix_uc, data, condition) }} {{ export_route_masks(this_prefix_uc, data, condition) }}
{%- endfor -%} {% endfor %}
{%- endif -%} {% endif %}
{%- endmacro -%} {% endmacro %}
{{ export_route_masks('XAP_ROUTE', xap, 'TRUE') }} {{ export_route_masks('XAP_ROUTE', xap, 'TRUE') }}
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Capabilities Values // Capabilities Values
{% macro export_route_capabilities(prefix, container) -%} {% macro export_route_capabilities(prefix, container) %}
{%- if 'routes' in container -%} {% if 'routes' in container %}
#define {{ prefix }}_CAPABILITIES (0 \ #define {{ prefix }}_CAPABILITIES (0 \
{% for route, data in container.routes | dictsort -%} {% for route, data in container.routes | dictsort %}
{%- set this_prefix_uc = (prefix + '_' + data.define) | upper -%} {% set this_prefix_uc = (prefix + '_' + data.define) | upper %}
| ({{ this_prefix_uc }}_MASK) \ | ({{ this_prefix_uc }}_MASK) \
{% endfor -%} {% endfor %}
) )
{% for route, data in container.routes | dictsort -%} {% for route, data in container.routes | dictsort %}
{%- set this_prefix_uc = (prefix + '_' + data.define) | upper -%} {% set this_prefix_uc = (prefix + '_' + data.define) | upper %}
{{ export_route_capabilities(this_prefix_uc, data) }} {{ export_route_capabilities(this_prefix_uc, data) }}
{% endfor -%} {% endfor %}
{%- endif -%} {% endif %}
{%- endmacro -%} {% endmacro %}
{{ export_route_capabilities('XAP_ROUTE', xap) }} {{ export_route_capabilities('XAP_ROUTE', xap) }}

30
data/templates/xap/firmware/xap_generated.inl.j2
View File

@ -4,6 +4,32 @@
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// Full XAP {{ xap.version }} definitions // Full XAP {{ xap.version }} definitions
{% for message_id,data in xap.broadcast_messages.messages | dictsort %}
{% if 'return_type' in data %}
void {{ xap.broadcast_messages.define_prefix | lower }}_{{ data.define | to_snake | lower }}({{ data.return_type | type_to_c('value') }}) { xap_broadcast({{ message_id }}, &value, sizeof(value)); }
{% else %}
void {{ xap.broadcast_messages.define_prefix | lower }}_{{ data.define | to_snake | lower }}(const void *data, size_t length) { xap_broadcast({{ message_id }}, data, length); }
{% endif %}
{% endfor %}
{% macro append_routing_table(prefix, container, route_stack) %}
{% set this_route_stack = route_stack.copy() %}
{{ this_route_stack.append(container) }}
{% set stack_names = this_route_stack | map(attribute='name') | join(', ') %}
Stack names: {{ stack_names }}
{% if 'routes' in container %}
{% for route, data in container.routes | dictsort %}
{% set this_prefix_uc = (prefix + '_' + data.define) | upper %}
{% set this_prefix_lc = this_prefix_uc | lower %}
{{ append_routing_table(this_prefix_lc, data, this_route_stack) }}
Inner route prefix for {{ prefix }}: {{ this_prefix_lc }}
{% endfor %}
{% endif %}
Prefix: {{ prefix }}
{% endmacro %}
{{ append_routing_table("xap_route", xap, []) }}
#if 0 #if 0
{{ xap | tojson(4) }} {{ xap | tojson(indent=4) }}
#endif #endif

2
lib/python/qmk/cli/xap/generate_qmk.py
View File

@ -29,7 +29,7 @@ def xap_generate_qmk_inc(cli):
generate_inline(cli.args.output, cli.args.keyboard, cli.args.keymap) generate_inline(cli.args.output, cli.args.keyboard, cli.args.keymap)
defs = merge_xap_defs(cli.args.keyboard, cli.args.keymap) defs = merge_xap_defs(cli.args.keyboard, cli.args.keymap)
with open(normpath(str(cli.args.output.resolve()) + '.generated.j2'), 'w', encoding='utf-8') as out_file: with open(normpath(str(cli.args.output.resolve()) + '.generated.j2.c'), 'w', encoding='utf-8') as out_file:
r = render_xap_output('firmware', 'xap_generated.inl.j2', defs, keyboard=cli.args.keyboard, keymap=cli.args.keymap) r = render_xap_output('firmware', 'xap_generated.inl.j2', defs, keyboard=cli.args.keyboard, keymap=cli.args.keymap)
while r.find('\n\n\n') != -1: while r.find('\n\n\n') != -1:
r = r.replace('\n\n\n', '\n\n') r = r.replace('\n\n\n', '\n\n')

2
lib/python/qmk/xap/common.py
View File

@ -56,7 +56,7 @@ def load_lighting_spec(feature, version='latest'):
def _get_jinja2_env(data_templates_xap_subdir: str): def _get_jinja2_env(data_templates_xap_subdir: str):
templates_dir = os.path.join(qmk.constants.QMK_FIRMWARE, 'data', 'templates', 'xap', data_templates_xap_subdir) templates_dir = os.path.join(qmk.constants.QMK_FIRMWARE, 'data', 'templates', 'xap', data_templates_xap_subdir)
j2 = Environment(loader=FileSystemLoader(templates_dir), autoescape=select_autoescape()) j2 = Environment(loader=FileSystemLoader(templates_dir), autoescape=select_autoescape(), lstrip_blocks=True, trim_blocks=True)
return j2 return j2