docs/devel/qapi-code-gen.rst

40 by any commands or events, for the side effect of generated C code
95 documentation is generated in schema definition order.  Code order
235 The generated C enumeration constants have values 0, 1, ..., N-1 (in
299 The C struct's members are generated in QAPI schema order.
383 resulting generated C data types, a union is represented as a struct
515 section `Code generated for commands`_ for examples.
519 order.  Else it takes them wrapped in the C struct generated for the
670 order.  Else it takes them wrapped in the C struct generated for the
671 complex type.  See section `Code generated for events`_ for examples.
741 becomes ``q_default`` in the generated C code.
796 The C code generated for the definition will then be guarded by an #if
797 preprocessing directive with an operand generated from that condition:
809 gets its generated code guarded like this::
812  ... generated code ...
1173 Undocumented members are not flagged, yet.  Instead, the generated
1177 When you change documentation comments, please check the generated
1230 not.  Therefore, the SchemaInfo for types have auto-generated
1492     $ python scripts/qapi-gen.py --output-dir="qapi-generated" \
1495 For a more thorough look at generated code, the testsuite includes
1501 Code generated for QAPI types
1513 generated code from one schema/code-generation separated from others so code
1514 can be generated/used from multiple schemas without clobbering previously
1519     $ cat qapi-generated/example-qapi-types.h
1556     $ cat qapi-generated/example-qapi-types.c
1588 each sub-module SUBDIR/SUBMODULE.json is actually generated into ::
1603 Code generated for visiting QAPI types
1608 QObject); the generated functions are named visit_type_FOO() and
1611 The following files are generated:
1623     $ cat qapi-generated/example-qapi-visit.h
1644     $ cat qapi-generated/example-qapi-visit.c
1733 each sub-module SUBDIR/SUBMODULE.json is actually generated into ::
1748 Code generated for commands
1752 in the schema.  The generated code provides qmp_marshal_COMMAND(), and
1755 The following files are generated:
1775     $ cat qapi-generated/example-qapi-commands.h
1788     $ cat qapi-generated/example-qapi-commands.trace-events
1789     # AUTOMATICALLY GENERATED, DO NOT MODIFY
1794     $ cat qapi-generated/example-qapi-commands.c
1863     $ cat qapi-generated/example-qapi-init-commands.h
1873     $ cat qapi-generated/example-qapi-init-commands.c
1885 each sub-module SUBDIR/SUBMODULE.json is actually generated into::
1891 Code generated for events
1913     $ cat qapi-generated/example-qapi-events.h
1925     $ cat qapi-generated/example-qapi-events.c
1940     $ cat qapi-generated/example-qapi-emit-events.h
1961     $ cat qapi-generated/example-qapi-emit-events.c
1974 each sub-module SUBDIR/SUBMODULE.json is actually generated into ::
1980 Code generated for introspection
1993     $ cat qapi-generated/example-qapi-introspect.h
2004     $ cat qapi-generated/example-qapi-introspect.c