[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL v2 05/25] qapi: Reserve '*List' type names for list t
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL v2 05/25] qapi: Reserve '*List' type names for list types |
Date: |
Mon, 2 Nov 2015 10:13:10 +0100 |
From: Eric Blake <address@hidden>
Type names ending in 'List' can clash with qapi list types in
generated C. We don't currently use such names. It is easier to
outlaw them now than to worry about how to resolve such a clash
in the future. For precedence, see commit 4dc2e69, which did the
same for names ending in 'Kind' versus implicit enum types for
qapi unions.
Update the testsuite to match.
Signed-off-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>
---
docs/qapi-code-gen.txt | 3 ++-
scripts/qapi.py | 10 ++++------
tests/qapi-schema/reserved-type-list.err | 1 +
tests/qapi-schema/reserved-type-list.exit | 2 +-
tests/qapi-schema/reserved-type-list.json | 6 +++---
tests/qapi-schema/reserved-type-list.out | 3 ---
6 files changed, 11 insertions(+), 14 deletions(-)
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index 2afab20..c4264a8 100644
--- a/docs/qapi-code-gen.txt
+++ b/docs/qapi-code-gen.txt
@@ -106,7 +106,8 @@ Types, commands, and events share a common namespace.
Therefore,
generally speaking, type definitions should always use CamelCase for
user-defined type names, while built-in types are lowercase. Type
definitions should not end in 'Kind', as this namespace is used for
-creating implicit C enums for visiting union types. Command names,
+creating implicit C enums for visiting union types, or in 'List', as
+this namespace is used for creating array types. Command names,
and field names within a type, should be all lower case with words
separated by a hyphen. However, some existing older commands and
complex types use underscore; when extending such expressions,
diff --git a/scripts/qapi.py b/scripts/qapi.py
index 3af4c2c..d53b5c4 100644
--- a/scripts/qapi.py
+++ b/scripts/qapi.py
@@ -390,10 +390,10 @@ def add_name(name, info, meta, implicit=False):
raise QAPIExprError(info,
"%s '%s' is already defined"
% (all_names[name], name))
- if not implicit and name.endswith('Kind'):
+ if not implicit and (name.endswith('Kind') or name.endswith('List')):
raise QAPIExprError(info,
- "%s '%s' should not end in 'Kind'"
- % (meta, name))
+ "%s '%s' should not end in '%s'"
+ % (meta, name, name[-4:]))
all_names[name] = meta
@@ -1196,9 +1196,7 @@ class QAPISchema(object):
return name
def _make_array_type(self, element_type, info):
- # TODO fooList namespace is not reserved; user can create collisions,
- # or abuse our type system with ['fooList'] for 2D array
- name = element_type + 'List'
+ name = element_type + 'List' # Use namespace reserved by add_name()
if not self.lookup_type(name):
self._def_entity(QAPISchemaArrayType(name, info, element_type))
return name
diff --git a/tests/qapi-schema/reserved-type-list.err
b/tests/qapi-schema/reserved-type-list.err
index e69de29..4510fa6 100644
--- a/tests/qapi-schema/reserved-type-list.err
+++ b/tests/qapi-schema/reserved-type-list.err
@@ -0,0 +1 @@
+tests/qapi-schema/reserved-type-list.json:5: struct 'FooList' should not end
in 'List'
diff --git a/tests/qapi-schema/reserved-type-list.exit
b/tests/qapi-schema/reserved-type-list.exit
index 573541a..d00491f 100644
--- a/tests/qapi-schema/reserved-type-list.exit
+++ b/tests/qapi-schema/reserved-type-list.exit
@@ -1 +1 @@
-0
+1
diff --git a/tests/qapi-schema/reserved-type-list.json
b/tests/qapi-schema/reserved-type-list.json
index 5b7d0f9..98d53bf 100644
--- a/tests/qapi-schema/reserved-type-list.json
+++ b/tests/qapi-schema/reserved-type-list.json
@@ -1,5 +1,5 @@
# Potential C name collision
-# FIXME - This parses and compiles on its own, but prevents the user from
-# creating a type named 'Foo' and using ['Foo'] for an array. We should
-# reject the use of any type names ending in 'List'.
+# We reserve names ending in 'List' for use by array types.
+# TODO - we could choose array names to avoid collision with user types,
+# in order to let this compile
{ 'struct': 'FooList', 'data': { 's': 'str' } }
diff --git a/tests/qapi-schema/reserved-type-list.out
b/tests/qapi-schema/reserved-type-list.out
index 0406bfe..e69de29 100644
--- a/tests/qapi-schema/reserved-type-list.out
+++ b/tests/qapi-schema/reserved-type-list.out
@@ -1,3 +0,0 @@
-object :empty
-object FooList
- member s: str optional=False
--
2.4.3
- [Qemu-devel] [PULL v2 00/25] QAPI patches, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 01/25] qapi-schema: mark InetSocketAddress as mandatory again, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 08/25] qapi-visit: Split off visit_type_FOO_fields forward decl, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 05/25] qapi: Reserve '*List' type names for list types,
Markus Armbruster <=
- [Qemu-devel] [PULL v2 07/25] vnc: Hoist allocation of VncBasicInfo to callers, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 10/25] qapi: Prefer typesafe upcasts to qapi base classes, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 03/25] qapi: More idiomatic string operations, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 04/25] qapi: More robust conditions for when labels are needed, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 02/25] tests/qapi-schema: Test for reserved names, empty struct, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 14/25] qapi-visit: Convert to new qapi union layout, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 22/25] tpm: Convert to new qapi union layout, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 06/25] qapi: Reserve 'q_*' and 'has_*' member names, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 12/25] qapi-visit: Remove redundant functions for flat union base, Markus Armbruster, 2015/11/02
- [Qemu-devel] [PULL v2 09/25] qapi-types: Refactor base fields output, Markus Armbruster, 2015/11/02