[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v3 26/26] qapi: Improve qobject visitor documentatio
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PATCH v3 26/26] qapi: Improve qobject visitor documentation |
Date: |
Tue, 28 Feb 2017 18:39:20 +0100 |
Signed-off-by: Markus Armbruster <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
---
include/qapi/qobject-input-visitor.h | 37 ++++++++++++++++++++++++++++++++++-
include/qapi/qobject-output-visitor.h | 35 +++++++++++++++++++++++++++++----
2 files changed, 67 insertions(+), 5 deletions(-)
diff --git a/include/qapi/qobject-input-visitor.h
b/include/qapi/qobject-input-visitor.h
index 21db9c4..0b7633a 100644
--- a/include/qapi/qobject-input-visitor.h
+++ b/include/qapi/qobject-input-visitor.h
@@ -1,6 +1,7 @@
/*
* Input Visitor
*
+ * Copyright (C) 2017 Red Hat, Inc.
* Copyright IBM, Corp. 2011
*
* Authors:
@@ -20,7 +21,41 @@
typedef struct QObjectInputVisitor QObjectInputVisitor;
/*
- * Return a new input visitor that converts a QObject to a QAPI object.
+ * Create a QObject input visitor for @obj
+ *
+ * A QObject input visitor visit builds a QAPI object from a QObject.
+ * This simultaneously walks the QAPI object being built and the
+ * QObject. The latter walk starts at @obj.
+ *
+ * visit_type_FOO() creates an instance of QAPI type FOO. The visited
+ * QObject must match FOO. QDict matches struct/union types, QList
+ * matches list types, QString matches type 'str' and enumeration
+ * types, QInt matches integer types, QFloat matches type 'number',
+ * QBool matches type 'bool'. Type 'any' is matched by QObject. A
+ * QAPI alternate type is matched when one of its member types is.
+ *
+ * visit_start_struct() ... visit_end_struct() visits a QDict and
+ * creates a QAPI struct/union. Visits in between visit the
+ * dictionary members. visit_optional() is true when the QDict has
+ * this member. visit_check_struct() fails if unvisited members
+ * remain.
+ *
+ * visit_start_list() ... visit_end_list() visits a QList and creates
+ * a QAPI list. Visits in between visit list members, one after the
+ * other. visit_next_list() returns NULL when all QList members have
+ * been visited. visit_check_list() fails if unvisited members
+ * remain.
+ *
+ * visit_start_alternate() ... visit_end_alternate() visits a QObject
+ * and creates a QAPI alternate. The visit in between visits the same
+ * QObject and initializes the alternate member that is in use.
+ *
+ * Error messages refer to parts of @obj in JavaScript/Python syntax.
+ * For example, 'a.b[2]' refers to the second member of the QList
+ * member 'b' of the QDict member 'a' of QDict @obj.
+ *
+ * The caller is responsible for freeing the visitor with
+ * visit_free().
*/
Visitor *qobject_input_visitor_new(QObject *obj);
diff --git a/include/qapi/qobject-output-visitor.h
b/include/qapi/qobject-output-visitor.h
index 8241877..9b990c3 100644
--- a/include/qapi/qobject-output-visitor.h
+++ b/include/qapi/qobject-output-visitor.h
@@ -19,11 +19,38 @@
typedef struct QObjectOutputVisitor QObjectOutputVisitor;
-/*
- * Create a new QObject output visitor.
+/**
+ * Create a QObject output visitor for @obj
*
- * If everything else succeeds, pass @result to visit_complete() to
- * collect the result of the visit.
+ * A QObject output visitor visit builds a QObject from QAPI Object.
+ * This simultaneously walks the QAPI object and the QObject being
+ * built. The latter walk starts at @obj.
+ *
+ * visit_type_FOO() creates a QObject for QAPI type FOO. It creates a
+ * QDict for struct/union types, a QList for list types, QString for
+ * type 'str' and enumeration types, QInt for integer types, QFloat
+ * for type 'number', QBool for type 'bool'. For type 'any', it
+ * increments the QObject's reference count. For QAPI alternate
+ * types, it creates the QObject for the member that is in use.
+ *
+ * visit_start_struct() ... visit_end_struct() visits a QAPI
+ * struct/union and creates a QDict. Visits in between visit the
+ * members. visit_optional() is true when the struct/union has this
+ * member. visit_check_struct() does nothing.
+ *
+ * visit_start_list() ... visit_end_list() visits a QAPI list and
+ * creates a QList. Visits in between visit list members, one after
+ * the other. visit_next_list() returns NULL when all QAPI list
+ * members have been visited. visit_check_list() does nothing.
+ *
+ * visit_start_alternate() ... visit_end_alternate() visits a QAPI
+ * alternate. The visit in between creates the QObject for the
+ * alternate member that is in use.
+ *
+ * Errors are not expected to happen.
+ *
+ * The caller is responsible for freeing the visitor with
+ * visit_free().
*/
Visitor *qobject_output_visitor_new(QObject **result);
--
2.7.4
- [Qemu-devel] [PATCH v3 04/26] qmp: Dumb down how we run QMP command registration, (continued)
- [Qemu-devel] [PATCH v3 04/26] qmp: Dumb down how we run QMP command registration, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 25/26] qapi: Fix object input visit beyond end of list, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 22/26] test-qobject-input-visitor: Cover missing nested struct member, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 02/26] libqtest: Work around a "QMP wants a newline" bug, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 15/26] qom: Make object_property_set_qobject()'s input visitor strict, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 05/26] qmp: Clean up how we enforce capability negotiation, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 07/26] qmp: Eliminate silly QERR_QMP_* macros, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 12/26] qapi: Improve qobject input visitor error reporting, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 18/26] tests-qobject-input-strict: Merge into test-qobject-input-visitor, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 26/26] qapi: Improve qobject visitor documentation,
Markus Armbruster <=
- [Qemu-devel] [PATCH v3 10/26] qapi: Clean up after commit 3d344c2, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 21/26] tests: Cover partial input visit of list, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 23/26] qapi: Make input visitors detect unvisited list tails, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 13/26] qapi: Drop string input visitor method optional(), Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 03/26] qmp-test: New, covering basic QMP protocol, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 06/26] qmp: Drop duplicated QMP command object checks, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 16/26] test-qobject-input-visitor: Use strict visitor, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 14/26] qapi: Make string input and opts visitor require non-null input, Markus Armbruster, 2017/02/28
- [Qemu-devel] [PATCH v3 19/26] test-string-input-visitor: Tear down existing test automatically, Markus Armbruster, 2017/02/28