[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH RFC v4 01/29] qapi: Provide nicer array names in int
From: |
Eric Blake |
Subject: |
[Qemu-devel] [PATCH RFC v4 01/29] qapi: Provide nicer array names in introspection |
Date: |
Wed, 9 Sep 2015 22:06:03 -0600 |
For the sake of humans reading introspection output, it is nice
to have the name of implicit array types be recognizable as
arrays of the underlying type. However, while this allows
humans to skip from a command with return type "[123]" straight
to the definition of type "123" without having to first inspect
type "[123]", document that this shortcut should not be taken by
client apps.
This makes the resulting introspection string slightly larger by
default, but slightly smaller when -u is in use (as '[FOO]' is
nicer than 'FOOList' for expressing 'array of FOO').
Signed-off-by: Eric Blake <address@hidden>
---
docs/qapi-code-gen.txt | 7 +++++--
scripts/qapi-introspect.py | 8 +++++---
2 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index 01e292b..8d87e67 100644
--- a/docs/qapi-code-gen.txt
+++ b/docs/qapi-code-gen.txt
@@ -650,11 +650,14 @@ Example: the SchemaInfo for BlockRef from section
Alternate types
The SchemaInfo for an array type has meta-type "array", and variant
member "element-type", which names the array's element type. Array
-types are implicitly defined.
+types are implicitly defined. For convenience, the array's name may
+resemble the element type; however, clients should examine member
+"element-type" instead of making assumptions based on parsing member
+"name".
Example: the SchemaInfo for ['str']
- { "name": "strList", "meta-type": "array",
+ { "name": "[str]", "meta-type": "array",
"element-type": "str" }
The SchemaInfo for an enumeration type has meta-type "enum" and
diff --git a/scripts/qapi-introspect.py b/scripts/qapi-introspect.py
index ce98321..eef5f1d 100644
--- a/scripts/qapi-introspect.py
+++ b/scripts/qapi-introspect.py
@@ -104,10 +104,12 @@ const char %(c_name)s[] = %(c_string)s;
# characters.
if isinstance(typ, QAPISchemaBuiltinType):
return typ.name
+ if isinstance(typ, QAPISchemaArrayType):
+ return '[' + self._use_type(typ.element_type) + ']'
return self._name(typ.name)
def _gen_json(self, name, mtype, obj):
- if mtype != 'command' and mtype != 'event' and mtype != 'builtin':
+ if mtype not in ('command', 'event', 'builtin', 'array'):
name = self._name(name)
obj['name'] = name
obj['meta-type'] = mtype
@@ -133,8 +135,8 @@ const char %(c_name)s[] = %(c_string)s;
self._gen_json(name, 'enum', {'values': values})
def visit_array_type(self, name, info, element_type):
- self._gen_json(name, 'array',
- {'element-type': self._use_type(element_type)})
+ element = self._use_type(element_type)
+ self._gen_json('[' + element + ']', 'array', {'element-type': element})
def visit_object_type_flat(self, name, info, members, variants):
obj = {'members': [self._gen_member(m) for m in members]}
--
2.4.3
- [Qemu-devel] [PATCH RFC v4 00/29] qapi-ify netdev_add, and other post-introspection cleanups, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 01/29] qapi: Provide nicer array names in introspection,
Eric Blake <=
- [Qemu-devel] [PATCH RFC v4 04/29] vnc: hoist allocation of VncBasicInfo to callers, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 06/29] qapi-visit: Remove redundant functions for flat union base, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 02/29] net: use Netdev instead of NetClientOptions in client init, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 05/29] qapi: Unbox base members, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 07/29] qapi: Test use of 'number' within alternates, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 09/29] qapi: Hide tag_name data member of variants, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 08/29] qapi: Simplify visiting of alternate types, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 12/29] qapi: Use consistent generated code patterns, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 17/29] qapi: Drop useless 'data' member of unions, Eric Blake, 2015/09/10
- [Qemu-devel] [PATCH RFC v4 11/29] qapi: Don't pass pre-existing error to later call, Eric Blake, 2015/09/10