[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 16/40] qapi: Detect collisions in C member names
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 16/40] qapi: Detect collisions in C member names |
Date: |
Thu, 17 Dec 2015 09:33:21 +0100 |
From: Eric Blake <address@hidden>
Detect attempts to declare two object members that would result
in the same C member name, by keying the 'seen' dictionary off
of the C name rather than the qapi name. It also requires passing
info through the check_clash() methods.
This addresses a TODO and fixes the previously-broken
args-name-clash test. The resulting error message demonstrates
the utility of the .describe() method added previously. No change
to generated code.
Signed-off-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>
---
scripts/qapi.py | 31 +++++++++++++++++++------------
tests/qapi-schema/args-name-clash.err | 1 +
tests/qapi-schema/args-name-clash.exit | 2 +-
tests/qapi-schema/args-name-clash.json | 5 ++---
tests/qapi-schema/args-name-clash.out | 6 ------
5 files changed, 23 insertions(+), 22 deletions(-)
diff --git a/scripts/qapi.py b/scripts/qapi.py
index 77d3e0a..4870326 100644
--- a/scripts/qapi.py
+++ b/scripts/qapi.py
@@ -977,20 +977,23 @@ class QAPISchemaObjectType(QAPISchemaType):
self.base = schema.lookup_type(self._base_name)
assert isinstance(self.base, QAPISchemaObjectType)
self.base.check(schema)
- self.base.check_clash(schema, seen)
+ self.base.check_clash(schema, self.info, seen)
for m in self.local_members:
m.check(schema)
- m.check_clash(seen)
+ m.check_clash(self.info, seen)
self.members = seen.values()
if self.variants:
self.variants.check(schema, seen)
assert self.variants.tag_member in self.members
- self.variants.check_clash(schema, seen)
+ self.variants.check_clash(schema, self.info, seen)
- def check_clash(self, schema, seen):
+ # Check that the members of this type do not cause duplicate JSON fields,
+ # and update seen to track the members seen so far. Report any errors
+ # on behalf of info, which is not necessarily self.info
+ def check_clash(self, schema, info, seen):
assert not self.variants # not implemented
for m in self.members:
- m.check_clash(seen)
+ m.check_clash(info, seen)
def is_implicit(self):
# See QAPISchema._make_implicit_object_type()
@@ -1036,10 +1039,13 @@ class QAPISchemaObjectTypeMember(object):
self.type = schema.lookup_type(self._type_name)
assert self.type
- def check_clash(self, seen):
- # TODO change key of seen from QAPI name to C name
- assert self.name not in seen
- seen[self.name] = self
+ def check_clash(self, info, seen):
+ cname = c_name(self.name)
+ if cname in seen:
+ raise QAPIExprError(info,
+ "%s collides with %s"
+ % (self.describe(), seen[cname].describe()))
+ seen[cname] = self
def _pretty_owner(self):
owner = self.owner
@@ -1080,7 +1086,8 @@ class QAPISchemaObjectTypeVariants(object):
def check(self, schema, seen):
if not self.tag_member: # flat union
- self.tag_member = seen[self.tag_name]
+ self.tag_member = seen[c_name(self.tag_name)]
+ assert self.tag_name == self.tag_member.name
assert isinstance(self.tag_member.type, QAPISchemaEnumType)
for v in self.variants:
v.check(schema)
@@ -1088,12 +1095,12 @@ class QAPISchemaObjectTypeVariants(object):
if isinstance(v.type, QAPISchemaObjectType):
v.type.check(schema)
- def check_clash(self, schema, seen):
+ def check_clash(self, schema, info, seen):
for v in self.variants:
# Reset seen map for each variant, since qapi names from one
# branch do not affect another branch
assert isinstance(v.type, QAPISchemaObjectType)
- v.type.check_clash(schema, dict(seen))
+ v.type.check_clash(schema, info, dict(seen))
class QAPISchemaObjectTypeVariant(QAPISchemaObjectTypeMember):
diff --git a/tests/qapi-schema/args-name-clash.err
b/tests/qapi-schema/args-name-clash.err
index e69de29..d953e8d 100644
--- a/tests/qapi-schema/args-name-clash.err
+++ b/tests/qapi-schema/args-name-clash.err
@@ -0,0 +1 @@
+tests/qapi-schema/args-name-clash.json:4: 'a_b' (parameter of oops) collides
with 'a-b' (parameter of oops)
diff --git a/tests/qapi-schema/args-name-clash.exit
b/tests/qapi-schema/args-name-clash.exit
index 573541a..d00491f 100644
--- a/tests/qapi-schema/args-name-clash.exit
+++ b/tests/qapi-schema/args-name-clash.exit
@@ -1 +1 @@
-0
+1
diff --git a/tests/qapi-schema/args-name-clash.json
b/tests/qapi-schema/args-name-clash.json
index 9e8f889..61423cb 100644
--- a/tests/qapi-schema/args-name-clash.json
+++ b/tests/qapi-schema/args-name-clash.json
@@ -1,5 +1,4 @@
# C member name collision
-# FIXME - This parses, but fails to compile, because the C struct is given
-# two 'a_b' members. Either reject this at parse time, or munge the C names
-# to avoid the collision.
+# Reject members that clash when mapped to C names (we would have two 'a_b'
+# members).
{ 'command': 'oops', 'data': { 'a-b': 'str', 'a_b': 'str' } }
diff --git a/tests/qapi-schema/args-name-clash.out
b/tests/qapi-schema/args-name-clash.out
index 9b2f6e4..e69de29 100644
--- a/tests/qapi-schema/args-name-clash.out
+++ b/tests/qapi-schema/args-name-clash.out
@@ -1,6 +0,0 @@
-object :empty
-object :obj-oops-arg
- member a-b: str optional=False
- member a_b: str optional=False
-command oops :obj-oops-arg -> None
- gen=True success_response=True
--
2.4.3
- [Qemu-devel] [PULL 25/40] qapi: Add alias for ErrorClass, (continued)
- [Qemu-devel] [PULL 25/40] qapi: Add alias for ErrorClass, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 32/40] qapi: Inline _make_implicit_tag(), Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 14/40] qapi: Remove outdated tests related to QMP/branch collisions, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 08/40] qapi: Eliminate QAPISchemaObjectType.check() variable members, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 13/40] qapi: Hoist tag collision check to Variants.check(), Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 21/40] qapi: Tighten the regex on valid names, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 23/40] qapi: Remove obsolete tests for MAX collision, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 31/40] qapi-types: Drop unnedeed ._fwdefn, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 11/40] qapi: Check for QAPI collisions involving variant members, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 20/40] blkdebug: Avoid '.' in enum values, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 16/40] qapi: Detect collisions in C member names,
Markus Armbruster <=
- [Qemu-devel] [PULL 15/40] qapi: Track owner of each object member, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 28/40] qobject: Rename qtype_code to QType, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 35/40] qapi: Shorter visits of optional fields, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 34/40] qapi: Simplify visits of optional fields, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 27/40] qobject: Simplify QObject, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 39/40] qapi: Move duplicate collision checks to schema check(), Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 29/40] qapi: Convert QType into QAPI built-in enum type, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 37/40] qapi: Track enum values by QAPISchemaMember, not string, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 40/40] qapi: Detect base class loops, Markus Armbruster, 2015/12/17
- [Qemu-devel] [PULL 33/40] qapi: Fix alternates that accept 'number' but not 'int', Markus Armbruster, 2015/12/17