param.h
Go to the documentation of this file.
/**********************************************************
* This file has been automatically created by "typemaker2"
* from the file "param.xml".
* Please do not edit this file, all changes will be lost.
* Better edit the mentioned source file instead.
**********************************************************/
#ifndef GWEN_PARAM_PARAM_H
#define GWEN_PARAM_PARAM_H
#ifdef __cplusplus
extern "C" {
#endif
/* define GWEN_PARAM_RTFLAGS */
/* define GWEN_PARAM_FLAGS */
/* needed system headers */
#include <gwenhywfar/types.h>
#include <gwenhywfar/list1.h>
#include <gwenhywfar/list2.h>
#include <gwenhywfar/tree.h>
#include <gwenhywfar/db.h>
#include <gwenhywfar/xml.h>
/* pre-headers */
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/stringlist2.h>
typedef struct GWEN_PARAM GWEN_PARAM;
GWEN_LIST_FUNCTION_LIB_DEFS(GWEN_PARAM, GWEN_Param, GWENHYWFAR_API)
GWEN_LIST2_FUNCTION_LIB_DEFS(GWEN_PARAM, GWEN_Param, GWENHYWFAR_API)
GWEN_TREE_FUNCTION_LIB_DEFS(GWEN_PARAM, GWEN_Param, GWENHYWFAR_API)
typedef enum {
GWEN_Param_DataType_Unknown = -1,
GWEN_Param_DataType_Int,
GWEN_Param_DataType_Bool,
GWEN_Param_DataType_Float,
GWEN_Param_DataType_String
} GWEN_PARAM_DATATYPE;
typedef enum {
GWEN_Param_Type_Unknown = -1,
GWEN_Param_Type_Simple,
GWEN_Param_Type_Choice
} GWEN_PARAM_TYPE;
/* post-headers */
#include <gwenhywfar/param_fns.h>
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_DataType_fromString(const char *p_s);
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_Type_fromString(const char *p_s);
GWENHYWFAR_API const char *GWEN_Param_DataType_toString(GWEN_PARAM_DATATYPE p_i);
GWENHYWFAR_API const char *GWEN_Param_Type_toString(GWEN_PARAM_TYPE p_i);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_new(void);
GWENHYWFAR_API void GWEN_Param_free(GWEN_PARAM *p_struct);
GWENHYWFAR_API void GWEN_Param_Attach(GWEN_PARAM *p_struct);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_dup(const GWEN_PARAM *p_struct);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_copy(GWEN_PARAM *p_struct, const GWEN_PARAM *p_src);
GWENHYWFAR_API const char *GWEN_Param_GetName(const GWEN_PARAM *p_struct);
GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct);
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_GetType(const GWEN_PARAM *p_struct);
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_GetDataType(const GWEN_PARAM *p_struct);
GWENHYWFAR_API const char *GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct);
GWENHYWFAR_API const char *GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct);
GWENHYWFAR_API const char *GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct);
GWENHYWFAR_API const char *GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct);
GWENHYWFAR_API GWEN_STRINGLIST2 *GWEN_Param_GetChoices(const GWEN_PARAM *p_struct);
GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct);
GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src);
GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src);
GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src);
GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src);
GWENHYWFAR_API void GWEN_Param_SetType(GWEN_PARAM *p_struct, GWEN_PARAM_TYPE p_src);
GWENHYWFAR_API void GWEN_Param_SetDataType(GWEN_PARAM *p_struct, GWEN_PARAM_DATATYPE p_src);
GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src);
GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src);
GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src);
GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src);
GWENHYWFAR_API void GWEN_Param_SetChoices(GWEN_PARAM *p_struct, GWEN_STRINGLIST2 *p_src);
GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src);
/* list1 functions */
GWENHYWFAR_API GWEN_PARAM_LIST *GWEN_Param_List_dup(const GWEN_PARAM_LIST *p_src);
GWENHYWFAR_API void GWEN_Param_ReadDb(GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_fromDb(GWEN_DB_NODE *p_db);
GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db);
GWENHYWFAR_API void GWEN_Param_ReadXml(GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_fromXml(GWEN_XMLNODE *p_db);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp);
GWENHYWFAR_API GWEN_PARAM *GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp);
/* end-headers */
#ifdef __cplusplus
}
#endif
#endif
db.h
GWEN_DB_NODE
struct GWEN_DB_NODE GWEN_DB_NODE
Definition db.h:228
gwenhywfarapi.h
GWENHYWFAR_API
#define GWENHYWFAR_API
Definition gwenhywfarapi.h:67
list1.h
GWEN_LIST_FUNCTION_LIB_DEFS
#define GWEN_LIST_FUNCTION_LIB_DEFS(t, pr, decl)
Definition list1.h:349
list2.h
This file contains some macros concerning lists.
GWEN_LIST2_FUNCTION_LIB_DEFS
#define GWEN_LIST2_FUNCTION_LIB_DEFS(t, pr, decl)
Definition list2.h:56
GWEN_Param_List_GetByName
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_List_GetByName(const GWEN_PARAM_LIST *p_list, const char *p_cmp)
GWEN_Param_Attach
GWENHYWFAR_API void GWEN_Param_Attach(GWEN_PARAM *p_struct)
GWEN_Param_SubRuntimeFlags
GWENHYWFAR_API void GWEN_Param_SubRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_WriteDb
GWENHYWFAR_API int GWEN_Param_WriteDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWEN_Param_new
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_new(void)
GWEN_Param_SetType
GWENHYWFAR_API void GWEN_Param_SetType(GWEN_PARAM *p_struct, GWEN_PARAM_TYPE p_src)
GWEN_Param_Type_fromString
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_Type_fromString(const char *p_s)
GWEN_Param_GetLongDescription
GWENHYWFAR_API const char * GWEN_Param_GetLongDescription(const GWEN_PARAM *p_struct)
GWEN_Param_Type_toString
GWENHYWFAR_API const char * GWEN_Param_Type_toString(GWEN_PARAM_TYPE p_i)
GWEN_Param_GetFlags
GWENHYWFAR_API uint32_t GWEN_Param_GetFlags(const GWEN_PARAM *p_struct)
GWEN_Param_SetDefaultValue
GWENHYWFAR_API void GWEN_Param_SetDefaultValue(GWEN_PARAM *p_struct, const char *p_src)
GWEN_PARAM_DATATYPE
GWEN_PARAM_DATATYPE
Definition param.h:123
GWEN_Param_DataType_Float
@ GWEN_Param_DataType_Float
Definition param.h:127
GWEN_Param_DataType_Unknown
@ GWEN_Param_DataType_Unknown
Definition param.h:124
GWEN_Param_DataType_Int
@ GWEN_Param_DataType_Int
Definition param.h:125
GWEN_Param_DataType_String
@ GWEN_Param_DataType_String
Definition param.h:128
GWEN_Param_DataType_Bool
@ GWEN_Param_DataType_Bool
Definition param.h:126
GWEN_Param_Tree_GetByName
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_Tree_GetByName(const GWEN_PARAM_TREE *p_tree, const char *p_cmp)
GWEN_Param_SetChoices
GWENHYWFAR_API void GWEN_Param_SetChoices(GWEN_PARAM *p_struct, GWEN_STRINGLIST2 *p_src)
GWEN_Param_GetRuntimeFlags
GWENHYWFAR_API uint32_t GWEN_Param_GetRuntimeFlags(const GWEN_PARAM *p_struct)
GWEN_Param_SetShortDescription
GWENHYWFAR_API void GWEN_Param_SetShortDescription(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_List_dup
GWENHYWFAR_API GWEN_PARAM_LIST * GWEN_Param_List_dup(const GWEN_PARAM_LIST *p_src)
GWEN_Param_DataType_fromString
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_DataType_fromString(const char *p_s)
GWEN_Param_SubFlags
GWENHYWFAR_API void GWEN_Param_SubFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_WriteXml
GWENHYWFAR_API void GWEN_Param_WriteXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWEN_PARAM_TYPE
GWEN_PARAM_TYPE
Definition param.h:132
GWEN_Param_Type_Unknown
@ GWEN_Param_Type_Unknown
Definition param.h:133
GWEN_Param_Type_Choice
@ GWEN_Param_Type_Choice
Definition param.h:135
GWEN_Param_Type_Simple
@ GWEN_Param_Type_Simple
Definition param.h:134
GWEN_Param_AddFlags
GWENHYWFAR_API void GWEN_Param_AddFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_toXml
GWENHYWFAR_API void GWEN_Param_toXml(const GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWEN_Param_GetChoices
GWENHYWFAR_API GWEN_STRINGLIST2 * GWEN_Param_GetChoices(const GWEN_PARAM *p_struct)
GWEN_Param_toDb
GWENHYWFAR_API int GWEN_Param_toDb(const GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWEN_Param_SetCurrentValue
GWENHYWFAR_API void GWEN_Param_SetCurrentValue(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_GetDataType
GWENHYWFAR_API GWEN_PARAM_DATATYPE GWEN_Param_GetDataType(const GWEN_PARAM *p_struct)
GWEN_Param_AddRuntimeFlags
GWENHYWFAR_API void GWEN_Param_AddRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_GetCurrentValue
GWENHYWFAR_API const char * GWEN_Param_GetCurrentValue(const GWEN_PARAM *p_struct)
GWEN_Param_fromXml
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_fromXml(GWEN_XMLNODE *p_db)
GWEN_Param_fromDb
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_fromDb(GWEN_DB_NODE *p_db)
GWEN_Param_dup
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_dup(const GWEN_PARAM *p_struct)
GWEN_Param_GetShortDescription
GWENHYWFAR_API const char * GWEN_Param_GetShortDescription(const GWEN_PARAM *p_struct)
GWEN_Param_SetLongDescription
GWENHYWFAR_API void GWEN_Param_SetLongDescription(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_SetRuntimeFlags
GWENHYWFAR_API void GWEN_Param_SetRuntimeFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_GetDefaultValue
GWENHYWFAR_API const char * GWEN_Param_GetDefaultValue(const GWEN_PARAM *p_struct)
GWEN_Param_ReadXml
GWENHYWFAR_API void GWEN_Param_ReadXml(GWEN_PARAM *p_struct, GWEN_XMLNODE *p_db)
GWEN_Param_SetName
GWENHYWFAR_API void GWEN_Param_SetName(GWEN_PARAM *p_struct, const char *p_src)
GWEN_Param_SetDataType
GWENHYWFAR_API void GWEN_Param_SetDataType(GWEN_PARAM *p_struct, GWEN_PARAM_DATATYPE p_src)
GWEN_Param_free
GWENHYWFAR_API void GWEN_Param_free(GWEN_PARAM *p_struct)
GWEN_Param_ReadDb
GWENHYWFAR_API void GWEN_Param_ReadDb(GWEN_PARAM *p_struct, GWEN_DB_NODE *p_db)
GWEN_Param_SetFlags
GWENHYWFAR_API void GWEN_Param_SetFlags(GWEN_PARAM *p_struct, uint32_t p_src)
GWEN_Param_GetName
GWENHYWFAR_API const char * GWEN_Param_GetName(const GWEN_PARAM *p_struct)
GWEN_PARAM
struct GWEN_PARAM GWEN_PARAM
Definition param.h:116
GWEN_Param_copy
GWENHYWFAR_API GWEN_PARAM * GWEN_Param_copy(GWEN_PARAM *p_struct, const GWEN_PARAM *p_src)
GWEN_Param_DataType_toString
GWENHYWFAR_API const char * GWEN_Param_DataType_toString(GWEN_PARAM_DATATYPE p_i)
GWEN_Param_GetType
GWENHYWFAR_API GWEN_PARAM_TYPE GWEN_Param_GetType(const GWEN_PARAM *p_struct)
param_fns.h
stringlist2.h
GWEN_STRINGLIST2
struct GWEN_STRINGLIST2 GWEN_STRINGLIST2
Definition stringlist2.h:43
GWEN_PARAM_LIST
Definition listdoc.h:6402
tree.h
GWEN_TREE_FUNCTION_LIB_DEFS
#define GWEN_TREE_FUNCTION_LIB_DEFS(t, pr, decl)
Definition tree.h:384
types.h
xml.h
GWEN_XMLNODE
struct GWEN__XMLNODE GWEN_XMLNODE
Definition xml.h:156