| Message ID | 20201015165255.1573897-10-marcandre.lureau@redhat.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | qapi: untie 'if' conditions from C preprocessor | expand |
On Thu, Oct 15, 2020 at 8:54 PM <marcandre.lureau@redhat.com> wrote: > > From: Marc-André Lureau <marcandre.lureau@redhat.com> > > Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> > --- > docs/devel/qapi-code-gen.txt | 26 +++++++++++++++----------- > 1 file changed, 15 insertions(+), 11 deletions(-) > > diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt > index 3d22a7ae21..517bc29507 100644 > --- a/docs/devel/qapi-code-gen.txt > +++ b/docs/devel/qapi-code-gen.txt > @@ -772,26 +772,30 @@ downstream command __com.redhat_drive-mirror. > === Configuring the schema === > > Syntax: > - COND = STRING > - | [ STRING, ... ] > + COND = CFG-ID > + | [ CFG-ID, ... ] > + | { 'all: [ CFG-ID, ... ] } > + | { 'any: [ CFG-ID, ... ] } > + | { 'not': COND } Btw, I realized while writing that, the doc is actually quite faithfull with the currently limited supported expressions, but I will probably improve on that in v2 (unless it's considered a feature :) > > -All definitions take an optional 'if' member. Its value must be a > -string or a list of strings. A string is shorthand for a list > -containing just that string. The code generated for the definition > -will then be guarded by #if STRING for each STRING in the COND list. > + CFG-ID = STRING > + > +All definitions take an optional 'if' member. Its value must be a string, a list > +of strings or an object with a single member 'all', 'any' or 'not'. A string is > +shorthand for a list containing just that string. A list is a shorthand for a > +'all'-member object. The C code generated for the definition will then be guarded > +by an #if precessor expression. > > Example: a conditional struct > > { 'struct': 'IfStruct', 'data': { 'foo': 'int' }, > - 'if': ['CONFIG_FOO', 'HAVE_BAR'] } > + 'if': { 'all': [ 'CONFIG_FOO', 'HAVE_BAR' ] } } > > gets its generated code guarded like this: > > - #if defined(CONFIG_FOO) > - #if defined(HAVE_BAR) > + #if defined(CONFIG_FOO) && defined(HAVE_BAR) > ... generated code ... > - #endif /* defined(HAVE_BAR) */ > - #endif /* defined(CONFIG_FOO) */ > + #endif /* defined(HAVE_BAR) && defined(CONFIG_FOO) */ > > Individual members of complex types, commands arguments, and > event-specific data can also be made conditional. This requires the > -- > 2.28.0 >
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt index 3d22a7ae21..517bc29507 100644 --- a/docs/devel/qapi-code-gen.txt +++ b/docs/devel/qapi-code-gen.txt @@ -772,26 +772,30 @@ downstream command __com.redhat_drive-mirror. === Configuring the schema === Syntax: - COND = STRING - | [ STRING, ... ] + COND = CFG-ID + | [ CFG-ID, ... ] + | { 'all: [ CFG-ID, ... ] } + | { 'any: [ CFG-ID, ... ] } + | { 'not': COND } -All definitions take an optional 'if' member. Its value must be a -string or a list of strings. A string is shorthand for a list -containing just that string. The code generated for the definition -will then be guarded by #if STRING for each STRING in the COND list. + CFG-ID = STRING + +All definitions take an optional 'if' member. Its value must be a string, a list +of strings or an object with a single member 'all', 'any' or 'not'. A string is +shorthand for a list containing just that string. A list is a shorthand for a +'all'-member object. The C code generated for the definition will then be guarded +by an #if precessor expression. Example: a conditional struct { 'struct': 'IfStruct', 'data': { 'foo': 'int' }, - 'if': ['CONFIG_FOO', 'HAVE_BAR'] } + 'if': { 'all': [ 'CONFIG_FOO', 'HAVE_BAR' ] } } gets its generated code guarded like this: - #if defined(CONFIG_FOO) - #if defined(HAVE_BAR) + #if defined(CONFIG_FOO) && defined(HAVE_BAR) ... generated code ... - #endif /* defined(HAVE_BAR) */ - #endif /* defined(CONFIG_FOO) */ + #endif /* defined(HAVE_BAR) && defined(CONFIG_FOO) */ Individual members of complex types, commands arguments, and event-specific data can also be made conditional. This requires the