aboutsummaryrefslogtreecommitdiff
path: root/include/qapi/string-output-visitor.h
diff options
context:
space:
mode:
authorEric Blake <eblake@redhat.com>2016-04-28 15:45:22 -0600
committerMarkus Armbruster <armbru@redhat.com>2016-05-12 09:47:54 +0200
commit3bc97fd5924561d92f32758c67eaffd2e4e25038 (patch)
treea544ba5f5abad205a52d6255d0560d2ee23d32ce /include/qapi/string-output-visitor.h
parent7d7a337ec32c77f11ba04da412752b35e18d3c5c (diff)
downloadqemu-3bc97fd5924561d92f32758c67eaffd2e4e25038.zip
qemu-3bc97fd5924561d92f32758c67eaffd2e4e25038.tar.gz
qemu-3bc97fd5924561d92f32758c67eaffd2e4e25038.tar.bz2
qapi: Add visit_type_null() visitor
Right now, qmp-output-visitor happens to produce a QNull result if nothing is actually visited between the creation of the visitor and the request for the resulting QObject. A stronger protocol would require that a QMP output visit MUST visit something. But to still be able to produce a JSON 'null' output, we need a new visitor function that states our intentions. Yes, we could say that such a visit must go through visit_type_any(), but that feels clunky. So this patch introduces the new visit_type_null() interface and its no-op interface in the dealloc visitor, and stubs in the qmp visitors (the next patch will finish the implementation). For the visitors that will not implement the callback, document the situation. The code in qapi-visit-core unconditionally dereferences the callback pointer, so that a segfault will inform a developer if they need to implement the callback for their choice of visitor. Note that JSON has a primitive null type, with the single value null; likewise with the QNull type for QObject; but for QAPI, we just have the 'null' value without a null type. We may eventually want to add more support in QAPI for null (most likely, we'd use it via an alternate type that permits 'null' or an object); but we'll create that usage when we need it. Signed-off-by: Eric Blake <eblake@redhat.com> Message-Id: <1461879932-9020-15-git-send-email-eblake@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'include/qapi/string-output-visitor.h')
-rw-r--r--include/qapi/string-output-visitor.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/qapi/string-output-visitor.h b/include/qapi/string-output-visitor.h
index 3bb09af..89b7e4b 100644
--- a/include/qapi/string-output-visitor.h
+++ b/include/qapi/string-output-visitor.h
@@ -19,7 +19,7 @@ typedef struct StringOutputVisitor StringOutputVisitor;
/*
* The string output visitor does not implement support for visiting
- * QAPI structs, alternates, or arbitrary QTypes.
+ * QAPI structs, alternates, null, or arbitrary QTypes.
*/
StringOutputVisitor *string_output_visitor_new(bool human);
void string_output_visitor_cleanup(StringOutputVisitor *v);