include/qapi/visitor.h

   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, const char *name, void **obj,
  31                         const char *kind, 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, const char *name, bool *present);
  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, const char *name, QType *type,
  55                          bool promote_int, Error **errp);
  56 void visit_type_enum(Visitor *v, const char *name, int *obj,
  57                      const char *const strings[], const char *kind,
  58                      Error **errp);
  59 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp);
  60 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
  61                       Error **errp);
  62 void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
  63                        Error **errp);
  64 void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
  65                        Error **errp);
  66 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
  67                        Error **errp);
  68 void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp);
  69 void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
  70                       Error **errp);
  71 void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
  72                       Error **errp);
  73 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
  74                       Error **errp);
  75 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
  76                      Error **errp);
  77 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp);
  78 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp);
  79 void visit_type_number(Visitor *v, const char *name, double *obj,
  80                        Error **errp);
  81 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp);
  82 bool visit_start_union(Visitor *v, bool data_present, Error **errp);
  83
  84 #endif