mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qapi: Clean up member name case checking

Browse Source 
QAPISchemaMember.check_clash() checks for member names that map to the
same c_name().  Takes care of rejecting duplicate names.

It also checks a naming rule: no uppercase in member names.  That's a
rather odd place to do it.  Enforcing naming rules is
check_name_str()'s job.

qapi-code-gen.txt specifies the name case rule applies to the name as
it appears in the schema.  check_clash() checks c_name(name) instead.
No difference, as c_name() leaves alone case, but unclean.

Move the name case check into check_name_str(), less the c_name().
New argument @permit_upper suppresses it.  Pass permit_upper=True for
definitions (which are not members), and when the member's owner is
whitelisted with pragma name-case-whitelist.

Bonus: name-case-whitelist now applies to a union's inline base, too.
Update qapi/qapi-schema.json pragma to whitelist union CpuInfo instead
of CpuInfo's implicit base type's name q_obj_CpuInfo-base.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190927134639.4284-6-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2019-09-27 15:46:18 +02:00
parent 7be6c51194
commit 638c4af931
7 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
qapi/qapi-schema.json
View File

@ -71,7 +71,7 @@
'QapiErrorClass', # all members, visible through errors
'UuidInfo', # UUID, visible through query-uuid
'X86CPURegister32', # all members, visible indirectly through qom-get
'q_obj_CpuInfo-base' # CPU, visible through query-cpu
'CpuInfo' # CPU, visible through query-cpu
] } }
# Documentation generated with qapi-gen.py is in source order, with

25
scripts/qapi/common.py
View File

@ -704,8 +704,8 @@ valid_name = re.compile(r'^(__[a-zA-Z0-9.-]+_)?'
'[a-zA-Z][a-zA-Z0-9_-]*$')
def check_name(info, source, name, allow_optional=False,
enum_member=False):
def check_name(info, source, name,
allow_optional=False, enum_member=False, permit_upper=False):
global valid_name
membername = name
@ -725,11 +725,14 @@ def check_name(info, source, name, allow_optional=False,
if not valid_name.match(membername) or \
c_name(membername, False).startswith('q_'):
raise QAPISemError(info, "%s uses invalid name '%s'" % (source, name))
if not permit_upper and name.lower() != name:
raise QAPISemError(
info, "%s uses uppercase in name '%s'" % (source, name))
def add_name(name, info, meta):
global all_names
check_name(info, "'%s'" % meta, name)
check_name(info, "'%s'" % meta, name, permit_upper=True)
# FIXME should reject names that differ only in '_' vs. '.'
# vs. '-', because they're liable to clash in generated C.
if name in all_names:
@ -797,10 +800,12 @@ def check_type(info, source, value,
raise QAPISemError(info,
"%s should be an object or type name" % source)
permit_upper = allow_dict in name_case_whitelist
# value is a dictionary, check that each member is okay
for (key, arg) in value.items():
check_name(info, "Member of %s" % source, key,
allow_optional=True)
allow_optional=True, permit_upper=permit_upper)
if c_name(key, False) == 'u' or c_name(key, False).startswith('has_'):
raise QAPISemError(info, "Member of %s uses reserved name '%s'"
% (source, key))
@ -870,7 +875,7 @@ def check_union(expr, info):
else:
# The object must have a string or dictionary 'base'.
check_type(info, "'base' for union '%s'" % name,
base, allow_dict=True,
base, allow_dict=name,
allow_metas=['struct'])
if not base:
raise QAPISemError(info, "Flat union '%s' must have a base"
@ -982,13 +987,15 @@ def check_enum(expr, info):
raise QAPISemError(info,
"Enum '%s' requires a string for 'prefix'" % name)
permit_upper = name in name_case_whitelist
for member in members:
check_known_keys(info, "member of enum '%s'" % name, member,
['name'], ['if'])
check_if(member, info)
normalize_if(member)
check_name(info, "Member of enum '%s'" % name, member['name'],
enum_member=True)
enum_member=True, permit_upper=permit_upper)
def check_struct(expr, info):
@ -997,7 +1004,7 @@ def check_struct(expr, info):
features = expr.get('features')
check_type(info, "'data' for struct '%s'" % name, members,
allow_dict=True)
allow_dict=name)
check_type(info, "'base' for struct '%s'" % name, expr.get('base'),
allow_metas=['struct'])
@ -1555,10 +1562,6 @@ class QAPISchemaMember(object):
def check_clash(self, info, seen):
cname = c_name(self.name)
if (cname.lower() != cname
and self.defined_in not in name_case_whitelist):
raise QAPISemError(info,
"%s should not use uppercase" % self.describe())
if cname in seen:
raise QAPISemError(info, "%s collides with %s" %
(self.describe(), seen[cname].describe()))

2
tests/qapi-schema/args-member-case.err
View File

@ -1,2 +1,2 @@
tests/qapi-schema/args-member-case.json: In command 'no-way-this-will-get-whitelisted':
tests/qapi-schema/args-member-case.json:2: 'Arg' (parameter of no-way-this-will-get-whitelisted) should not use uppercase
tests/qapi-schema/args-member-case.json:2: Member of 'data' for command 'no-way-this-will-get-whitelisted' uses uppercase in name 'Arg'

2
tests/qapi-schema/args-member-case.json
View File

@ -1,2 +1,2 @@
# Member names should be 'lower-case' unless the struct/command is whitelisted
# Member names should be 'lower-case' unless the struct is whitelisted
{ 'command': 'no-way-this-will-get-whitelisted', 'data': { 'Arg': 'int' } }

2
tests/qapi-schema/enum-member-case.err
View File

@ -1,2 +1,2 @@
tests/qapi-schema/enum-member-case.json: In enum 'NoWayThisWillGetWhitelisted':
tests/qapi-schema/enum-member-case.json:4: 'Value' (value of NoWayThisWillGetWhitelisted) should not use uppercase
tests/qapi-schema/enum-member-case.json:4: Member of enum 'NoWayThisWillGetWhitelisted' uses uppercase in name 'Value'

4
tests/qapi-schema/union-branch-case.err
View File

@ -1,2 +1,2 @@
tests/qapi-schema/union-branch-case.json: In union 'NoWayThisWillGetWhitelisted':
tests/qapi-schema/union-branch-case.json:2: 'Branch' (branch of NoWayThisWillGetWhitelisted) should not use uppercase
tests/qapi-schema/union-branch-case.json: In union 'Uni':
tests/qapi-schema/union-branch-case.json:2: Member of union 'Uni' uses uppercase in name 'Branch'

4
tests/qapi-schema/union-branch-case.json
View File

@ -1,2 +1,2 @@
# Branch names should be 'lower-case' unless the union is whitelisted
{ 'union': 'NoWayThisWillGetWhitelisted', 'data': { 'Branch': 'int' } }
# Branch names should be 'lower-case'
{ 'union': 'Uni', 'data': { 'Branch': 'int' } }