Skip to content

Commit

Permalink
qapi: Plumb info to the QAPISchemaMember
Browse files Browse the repository at this point in the history 
Future commits will need info in the .check() methods of
QAPISchemaMember and its descendants.  Get it there.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190927134639.4284-15-armbru@redhat.com>
  • Loading branch information
Markus Armbruster committed Sep 28, 2019
1 parent 8811248 commit e6f9678
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 35 deletions.
76 changes: 42 additions & 34 deletions scripts/qapi/common.py
View file
Expand Up @@ -1574,9 +1574,10 @@ class QAPISchemaMember(object):
""" Represents object members, enum members and features """
role = 'member'

def __init__(self, name, ifcond=None):
def __init__(self, name, info, ifcond=None):
assert isinstance(name, str)
self.name = name
self.info = info
self.ifcond = ifcond or []
self.defined_in = None

Expand Down Expand Up @@ -1633,8 +1634,8 @@ class QAPISchemaFeature(QAPISchemaMember):


class QAPISchemaObjectTypeMember(QAPISchemaMember):
def __init__(self, name, typ, optional, ifcond=None):
QAPISchemaMember.__init__(self, name, ifcond)
def __init__(self, name, info, typ, optional, ifcond=None):
QAPISchemaMember.__init__(self, name, info, ifcond)
assert isinstance(typ, str)
assert isinstance(optional, bool)
self._type_name = typ
Expand All @@ -1648,7 +1649,7 @@ def check(self, schema):


class QAPISchemaObjectTypeVariants(object):
def __init__(self, tag_name, tag_member, variants):
def __init__(self, tag_name, info, tag_member, variants):
# Flat unions pass tag_name but not tag_member.
# Simple unions and alternates pass tag_member but not tag_name.
# After check(), tag_member is always set, and tag_name remains
Expand All @@ -1659,6 +1660,7 @@ def __init__(self, tag_name, tag_member, variants):
for v in variants:
assert isinstance(v, QAPISchemaObjectTypeVariant)
self._tag_name = tag_name
self.info = info
self.tag_member = tag_member
self.variants = variants

Expand All @@ -1678,8 +1680,8 @@ def check(self, schema, seen):
cases = set([v.name for v in self.variants])
for m in self.tag_member.type.members:
if m.name not in cases:
v = QAPISchemaObjectTypeVariant(m.name, 'q_empty',
m.ifcond)
v = QAPISchemaObjectTypeVariant(m.name, self.info,
'q_empty', m.ifcond)
v.set_defined_in(self.tag_member.defined_in)
self.variants.append(v)
assert self.variants
Expand All @@ -1703,8 +1705,9 @@ def check_clash(self, info, seen):
class QAPISchemaObjectTypeVariant(QAPISchemaObjectTypeMember):
role = 'branch'

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


class QAPISchemaAlternateType(QAPISchemaType):
Expand Down Expand Up @@ -1880,23 +1883,26 @@ def _def_predefineds(self):

qtypes = ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist',
'qbool']
qtype_values = self._make_enum_members([{'name': n} for n in qtypes])
qtype_values = self._make_enum_members(
[{'name': n} for n in qtypes], None)

self._def_entity(QAPISchemaEnumType('QType', None, None, None,
qtype_values, 'QTYPE'))

def _make_features(self, features):
return [QAPISchemaFeature(f['name'], f.get('if')) for f in features]
def _make_features(self, features, info):
return [QAPISchemaFeature(f['name'], info, f.get('if'))
for f in features]

def _make_enum_members(self, values):
return [QAPISchemaEnumMember(v['name'], v.get('if'))
def _make_enum_members(self, values, info):
return [QAPISchemaEnumMember(v['name'], info, v.get('if'))
for v in values]

def _make_implicit_enum_type(self, name, info, ifcond, values):
# See also QAPISchemaObjectTypeMember.describe()
name = name + 'Kind' # reserved by check_defn_name_str()
self._def_entity(QAPISchemaEnumType(
name, info, None, ifcond, self._make_enum_members(values), None))
name, info, None, ifcond, self._make_enum_members(values, info),
None))
return name

def _make_array_type(self, element_type, info):
Expand Down Expand Up @@ -1935,7 +1941,7 @@ def _def_enum_type(self, expr, info, doc):
ifcond = expr.get('if')
self._def_entity(QAPISchemaEnumType(
name, info, doc, ifcond,
self._make_enum_members(data), prefix))
self._make_enum_members(data, info), prefix))

def _make_member(self, name, typ, ifcond, info):
optional = False
Expand All @@ -1945,7 +1951,7 @@ def _make_member(self, name, typ, ifcond, info):
if isinstance(typ, list):
assert len(typ) == 1
typ = self._make_array_type(typ[0], info)
return QAPISchemaObjectTypeMember(name, typ, optional, ifcond)
return QAPISchemaObjectTypeMember(name, info, typ, optional, ifcond)

def _make_members(self, data, info):
return [self._make_member(key, value['type'], value.get('if'), info)
Expand All @@ -1957,13 +1963,14 @@ def _def_struct_type(self, expr, info, doc):
data = expr['data']
ifcond = expr.get('if')
features = expr.get('features', [])
self._def_entity(QAPISchemaObjectType(name, info, doc, ifcond, base,
self._make_members(data, info),
None,
self._make_features(features)))
self._def_entity(QAPISchemaObjectType(
name, info, doc, ifcond, base,
self._make_members(data, info),
None,
self._make_features(features, info)))

def _make_variant(self, case, typ, ifcond):
return QAPISchemaObjectTypeVariant(case, typ, ifcond)
def _make_variant(self, case, typ, ifcond, info):
return QAPISchemaObjectTypeVariant(case, info, typ, ifcond)

def _make_simple_variant(self, case, typ, ifcond, info):
if isinstance(typ, list):
Expand All @@ -1972,7 +1979,7 @@ def _make_simple_variant(self, case, typ, ifcond, 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, ifcond)
return QAPISchemaObjectTypeVariant(case, info, typ, ifcond)

def _def_union_type(self, expr, info, doc):
name = expr['union']
Expand All @@ -1986,7 +1993,8 @@ def _def_union_type(self, expr, info, doc):
name, info, doc, ifcond,
'base', self._make_members(base, info))
if tag_name:
variants = [self._make_variant(key, value['type'], value.get('if'))
variants = [self._make_variant(key, value['type'],
value.get('if'), info)
for (key, value) in data.items()]
members = []
else:
Expand All @@ -1995,26 +2003,26 @@ def _def_union_type(self, expr, info, doc):
for (key, value) in data.items()]
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)
tag_member = QAPISchemaObjectTypeMember('type', info, typ, False)
members = [tag_member]
self._def_entity(
QAPISchemaObjectType(name, info, doc, ifcond, base, members,
QAPISchemaObjectTypeVariants(tag_name,
tag_member,
variants), []))
QAPISchemaObjectTypeVariants(
tag_name, info, tag_member, variants),
[]))

def _def_alternate_type(self, expr, info, doc):
name = expr['alternate']
data = expr['data']
ifcond = expr.get('if')
variants = [self._make_variant(key, value['type'], value.get('if'))
variants = [self._make_variant(key, value['type'], value.get('if'),
info)
for (key, value) in data.items()]
tag_member = QAPISchemaObjectTypeMember('type', 'QType', False)
tag_member = QAPISchemaObjectTypeMember('type', info, 'QType', False)
self._def_entity(
QAPISchemaAlternateType(name, info, doc, ifcond,
QAPISchemaObjectTypeVariants(None,
tag_member,
variants)))
QAPISchemaObjectTypeVariants(
None, info, tag_member, variants)))

def _def_command(self, expr, info, doc):
name = expr['command']
Expand Down Expand Up @@ -2306,7 +2314,7 @@ def gen_enum_lookup(name, members, prefix=None):

def gen_enum(name, members, prefix=None):
# append automatically generated _MAX value
enum_members = members + [QAPISchemaEnumMember('_MAX')]
enum_members = members + [QAPISchemaEnumMember('_MAX', None)]

ret = mcgen('''
Expand Down
2 changes: 1 addition & 1 deletion scripts/qapi/events.py
View file
Expand Up @@ -194,7 +194,7 @@ def visit_event(self, name, info, ifcond, arg_type, boxed):
self._event_emit_name))
# Note: we generate the enum member regardless of @ifcond, to
# keep the enumeration usable in target-independent code.
self._event_enum_members.append(QAPISchemaEnumMember(name))
self._event_enum_members.append(QAPISchemaEnumMember(name, None))


def gen_events(schema, output_dir, prefix):
Expand Down

0 comments on commit e6f9678

Please sign in to comment.