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++ */
42 typedef struct s_gras_datadesc_type gras_datadesc_type_t;
44 /* callbacks prototypes */
45 typedef void (*gras_datadesc_type_cb_void_t)(void *vars,
46 gras_datadesc_type_t *p_type,
48 typedef int (*gras_datadesc_type_cb_int_t)(void *vars,
49 gras_datadesc_type_t *p_type,
52 /***********************************************
53 **** Search and retrieve declared datatype ****
54 ***********************************************/
55 gras_error_t gras_datadesc_by_name(const char *name,
56 gras_datadesc_type_t **type);
58 /******************************************
59 **** Declare datadescription yourself ****
60 ******************************************/
63 gras_datadesc_declare_struct(const char *name,
64 gras_datadesc_type_t **dst);
66 gras_datadesc_declare_struct_append(gras_datadesc_type_t *struct_type,
68 gras_datadesc_type_t *field_type);
70 gras_datadesc_declare_struct_append_name(gras_datadesc_type_t *struct_type,
72 const char *field_type_name);
74 gras_datadesc_declare_union(const char *name,
75 gras_datadesc_type_cb_int_t selector,
76 gras_datadesc_type_t **dst);
78 gras_datadesc_declare_union_append(gras_datadesc_type_t *union_type,
80 gras_datadesc_type_t *field_type);
82 gras_datadesc_declare_union_append_name(gras_datadesc_type_t *union_type,
84 const char *field_type_name);
86 gras_datadesc_declare_ref(const char *name,
87 gras_datadesc_type_t *referenced_type,
88 gras_datadesc_type_t **dst);
90 gras_datadesc_declare_ref_generic(const char *name,
91 gras_datadesc_type_cb_int_t discriminant,
92 gras_datadesc_type_t **dst);
94 gras_datadesc_declare_array_fixed(const char *name,
95 gras_datadesc_type_t *element_type,
97 gras_datadesc_type_t **dst);
99 gras_datadesc_declare_array_dyn(const char *name,
100 gras_datadesc_type_t *element_type,
101 gras_datadesc_type_cb_int_t dynamic_size,
102 gras_datadesc_type_t **dst);
104 /*********************************
105 * Change stuff within datadescs *
106 *********************************/
108 typedef struct s_gras_dd_cbps gras_dd_cbps_t;
109 void gras_datadesc_cb_set_pre (gras_datadesc_type_t *type,
110 gras_datadesc_type_cb_void_t pre);
111 void gras_datadesc_cb_set_post(gras_datadesc_type_t *type,
112 gras_datadesc_type_cb_void_t post);
114 /********************************************************
115 * Advanced data describing: callback persistent states *
116 ********************************************************/
119 gras_dd_cbps_pop (gras_dd_cbps_t *ps,
121 gras_datadesc_type_t **ddt);
123 gras_dd_cbps_push(gras_dd_cbps_t *ps,
126 gras_datadesc_type_t *ddt);
128 gras_dd_cbps_set (gras_dd_cbps_t *ps,
131 gras_datadesc_type_t *ddt);
134 gras_dd_cbps_get (gras_dd_cbps_t *ps,
136 gras_datadesc_type_t **ddt);
139 gras_dd_cbps_block_begin(gras_dd_cbps_t *ps);
141 gras_dd_cbps_block_end(gras_dd_cbps_t *ps);
146 /*******************************
147 **** About data convertion ****
148 *******************************/
149 int gras_arch_selfid(void); /* ID of this arch */
151 /****************************
152 **** Parse C statements ****
153 ****************************/
155 gras_datadesc_parse(const char *name,
156 const char *Cdefinition,
157 gras_datadesc_type_t **dst);
158 #define GRAS_DEFINE_TYPE(name,def) \
159 static const char * _gras_this_type_symbol_does_not_exist__##name=#def; def
161 /*#define gras_type_symbol_parse(name) \
162 _gras_datadesc_parse(_gras_this_datadesc_type_symbol_does_not_exist__##name)
164 #define gras_datadesc_by_symbol(name) \
165 (bag->bag_ops->get_type_by_name(bag, NULL, #name) ? \
166 bag->bag_ops->get_type_by_name(bag, NULL, #name) : \
167 gras_datadesc_parse(name) \
170 /*****************************
171 **** NWS datadescription ****
172 *****************************/
175 * Basic types we can embeed in DataDescriptors.
178 {CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE,
179 UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE}
181 #define SIMPLE_TYPE_COUNT 9
183 /*! \brief Describe a collection of data.
185 ** A description of a collection of #type# data. #repetitions# is used only
186 ** for arrays; it contains the number of elements. #offset# is used only for
187 ** struct members in host format; it contains the offset of the member from the
188 ** beginning of the struct, taking into account internal padding added by the
189 ** compiler for alignment purposes. #members#, #length#, and #tailPadding# are
190 ** used only for STRUCT_TYPE data; the #length#-long array #members# describes
191 ** the members of the nested struct, and #tailPadding# indicates how many
192 ** padding bytes the compiler adds to the end of the structure.
195 typedef struct DataDescriptorStruct {
199 /*@null@*/ struct DataDescriptorStruct *members;
203 /** DataDescriptor for an array */
204 #define SIMPLE_DATA(type,repetitions) \
205 {type, repetitions, 0, NULL, 0, 0}
206 /** DataDescriptor for an structure member */
207 #define SIMPLE_MEMBER(type,repetitions,offset) \
208 {type, repetitions, offset, NULL, 0, 0}
209 /** DataDescriptor for padding bytes */
210 #define PAD_BYTES(structType,lastMember,memberType,repetitions) \
211 sizeof(structType) - offsetof(structType, lastMember) - \
212 sizeof(memberType) * repetitions
215 gras_datadesc_import_nws(const char *name,
216 const DataDescriptor *desc,
218 gras_datadesc_type_t **dst);
222 #endif /* GRAS_DATADESC_H */