[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 05/26] qapi: Clean up member name case checking
From: |
Markus Armbruster |
Subject: |
[PATCH v2 05/26] qapi: Clean up member name case checking |
Date: |
Fri, 27 Sep 2019 15:46:18 +0200 |
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 <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
---
qapi/qapi-schema.json | 2 +-
scripts/qapi/common.py | 25 +++++++++++++-----------
tests/qapi-schema/args-member-case.err | 2 +-
tests/qapi-schema/args-member-case.json | 2 +-
tests/qapi-schema/enum-member-case.err | 2 +-
tests/qapi-schema/union-branch-case.err | 4 ++--
tests/qapi-schema/union-branch-case.json | 4 ++--
7 files changed, 22 insertions(+), 19 deletions(-)
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
index 920b03b0aa..9751b11f8f 100644
--- a/qapi/qapi-schema.json
+++ b/qapi/qapi-schema.json
@@ -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
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index f0e7d5ad34..ed4bff4479 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -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()))
diff --git a/tests/qapi-schema/args-member-case.err
b/tests/qapi-schema/args-member-case.err
index 725ba16192..da183957b2 100644
--- a/tests/qapi-schema/args-member-case.err
+++ b/tests/qapi-schema/args-member-case.err
@@ -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'
diff --git a/tests/qapi-schema/args-member-case.json
b/tests/qapi-schema/args-member-case.json
index 93439bee8b..e27c603548 100644
--- a/tests/qapi-schema/args-member-case.json
+++ b/tests/qapi-schema/args-member-case.json
@@ -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' } }
diff --git a/tests/qapi-schema/enum-member-case.err
b/tests/qapi-schema/enum-member-case.err
index f6c872d3bf..8f2007c86f 100644
--- a/tests/qapi-schema/enum-member-case.err
+++ b/tests/qapi-schema/enum-member-case.err
@@ -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'
diff --git a/tests/qapi-schema/union-branch-case.err
b/tests/qapi-schema/union-branch-case.err
index 8e81a2d0b6..09313d7f83 100644
--- a/tests/qapi-schema/union-branch-case.err
+++ b/tests/qapi-schema/union-branch-case.err
@@ -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'
diff --git a/tests/qapi-schema/union-branch-case.json
b/tests/qapi-schema/union-branch-case.json
index e6565dc3b3..b7894b75d6 100644
--- a/tests/qapi-schema/union-branch-case.json
+++ b/tests/qapi-schema/union-branch-case.json
@@ -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' } }
--
2.21.0
- [PATCH v2 07/26] qapi: Improve reporting of member name clashes, (continued)
- [PATCH v2 07/26] qapi: Improve reporting of member name clashes, Markus Armbruster, 2019/09/27
- [PATCH v2 15/26] qapi: Inline check_name() into check_union(), Markus Armbruster, 2019/09/27
- [PATCH v2 11/26] qapi: Report invalid '*' prefix like any other invalid name, Markus Armbruster, 2019/09/27
- [PATCH v2 17/26] qapi: Move context-free checking to the proper place, Markus Armbruster, 2019/09/27
- [PATCH v2 09/26] qapi: Improve reporting of invalid name errors, Markus Armbruster, 2019/09/27
- [PATCH v2 12/26] qapi: Move check for reserved names out of add_name(), Markus Armbruster, 2019/09/27
- [PATCH v2 21/26] qapi: Avoid redundant definition references in error messages, Markus Armbruster, 2019/09/27
- [PATCH v2 04/26] qapi: Prefix frontend errors with an "in definition" line, Markus Armbruster, 2019/09/27
- [PATCH v2 18/26] qapi: Improve reporting of invalid 'if' errors, Markus Armbruster, 2019/09/27
- [PATCH v2 08/26] qapi: Reorder check_FOO() parameters for consistency, Markus Armbruster, 2019/09/27
- [PATCH v2 05/26] qapi: Clean up member name case checking,
Markus Armbruster <=
- [PATCH v2 16/26] qapi: Move context-sensitive checking to the proper place, Markus Armbruster, 2019/09/27
- [PATCH v2 23/26] qapi: Eliminate check_keys(), rename check_known_keys(), Markus Armbruster, 2019/09/27
- [PATCH v2 14/26] qapi: Plumb info to the QAPISchemaMember, Markus Armbruster, 2019/09/27
- [PATCH v2 24/26] qapi: Improve reporting of missing documentation comment, Markus Armbruster, 2019/09/27
- [PATCH v2 20/26] qapi: Improve reporting of missing / unknown definition keys, Markus Armbruster, 2019/09/27
- [PATCH v2 26/26] qapi: Improve source file read error handling, Markus Armbruster, 2019/09/27
- [PATCH v2 06/26] qapi: Change frontend error messages to start with lower case, Markus Armbruster, 2019/09/27