mirrors/qemu
0
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2024-12-13 14:33:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

qapi: Update docs for generator changes since commit 9ee86b8526

Browse Source 
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20180828120736.32323-3-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Markus Armbruster 2018-08-28 14:07:36 +02:00
parent 5f1450f544
commit 913b5e28a1
1 changed files with 99 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
docs/devel/qapi-code-gen.txt
View File

@ -1035,7 +1035,7 @@ Example:
#ifndef EXAMPLE_QAPI_TYPES_H
#define EXAMPLE_QAPI_TYPES_H
[Built-in types omitted...]
#include "qapi/qapi-builtin-types.h"
typedef struct UserDefOne UserDefOne;
@ -1062,7 +1062,7 @@ Example:
UserDefOneList *arg1;
};
#endif
#endif /* EXAMPLE_QAPI_TYPES_H */
$ cat qapi-generated/example-qapi-types.c
[Uninteresting stuff omitted...]
@ -1092,6 +1092,8 @@ Example:
visit_free(v);
}
[Uninteresting stuff omitted...]
=== Code generated for visiting QAPI types ===
These are the visitor functions used to walk through and convert
@ -1118,7 +1120,9 @@ Example:
#ifndef EXAMPLE_QAPI_VISIT_H
#define EXAMPLE_QAPI_VISIT_H
[Visitors for built-in types omitted...]
#include "qapi/qapi-builtin-visit.h"
#include "example-qapi-types.h"
void visit_type_UserDefOne_members(Visitor *v, UserDefOne *obj, Error **errp);
void visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **obj, Error **errp);
@ -1126,7 +1130,7 @@ Example:
void visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_command_arg *obj, Error **errp);
#endif
#endif /* EXAMPLE_QAPI_VISIT_H */
$ cat qapi-generated/example-qapi-visit.c
[Uninteresting stuff omitted...]
@ -1219,6 +1223,8 @@ Example:
error_propagate(errp, err);
}
[Uninteresting stuff omitted...]
=== Code generated for commands ===
These are the marshaling/dispatch functions for the commands defined
@ -1238,18 +1244,17 @@ Example:
$ cat qapi-generated/example-qapi-commands.h
[Uninteresting stuff omitted...]
#ifndef EXAMPLE_QMP_COMMANDS_H
#define EXAMPLE_QMP_COMMANDS_H
#ifndef EXAMPLE_QAPI_COMMANDS_H
#define EXAMPLE_QAPI_COMMANDS_H
#include "example-qapi-types.h"
#include "qapi/qmp/qdict.h"
#include "qapi/qmp/dispatch.h"
void example_qmp_init_marshal(QmpCommandList *cmds);
UserDefOne *qmp_my_command(UserDefOneList *arg1, Error **errp);
void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp);
void example_qmp_init_marshal(QmpCommandList *cmds);
#endif
#endif /* EXAMPLE_QAPI_COMMANDS_H */
$ cat qapi-generated/example-qapi-commands.c
[Uninteresting stuff omitted...]
@ -1316,6 +1321,8 @@ Example:
qmp_marshal_my_command, QCO_NO_OPTIONS);
}
[Uninteresting stuff omitted...]
=== Code generated for events ===
This is the code related to events defined in the schema, providing
@ -1333,10 +1340,10 @@ Example:
$ cat qapi-generated/example-qapi-events.h
[Uninteresting stuff omitted...]
#ifndef EXAMPLE_QAPI_EVENT_H
#define EXAMPLE_QAPI_EVENT_H
#ifndef EXAMPLE_QAPI_EVENTS_H
#define EXAMPLE_QAPI_EVENTS_H
#include "qapi/qmp/qdict.h"
#include "qapi/util.h"
#include "example-qapi-types.h"
@ -1348,11 +1355,11 @@ Example:
} example_QAPIEvent;
#define example_QAPIEvent_str(val) \
qapi_enum_lookup(example_QAPIEvent_lookup, (val))
qapi_enum_lookup(&example_QAPIEvent_lookup, (val))
extern const char *const example_QAPIEvent_lookup[];
extern const QEnumLookup example_QAPIEvent_lookup;
#endif
#endif /* EXAMPLE_QAPI_EVENTS_H */
$ cat qapi-generated/example-qapi-events.c
[Uninteresting stuff omitted...]
@ -1380,6 +1387,8 @@ Example:
.size = EXAMPLE_QAPI_EVENT__MAX
};
[Uninteresting stuff omitted...]
=== Code generated for introspection ===
The following files are created:
@ -1394,30 +1403,90 @@ Example:
$ cat qapi-generated/example-qapi-introspect.h
[Uninteresting stuff omitted...]
#ifndef EXAMPLE_QMP_INTROSPECT_H
#define EXAMPLE_QMP_INTROSPECT_H
#ifndef EXAMPLE_QAPI_INTROSPECT_H
#define EXAMPLE_QAPI_INTROSPECT_H
extern const QLitObject qmp_schema_qlit;
#include "qapi/qmp/qlit.h"
#endif
extern const QLitObject example_qmp_schema_qlit;
#endif /* EXAMPLE_QAPI_INTROSPECT_H */
$ cat qapi-generated/example-qapi-introspect.c
[Uninteresting stuff omitted...]
const QLitObject example_qmp_schema_qlit = QLIT_QLIST(((QLitObject[]) {
QLIT_QDICT(((QLitDictEntry[]) {
{ "arg-type", QLIT_QSTR("0") },
{ "meta-type", QLIT_QSTR("event") },
{ "name", QLIT_QSTR("Event") },
{ }
{ "arg-type", QLIT_QSTR("0"), },
{ "meta-type", QLIT_QSTR("command"), },
{ "name", QLIT_QSTR("my-command"), },
{ "ret-type", QLIT_QSTR("1"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "arg-type", QLIT_QSTR("2"), },
{ "meta-type", QLIT_QSTR("event"), },
{ "name", QLIT_QSTR("MY_EVENT"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "members", QLIT_QLIST(((QLitObject[]) {
{ }
})) },
{ "meta-type", QLIT_QSTR("object") },
{ "name", QLIT_QSTR("0") },
{ }
QLIT_QDICT(((QLitDictEntry[]) {
{ "name", QLIT_QSTR("arg1"), },
{ "type", QLIT_QSTR("[1]"), },
{}
})),
{}
})), },
{ "meta-type", QLIT_QSTR("object"), },
{ "name", QLIT_QSTR("0"), },
{}
})),
...
{ }
QLIT_QDICT(((QLitDictEntry[]) {
{ "members", QLIT_QLIST(((QLitObject[]) {
QLIT_QDICT(((QLitDictEntry[]) {
{ "name", QLIT_QSTR("integer"), },
{ "type", QLIT_QSTR("int"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "default", QLIT_QNULL, },
{ "name", QLIT_QSTR("string"), },
{ "type", QLIT_QSTR("str"), },
{}
})),
{}
})), },
{ "meta-type", QLIT_QSTR("object"), },
{ "name", QLIT_QSTR("1"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "members", QLIT_QLIST(((QLitObject[]) {
{}
})), },
{ "meta-type", QLIT_QSTR("object"), },
{ "name", QLIT_QSTR("2"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "element-type", QLIT_QSTR("1"), },
{ "meta-type", QLIT_QSTR("array"), },
{ "name", QLIT_QSTR("[1]"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "json-type", QLIT_QSTR("int"), },
{ "meta-type", QLIT_QSTR("builtin"), },
{ "name", QLIT_QSTR("int"), },
{}
})),
QLIT_QDICT(((QLitDictEntry[]) {
{ "json-type", QLIT_QSTR("string"), },
{ "meta-type", QLIT_QSTR("builtin"), },
{ "name", QLIT_QSTR("str"), },
{}
})),
{}
}));
[Uninteresting stuff omitted...]