qapi: Record 'include' directives in parse tree

The parse tree is a list of expressions. Except include expressions
currently get replaced by the included file's parse tree.

Instead of throwing away the include expression, keep it with the file
name expanded so you don't have to track the including file's
directory to make sense of it.

A future commit will put this include expression to use.

Backports commit 97f0249474d19c1d60fb9d934c8bc08625a619ca from qemu
This commit is contained in:
Markus Armbruster 2018-03-09 08:58:47 -05:00 committed by Lioncash
parent 07453b11b8
commit cad1593b7d
No known key found for this signature in database
GPG key ID: 4E3C3CC1031BA9C7

View file

@ -299,8 +299,11 @@ class QAPISchemaParser(object):
if not isinstance(include, str): if not isinstance(include, str):
raise QAPISemError(info, raise QAPISemError(info,
"Value of 'include' must be a string") "Value of 'include' must be a string")
exprs_include = self._include(include, info, incl_fname = os.path.join(os.path.dirname(self.fname),
os.path.dirname(self.fname), include)
self.exprs.append({'expr': {'include': incl_fname},
'info': info})
exprs_include = self._include(include, info, incl_fname,
previously_included) previously_included)
if exprs_include: if exprs_include:
self.exprs.extend(exprs_include.exprs) self.exprs.extend(exprs_include.exprs)
@ -336,8 +339,7 @@ class QAPISchemaParser(object):
"Documentation for '%s' is not followed by the definition" "Documentation for '%s' is not followed by the definition"
% self.cur_doc.symbol) % self.cur_doc.symbol)
def _include(self, include, info, base_dir, previously_included): def _include(self, include, info, incl_fname, previously_included):
incl_fname = os.path.join(base_dir, include)
incl_abs_fname = os.path.abspath(incl_fname) incl_abs_fname = os.path.abspath(incl_fname)
# catch inclusion cycle # catch inclusion cycle
inf = info inf = info
@ -902,6 +904,9 @@ def check_exprs(exprs):
info = expr_elem['info'] info = expr_elem['info']
doc = expr_elem.get('doc') doc = expr_elem.get('doc')
if 'include' in expr:
continue
if not doc and doc_required: if not doc and doc_required:
raise QAPISemError(info, raise QAPISemError(info,
"Expression missing documentation comment") "Expression missing documentation comment")
@ -941,6 +946,9 @@ def check_exprs(exprs):
# Try again for hidden UnionKind enum # Try again for hidden UnionKind enum
for expr_elem in exprs: for expr_elem in exprs:
expr = expr_elem['expr'] expr = expr_elem['expr']
if 'include' in expr:
continue
if 'union' in expr and not discriminator_find_enum_define(expr): if 'union' in expr and not discriminator_find_enum_define(expr):
name = '%sKind' % expr['union'] name = '%sKind' % expr['union']
elif 'alternate' in expr: elif 'alternate' in expr:
@ -956,6 +964,8 @@ def check_exprs(exprs):
info = expr_elem['info'] info = expr_elem['info']
doc = expr_elem.get('doc') doc = expr_elem.get('doc')
if 'include' in expr:
continue
if 'enum' in expr: if 'enum' in expr:
check_enum(expr, info) check_enum(expr, info)
elif 'union' in expr: elif 'union' in expr:
@ -1676,6 +1686,8 @@ class QAPISchema(object):
self._def_command(expr, info, doc) self._def_command(expr, info, doc)
elif 'event' in expr: elif 'event' in expr:
self._def_event(expr, info, doc) self._def_event(expr, info, doc)
elif 'include' in expr:
pass
else: else:
assert False assert False