vmodtool: Add option to specify c names of arguments and avoid "bool" #4240
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
I tried gcc version 15.0.0 20241203 and even without -std=c23, it would reserve
"bool":
In file included from vcc_std_if.c:10:
vcc_std_if.h:78:33: error: two or more data types in declaration specifiers
78 | VCL_BOOL bool;
| ^~~~
(and more)
So this patch adds the option to specify the c name of arguments to vmod
functions/methods by separating it with a colon in the spec in the VCC file.
vclname:cname
We use this facility to rename the "bool" argument to vmod_std functions to
"boola".
Implementation
--------------
The cname needs to be specified by the VMOD author because it is also used in
the vmod implementation.
Obviously, VCC needs to know that name, too, to generate argument structs, so we
need to transport it from the VMOD to VCC via the JSON spec. A logical place for
cname is next to the name, because the other attributes following in the
argument spec array are optional. So this changes the JSON spec format, and,
consequently, we need to increase the version number.
So, ultimately, this is a breaking change with respect to vmodtool: One can not
import vmods built before this change. We could add compatibility for this case,
but as we have a tradition of forcing rebuilds with each release by bumping the
VRT major number anyway, I did not see my time well spent on implementing
backwards compatibility.
nigoroll
force-pushed
the
vmodtool_argument_cname
branch
from
2c73ff9 to
7265024
Compare
dridi
reviewed
Dec 9, 2024
vmod/vmod_std_conversions.c
Outdated
Comment on lines
159
to
160
| if (a->valid_bool) | ||
| return (a->bool ? 1 : 0); | ||
| if (a->valid_boola) | ||
| return (a->boola ? 1 : 0); |
There was a problem hiding this comment.
I'm not fond of "boola" here, why not "boolean" instead?
There was a problem hiding this comment.
yeah... walid_boolean ;)
|
bugwash: |
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.
I tried gcc version 15.0.0 20241203 and even without -std=c23, it would reserve "bool":
(and more)
So this patch adds the option to specify the c name of arguments to vmod functions/methods by separating it with a colon:
We use this facility to rename the "bool" argument to vmod_std functions to "boola".
Implementation
cname needs to be specified by the VMOD author because it is also used in the vmod implementation.
Obviously, VCC needs to know that name, too, to generate argument structs, so we need to transport it from the VMOD to VCC via the JSON spec. A logical place for is next to the name, because the other attributes following in the argument spec array are optional. So this changes the JSON spec format, and, consequently, we need to increase the version number.
So, ultimately, this is a breaking change with respect to vmodtool: One can not import vmods built before this change. We could add compatibility for this case, but as we have a tradition of forcing rebuilds with each release by bumping the VRT major number anyway, I did not see my time well spent on implementing backwards compatibility.