This series introduces alias definitions for QAPI object types (structs
and unions).
This allows using the same QAPI type and visitor even when the syntax
has some variations between different external interfaces such as QMP
and the command line.
It also provides a new tool for evolving the schema while maintaining
backwards compatibility (possibly during a deprecation period).
The first user is intended to be a QAPIfied -chardev command line
option, for which I'll send a separate series. A git tag is available
that contains both this series and the chardev changes that make use of
it:
https://repo.or.cz/qemu/kevin.git qapi-alias-chardev-v3
v3:
- Mention the new functions in the big comment in visitor.h. However,
since the comment is about users of the visitor rather than the
generated code, it seems like to wrong place to go into details.
- Updated commit message for patch 3 ('Simplify full_name_nth() ...')
- Patch 4 ('qapi: Apply aliases in qobject-input-visitor'):
- Multiple matching wildcard aliases are considered conflicting now
- Improved comments for several functions
- Renamed bool *implicit_object into *is_alias_prefix, which
describes better what it is rather than what it is used for
- Simplified alias_present() into input_present()
- Fixed potential use of wrong StackObject in error message
- Patch 5 ('qapi: Add support for aliases'):
- Made QAPISchemaAlias a QAPISchemaMember
- Check validity of alias source paths (must exist in at least one
variant, no optional objects in the path of a wildcard alias, no
alias loops)
- Many new tests cases, both positive and negative, including unit tests
of the generated visit functions
- Coding style changes
- Rebased documentation (.txt -> .rst conversion in master)
v2:
- Renamed 'alias' to 'name' in all data structures describing aliases
- Tons of new or changed comments and other documentation
- Be more explicit that empty 'source' is invalid and assert it
- Fixed full_name_so() for lists (added a parameter to tell the function
whether the name of a list member or the list itself is meant)
- Changed some QAPI generator error messages
- Assert the type of parameters in QAPISchemaAlias.__init__()
Kevin Wolf (6):
qapi: Add interfaces for alias support to Visitor
qapi: Remember alias definitions in qobject-input-visitor
qapi: Simplify full_name_nth() in qobject-input-visitor
qapi: Apply aliases in qobject-input-visitor
qapi: Add support for aliases
tests/qapi-schema: Test cases for aliases
docs/devel/qapi-code-gen.rst | 104 ++++-
docs/sphinx/qapidoc.py | 2 +-
include/qapi/visitor-impl.h | 12 +
include/qapi/visitor.h | 59 ++-
qapi/qapi-visit-core.c | 22 +
qapi/qobject-input-visitor.c | 417 ++++++++++++++++--
tests/unit/test-qobject-input-visitor.c | 218 +++++++++
scripts/qapi/expr.py | 47 +-
scripts/qapi/schema.py | 116 ++++-
scripts/qapi/types.py | 4 +-
scripts/qapi/visit.py | 34 +-
tests/qapi-schema/test-qapi.py | 7 +-
tests/qapi-schema/alias-bad-type.err | 2 +
tests/qapi-schema/alias-bad-type.json | 3 +
tests/qapi-schema/alias-bad-type.out | 0
tests/qapi-schema/alias-missing-source.err | 2 +
tests/qapi-schema/alias-missing-source.json | 3 +
tests/qapi-schema/alias-missing-source.out | 0
tests/qapi-schema/alias-name-bad-type.err | 2 +
tests/qapi-schema/alias-name-bad-type.json | 3 +
tests/qapi-schema/alias-name-bad-type.out | 0
tests/qapi-schema/alias-name-conflict.err | 2 +
tests/qapi-schema/alias-name-conflict.json | 4 +
tests/qapi-schema/alias-name-conflict.out | 0
tests/qapi-schema/alias-recursive.err | 2 +
tests/qapi-schema/alias-recursive.json | 4 +
tests/qapi-schema/alias-recursive.out | 0
tests/qapi-schema/alias-source-bad-type.err | 2 +
tests/qapi-schema/alias-source-bad-type.json | 3 +
tests/qapi-schema/alias-source-bad-type.out | 0
.../alias-source-elem-bad-type.err | 2 +
.../alias-source-elem-bad-type.json | 3 +
.../alias-source-elem-bad-type.out | 0
tests/qapi-schema/alias-source-empty.err | 2 +
tests/qapi-schema/alias-source-empty.json | 3 +
tests/qapi-schema/alias-source-empty.out | 0
.../alias-source-inexistent-variants.err | 2 +
.../alias-source-inexistent-variants.json | 12 +
.../alias-source-inexistent-variants.out | 0
tests/qapi-schema/alias-source-inexistent.err | 2 +
.../qapi-schema/alias-source-inexistent.json | 3 +
tests/qapi-schema/alias-source-inexistent.out | 0
.../alias-source-non-object-path.err | 2 +
.../alias-source-non-object-path.json | 3 +
.../alias-source-non-object-path.out | 0
.../alias-source-non-object-wildcard.err | 2 +
.../alias-source-non-object-wildcard.json | 3 +
.../alias-source-non-object-wildcard.out | 0
...lias-source-optional-wildcard-indirect.err | 2 +
...ias-source-optional-wildcard-indirect.json | 6 +
...lias-source-optional-wildcard-indirect.out | 0
.../alias-source-optional-wildcard.err | 2 +
.../alias-source-optional-wildcard.json | 5 +
.../alias-source-optional-wildcard.out | 0
tests/qapi-schema/alias-unknown-key.err | 3 +
tests/qapi-schema/alias-unknown-key.json | 3 +
tests/qapi-schema/alias-unknown-key.out | 0
tests/qapi-schema/aliases-bad-type.err | 2 +
tests/qapi-schema/aliases-bad-type.json | 3 +
tests/qapi-schema/aliases-bad-type.out | 0
tests/qapi-schema/double-type.err | 2 +-
tests/qapi-schema/meson.build | 16 +
tests/qapi-schema/qapi-schema-test.json | 26 ++
tests/qapi-schema/qapi-schema-test.out | 31 ++
tests/qapi-schema/unknown-expr-key.err | 2 +-
65 files changed, 1163 insertions(+), 53 deletions(-)
create mode 100644 tests/qapi-schema/alias-bad-type.err
create mode 100644 tests/qapi-schema/alias-bad-type.json
create mode 100644 tests/qapi-schema/alias-bad-type.out
create mode 100644 tests/qapi-schema/alias-missing-source.err
create mode 100644 tests/qapi-schema/alias-missing-source.json
create mode 100644 tests/qapi-schema/alias-missing-source.out
create mode 100644 tests/qapi-schema/alias-name-bad-type.err
create mode 100644 tests/qapi-schema/alias-name-bad-type.json
create mode 100644 tests/qapi-schema/alias-name-bad-type.out
create mode 100644 tests/qapi-schema/alias-name-conflict.err
create mode 100644 tests/qapi-schema/alias-name-conflict.json
create mode 100644 tests/qapi-schema/alias-name-conflict.out
create mode 100644 tests/qapi-schema/alias-recursive.err
create mode 100644 tests/qapi-schema/alias-recursive.json
create mode 100644 tests/qapi-schema/alias-recursive.out
create mode 100644 tests/qapi-schema/alias-source-bad-type.err
create mode 100644 tests/qapi-schema/alias-source-bad-type.json
create mode 100644 tests/qapi-schema/alias-source-bad-type.out
create mode 100644 tests/qapi-schema/alias-source-elem-bad-type.err
create mode 100644 tests/qapi-schema/alias-source-elem-bad-type.json
create mode 100644 tests/qapi-schema/alias-source-elem-bad-type.out
create mode 100644 tests/qapi-schema/alias-source-empty.err
create mode 100644 tests/qapi-schema/alias-source-empty.json
create mode 100644 tests/qapi-schema/alias-source-empty.out
create mode 100644 tests/qapi-schema/alias-source-inexistent-variants.err
create mode 100644 tests/qapi-schema/alias-source-inexistent-variants.json
create mode 100644 tests/qapi-schema/alias-source-inexistent-variants.out
create mode 100644 tests/qapi-schema/alias-source-inexistent.err
create mode 100644 tests/qapi-schema/alias-source-inexistent.json
create mode 100644 tests/qapi-schema/alias-source-inexistent.out
create mode 100644 tests/qapi-schema/alias-source-non-object-path.err
create mode 100644 tests/qapi-schema/alias-source-non-object-path.json
create mode 100644 tests/qapi-schema/alias-source-non-object-path.out
create mode 100644 tests/qapi-schema/alias-source-non-object-wildcard.err
create mode 100644 tests/qapi-schema/alias-source-non-object-wildcard.json
create mode 100644 tests/qapi-schema/alias-source-non-object-wildcard.out
create mode 100644
tests/qapi-schema/alias-source-optional-wildcard-indirect.err
create mode 100644
tests/qapi-schema/alias-source-optional-wildcard-indirect.json
create mode 100644
tests/qapi-schema/alias-source-optional-wildcard-indirect.out
create mode 100644 tests/qapi-schema/alias-source-optional-wildcard.err
create mode 100644 tests/qapi-schema/alias-source-optional-wildcard.json
create mode 100644 tests/qapi-schema/alias-source-optional-wildcard.out
create mode 100644 tests/qapi-schema/alias-unknown-key.err
create mode 100644 tests/qapi-schema/alias-unknown-key.json
create mode 100644 tests/qapi-schema/alias-unknown-key.out
create mode 100644 tests/qapi-schema/aliases-bad-type.err
create mode 100644 tests/qapi-schema/aliases-bad-type.json
create mode 100644 tests/qapi-schema/aliases-bad-type.out
--
2.31.1
