unicorn/qemu/qapi
Eric Blake fafb3e354b
qapi: Document visitor interfaces, add assertions
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.

Backports commit adfb264c9ed04bfc694921b72173be8e29e90024 from qemu
2018-02-23 15:45:31 -05:00
..
common.json qapi: Add alias for ErrorClass 2018-02-19 20:38:51 -05:00
Makefile.objs remove glib dependency by provide compatible replacements 2016-12-18 14:56:58 -08:00
qapi-dealloc-visitor.c qapi: Change visit_start_implicit_struct to visit_start_alternate 2018-02-23 15:33:25 -05:00
qapi-visit-core.c qapi: Document visitor interfaces, add assertions 2018-02-23 15:45:31 -05:00
qmp-input-visitor.c qapi: Change visit_start_implicit_struct to visit_start_alternate 2018-02-23 15:33:25 -05:00
qmp-output-visitor.c qapi: Adjust layout of FooList types 2018-02-23 14:49:06 -05:00
string-input-visitor.c qapi: Guarantee NULL obj on input visitor callback error 2018-02-23 14:53:23 -05:00