gwenhywfar  5.3.0
param.h
Go to the documentation of this file.
1 /**********************************************************
2  * This file has been automatically created by "typemaker2"
3  * from the file "param.xml".
4  * Please do not edit this file, all changes will be lost.
5  * Better edit the mentioned source file instead.
6  **********************************************************/
7 
8 #ifndef GWEN_PARAM_PARAM_H
9 #define GWEN_PARAM_PARAM_H
10 
11 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
98 /* define GWEN_PARAM_RTFLAGS */
99 
100 
101 /* define GWEN_PARAM_FLAGS */
102 
103 
104 /* needed system headers */
105 #include <gwenhywfar/types.h>
106 #include <gwenhywfar/list1.h>
107 #include <gwenhywfar/list2.h>
108 #include <gwenhywfar/tree.h>
109 #include <gwenhywfar/db.h>
110 #include <gwenhywfar/xml.h>
111 
112 /* pre-headers */
114 #include <gwenhywfar/stringlist2.h>
115 
116 typedef struct GWEN_PARAM GWEN_PARAM;
120 
121 
122 
123 typedef enum {
130 
131 
132 typedef enum {
137 
138 
139 /* post-headers */
140 #include <gwenhywfar/param_fns.h>
141 
142 
144 
146 
148 
150 
153 
156 
158 
160 
162 
166 GWENHYWFAR_API const char *GWEN_Param_GetName(const GWEN_PARAM *p_struct);
167 
171 GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct);
172 
177 
182 
186 GWENHYWFAR_API const char *GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct);
187 
191 GWENHYWFAR_API const char *GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct);
192 
196 GWENHYWFAR_API const char *GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct);
197 
201 GWENHYWFAR_API const char *GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct);
202 
207 
211 GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct);
212 
216 GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src);
217 
221 GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src);
222 
226 GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src);
227 
231 GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src);
232 
237 
242 
246 GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src);
247 
251 GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src);
252 
256 GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src);
257 
261 GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src);
262 
267 
271 GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
272 
276 GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
277 
281 GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
282 
283 /* list1 functions */
285 
287 
288 GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
289 
291 
292 GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
293 
295 
296 GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
297 
298 GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
299 
301 
302 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp);
303 
304 GWENHYWFAR_API GWEN_PARAM *GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp);
305 
306 /* end-headers */
307 
308 
309 #ifdef __cplusplus
310 }
311 #endif
312 
313 #endif
314 
GWEN_Param_GetRuntimeFlags
GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct)
GWEN_Param_Type_toString
const GWENHYWFAR_API char * GWEN_Param_Type_toString(GWEN_PARAM_TYPE p_i)
GWEN_Param_SetCurrentValue
GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_Type_Choice
@ GWEN_Param_Type_Choice
Definition: param.h:135
GWEN_Param_AddFlags
GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_Type_Unknown
@ GWEN_Param_Type_Unknown
Definition: param.h:133
GWEN_Param_SubRuntimeFlags
GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_DataType_fromString
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_DataType_fromString(const char *p_s)
GWEN_Param_new
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_new(void)
types.h
GWEN_Param_Type_fromString
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_Type_fromString(const char *p_s)
GWEN_Param_GetDefaultValue
const GWENHYWFAR_API char * GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct)
GWEN_Param_List_dup
GWENHYWFAR_API GWEN_PARAM_LIST * GWEN_Param_List_dup(const GWEN_PARAM_LIST *p_src)
GWEN_Param_GetFlags
GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct)
GWEN_Param_SetType
GWENHYWFAR_API void GWEN_Param_SetType(GWEN_PARAM *p_struct, GWEN_PARAM_TYPE p_src)
GWEN_Param_SetDataType
GWENHYWFAR_API void GWEN_Param_SetDataType(GWEN_PARAM *p_struct, GWEN_PARAM_DATATYPE p_src)
GWEN_Param_DataType_Bool
@ GWEN_Param_DataType_Bool
Definition: param.h:126
GWEN_Param_GetLongDescription
const GWENHYWFAR_API char * GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct)
stringlist2.h
GWEN_Param_GetName
const GWENHYWFAR_API char * GWEN_Param_GetName(const GWEN_PARAM *p_struct)
GWEN_Param_free
GWENHYWFAR_API void GWEN_Param_free(GWEN_PARAM *p_struct)
GWEN_Param_ReadXml
GWENHYWFAR_API void GWEN_Param_ReadXml(GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
db.h
GWEN_PARAM_LIST
Definition: listdoc.h:6102
xml.h
GWEN_Param_WriteXml
GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWEN_PARAM
struct GWEN_PARAM GWEN_PARAM
Definition: param.h:116
GWEN_Param_SetFlags
GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_fromXml
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_fromXml(GWEN_XMLNODE *p_db)
GWEN_Param_SetDefaultValue
GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src)
GWEN_PARAM_TYPE
GWEN_PARAM_TYPE
Definition: param.h:132
GWEN_Param_dup
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_dup(const GWEN_PARAM *p_struct)
GWEN_Param_DataType_toString
const GWENHYWFAR_API char * GWEN_Param_DataType_toString(GWEN_PARAM_DATATYPE p_i)
GWEN_Param_DataType_String
@ GWEN_Param_DataType_String
Definition: param.h:128
GWEN_TREE_FUNCTION_LIB_DEFS
#define GWEN_TREE_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: tree.h:384
GWEN_Param_toXml
GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWEN_Param_ReadDb
GWENHYWFAR_API void GWEN_Param_ReadDb(GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWEN_Param_Type_Simple
@ GWEN_Param_Type_Simple
Definition: param.h:134
GWEN_Param_SetRuntimeFlags
GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_LIST_FUNCTION_LIB_DEFS
#define GWEN_LIST_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list1.h:348
GWEN_Param_GetType
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_GetType(const GWEN_PARAM *p_struct)
GWEN_Param_DataType_Int
@ GWEN_Param_DataType_Int
Definition: param.h:125
GWEN_Param_GetShortDescription
const GWENHYWFAR_API char * GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct)
GWEN_PARAM_DATATYPE
GWEN_PARAM_DATATYPE
Definition: param.h:123
GWEN_Param_SetName
GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src)
param_fns.h
GWEN_Param_List_GetByName
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp)
GWEN_Param_GetDataType
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_GetDataType(const GWEN_PARAM *p_struct)
tree.h
GWEN_LIST2_FUNCTION_LIB_DEFS
#define GWEN_LIST2_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list2.h:56
GWEN_XMLNODE
struct GWEN__XMLNODE GWEN_XMLNODE
Definition: xml.h:149
GWEN_Param_fromDb
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_fromDb(GWEN_DB_NODE *p_db)
GWEN_Param_Attach
GWENHYWFAR_API void GWEN_Param_Attach(GWEN_PARAM *p_struct)
GWEN_Param_copy
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_copy(GWEN_PARAM *p_struct, const GWEN_PARAM *p_src)
GWEN_Param_SetShortDescription
GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_AddRuntimeFlags
GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
gwenhywfarapi.h
GWEN_Param_WriteDb
GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWEN_Param_GetChoices
GWENHYWFAR_API GWEN_STRINGLIST2 * GWEN_Param_GetChoices(const GWEN_PARAM *p_struct)
GWEN_Param_DataType_Float
@ GWEN_Param_DataType_Float
Definition: param.h:127
GWEN_Param_Tree_GetByName
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp)
GWEN_STRINGLIST2
struct GWEN_STRINGLIST2 GWEN_STRINGLIST2
Definition: stringlist2.h:43
GWEN_Param_GetCurrentValue
const GWENHYWFAR_API char * GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct)
GWEN_DB_NODE
struct GWEN_DB_NODE GWEN_DB_NODE
Definition: db.h:228
list2.h
This file contains some macros concerning lists.
GWEN_Param_DataType_Unknown
@ GWEN_Param_DataType_Unknown
Definition: param.h:124
GWEN_Param_SetLongDescription
GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_SubFlags
GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWENHYWFAR_API
#define GWENHYWFAR_API
Definition: gwenhywfarapi.h:67
GWEN_Param_SetChoices
GWENHYWFAR_API void GWEN_Param_SetChoices(GWEN_PARAM *p_struct, GWEN_STRINGLIST2 *p_src)
GWEN_Param_toDb
GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
list1.h