Commit ccadd6bc authored by Marc-André Lureau's avatar Marc-André Lureau Committed by Markus Armbruster
Browse files

qapi: Add 'if' to implicit struct members 



The generated code is for now *unconditional*.  Later patches generate
the conditionals.

Note that union discriminators may not have 'if' conditionals.

Signed-off-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
Message-Id: <20181213123724.4866-14-marcandre.lureau@redhat.com>
Message-Id: <20181213123724.4866-15-marcandre.lureau@redhat.com>
[Patches squashed, commit message tweaked]
Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
parent 87adbbff

docs/devel/qapi-code-gen.txt

+10 −0
Original line number Diff line number Diff line
@@ -752,6 +752,16 @@ gets its generated code guarded like this: 
 #endif /* defined(HAVE_BAR) */

 #endif /* defined(CONFIG_FOO) */



Where a member can be defined with a single string value for its type,

it is also possible to supply a dictionary instead with both 'type'

and 'if' keys. (TODO: union and alternate)



Example: a conditional 'bar' member



{ 'struct': 'IfStruct', 'data':

  { 'foo': 'int',

    'bar': { 'type': 'int', 'if': 'defined(IFCOND)'} } }



An enum value can be replaced by a dictionary with a 'name' and a 'if'

key.

scripts/qapi/common.py

+11 −7
Original line number Diff line number Diff line
@@ -705,7 +705,7 @@ def check_type(info, source, value, allow_array=False, 
        # Todo: allow dictionaries to represent default values of

        # an optional argument.

        check_known_keys(info, "member '%s' of %s" % (key, source),

                         arg, ['type'], [])

                         arg, ['type'], ['if'])

        check_type(info, "Member '%s' of %s" % (key, source),

                   arg['type'], allow_array=True,

                   allow_metas=['built-in', 'union', 'alternate', 'struct',
@@ -784,6 +784,10 @@ def check_union(expr, info): 
                               "Discriminator '%s' is not a member of base "

                               "struct '%s'"

                               % (discriminator, base))

        if discriminator_value.get('if'):

            raise QAPISemError(info, 'The discriminator %s.%s for union %s '

                               'must not be conditional' %

                               (base, discriminator, name))

        enum_define = enum_types.get(discriminator_value['type'])

        allow_metas = ['struct']

        # Do not allow string discriminator
@@ -1412,8 +1416,8 @@ class QAPISchemaMember(object): 




class QAPISchemaObjectTypeMember(QAPISchemaMember):

    def __init__(self, name, typ, optional):

        QAPISchemaMember.__init__(self, name)

    def __init__(self, name, typ, optional, ifcond=None):

        QAPISchemaMember.__init__(self, name, ifcond)

        assert isinstance(typ, str)

        assert isinstance(optional, bool)

        self._type_name = typ
@@ -1727,7 +1731,7 @@ class QAPISchema(object): 
            name, info, doc, ifcond,

            self._make_enum_members(data), prefix))



    def _make_member(self, name, typ, info):

    def _make_member(self, name, typ, ifcond, info):

        optional = False

        if name.startswith('*'):

            name = name[1:]
@@ -1735,10 +1739,10 @@ class QAPISchema(object): 
        if isinstance(typ, list):

            assert len(typ) == 1

            typ = self._make_array_type(typ[0], info)

        return QAPISchemaObjectTypeMember(name, typ, optional)

        return QAPISchemaObjectTypeMember(name, typ, optional, ifcond)



    def _make_members(self, data, info):

        return [self._make_member(key, value['type'], info)

        return [self._make_member(key, value['type'], value.get('if'), info)

                for (key, value) in data.items()]



    def _def_struct_type(self, expr, info, doc):
@@ -1759,7 +1763,7 @@ class QAPISchema(object): 
            typ = self._make_array_type(typ[0], info)

        typ = self._make_implicit_object_type(

            typ, info, None, self.lookup_type(typ),

            'wrapper', [self._make_member('data', typ, info)])

            'wrapper', [self._make_member('data', typ, None, info)])

        return QAPISchemaObjectTypeVariant(case, typ)



    def _def_union_type(self, expr, info, doc):

tests/Makefile.include

+1 −0
Original line number Diff line number Diff line
@@ -409,6 +409,7 @@ qapi-schema += flat-union-inline-invalid-dict.json 
qapi-schema += flat-union-int-branch.json

qapi-schema += flat-union-invalid-branch-key.json

qapi-schema += flat-union-invalid-discriminator.json

qapi-schema += flat-union-invalid-if-discriminator.json

qapi-schema += flat-union-no-base.json

qapi-schema += flat-union-optional-discriminator.json

qapi-schema += flat-union-string-discriminator.json

tests/qapi-schema/flat-union-invalid-if-discriminator.err

0 → 100644
+1 −0
Original line number Diff line number Diff line 
tests/qapi-schema/flat-union-invalid-if-discriminator.json:13: The discriminator TestBase.enum1 for union TestUnion must not be conditional

tests/qapi-schema/flat-union-invalid-if-discriminator.exit

0 → 100644
+1 −0
Original line number Diff line number Diff line 
1