qapi/qapi-visit-core.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 "qapi/qapi-types-core.h"
  17 #include <stdlib.h>
  18
  19 typedef struct GenericList
  20 {
  21     void *value;
  22     struct GenericList *next;
  23 } GenericList;
  24
  25 typedef struct Visitor Visitor;
  26
  27 struct Visitor
  28 {
  29     /* Must be set */
  30     void (*start_struct)(Visitor *v, void **obj, const char *kind,
  31                          const char *name, size_t size, Error **errp);
  32     void (*end_struct)(Visitor *v, Error **errp);
  33
  34     void (*start_list)(Visitor *v, const char *name, Error **errp);
  35     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
  36     void (*end_list)(Visitor *v, Error **errp);
  37
  38     void (*type_enum)(Visitor *v, int *obj, const char *strings[],
  39                       const char *kind, const char *name, Error **errp);
  40
  41     void (*type_int)(Visitor *v, int64_t *obj, const char *name, Error **errp);
  42     void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
  43     void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
  44     void (*type_number)(Visitor *v, double *obj, const char *name,
  45                         Error **errp);
  46
  47     /* May be NULL */
  48     void (*start_optional)(Visitor *v, bool *present, const char *name,
  49                            Error **errp);
  50     void (*end_optional)(Visitor *v, Error **errp);
  51
  52     void (*start_handle)(Visitor *v, void **obj, const char *kind,
  53                          const char *name, Error **errp);
  54     void (*end_handle)(Visitor *v, Error **errp);
  55     void (*type_uint8)(Visitor *v, uint8_t *obj, const char *name, Error **errp);
  56     void (*type_uint16)(Visitor *v, uint16_t *obj, const char *name, Error **errp);
  57     void (*type_uint32)(Visitor *v, uint32_t *obj, const char *name, Error **errp);
  58     void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
  59     void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
  60     void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
  61     void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
  62     void (*type_int64)(Visitor *v, int64_t *obj, const char *name, Error **errp);
  63     /* visit_type_size() falls back to (*type_uint64)() if type_size is unset */
  64     void (*type_size)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
  65 };
  66
  67 void visit_start_handle(Visitor *v, void **obj, const char *kind,
  68                         const char *name, Error **errp);
  69 void visit_end_handle(Visitor *v, Error **errp);
  70 void visit_start_struct(Visitor *v, void **obj, const char *kind,
  71                         const char *name, size_t size, Error **errp);
  72 void visit_end_struct(Visitor *v, Error **errp);
  73 void visit_start_list(Visitor *v, const char *name, Error **errp);
  74 GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp);
  75 void visit_end_list(Visitor *v, Error **errp);
  76 void visit_start_optional(Visitor *v, bool *present, const char *name,
  77                           Error **errp);
  78 void visit_end_optional(Visitor *v, Error **errp);
  79 void visit_type_enum(Visitor *v, int *obj, const char *strings[],
  80                      const char *kind, const char *name, Error **errp);
  81 void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp);
  82 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp);
  83 void visit_type_uint16(Visitor *v, uint16_t *obj, const char *name, Error **errp);
  84 void visit_type_uint32(Visitor *v, uint32_t *obj, const char *name, Error **errp);
  85 void visit_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp);
  86 void visit_type_int8(Visitor *v, int8_t *obj, const char *name, Error **errp);
  87 void visit_type_int16(Visitor *v, int16_t *obj, const char *name, Error **errp);
  88 void visit_type_int32(Visitor *v, int32_t *obj, const char *name, Error **errp);
  89 void visit_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp);
  90 void visit_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp);
  91 void visit_type_bool(Visitor *v, bool *obj, const char *name, Error **errp);
  92 void visit_type_str(Visitor *v, char **obj, const char *name, Error **errp);
  93 void visit_type_number(Visitor *v, double *obj, const char *name, Error **errp);
  94
  95 #endif