Skip to content

Commit

Permalink
qapi: Consistent generated code: minimize push_indent() usage
Browse files Browse the repository at this point in the history
We had some pointless differences in the generated code for visit,
command marshalling, and events; unifying them makes it easier for
future patches to consolidate to common helper functions.
This is one patch of a series to clean up these differences.

This patch reduces the number of push_indent()/pop_indent() pairs
so that generated code is typically already at its natural output
indentation in the python files.  It is easier to reason about
generated code if the reader does not have to track how much
spacing will be inserted alongside the code, and moreso when all
of the generators use the same patterns (qapi-type and qapi-event
were already using in-place indentation).

Arguably, the resulting python may be a bit harder to read with C
code at the same indentation as python; on the other hand, not
having to think about push_indent() is a win, and most decent
editors provide syntax highlighting that makes it easier to
visually distinguish python code from string literals that will
become C code.

There is no change to the generated output.

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1443565276-4535-15-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
  • Loading branch information
ebblake authored and Markus Armbruster committed Oct 12, 2015
1 parent e36c714 commit 05372f7
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 45 deletions.
54 changes: 22 additions & 32 deletions scripts/qapi-commands.py
Expand Up @@ -29,9 +29,9 @@ def gen_err_check(err):
if not err:
return ''
return mcgen('''
if (%(err)s) {
goto out;
}
if (%(err)s) {
goto out;
}
''',
err=err)

Expand All @@ -50,20 +50,18 @@ def gen_call(name, arg_type, ret_type):
if ret_type:
lhs = 'retval = '

push_indent()
ret = mcgen('''
%(lhs)sqmp_%(c_name)s(%(args)s&err);
%(lhs)sqmp_%(c_name)s(%(args)s&err);
''',
c_name=c_name(name), args=argstr, lhs=lhs)
if ret_type:
ret += gen_err_check('err')
ret += mcgen('''
qmp_marshal_output_%(c_name)s(retval, ret, &err);
qmp_marshal_output_%(c_name)s(retval, ret, &err);
''',
c_name=ret_type.c_name())
pop_indent()
return ret


Expand All @@ -72,29 +70,27 @@ def gen_marshal_vars(arg_type, ret_type):
Error *err = NULL;
''')

push_indent()

if ret_type:
ret += mcgen('''
%(c_type)s retval;
%(c_type)s retval;
''',
c_type=ret_type.c_type())

if arg_type:
ret += mcgen('''
QmpInputVisitor *qiv = qmp_input_visitor_new_strict(QOBJECT(args));
QapiDeallocVisitor *qdv;
Visitor *v;
QmpInputVisitor *qiv = qmp_input_visitor_new_strict(QOBJECT(args));
QapiDeallocVisitor *qdv;
Visitor *v;
''')

for memb in arg_type.members:
if memb.optional:
ret += mcgen('''
bool has_%(c_name)s = false;
bool has_%(c_name)s = false;
''',
c_name=c_name(memb.name))
ret += mcgen('''
%(c_type)s %(c_name)s = %(c_null)s;
%(c_type)s %(c_name)s = %(c_null)s;
''',
c_name=c_name(memb.name),
c_type=memb.type.c_type(),
Expand All @@ -103,10 +99,9 @@ def gen_marshal_vars(arg_type, ret_type):
else:
ret += mcgen('''
(void)args;
(void)args;
''')

pop_indent()
return ret


Expand All @@ -116,53 +111,50 @@ def gen_marshal_input_visit(arg_type, dealloc=False):
if not arg_type:
return ret

push_indent()

if dealloc:
errparg = 'NULL'
errarg = None
ret += mcgen('''
qmp_input_visitor_cleanup(qiv);
qdv = qapi_dealloc_visitor_new();
v = qapi_dealloc_get_visitor(qdv);
qmp_input_visitor_cleanup(qiv);
qdv = qapi_dealloc_visitor_new();
v = qapi_dealloc_get_visitor(qdv);
''')
else:
errparg = '&err'
errarg = 'err'
ret += mcgen('''
v = qmp_input_get_visitor(qiv);
v = qmp_input_get_visitor(qiv);
''')

for memb in arg_type.members:
if memb.optional:
ret += mcgen('''
visit_optional(v, &has_%(c_name)s, "%(name)s", %(errp)s);
visit_optional(v, &has_%(c_name)s, "%(name)s", %(errp)s);
''',
c_name=c_name(memb.name), name=memb.name,
errp=errparg)
ret += gen_err_check(errarg)
ret += mcgen('''
if (has_%(c_name)s) {
if (has_%(c_name)s) {
''',
c_name=c_name(memb.name))
push_indent()
ret += mcgen('''
visit_type_%(c_type)s(v, &%(c_name)s, "%(name)s", %(errp)s);
visit_type_%(c_type)s(v, &%(c_name)s, "%(name)s", %(errp)s);
''',
c_name=c_name(memb.name), name=memb.name,
c_type=memb.type.c_name(), errp=errparg)
ret += gen_err_check(errarg)
if memb.optional:
pop_indent()
ret += mcgen('''
}
}
''')

if dealloc:
ret += mcgen('''
qapi_dealloc_visitor_cleanup(qdv);
qapi_dealloc_visitor_cleanup(qdv);
''')
pop_indent()
return ret


Expand Down Expand Up @@ -237,17 +229,15 @@ def gen_marshal(name, arg_type, ret_type):


def gen_register_command(name, success_response):
push_indent()
options = 'QCO_NO_OPTIONS'
if not success_response:
options = 'QCO_NO_SUCCESS_RESP'

ret = mcgen('''
qmp_register_command("%(name)s", qmp_marshal_%(c_name)s, %(opts)s);
qmp_register_command("%(name)s", qmp_marshal_%(c_name)s, %(opts)s);
''',
name=name, c_name=c_name(name),
opts=options)
pop_indent()
return ret


Expand Down
24 changes: 11 additions & 13 deletions scripts/qapi-visit.py
Expand Up @@ -77,44 +77,42 @@ def gen_visit_struct_fields(name, base, members):
''',
c_name=c_name(name))
push_indent()

if base:
ret += mcgen('''
visit_type_implicit_%(c_type)s(v, &(*obj)->%(c_name)s, &err);
if (err) {
goto out;
}
visit_type_implicit_%(c_type)s(v, &(*obj)->%(c_name)s, &err);
if (err) {
goto out;
}
''',
c_type=base.c_name(), c_name=c_name('base'))

for memb in members:
if memb.optional:
ret += mcgen('''
visit_optional(v, &(*obj)->has_%(c_name)s, "%(name)s", &err);
if (!err && (*obj)->has_%(c_name)s) {
visit_optional(v, &(*obj)->has_%(c_name)s, "%(name)s", &err);
if (!err && (*obj)->has_%(c_name)s) {
''',
c_name=c_name(memb.name), name=memb.name)
push_indent()

ret += mcgen('''
visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "%(name)s", &err);
visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "%(name)s", &err);
''',
c_type=memb.type.c_name(), c_name=c_name(memb.name),
name=memb.name)

if memb.optional:
pop_indent()
ret += mcgen('''
}
}
''')
ret += mcgen('''
if (err) {
goto out;
}
if (err) {
goto out;
}
''')

pop_indent()
if re.search('^ *goto out;', ret, re.MULTILINE):
ret += mcgen('''
Expand Down

0 comments on commit 05372f7

Please sign in to comment.