3 /* gras/datadesc.h - Describing the data you want to exchange */
5 /* Authors: Martin Quinson */
6 /* Copyright (C) 2003 the OURAGAN project. */
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. */
11 #ifndef GRAS_DATADESC_H
12 #define GRAS_DATADESC_H
14 #include <stddef.h> /* offsetof() */
15 #include <sys/types.h> /* size_t */
19 /*! C++ users need love */
22 # define BEGIN_DECL extern "C" {
28 /*! C++ users need love */
36 /* End of cruft for C++ */
41 typedef struct s_gras_datadesc_type gras_datadesc_type_t;
43 /***********************************************
44 **** Search and retrieve declared datatype ****
45 ***********************************************/
46 long int gras_datadesc_get_id_from_name(const char *name);
48 /*********************************************
49 **** DataDesc callback persistent states ****
50 *********************************************/
51 typedef struct s_gras_dd_cbps gras_dd_cbps_t;
54 gras_dd_cbps_pop (gras_dd_cbps_t *ps,
56 gras_datadesc_type_t **ddt);
58 gras_dd_cbps_push(gras_dd_cbps_t *ps,
61 gras_datadesc_type_t *ddt);
63 gras_dd_cbps_set (gras_dd_cbps_t *ps,
66 gras_datadesc_type_t *ddt);
69 gras_dd_cbps_get (gras_dd_cbps_t *ps,
71 gras_datadesc_type_t **ddt);
74 gras_dd_cbps_block_begin(gras_dd_cbps_t *ps);
76 gras_dd_cbps_block_end(gras_dd_cbps_t *ps);
79 /******************************************
80 **** Declare datadescription manually ****
81 ******************************************/
83 typedef void (*gras_datadesc_type_cb_void_t)(void *vars,
84 gras_datadesc_type_t *p_type,
86 typedef int (*gras_datadesc_type_cb_int_t)(void *vars,
87 gras_datadesc_type_t *p_type,
92 /* Create a new type and register it on the local machine */
93 #define gras_datadesc_declare_struct( name, code) \
94 gras_datadesc_declare_struct_cb(name, NULL, NULL, code)
96 #define gras_datadesc_declare_struct_add_name( struct_code,field_name,field_type_name) \
97 gras_datadesc_declare_struct_add_name_cb(struct_code,field_name,field_type_name, NULL, NULL)
99 #define gras_datadesc_declare_struct_add_code( struct_code,field_name,field_type_code) \
100 gras_datadesc_declare_struct_add_code_cb(struct_code,field_name,field_type_code, NULL, NULL)
103 gras_datadesc_declare_struct_cb(const char *name,
104 gras_datadesc_type_cb_void_t pre_cb,
105 gras_datadesc_type_cb_void_t post_cb,
108 gras_datadesc_declare_struct_add_name_cb(long int struct_code,
109 const char *field_name,
110 const char *field_type_name,
111 gras_datadesc_type_cb_void_t pre_cb,
112 gras_datadesc_type_cb_void_t post_cb);
115 gras_datadesc_declare_struct_add_code_cb(long int struct_code,
116 const char *field_name,
118 gras_datadesc_type_cb_void_t pre_cb,
119 gras_datadesc_type_cb_void_t post_cb);
121 #define gras_datadesc_declare_union( name, code) \
122 gras_datadesc_declare_union_cb(name, NULL, NULL, code)
124 #define gras_datadesc_declare_union_add_name( union_code,field_name,field_type_name) \
125 gras_datadesc_declare_union_add_name_cb(union_code,field_name,field_type_name, NULL, NULL)
127 #define gras_datadesc_declare_union_add_code( union_code,field_name,field_type_code) \
128 gras_datadesc_declare_union_add_code_cb(union_code,field_name,field_type_code, NULL, NULL)
131 gras_datadesc_declare_union_cb(const char *name,
132 gras_datadesc_type_cb_int_t field_count,
133 gras_datadesc_type_cb_void_t post,
136 gras_datadesc_declare_union_add_name_cb(long int union_code,
137 const char *field_name,
138 const char *field_type_name,
139 gras_datadesc_type_cb_void_t pre_cb,
140 gras_datadesc_type_cb_void_t post_cb);
142 gras_datadesc_declare_union_add_code_cb(long int union_code,
143 const char *field_name,
145 gras_datadesc_type_cb_void_t pre_cb,
146 gras_datadesc_type_cb_void_t post_cb);
148 #define gras_datadesc_declare_ref(name,ref_type, code) \
149 gras_datadesc_declare_ref_cb(name, ref_type, NULL, NULL, code)
150 #define gras_datadesc_declare_ref_disc(name,discriminant, code) \
151 gras_datadesc_declare_ref_cb(name, NULL, discriminant, NULL, code)
154 gras_datadesc_declare_ref_cb(const char *name,
155 gras_datadesc_type_t *referenced_type,
156 gras_datadesc_type_cb_int_t discriminant,
157 gras_datadesc_type_cb_void_t post,
160 #define gras_datadesc_declare_array(name,elm_type, size, code) \
161 gras_datadesc_declare_array_cb(name, elm_type, size, NULL, NULL, code)
162 #define gras_datadesc_declare_array_dyn(name,elm_type, dynamic_size, code) \
163 gras_datadesc_declare_array_cb(name, elm_type, -1, dynamic_size, NULL, code)
166 gras_datadesc_declare_array_cb(const char *name,
167 gras_datadesc_type_t *element_type,
169 gras_datadesc_type_cb_int_t dynamic_size,
170 gras_datadesc_type_cb_void_t post,
173 /****************************
174 **** Parse C statements ****
175 ****************************/
177 gras_datadesc_parse(const char *name,
178 const char *Cdefinition,
180 #define GRAS_DEFINE_TYPE(name,def) \
181 static const char * _gras_this_type_symbol_does_not_exist__##name=#def; def
183 #define gras_type_symbol_parse(bag,name) \
184 _gs_type_parse(bag, _gs_this_type_symbol_does_not_exist__##name)
186 #define gs_type_get_by_symbol(bag,name) \
187 (bag->bag_ops->get_type_by_name(bag, NULL, #name) ? \
188 bag->bag_ops->get_type_by_name(bag, NULL, #name) : \
189 gras_type_symbol_parse(bag, name) \
192 /*****************************
193 **** NWS datadescription ****
194 *****************************/
197 * Basic types we can embeed in DataDescriptors.
200 {CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE,
201 UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE}
203 #define SIMPLE_TYPE_COUNT 9
205 /*! \brief Describe a collection of data.
207 ** A description of a collection of #type# data. #repetitions# is used only
208 ** for arrays; it contains the number of elements. #offset# is used only for
209 ** struct members in host format; it contains the offset of the member from the
210 ** beginning of the struct, taking into account internal padding added by the
211 ** compiler for alignment purposes. #members#, #length#, and #tailPadding# are
212 ** used only for STRUCT_TYPE data; the #length#-long array #members# describes
213 ** the members of the nested struct, and #tailPadding# indicates how many
214 ** padding bytes the compiler adds to the end of the structure.
217 typedef struct DataDescriptorStruct {
221 /*@null@*/ struct DataDescriptorStruct *members;
225 /** DataDescriptor for an array */
226 #define SIMPLE_DATA(type,repetitions) \
227 {type, repetitions, 0, NULL, 0, 0}
228 /** DataDescriptor for an structure member */
229 #define SIMPLE_MEMBER(type,repetitions,offset) \
230 {type, repetitions, offset, NULL, 0, 0}
231 /** DataDescriptor for padding bytes */
232 #define PAD_BYTES(structType,lastMember,memberType,repetitions) \
233 sizeof(structType) - offsetof(structType, lastMember) - \
234 sizeof(memberType) * repetitions
237 gras_datadesc_from_nws(const char *name,
238 const DataDescriptor *desc,
245 #endif /* GRAS_DATADESC_H */