include/datadesc.h

   1 /* $Id$ */
   2
   3 /* gras/datadesc.h - Describing the data you want to exchange               */
   4
   5 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2003, 2004 Martin Quinson.                                 */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9    under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef GRAS_DATADESC_H
  12 #define GRAS_DATADESC_H
  13
  14 #include <stddef.h>    /* offsetof() */
  15 #include <sys/types.h>  /* size_t */
  16 #include <stdarg.h>
  17
  18
  19 /*! C++ users need love */
  20 #ifndef BEGIN_DECL
  21 # ifdef __cplusplus
  22 #  define BEGIN_DECL extern "C" {
  23 # else
  24 #  define BEGIN_DECL
  25 # endif
  26 #endif
  27
  28 /*! C++ users need love */
  29 #ifndef END_DECL
  30 # ifdef __cplusplus
  31 #  define END_DECL }
  32 # else
  33 #  define END_DECL
  34 # endif
  35 #endif
  36 /* End of cruft for C++ */
  37
  38 BEGIN_DECL
  39
  40
  41 /**
  42  * gras_datadesc_type_t:
  43  *
  44  * Opaque type describing a type description you don't want to open.
  45  */
  46 typedef struct s_gras_datadesc_type gras_datadesc_type_t;
  47
  48 /* callbacks prototypes */
  49 typedef void (*gras_datadesc_type_cb_void_t)(void                 *vars,
  50                                              gras_datadesc_type_t *p_type,
  51                                              void                 *data);
  52 typedef int (*gras_datadesc_type_cb_int_t)(void                 *vars,
  53                                            gras_datadesc_type_t *p_type,
  54                                            void                 *data);
  55
  56 /***********************************************
  57  **** Search and retrieve declared datatype ****
  58  ***********************************************/
  59 gras_datadesc_type_t *gras_datadesc_by_name(const char *name);
  60
  61 /******************************************
  62  **** Declare datadescription yourself ****
  63  ******************************************/
  64
  65 gras_error_t
  66 gras_datadesc_declare_struct(const char            *name,
  67                              gras_datadesc_type_t **dst);
  68 gras_error_t
  69 gras_datadesc_declare_struct_append(gras_datadesc_type_t          *struct_type,
  70                                     const char                    *name,
  71                                     gras_datadesc_type_t          *field_type);
  72 void
  73 gras_datadesc_declare_struct_close(gras_datadesc_type_t          *struct_type);
  74 gras_error_t
  75 gras_datadesc_declare_union(const char                      *name,
  76                             gras_datadesc_type_cb_int_t      selector,
  77                             gras_datadesc_type_t           **dst);
  78 gras_error_t
  79 gras_datadesc_declare_union_append(gras_datadesc_type_t          *union_type,
  80                                    const char                    *name,
  81                                    gras_datadesc_type_t          *field_type);
  82 void
  83 gras_datadesc_declare_union_close(gras_datadesc_type_t          *union_type);
  84 gras_error_t
  85 gras_datadesc_declare_ref(const char                      *name,
  86                           gras_datadesc_type_t            *referenced_type,
  87                           gras_datadesc_type_t           **dst);
  88 gras_error_t
  89 gras_datadesc_declare_ref_generic(const char                   *name,
  90                                   gras_datadesc_type_cb_int_t   discriminant,
  91                                   gras_datadesc_type_t        **dst);
  92 gras_error_t
  93 gras_datadesc_declare_array_fixed(const char                    *name,
  94                                   gras_datadesc_type_t          *element_type,
  95                                   long int                       fixed_size,
  96                                   gras_datadesc_type_t         **dst);
  97 gras_error_t
  98 gras_datadesc_declare_array_dyn(const char                      *name,
  99                                 gras_datadesc_type_t            *element_type,
 100                                 gras_datadesc_type_cb_int_t      dynamic_size,
 101                                 gras_datadesc_type_t           **dst);
 102
 103 /*********************************
 104  * Change stuff within datadescs *
 105  *********************************/
 106
 107 typedef struct s_gras_dd_cbps gras_dd_cbps_t;
 108 void gras_datadesc_cb_set_pre (gras_datadesc_type_t    *type,
 109                                gras_datadesc_type_cb_void_t  pre);
 110 void gras_datadesc_cb_set_post(gras_datadesc_type_t    *type,
 111                                gras_datadesc_type_cb_void_t  post);
 112
 113 /******************************
 114  * Get stuff within datadescs *
 115  ******************************/
 116 char * gras_datadesc_get_name(gras_datadesc_type_t *ddt);
 117 int gras_datadesc_get_id(gras_datadesc_type_t *ddt);
 118
 119 /********************************************************
 120  * Advanced data describing: callback persistent states *
 121  ********************************************************/
 122
 123 void *
 124 gras_dd_cbps_pop (gras_dd_cbps_t        *ps,
 125                   const char            *name,
 126                   gras_datadesc_type_t **ddt);
 127 void
 128 gras_dd_cbps_push(gras_dd_cbps_t        *ps,
 129                   const char            *name,
 130                   void                  *data,
 131                   gras_datadesc_type_t  *ddt);
 132 void
 133 gras_dd_cbps_set (gras_dd_cbps_t        *ps,
 134                   const char            *name,
 135                   void                  *data,
 136                   gras_datadesc_type_t  *ddt);
 137
 138 void *
 139 gras_dd_cbps_get (gras_dd_cbps_t        *ps,
 140                   const char            *name,
 141                   gras_datadesc_type_t **ddt);
 142
 143 void
 144 gras_dd_cbps_block_begin(gras_dd_cbps_t *ps);
 145 void
 146 gras_dd_cbps_block_end(gras_dd_cbps_t *ps);
 147
 148
 149
 150
 151 /*******************************
 152  **** About data convertion ****
 153  *******************************/
 154 int gras_arch_selfid(void); /* ID of this arch */
 155
 156 /****************************
 157  **** Parse C statements ****
 158  ****************************/
 159 gras_datadesc_type_t *
 160 gras_datadesc_parse(const char *name,
 161                     const char *Cdefinition);
 162 #define GRAS_DEFINE_TYPE(name,def) \
 163   static const char * _gras_this_type_symbol_does_not_exist__##name=#def; def
 164
 165 #define gras_datadesc_by_symbol(name)  \
 166   (gras_datadesc_by_name(#name) ?      \
 167    gras_datadesc_by_name(#name) :      \
 168      gras_datadesc_parse(#name,        \
 169                          _gras_this_type_symbol_does_not_exist__##name) \
 170   )
 171
 172 /*****************************
 173  **** NWS datadescription ****
 174  *****************************/
 175
 176 /**
 177  * Basic types we can embeed in DataDescriptors.
 178  */
 179 typedef enum
 180   {CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE,
 181    UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE}
 182   DataTypes;
 183 #define SIMPLE_TYPE_COUNT 9
 184
 185 /*!  \brief Describe a collection of data.
 186  *
 187 ** A description of a collection of #type# data.  #repetitions# is used only
 188 ** for arrays; it contains the number of elements.  #offset# is used only for
 189 ** struct members in host format; it contains the offset of the member from the
 190 ** beginning of the struct, taking into account internal padding added by the
 191 ** compiler for alignment purposes.  #members#, #length#, and #tailPadding# are
 192 ** used only for STRUCT_TYPE data; the #length#-long array #members# describes
 193 ** the members of the nested struct, and #tailPadding# indicates how many
 194 ** padding bytes the compiler adds to the end of the structure.
 195 */
 196
 197 typedef struct DataDescriptorStruct {
 198   DataTypes type;
 199   size_t repetitions;
 200   size_t offset;
 201   /*@null@*/ struct DataDescriptorStruct *members;
 202   size_t length;
 203   size_t tailPadding;
 204 } DataDescriptor;
 205 /** DataDescriptor for an array */
 206 #define SIMPLE_DATA(type,repetitions) \
 207   {type, repetitions, 0, NULL, 0, 0}
 208 /** DataDescriptor for an structure member */
 209 #define SIMPLE_MEMBER(type,repetitions,offset) \
 210   {type, repetitions, offset, NULL, 0, 0}
 211 /** DataDescriptor for padding bytes */
 212 #define PAD_BYTES(structType,lastMember,memberType,repetitions) \
 213   sizeof(structType) - offsetof(structType, lastMember) - \
 214   sizeof(memberType) * repetitions
 215
 216 gras_error_t
 217 gras_datadesc_import_nws(const char           *name,
 218                          const DataDescriptor *desc,
 219                          size_t                howmany,
 220                          gras_datadesc_type_t **dst);
 221
 222 END_DECL
 223
 224 #endif /* GRAS_DATADESC_H */