Skip to content

Commit

Permalink
qapi: add 'if' to union members
Browse files Browse the repository at this point in the history
Add 'if' key to union members:

{ 'union': 'TestIfUnion', 'data':
    'mem': { 'type': 'str', 'if': 'COND'} }

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

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20181213123724.4866-16-marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
  • Loading branch information
elmarco authored and Markus Armbruster committed Dec 13, 2018
1 parent ccadd6b commit a272428
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/devel/qapi-code-gen.txt
Expand Up @@ -754,7 +754,7 @@ gets its generated code guarded like this:

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)
and 'if' keys. (TODO: alternate)

Example: a conditional 'bar' member

Expand Down
15 changes: 8 additions & 7 deletions scripts/qapi/common.py
Expand Up @@ -803,7 +803,7 @@ def check_union(expr, info):
check_name(info, "Member of union '%s'" % name, key)

check_known_keys(info, "member '%s' of union '%s'" % (key, name),
value, ['type'], [])
value, ['type'], ['if'])
# Each value must name a known type
check_type(info, "Member '%s' of union '%s'" % (key, name),
value['type'],
Expand Down Expand Up @@ -1483,8 +1483,8 @@ def check_clash(self, info, seen):
class QAPISchemaObjectTypeVariant(QAPISchemaObjectTypeMember):
role = 'branch'

def __init__(self, name, typ):
QAPISchemaObjectTypeMember.__init__(self, name, typ, False)
def __init__(self, name, typ, ifcond=None):
QAPISchemaObjectTypeMember.__init__(self, name, typ, False, ifcond)


class QAPISchemaAlternateType(QAPISchemaType):
Expand Down Expand Up @@ -1757,14 +1757,14 @@ def _def_struct_type(self, expr, info, doc):
def _make_variant(self, case, typ):
return QAPISchemaObjectTypeVariant(case, typ)

def _make_simple_variant(self, case, typ, info):
def _make_simple_variant(self, case, typ, ifcond, info):
if isinstance(typ, list):
assert len(typ) == 1
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, None, info)])
return QAPISchemaObjectTypeVariant(case, typ)
return QAPISchemaObjectTypeVariant(case, typ, ifcond)

def _def_union_type(self, expr, info, doc):
name = expr['union']
Expand All @@ -1782,9 +1782,10 @@ def _def_union_type(self, expr, info, doc):
for (key, value) in data.items()]
members = []
else:
variants = [self._make_simple_variant(key, value['type'], info)
variants = [self._make_simple_variant(key, value['type'],
value.get('if'), info)
for (key, value) in data.items()]
enum = [{'name': v.name} for v in variants]
enum = [{'name': v.name, 'if': v.ifcond} for v in variants]
typ = self._make_implicit_enum_type(name, info, ifcond, enum)
tag_member = QAPISchemaObjectTypeMember('type', typ, False)
members = [tag_member]
Expand Down
4 changes: 3 additions & 1 deletion tests/qapi-schema/qapi-schema-test.json
Expand Up @@ -210,7 +210,9 @@
[ 'foo', { 'name' : 'bar', 'if': 'defined(TEST_IF_ENUM_BAR)' } ],
'if': 'defined(TEST_IF_ENUM)' }

{ 'union': 'TestIfUnion', 'data': { 'foo': 'TestStruct' },
{ 'union': 'TestIfUnion', 'data':
{ 'foo': 'TestStruct',
'union_bar': { 'type': 'str', 'if': 'defined(TEST_IF_UNION_BAR)'} },
'if': 'defined(TEST_IF_UNION) && defined(TEST_IF_STRUCT)' }

{ 'command': 'TestIfUnionCmd', 'data': { 'union_cmd_arg': 'TestIfUnion' },
Expand Down
4 changes: 4 additions & 0 deletions tests/qapi-schema/qapi-schema-test.out
Expand Up @@ -280,11 +280,15 @@ object q_obj_TestStruct-wrapper
member data: TestStruct optional=False
enum TestIfUnionKind
member foo
member union_bar
if ['defined(TEST_IF_UNION_BAR)']
if ['defined(TEST_IF_UNION) && defined(TEST_IF_STRUCT)']
object TestIfUnion
member type: TestIfUnionKind optional=False
tag type
case foo: q_obj_TestStruct-wrapper
case union_bar: q_obj_str-wrapper
if ['defined(TEST_IF_UNION_BAR)']
if ['defined(TEST_IF_UNION) && defined(TEST_IF_STRUCT)']
object q_obj_TestIfUnionCmd-arg
member union_cmd_arg: TestIfUnion optional=False
Expand Down
1 change: 1 addition & 0 deletions tests/qapi-schema/test-qapi.py
Expand Up @@ -68,6 +68,7 @@ def _print_variants(variants):
print(' tag %s' % variants.tag_member.name)
for v in variants.variants:
print(' case %s: %s' % (v.name, v.type.name))
QAPISchemaTestVisitor._print_if(v.ifcond, indent=8)

@staticmethod
def _print_if(ifcond, indent=4):
Expand Down

0 comments on commit a272428

Please sign in to comment.