qemu/tests/qapi-schema/args-union.json

# use of union arguments requires 'boxed':true
{ 'enum': 'Enum', 'data': [ 'case1', 'case2' ] }
{ 'struct': 'Case1', 'data': { 'data': 'int' } }
{ 'struct': 'Case2', 'data': { 'data': 'str' } }
{ 'union': 'Uni',
  'base': { 'type': 'Enum' },
  'discriminator': 'type',
  'data': { 'case1': 'Case1', 'case2': 'Case2' } }
{ 'command': 'oops', 'data': 'Uni' }
qapi: Implement boxed types for commands/events Turn on the ability to pass command and event arguments in a single boxed parameter, which must name a non-empty type (although the type can be a struct with all optional members). For structs, it makes it possible to pass a single qapi type instead of a breakout of all struct members (useful if the arguments are already in a struct or if the number of members is large); for other complex types, it is now possible to use a union or alternate as the data for a command or event. The empty type may be technically feasible if needed down the road, but it's easier to forbid it now and relax things to allow it later, than it is to allow it now and have to special case how the generated 'q_empty' type is handled (see commit 7ce106a9 for reasons why nothing is generated for the empty type). An alternate type is never considered empty, but now that a boxed type can be either an object or an alternate, we have to provide a trivial QAPISchemaAlternateType.is_empty(). The new call to arg_type.is_empty() during QAPISchemaCommand.check() requires that we first check the type in question; but there is no chance of introducing a cycle since objects do not refer back to commands. We still have a split in syntax checking between ad-hoc parsing up front (merely validates that 'boxed' has a sane value) and during .check() methods (if 'boxed' is set, then 'data' must name a non-empty user-defined type). Generated code is unchanged, as long as no client uses the new feature. Signed-off-by: Eric Blake <eblake@redhat.com> Message-Id: <1468468228-27827-10-git-send-email-eblake@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Test files renamed to -boxed-] Signed-off-by: Markus Armbruster <armbru@redhat.com> 2016-07-14 06:50:20 +03:00			`# use of union arguments requires 'boxed':true`
tests/qapi-schema: Purge simple unions from tests Drop tests that are specifically about simple unions: * SugaredUnion in doc-good: flat unions are covered by @Object. * union-branch-case and union-clash-branches: branch naming for flat unions is enforced for the tag enum instead, which is covered by enum-member-case and enum-clash-member. * union-empty: empty flat unions are covered by flat-union-empty. Rewrite the remainder to use flat unions: args-union, bad-base, flat-union-base-union, union-branch-invalid-dict, union-unknown. Except drop union-optional-branch. because converting this one is not worth the trouble; we don't explicitly check names beginning with '*' in other places, either. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-Id: <20210917143134.412106-21-armbru@redhat.com> 2021-09-17 17:31:31 +03:00			`{ 'enum': 'Enum', 'data': [ 'case1', 'case2' ] }`
			`{ 'struct': 'Case1', 'data': { 'data': 'int' } }`
			`{ 'struct': 'Case2', 'data': { 'data': 'str' } }`
			`{ 'union': 'Uni',`
			`'base': { 'type': 'Enum' },`
			`'discriminator': 'type',`
			`'data': { 'case1': 'Case1', 'case2': 'Case2' } }`
qapi-tests: New tests for union, alternate command arguments A command's 'data' must be a struct type, given either as a dictionary, or as struct type name. Existing test case data-int.json covers simple type 'int'. Add test cases for type names referring to union and alternate types. The latter is caught (good), but the former is not (bug). Events have the same problem, but since they get checked by the same code, we don't bother to duplicate the tests. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> 2015-07-01 10:54:11 +03:00			`{ 'command': 'oops', 'data': 'Uni' }`