adfb264c9e
The visitor interface for mapping between QObject/QemuOpts/string and QAPI is scandalously under-documented, making changes to visitor core, individual visitors, and users of visitors difficult to coordinate. Among other questions: when is it safe to pass NULL, vs. when a string must be provided; which visitors implement which callbacks; the difference between concrete and virtual visits. Correct this by retrofitting proper contracts, and document where some of the interface warts remain (for example, we may want to modify visit_end_* to require the same 'obj' as the visit_start counterpart, so the dealloc visitor can be simplified). Later patches in this series will tackle some, but not all, of these warts. Add assertions to (partially) enforce the contract. Some of these were only made possible by recent cleanup commits. Signed-off-by: Eric Blake <eblake@redhat.com> Message-Id: <1461879932-9020-13-git-send-email-eblake@redhat.com> [Doc fix from Eric squashed in] Signed-off-by: Markus Armbruster <armbru@redhat.com>
31 lines
782 B
C
31 lines
782 B
C
/*
|
|
* String printing Visitor
|
|
*
|
|
* Copyright Red Hat, Inc. 2012
|
|
*
|
|
* Author: Paolo Bonzini <pbonzini@redhat.com>
|
|
*
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
*
|
|
*/
|
|
|
|
#ifndef STRING_OUTPUT_VISITOR_H
|
|
#define STRING_OUTPUT_VISITOR_H
|
|
|
|
#include "qapi/visitor.h"
|
|
|
|
typedef struct StringOutputVisitor StringOutputVisitor;
|
|
|
|
/*
|
|
* The string output visitor does not implement support for visiting
|
|
* QAPI structs, alternates, or arbitrary QTypes.
|
|
*/
|
|
StringOutputVisitor *string_output_visitor_new(bool human);
|
|
void string_output_visitor_cleanup(StringOutputVisitor *v);
|
|
|
|
char *string_output_get_string(StringOutputVisitor *v);
|
|
Visitor *string_output_get_visitor(StringOutputVisitor *v);
|
|
|
|
#endif
|