API: New macros for version 2 #210
Merged
Conversation
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
The old macros are re-implemented as wrappers for the new ones. This means old code will continue to build. The new macros enable greater flexibility, allowing initialisers to be passed for type-specific schema data.
Codecov Report
@@ Coverage Diff @@
## main #210 +/- ##
=======================================
Coverage 96.88% 96.88%
=======================================
Files 9 9
Lines 1637 1637
Branches 347 347
=======================================
Hits 1586 1586
Misses 24 24
Partials 27 27
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds new schema building macros for version 2.
The old macros are still available, but they are now implemented as wrappers around the new v2 macros.
The problem with the old macros was that they required a fixed number of parameters, and to handle optional fields in the schema, would have required multiple variants. Since more optional features are planned for v2, the multiple variants would have got out of hand. Alternatively the new macros could have contained arguments for setting every field, however this would have made them cumbersome and less attractive than using a struct initialiser directly.
The new macros are a compromise. The new macros take the
CYAML_[TYPE]as a first parameter, and a struct initialiser for the type-specific anonymous union member may be provided as the last parameter.