Commit 83d98d0
authored
Fix Doxygen wire-format rendering, unify internal constants, and add misalignment tests (#9)
## Pull Request
### Description
Systematic quality sweep across generated headers, Jinja2 templates,
Python tooling, and C tests to resolve naming inconsistencies, improve
Doxygen output, harden the code generator, and expand test coverage.
1. **`ROOT_SIZE` → `J2735_BW_*` constant unification:** Removed
per-header `J2735_INTERNAL_ROOT_SIZE_<TYPE>` constants from all 15
non-extensible DE headers. `_RAW_READ` and `_SIZE` macros now reference
the canonical `J2735_BW_*` constants from `J2735_internal_constants.h`,
eliminating the dual-name problem.
2. **`_Static_assert` for non-extensible DE headers:** Added
compile-time assertions to 7 non-extensible DE headers that were missing
them, ensuring the root bitstring size matches the `J2735_BW_*` constant
at compile time.
3. **Doxygen wire-format tag fixes:** Replaced `@code`/`@endcode` with
`@verbatim`/`@endverbatim` for ASCII-art wire diagrams across all 15 DE
headers and 4 DF headers (Doxygen was mangling box-drawing characters as
C code). Added `@par` section prefixes for proper Doxygen section
grouping.
4. **Hex range width normalization:** Updated
`bitstring_internal_get_all.j2` template to derive hex format width from
`return_type`, fixing 10 headers where `uint8_t` return types
incorrectly showed `0x0000–0x00FF` instead of `0x00–0xFF`.
5. **Jinja2 filter ASN.1 hyphen support:** Extended
`filter_screaming_snake()` and `filter_snake_case()` to handle
hyphenated ASN.1 names (e.g., `Offset-B10` → `OFFSET_B_10`,
`Node-LL-24B` → `NODE_LL_24_B`) with 4 new doctests.
6. **`_sum_field_bits()` validation:** Replaced silent `None → 0`
coercion with an explicit `ValueError` for unresolved field types,
preventing silent corruption of wire-format calculations.
7. **Python code quality:** Replaced `hasattr`/`getattr` chains with
`isinstance` checks in `filter_format_range()` and `filter_is_signed()`;
added `@lru_cache` to `create_jinja_env()`; added `StrictUndefined` to
the Jinja2 environment; replaced magic numbers `1`/`7` with
`_UPER_EXTENSION_MARKER_BITS`/`_UPER_NSNNWN_SMALL_BITS` named constants.
8. **Misalignment tests:** Added
`test_vehicle_event_flags_misaligned_access()` and 3 UPER misalignment
tests (`read_length_determinant`, `read_nsnnwn`, `skip_extensions`) per
testing standards requirement.
9. **Template documentation unification:** Unified docstring format
across all bitstring Jinja2 templates to use consistent `Context
variables:`/`Filters used:`/`Output format:` sections.
10. **License header template for `.j2` files:** Added explicit Jinja2
template example to `license_header.instructions.md` and normalized
indentation in 6 bitstring templates.
11. **Test cleanup:** Removed redundant per-line `cppcheck-suppress`
comments in 4 DF test files (replaced with block-level
`cppcheck-suppress-begin`/`end`); removed unused `<inttypes.h>` and
`<stdbool.h>` includes from 5 DF/UPER test files; clarified test header
`@brief` descriptions across 15 DE test headers.
12. **`asn1_definition.j2` unification:** Generalized the ASN.1
definition template to handle SEQUENCE, CHOICE, and BIT STRING via
`typedef.type_class.name` branching; removed inline ASN.1 blocks from
`assemble_df_choice.j2` and `assemble_de_bitstring.j2`.
13. **Minor fixes:** Renamed `_TEMPLATE_NAME` →
`_SIZE_CONSTANTS_TEMPLATE_NAME` for consistency with other module-level
constants; added `kw_only=True` to 2 wire-format dataclasses; split long
`@note` box lines in `assemble_de_bitstring.j2`.
### Related Issue
N/A
### Additional Notes
N/A
### Type of Change
- [x] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Performance improvement
### Checklist
- [x] My code follows the project's zero-copy coding style
- [x] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
- [x] I have added/updated documentation as needed
- [x] I have added tests that prove my fix/feature works
- [x] I have run `make pre-push` and all checks pass
- [x] I have signed my commits (DCO) using `git commit -s`
---------
Signed-off-by: Yogev Neumann <xqgex@users.noreply.github.com>1 parent e32835c commit 83d98d0
76 files changed
Lines changed: 2332 additions & 949 deletions
File tree
- .github/instructions
- src
- tests
- tools
- templates
- bitstring
- tests
- c_generator
- spec
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| 34 | + | |
34 | 35 | | |
35 | 36 | | |
36 | 37 | | |
| |||
54 | 55 | | |
55 | 56 | | |
56 | 57 | | |
57 | | - | |
| 58 | + | |
58 | 59 | | |
59 | 60 | | |
60 | | - | |
| 61 | + | |
61 | 62 | | |
62 | | - | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
63 | 86 | | |
64 | 87 | | |
65 | 88 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
35 | 36 | | |
36 | 37 | | |
37 | 38 | | |
| 39 | + | |
38 | 40 | | |
39 | 41 | | |
40 | 42 | | |
41 | | - | |
| 43 | + | |
| 44 | + | |
42 | 45 | | |
43 | 46 | | |
44 | 47 | | |
45 | 48 | | |
46 | 49 | | |
| 50 | + | |
47 | 51 | | |
48 | | - | |
49 | | - | |
| 52 | + | |
| 53 | + | |
50 | 54 | | |
51 | 55 | | |
52 | 56 | | |
53 | 57 | | |
54 | 58 | | |
55 | 59 | | |
| 60 | + | |
56 | 61 | | |
57 | 62 | | |
58 | 63 | | |
59 | 64 | | |
60 | 65 | | |
61 | 66 | | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | 67 | | |
72 | 68 | | |
73 | 69 | | |
74 | 70 | | |
75 | 71 | | |
76 | 72 | | |
77 | | - | |
| 73 | + | |
| 74 | + | |
78 | 75 | | |
79 | 76 | | |
80 | 77 | | |
| |||
107 | 104 | | |
108 | 105 | | |
109 | 106 | | |
110 | | - | |
| 107 | + | |
111 | 108 | | |
112 | 109 | | |
113 | 110 | | |
| |||
174 | 171 | | |
175 | 172 | | |
176 | 173 | | |
177 | | - | |
| 174 | + | |
178 | 175 | | |
179 | 176 | | |
180 | 177 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
29 | 30 | | |
30 | 31 | | |
| 32 | + | |
31 | 33 | | |
32 | 34 | | |
33 | 35 | | |
34 | | - | |
| 36 | + | |
| 37 | + | |
35 | 38 | | |
36 | 39 | | |
37 | 40 | | |
38 | 41 | | |
39 | 42 | | |
| 43 | + | |
40 | 44 | | |
41 | | - | |
42 | | - | |
| 45 | + | |
| 46 | + | |
43 | 47 | | |
44 | 48 | | |
45 | 49 | | |
46 | 50 | | |
47 | 51 | | |
48 | 52 | | |
| 53 | + | |
49 | 54 | | |
50 | 55 | | |
51 | 56 | | |
52 | 57 | | |
53 | 58 | | |
54 | 59 | | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | 60 | | |
65 | 61 | | |
66 | 62 | | |
67 | 63 | | |
68 | 64 | | |
69 | 65 | | |
70 | | - | |
| 66 | + | |
| 67 | + | |
71 | 68 | | |
72 | 69 | | |
73 | 70 | | |
| |||
93 | 90 | | |
94 | 91 | | |
95 | 92 | | |
96 | | - | |
| 93 | + | |
97 | 94 | | |
98 | 95 | | |
99 | 96 | | |
| |||
119 | 116 | | |
120 | 117 | | |
121 | 118 | | |
122 | | - | |
| 119 | + | |
123 | 120 | | |
124 | 121 | | |
125 | 122 | | |
| |||
160 | 157 | | |
161 | 158 | | |
162 | 159 | | |
163 | | - | |
164 | | - | |
| 160 | + | |
165 | 161 | | |
166 | 162 | | |
167 | 163 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
| 36 | + | |
35 | 37 | | |
36 | 38 | | |
37 | 39 | | |
38 | | - | |
| 40 | + | |
| 41 | + | |
39 | 42 | | |
40 | 43 | | |
41 | 44 | | |
42 | 45 | | |
43 | 46 | | |
| 47 | + | |
44 | 48 | | |
45 | | - | |
| 49 | + | |
| 50 | + | |
46 | 51 | | |
47 | 52 | | |
48 | 53 | | |
49 | 54 | | |
50 | 55 | | |
| 56 | + | |
51 | 57 | | |
52 | | - | |
53 | | - | |
| 58 | + | |
| 59 | + | |
54 | 60 | | |
55 | 61 | | |
56 | 62 | | |
| |||
61 | 67 | | |
62 | 68 | | |
63 | 69 | | |
| 70 | + | |
64 | 71 | | |
65 | 72 | | |
66 | 73 | | |
| |||
102 | 109 | | |
103 | 110 | | |
104 | 111 | | |
105 | | - | |
| 112 | + | |
| 113 | + | |
106 | 114 | | |
107 | 115 | | |
108 | 116 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
31 | 32 | | |
32 | 33 | | |
33 | 34 | | |
| 35 | + | |
34 | 36 | | |
35 | 37 | | |
36 | 38 | | |
37 | | - | |
| 39 | + | |
| 40 | + | |
38 | 41 | | |
39 | 42 | | |
40 | 43 | | |
41 | 44 | | |
42 | 45 | | |
| 46 | + | |
43 | 47 | | |
44 | | - | |
45 | | - | |
| 48 | + | |
| 49 | + | |
46 | 50 | | |
47 | 51 | | |
48 | 52 | | |
49 | 53 | | |
50 | 54 | | |
51 | 55 | | |
| 56 | + | |
52 | 57 | | |
53 | 58 | | |
54 | 59 | | |
55 | 60 | | |
56 | 61 | | |
57 | 62 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | 63 | | |
68 | 64 | | |
69 | 65 | | |
70 | 66 | | |
71 | 67 | | |
72 | 68 | | |
73 | | - | |
| 69 | + | |
| 70 | + | |
74 | 71 | | |
75 | 72 | | |
76 | 73 | | |
| |||
98 | 95 | | |
99 | 96 | | |
100 | 97 | | |
101 | | - | |
102 | | - | |
| 98 | + | |
103 | 99 | | |
104 | 100 | | |
105 | 101 | | |
| |||
125 | 121 | | |
126 | 122 | | |
127 | 123 | | |
128 | | - | |
| 124 | + | |
129 | 125 | | |
130 | 126 | | |
131 | 127 | | |
| |||
166 | 162 | | |
167 | 163 | | |
168 | 164 | | |
169 | | - | |
| 165 | + | |
170 | 166 | | |
171 | 167 | | |
172 | 168 | | |
| |||
0 commit comments