xref: /openbmc/qemu/include/qapi/visitor.h (revision f1f7e4bf)
1 /*
2  * Core Definitions for QAPI Visitor Classes
3  *
4  * Copyright IBM, Corp. 2011
5  *
6  * Authors:
7  *  Anthony Liguori   <aliguori@us.ibm.com>
8  *
9  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
10  * See the COPYING.LIB file in the top-level directory.
11  *
12  */
13 #ifndef QAPI_VISITOR_CORE_H
14 #define QAPI_VISITOR_CORE_H
15 
16 #include "qemu/typedefs.h"
17 #include "qapi/qmp/qobject.h"
18 #include "qapi/error.h"
19 #include <stdlib.h>
20 
21 typedef struct GenericList
22 {
23     union {
24         void *value;
25         uint64_t padding;
26     };
27     struct GenericList *next;
28 } GenericList;
29 
30 void visit_start_struct(Visitor *v, void **obj, const char *kind,
31                         const char *name, size_t size, Error **errp);
32 void visit_end_struct(Visitor *v, Error **errp);
33 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
34                                  Error **errp);
35 void visit_end_implicit_struct(Visitor *v, Error **errp);
36 void visit_start_list(Visitor *v, const char *name, Error **errp);
37 GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp);
38 void visit_end_list(Visitor *v, Error **errp);
39 
40 /**
41  * Check if an optional member @name of an object needs visiting.
42  * For input visitors, set *@present according to whether the
43  * corresponding visit_type_*() needs calling; for other visitors,
44  * leave *@present unchanged.  Return *@present for convenience.
45  */
46 bool visit_optional(Visitor *v, bool *present, const char *name);
47 
48 /**
49  * Determine the qtype of the item @name in the current object visit.
50  * For input visitors, set *@type to the correct qtype of a qapi
51  * alternate type; for other visitors, leave *@type unchanged.
52  * If @promote_int, treat integers as QTYPE_FLOAT.
53  */
54 void visit_get_next_type(Visitor *v, QType *type, bool promote_int,
55                          const char *name, Error **errp);
56 void visit_type_enum(Visitor *v, int *obj, const char * const strings[],
57                      const char *kind, const char *name, Error **errp);
58 void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp);
59 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp);
60 void visit_type_uint16(Visitor *v, uint16_t *obj, const char *name, Error **errp);
61 void visit_type_uint32(Visitor *v, uint32_t *obj, const char *name, Error **errp);
62 void visit_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp);
63 void visit_type_int8(Visitor *v, int8_t *obj, const char *name, Error **errp);
64 void visit_type_int16(Visitor *v, int16_t *obj, const char *name, Error **errp);
65 void visit_type_int32(Visitor *v, int32_t *obj, const char *name, Error **errp);
66 void visit_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp);
67 void visit_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp);
68 void visit_type_bool(Visitor *v, bool *obj, const char *name, Error **errp);
69 void visit_type_str(Visitor *v, char **obj, const char *name, Error **errp);
70 void visit_type_number(Visitor *v, double *obj, const char *name, Error **errp);
71 void visit_type_any(Visitor *v, QObject **obj, const char *name, Error **errp);
72 bool visit_start_union(Visitor *v, bool data_present, Error **errp);
73 void visit_end_union(Visitor *v, bool data_present, Error **errp);
74 
75 #endif
76