Proxmox-Port/qemu
1
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2025-07-27 12:20:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

qapi: Prepare for requiring more complete documentation

Browse Source 
We currently neglect to check all enumeration values, common members
of object types and members of alternate types are documented.
Unsurprisingly, many aren't.

Add the necessary plumbing to find undocumented ones, except for
variant members of object types.  Don't enforce anything just yet, but
connect each QAPIDoc.ArgSection to its QAPISchemaMember.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-15-git-send-email-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2017-03-15 13:57:03 +01:00
parent 4636211e4d
commit 069fb5b250
1 changed files with 65 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
scripts/qapi.py
View File

@ -116,7 +116,12 @@ def __repr__(self):
return "\n".join(self.content).strip() return "\n".join(self.content).strip()
class ArgSection(Section): class ArgSection(Section):
pass def __init__(self, name):
QAPIDoc.Section.__init__(self, name)
self.member = None
def connect(self, member):
self.member = member
def __init__(self, parser, info): def __init__(self, parser, info):
# self.parser is used to report errors with QAPIParseError. The # self.parser is used to report errors with QAPIParseError. The
@ -216,6 +221,13 @@ def _append_freeform(self, line):
line = line.strip() line = line.strip()
self.section.append(line) self.section.append(line)
def connect_member(self, member):
if member.name not in self.args:
# Undocumented TODO outlaw
pass
else:
self.args[member.name].connect(member)
class QAPISchemaParser(object): class QAPISchemaParser(object):
@ -1021,7 +1033,7 @@ def check_docs(docs):
# #
class QAPISchemaEntity(object): class QAPISchemaEntity(object):
def __init__(self, name, info): def __init__(self, name, info, doc):
assert isinstance(name, str) assert isinstance(name, str)
self.name = name self.name = name
# For explicitly defined entities, info points to the (explicit) # For explicitly defined entities, info points to the (explicit)
@ -1030,6 +1042,7 @@ def __init__(self, name, info):
# triggered the implicit definition (there may be more than one # triggered the implicit definition (there may be more than one
# such place). # such place).
self.info = info self.info = info
self.doc = doc
def c_name(self): def c_name(self):
return c_name(self.name) return c_name(self.name)
@ -1111,7 +1124,7 @@ def alternate_qtype(self):
class QAPISchemaBuiltinType(QAPISchemaType): class QAPISchemaBuiltinType(QAPISchemaType):
def __init__(self, name, json_type, c_type): def __init__(self, name, json_type, c_type):
QAPISchemaType.__init__(self, name, None) QAPISchemaType.__init__(self, name, None, None)
assert not c_type or isinstance(c_type, str) assert not c_type or isinstance(c_type, str)
assert json_type in ('string', 'number', 'int', 'boolean', 'null', assert json_type in ('string', 'number', 'int', 'boolean', 'null',
'value') 'value')
@ -1137,8 +1150,8 @@ def visit(self, visitor):
class QAPISchemaEnumType(QAPISchemaType): class QAPISchemaEnumType(QAPISchemaType):
def __init__(self, name, info, values, prefix): def __init__(self, name, info, doc, values, prefix):
QAPISchemaType.__init__(self, name, info) QAPISchemaType.__init__(self, name, info, doc)
for v in values: for v in values:
assert isinstance(v, QAPISchemaMember) assert isinstance(v, QAPISchemaMember)
v.set_owner(name) v.set_owner(name)
@ -1150,6 +1163,8 @@ def check(self, schema):
seen = {} seen = {}
for v in self.values: for v in self.values:
v.check_clash(self.info, seen) v.check_clash(self.info, seen)
if self.doc:
self.doc.connect_member(v)
def is_implicit(self): def is_implicit(self):
# See QAPISchema._make_implicit_enum_type() and ._def_predefineds() # See QAPISchema._make_implicit_enum_type() and ._def_predefineds()
@ -1171,7 +1186,7 @@ def visit(self, visitor):
class QAPISchemaArrayType(QAPISchemaType): class QAPISchemaArrayType(QAPISchemaType):
def __init__(self, name, info, element_type): def __init__(self, name, info, element_type):
QAPISchemaType.__init__(self, name, info) QAPISchemaType.__init__(self, name, info, None)
assert isinstance(element_type, str) assert isinstance(element_type, str)
self._element_type_name = element_type self._element_type_name = element_type
self.element_type = None self.element_type = None
@ -1194,11 +1209,11 @@ def visit(self, visitor):
class QAPISchemaObjectType(QAPISchemaType): class QAPISchemaObjectType(QAPISchemaType):
def __init__(self, name, info, base, local_members, variants): def __init__(self, name, info, doc, base, local_members, variants):
# struct has local_members, optional base, and no variants # struct has local_members, optional base, and no variants
# flat union has base, variants, and no local_members # flat union has base, variants, and no local_members
# simple union has local_members, variants, and no base # simple union has local_members, variants, and no base
QAPISchemaType.__init__(self, name, info) QAPISchemaType.__init__(self, name, info, doc)
assert base is None or isinstance(base, str) assert base is None or isinstance(base, str)
for m in local_members: for m in local_members:
assert isinstance(m, QAPISchemaObjectTypeMember) assert isinstance(m, QAPISchemaObjectTypeMember)
@ -1228,6 +1243,8 @@ def check(self, schema):
for m in self.local_members: for m in self.local_members:
m.check(schema) m.check(schema)
m.check_clash(self.info, seen) m.check_clash(self.info, seen)
if self.doc:
self.doc.connect_member(m)
self.members = seen.values() self.members = seen.values()
if self.variants: if self.variants:
self.variants.check(schema, seen) self.variants.check(schema, seen)
@ -1382,8 +1399,8 @@ def __init__(self, name, typ):
class QAPISchemaAlternateType(QAPISchemaType): class QAPISchemaAlternateType(QAPISchemaType):
def __init__(self, name, info, variants): def __init__(self, name, info, doc, variants):
QAPISchemaType.__init__(self, name, info) QAPISchemaType.__init__(self, name, info, doc)
assert isinstance(variants, QAPISchemaObjectTypeVariants) assert isinstance(variants, QAPISchemaObjectTypeVariants)
assert variants.tag_member assert variants.tag_member
variants.set_owner(name) variants.set_owner(name)
@ -1400,6 +1417,8 @@ def check(self, schema):
seen = {} seen = {}
for v in self.variants.variants: for v in self.variants.variants:
v.check_clash(self.info, seen) v.check_clash(self.info, seen)
if self.doc:
self.doc.connect_member(v)
def c_type(self): def c_type(self):
return c_name(self.name) + pointer_suffix return c_name(self.name) + pointer_suffix
@ -1415,9 +1434,9 @@ def is_empty(self):
class QAPISchemaCommand(QAPISchemaEntity): class QAPISchemaCommand(QAPISchemaEntity):
def __init__(self, name, info, arg_type, ret_type, gen, success_response, def __init__(self, name, info, doc, arg_type, ret_type,
boxed): gen, success_response, boxed):
QAPISchemaEntity.__init__(self, name, info) QAPISchemaEntity.__init__(self, name, info, doc)
assert not arg_type or isinstance(arg_type, str) assert not arg_type or isinstance(arg_type, str)
assert not ret_type or isinstance(ret_type, str) assert not ret_type or isinstance(ret_type, str)
self._arg_type_name = arg_type self._arg_type_name = arg_type
@ -1454,8 +1473,8 @@ def visit(self, visitor):
class QAPISchemaEvent(QAPISchemaEntity): class QAPISchemaEvent(QAPISchemaEntity):
def __init__(self, name, info, arg_type, boxed): def __init__(self, name, info, doc, arg_type, boxed):
QAPISchemaEntity.__init__(self, name, info) QAPISchemaEntity.__init__(self, name, info, doc)
assert not arg_type or isinstance(arg_type, str) assert not arg_type or isinstance(arg_type, str)
self._arg_type_name = arg_type self._arg_type_name = arg_type
self.arg_type = None self.arg_type = None
@ -1537,14 +1556,14 @@ def _def_predefineds(self):
('bool', 'boolean', 'bool'), ('bool', 'boolean', 'bool'),
('any', 'value', 'QObject' + pointer_suffix)]: ('any', 'value', 'QObject' + pointer_suffix)]:
self._def_builtin_type(*t) self._def_builtin_type(*t)
self.the_empty_object_type = QAPISchemaObjectType('q_empty', None, self.the_empty_object_type = QAPISchemaObjectType(
None, [], None) 'q_empty', None, None, None, [], None)
self._def_entity(self.the_empty_object_type) self._def_entity(self.the_empty_object_type)
qtype_values = self._make_enum_members(['none', 'qnull', 'qint', qtype_values = self._make_enum_members(['none', 'qnull', 'qint',
'qstring', 'qdict', 'qlist', 'qstring', 'qdict', 'qlist',
'qfloat', 'qbool']) 'qfloat', 'qbool'])
self._def_entity(QAPISchemaEnumType('QType', None, qtype_values, self._def_entity(QAPISchemaEnumType('QType', None, None,
'QTYPE')) qtype_values, 'QTYPE'))
def _make_enum_members(self, values): def _make_enum_members(self, values):
return [QAPISchemaMember(v) for v in values] return [QAPISchemaMember(v) for v in values]
@ -1553,7 +1572,7 @@ def _make_implicit_enum_type(self, name, info, values):
# See also QAPISchemaObjectTypeMember._pretty_owner() # See also QAPISchemaObjectTypeMember._pretty_owner()
name = name + 'Kind' # Use namespace reserved by add_name() name = name + 'Kind' # Use namespace reserved by add_name()
self._def_entity(QAPISchemaEnumType( self._def_entity(QAPISchemaEnumType(
name, info, self._make_enum_members(values), None)) name, info, None, self._make_enum_members(values), None))
return name return name
def _make_array_type(self, element_type, info): def _make_array_type(self, element_type, info):
@ -1562,22 +1581,22 @@ def _make_array_type(self, element_type, info):
self._def_entity(QAPISchemaArrayType(name, info, element_type)) self._def_entity(QAPISchemaArrayType(name, info, element_type))
return name return name
def _make_implicit_object_type(self, name, info, role, members): def _make_implicit_object_type(self, name, info, doc, role, members):
if not members: if not members:
return None return None
# See also QAPISchemaObjectTypeMember._pretty_owner() # See also QAPISchemaObjectTypeMember._pretty_owner()
name = 'q_obj_%s-%s' % (name, role) name = 'q_obj_%s-%s' % (name, role)
if not self.lookup_entity(name, QAPISchemaObjectType): if not self.lookup_entity(name, QAPISchemaObjectType):
self._def_entity(QAPISchemaObjectType(name, info, None, self._def_entity(QAPISchemaObjectType(name, info, doc, None,
members, None)) members, None))
return name return name
def _def_enum_type(self, expr, info): def _def_enum_type(self, expr, info, doc):
name = expr['enum'] name = expr['enum']
data = expr['data'] data = expr['data']
prefix = expr.get('prefix') prefix = expr.get('prefix')
self._def_entity(QAPISchemaEnumType( self._def_entity(QAPISchemaEnumType(
name, info, self._make_enum_members(data), prefix)) name, info, doc, self._make_enum_members(data), prefix))
def _make_member(self, name, typ, info): def _make_member(self, name, typ, info):
optional = False optional = False
@ -1593,11 +1612,11 @@ def _make_members(self, data, info):
return [self._make_member(key, value, info) return [self._make_member(key, value, info)
for (key, value) in data.iteritems()] for (key, value) in data.iteritems()]
def _def_struct_type(self, expr, info): def _def_struct_type(self, expr, info, doc):
name = expr['struct'] name = expr['struct']
base = expr.get('base') base = expr.get('base')
data = expr['data'] data = expr['data']
self._def_entity(QAPISchemaObjectType(name, info, base, self._def_entity(QAPISchemaObjectType(name, info, doc, base,
self._make_members(data, info), self._make_members(data, info),
None)) None))
@ -1609,10 +1628,10 @@ def _make_simple_variant(self, case, typ, info):
assert len(typ) == 1 assert len(typ) == 1
typ = self._make_array_type(typ[0], info) typ = self._make_array_type(typ[0], info)
typ = self._make_implicit_object_type( typ = self._make_implicit_object_type(
typ, info, 'wrapper', [self._make_member('data', typ, info)]) typ, info, None, 'wrapper', [self._make_member('data', typ, info)])
return QAPISchemaObjectTypeVariant(case, typ) return QAPISchemaObjectTypeVariant(case, typ)
def _def_union_type(self, expr, info): def _def_union_type(self, expr, info, doc):
name = expr['union'] name = expr['union']
data = expr['data'] data = expr['data']
base = expr.get('base') base = expr.get('base')
@ -1620,7 +1639,7 @@ def _def_union_type(self, expr, info):
tag_member = None tag_member = None
if isinstance(base, dict): if isinstance(base, dict):
base = (self._make_implicit_object_type( base = (self._make_implicit_object_type(
name, info, 'base', self._make_members(base, info))) name, info, doc, 'base', self._make_members(base, info)))
if tag_name: if tag_name:
variants = [self._make_variant(key, value) variants = [self._make_variant(key, value)
for (key, value) in data.iteritems()] for (key, value) in data.iteritems()]
@ -1633,24 +1652,24 @@ def _def_union_type(self, expr, info):
tag_member = QAPISchemaObjectTypeMember('type', typ, False) tag_member = QAPISchemaObjectTypeMember('type', typ, False)
members = [tag_member] members = [tag_member]
self._def_entity( self._def_entity(
QAPISchemaObjectType(name, info, base, members, QAPISchemaObjectType(name, info, doc, base, members,
QAPISchemaObjectTypeVariants(tag_name, QAPISchemaObjectTypeVariants(tag_name,
tag_member, tag_member,
variants))) variants)))
def _def_alternate_type(self, expr, info): def _def_alternate_type(self, expr, info, doc):
name = expr['alternate'] name = expr['alternate']
data = expr['data'] data = expr['data']
variants = [self._make_variant(key, value) variants = [self._make_variant(key, value)
for (key, value) in data.iteritems()] for (key, value) in data.iteritems()]
tag_member = QAPISchemaObjectTypeMember('type', 'QType', False) tag_member = QAPISchemaObjectTypeMember('type', 'QType', False)
self._def_entity( self._def_entity(
QAPISchemaAlternateType(name, info, QAPISchemaAlternateType(name, info, doc,
QAPISchemaObjectTypeVariants(None, QAPISchemaObjectTypeVariants(None,
tag_member, tag_member,
variants))) variants)))
def _def_command(self, expr, info): def _def_command(self, expr, info, doc):
name = expr['command'] name = expr['command']
data = expr.get('data') data = expr.get('data')
rets = expr.get('returns') rets = expr.get('returns')
@ -1659,38 +1678,39 @@ def _def_command(self, expr, info):
boxed = expr.get('boxed', False) boxed = expr.get('boxed', False)
if isinstance(data, OrderedDict): if isinstance(data, OrderedDict):
data = self._make_implicit_object_type( data = self._make_implicit_object_type(
name, info, 'arg', self._make_members(data, info)) name, info, doc, 'arg', self._make_members(data, info))
if isinstance(rets, list): if isinstance(rets, list):
assert len(rets) == 1 assert len(rets) == 1
rets = self._make_array_type(rets[0], info) rets = self._make_array_type(rets[0], info)
self._def_entity(QAPISchemaCommand(name, info, data, rets, gen, self._def_entity(QAPISchemaCommand(name, info, doc, data, rets,
success_response, boxed)) gen, success_response, boxed))
def _def_event(self, expr, info): def _def_event(self, expr, info, doc):
name = expr['event'] name = expr['event']
data = expr.get('data') data = expr.get('data')
boxed = expr.get('boxed', False) boxed = expr.get('boxed', False)
if isinstance(data, OrderedDict): if isinstance(data, OrderedDict):
data = self._make_implicit_object_type( data = self._make_implicit_object_type(
name, info, 'arg', self._make_members(data, info)) name, info, doc, 'arg', self._make_members(data, info))
self._def_entity(QAPISchemaEvent(name, info, data, boxed)) self._def_entity(QAPISchemaEvent(name, info, doc, data, boxed))
def _def_exprs(self): def _def_exprs(self):
for expr_elem in self.exprs: for expr_elem in self.exprs:
expr = expr_elem['expr'] expr = expr_elem['expr']
info = expr_elem['info'] info = expr_elem['info']
doc = expr_elem.get('doc')
if 'enum' in expr: if 'enum' in expr:
self._def_enum_type(expr, info) self._def_enum_type(expr, info, doc)
elif 'struct' in expr: elif 'struct' in expr:
self._def_struct_type(expr, info) self._def_struct_type(expr, info, doc)
elif 'union' in expr: elif 'union' in expr:
self._def_union_type(expr, info) self._def_union_type(expr, info, doc)
elif 'alternate' in expr: elif 'alternate' in expr:
self._def_alternate_type(expr, info) self._def_alternate_type(expr, info, doc)
elif 'command' in expr: elif 'command' in expr:
self._def_command(expr, info) self._def_command(expr, info, doc)
elif 'event' in expr: elif 'event' in expr:
self._def_event(expr, info) self._def_event(expr, info, doc)
else: else:
assert False assert False