gwenhywfar
5.11.1beta
|
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/path.h>
#include <gwenhywfar/fastbuffer.h>
#include <gwenhywfar/types.h>
#include <stdio.h>
Go to the source code of this file.
Macros | |
#define | GWEN_DB_LINE_MAXSIZE 1024 |
DB Flags | |
Please note that the setter functions also take the flags from the module Paths (e.g. GWEN_PATH_FLAGS_PATHMUSTEXIST) into account. So you most likely need to specify them, too. However, for your conveniance there is a default flag value which suffices in most cases (GWEN_DB_FLAGS_DEFAULT). | |
#define | GWEN_DB_FLAGS_ADD_GROUP_NEWLINES 0x00800000 |
#define | GWEN_DB_FLAGS_ALLOW_EMPTY_STREAM 0x00008000 |
#define | GWEN_DB_FLAGS_APPEND_FILE 0x08000000 |
#define | GWEN_DB_FLAGS_COMPACT |
#define | GWEN_DB_FLAGS_DEFAULT |
#define | GWEN_DB_FLAGS_DETAILED_GROUPS 0x00200000 |
#define | GWEN_DB_FLAGS_DOSMODE 0x80000000 |
#define | GWEN_DB_FLAGS_ESCAPE_CHARVALUES 0x10000000 |
#define | GWEN_DB_FLAGS_HTTP |
#define | GWEN_DB_FLAGS_INDEND 0x00400000 |
#define | GWEN_DB_FLAGS_INSERT 0x40000000 |
#define | GWEN_DB_FLAGS_LOCKFILE 0x20000000 |
#define | GWEN_DB_FLAGS_OMIT_TYPES 0x04000000 |
#define | GWEN_DB_FLAGS_OVERWRITE_GROUPS 0x00020000 |
#define | GWEN_DB_FLAGS_OVERWRITE_VARS 0x00010000 |
#define | GWEN_DB_FLAGS_QUOTE_VALUES 0x00080000 |
#define | GWEN_DB_FLAGS_QUOTE_VARNAMES 0x00040000 |
#define | GWEN_DB_FLAGS_UNESCAPE_CHARVALUES 0x10000000 |
#define | GWEN_DB_FLAGS_UNTIL_EMPTY_LINE 0x02000000 |
#define | GWEN_DB_FLAGS_USE_COLON 0x01000000 |
#define | GWEN_DB_FLAGS_WRITE_SUBGROUPS 0x00100000 |
Functions | |
Constructing, Destructing, Copying | |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_Group_dup (const GWEN_DB_NODE *n) |
GWENHYWFAR_API void | GWEN_DB_Group_free (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_Group_new (const char *name) |
Variable Getter and Setter | |
These getter functions check for the existence of the given variable and return the value specified by an index. Under the following circumstances the also given default value will be returned:
The setter functions either replace an existing variable, create a missing variable, add a value or return an error if the variable does not exist (see description of the flags). All setter functions make deep copies of the given values, so you may free the params after calling the setter function. All getter functions return a const pointer to the variable's retrieved value. All setter functions return Zero if ok and Nonzero on error. This module knows about the following types (see GWEN_DB_VALUETYPE):
| |
GWENHYWFAR_API int | GWEN_DB_AddCharValue (GWEN_DB_NODE *n, const char *path, const char *val, int senseCase, int check) |
GWENHYWFAR_API const void * | GWEN_DB_GetBinValue (GWEN_DB_NODE *n, const char *path, int idx, const void *defVal, unsigned int defValSize, unsigned int *returnValueSize) |
GWENHYWFAR_API const char * | GWEN_DB_GetCharValue (GWEN_DB_NODE *n, const char *path, int idx, const char *defVal) |
GWENHYWFAR_API int | GWEN_DB_GetIntValue (GWEN_DB_NODE *n, const char *path, int idx, int defVal) |
GWENHYWFAR_API void * | GWEN_DB_GetPtrValue (GWEN_DB_NODE *n, const char *path, int idx, void *defVal) |
GWENHYWFAR_API int | GWEN_DB_RemoveCharValue (GWEN_DB_NODE *n, const char *path, const char *val, int senseCase) |
GWENHYWFAR_API int | GWEN_DB_SetBinValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, const void *val, unsigned int valSize) |
GWENHYWFAR_API int | GWEN_DB_SetCharValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, const char *val) |
GWENHYWFAR_API int | GWEN_DB_SetCharValueFromInt (GWEN_DB_NODE *n, uint32_t flags, const char *path, int val) |
GWENHYWFAR_API int | GWEN_DB_SetIntValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, int val) |
GWENHYWFAR_API int | GWEN_DB_SetPtrValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, void *val) |
GWENHYWFAR_API int | GWEN_DB_WriteVarValueToBuffer (GWEN_DB_NODE *n, const char *path, int index, GWEN_BUFFER *dstBuf) |
Group Handling | |
GWENHYWFAR_API int | GWEN_DB_AddGroup (GWEN_DB_NODE *parent, GWEN_DB_NODE *node) |
GWENHYWFAR_API int | GWEN_DB_AddGroupChildren (GWEN_DB_NODE *n, GWEN_DB_NODE *nn) |
GWENHYWFAR_API int | GWEN_DB_ClearGroup (GWEN_DB_NODE *n, const char *path) |
GWENHYWFAR_API int | GWEN_DB_DeleteGroup (GWEN_DB_NODE *n, const char *path) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetGroup (GWEN_DB_NODE *n, uint32_t flags, const char *path) |
GWENHYWFAR_API uint32_t | GWEN_DB_GetNodeFlags (const GWEN_DB_NODE *n) |
GWENHYWFAR_API const char * | GWEN_DB_GroupName (GWEN_DB_NODE *n) |
GWENHYWFAR_API void | GWEN_DB_GroupRename (GWEN_DB_NODE *n, const char *newname) |
GWENHYWFAR_API int | GWEN_DB_InsertGroup (GWEN_DB_NODE *parent, GWEN_DB_NODE *node) |
GWENHYWFAR_API int | GWEN_DB_IsGroup (const GWEN_DB_NODE *n) |
GWENHYWFAR_API void | GWEN_DB_ModifyBranchFlagsDown (GWEN_DB_NODE *n, uint32_t newflags, uint32_t mask) |
GWENHYWFAR_API void | GWEN_DB_ModifyBranchFlagsUp (GWEN_DB_NODE *n, uint32_t newflags, uint32_t mask) |
GWENHYWFAR_API void | GWEN_DB_SetNodeFlags (GWEN_DB_NODE *n, uint32_t flags) |
GWENHYWFAR_API void | GWEN_DB_UnlinkGroup (GWEN_DB_NODE *n) |
Reading and Writing From/To IO Layers | |
These functions read or write a DB from/to GWEN_IO_LAYER. This allows to use any source or target supported by GWEN_IO_LAYER for data storage (these are currently sockets, files and memory buffers). The flags determine how to read/write the data (e.g. if sub-groups are to be written etc). | |
GWENHYWFAR_API int | GWEN_DB_ReadFile (GWEN_DB_NODE *n, const char *fname, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_ReadFileAs (GWEN_DB_NODE *n, const char *fname, const char *type, GWEN_DB_NODE *params, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_ReadFromFastBuffer (GWEN_DB_NODE *n, GWEN_FAST_BUFFER *fb, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_ReadFromIo (GWEN_DB_NODE *n, GWEN_SYNCIO *sio, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_ReadFromString (GWEN_DB_NODE *n, const char *str, int len, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_WriteFile (GWEN_DB_NODE *n, const char *fname, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_WriteFileAs (GWEN_DB_NODE *n, const char *fname, const char *type, GWEN_DB_NODE *params, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_WriteToBuffer (GWEN_DB_NODE *n, GWEN_BUFFER *buf, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_WriteToFastBuffer (GWEN_DB_NODE *node, GWEN_FAST_BUFFER *fb, uint32_t dbflags) |
GWENHYWFAR_API int | GWEN_DB_WriteToIo (GWEN_DB_NODE *node, GWEN_SYNCIO *sio, uint32_t dbflags) |
Iterating Through Variables and variable handling | |
GWENHYWFAR_API int | GWEN_DB_DeleteVar (GWEN_DB_NODE *n, const char *path) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_FindFirstVar (GWEN_DB_NODE *n, const char *name) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_FindNextVar (GWEN_DB_NODE *n, const char *name) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetFirstVar (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetNextVar (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE_TYPE | GWEN_DB_GetVariableType (GWEN_DB_NODE *n, const char *p) |
GWENHYWFAR_API int | GWEN_DB_IsVariable (const GWEN_DB_NODE *n) |
GWENHYWFAR_API int | GWEN_DB_ValueExists (GWEN_DB_NODE *n, const char *path, unsigned int idx) |
GWENHYWFAR_API int | GWEN_DB_VariableExists (GWEN_DB_NODE *n, const char *path) |
GWENHYWFAR_API const char * | GWEN_DB_VariableName (GWEN_DB_NODE *n) |
GWENHYWFAR_API void | GWEN_DB_VariableRename (GWEN_DB_NODE *n, const char *newname) |
GWENHYWFAR_API unsigned int | GWEN_DB_Variables_Count (const GWEN_DB_NODE *node) |
GWENHYWFAR_API void * | GWEN_DB_Variables_Foreach (GWEN_DB_NODE *node, GWEN_DB_NODES_CB func, void *user_data) |
Iterating Through Values and value handling | |
GWENHYWFAR_API const void * | GWEN_DB_GetBinValueFromNode (const GWEN_DB_NODE *n, unsigned int *size) |
GWENHYWFAR_API const char * | GWEN_DB_GetCharValueFromNode (const GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetFirstValue (GWEN_DB_NODE *n) |
GWENHYWFAR_API int | GWEN_DB_GetIntValueFromNode (const GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetNextValue (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE_TYPE | GWEN_DB_GetValueType (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE_TYPE | GWEN_DB_GetValueTypeByPath (GWEN_DB_NODE *n, const char *p, unsigned int i) |
GWENHYWFAR_API int | GWEN_DB_IsValue (const GWEN_DB_NODE *n) |
GWENHYWFAR_API int | GWEN_DB_SetCharValueInNode (GWEN_DB_NODE *n, const char *s) |
GWENHYWFAR_API unsigned int | GWEN_DB_Values_Count (const GWEN_DB_NODE *node) |
GWENHYWFAR_API void * | GWEN_DB_Values_Foreach (GWEN_DB_NODE *node, GWEN_DB_NODES_CB func, void *user_data) |
Debugging | |
These functions are for debugging purposes only. You should NOT consider them part of the API. | |
GWENHYWFAR_API void | GWEN_DB_Dump (GWEN_DB_NODE *n, int insert) |
Higher Level Utility Functions | |
These functions make use of GWEN_DB groups. | |
GWENHYWFAR_API int | GWEN_DB_ReplaceVars (GWEN_DB_NODE *db, const char *s, GWEN_BUFFER *dbuf) |
Node Flags | |
#define | GWEN_DB_DEFAULT_LOCK_TIMEOUT 1000 |
typedef struct GWEN_DB_NODE | GWEN_DB_NODE |
#define | GWEN_DB_NODE_FLAGS_DIRTY 0x00000001 |
#define | GWEN_DB_NODE_FLAGS_INHERIT_HASH_MECHANISM 0x00000004 |
#define | GWEN_DB_NODE_FLAGS_SAFE 0x00000008 |
#define | GWEN_DB_NODE_FLAGS_VOLATILE 0x00000002 |
enum | GWEN_DB_NODE_TYPE { GWEN_DB_NodeType_Unknown =-1 , GWEN_DB_NodeType_Group =0 , GWEN_DB_NodeType_Var , GWEN_DB_NodeType_ValueChar , GWEN_DB_NodeType_ValueInt , GWEN_DB_NodeType_ValueBin , GWEN_DB_NodeType_ValuePtr , GWEN_DB_NodeType_ValueLast } |
Iterating Through Groups | |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_FindFirstGroup (GWEN_DB_NODE *n, const char *name) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_FindNextGroup (GWEN_DB_NODE *n, const char *name) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetFirstGroup (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetNextGroup (GWEN_DB_NODE *n) |
GWENHYWFAR_API GWEN_DB_NODE * | GWEN_DB_GetParentGroup (GWEN_DB_NODE *n) |
GWENHYWFAR_API unsigned int | GWEN_DB_Groups_Count (const GWEN_DB_NODE *node) |
GWENHYWFAR_API void * | GWEN_DB_Groups_Foreach (GWEN_DB_NODE *node, GWEN_DB_NODES_CB func, void *user_data) |
typedef void *(* | GWEN_DB_NODES_CB) (GWEN_DB_NODE *node, void *user_data) |
#define GWEN_DB_FLAGS_ADD_GROUP_NEWLINES 0x00800000 |
#define GWEN_DB_FLAGS_ALLOW_EMPTY_STREAM 0x00008000 |
#define GWEN_DB_FLAGS_APPEND_FILE 0x08000000 |
#define GWEN_DB_FLAGS_COMPACT |
same like GWEN_DB_FLAGS_DEFAULT except that the produced file (when writing to a stream) is more compact (but less readable)
#define GWEN_DB_FLAGS_DEFAULT |
These are the default flags which you use in most cases
#define GWEN_DB_FLAGS_DETAILED_GROUPS 0x00200000 |
#define GWEN_DB_FLAGS_DOSMODE 0x80000000 |
#define GWEN_DB_FLAGS_ESCAPE_CHARVALUES 0x10000000 |
#define GWEN_DB_FLAGS_HTTP |
These flags can be used to read a DB from a HTTP header. It uses a colon instead of the equation mark with variable definitions and stops when encountering an empty line.
#define GWEN_DB_FLAGS_INDEND 0x00400000 |
#define GWEN_DB_FLAGS_INSERT 0x40000000 |
#define GWEN_DB_FLAGS_LOCKFILE 0x20000000 |
locks a file before reading from or writing to it This is used by GWEN_DB_ReadFile and GWEN_DB_WriteFile
#define GWEN_DB_FLAGS_OMIT_TYPES 0x04000000 |
#define GWEN_DB_FLAGS_OVERWRITE_GROUPS 0x00020000 |
Overwrite existing groups when calling GWEN_DB_GetGroup()
#define GWEN_DB_FLAGS_OVERWRITE_VARS 0x00010000 |
#define GWEN_DB_FLAGS_QUOTE_VALUES 0x00080000 |
#define GWEN_DB_FLAGS_QUOTE_VARNAMES 0x00040000 |
#define GWEN_DB_FLAGS_UNESCAPE_CHARVALUES 0x10000000 |
Char values are unescaped when reading them from a file (uses the same bit GWEN_DB_FLAGS_ESCAPE_CHARVALUES uses)
#define GWEN_DB_FLAGS_UNTIL_EMPTY_LINE 0x02000000 |
#define GWEN_DB_FLAGS_USE_COLON 0x01000000 |
#define GWEN_DB_FLAGS_WRITE_SUBGROUPS 0x00100000 |
#define GWEN_DB_LINE_MAXSIZE 1024 |
#define GWEN_DB_NODE_FLAGS_DIRTY 0x00000001 |
#define GWEN_DB_NODE_FLAGS_INHERIT_HASH_MECHANISM 0x00000004 |
#define GWEN_DB_NODE_FLAGS_SAFE 0x00000008 |
#define GWEN_DB_NODE_FLAGS_VOLATILE 0x00000002 |
typedef struct GWEN_DB_NODE GWEN_DB_NODE |
typedef void*(* GWEN_DB_NODES_CB) (GWEN_DB_NODE *node, void *user_data) |
Callback function type for GWEN_DB_Groups_Foreach(), GWEN_DB_Variables_Foreach(), and GWEN_DB_Values_Foreach().
node | The current node element |
user_data | The arbitrary data passed to the foreach function. |
enum GWEN_DB_NODE_TYPE |
This specifies the type of a value stored in the DB.
GWENHYWFAR_API int GWEN_DB_AddCharValue | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
const char * | val, | ||
int | senseCase, | ||
int | check | ||
) |
Adds the given char value to the given variable if it not already exists (depending on the arguments senseCase and check).
n | db node |
path | path and name of the variable |
val | The string value that is copied into the DB |
senseCase | if 0 then the case of the value is ignored while checking |
check | if 1 then the variable will be checked for this value |
GWENHYWFAR_API int GWEN_DB_AddGroup | ( | GWEN_DB_NODE * | parent, |
GWEN_DB_NODE * | node | ||
) |
Adds the given group node as a new child of the given parent group node.
The group name has no influence on what will happen in this function. In other words, if the parent group already has a child group with the same name as 'node', then after this function two child group nodes with the same name will exist.
parent | Some group node that will be the parent of the added node |
node | Group node to add |
GWENHYWFAR_API int GWEN_DB_AddGroupChildren | ( | GWEN_DB_NODE * | n, |
GWEN_DB_NODE * | nn | ||
) |
This function adds all children of the second node as new children to the first given one.
n | db node |
nn | node whose children are to be added (makes deep copies) |
GWENHYWFAR_API int GWEN_DB_ClearGroup | ( | GWEN_DB_NODE * | n, |
const char * | path | ||
) |
Frees all children of the given node thereby clearing it.
n | db node |
path | path to the group under the given node to clear (if 0 then clear the given node) |
GWENHYWFAR_API int GWEN_DB_DeleteGroup | ( | GWEN_DB_NODE * | n, |
const char * | path | ||
) |
Locates and removes the group of the given name.
n | db node |
path | path to the group to delete |
GWENHYWFAR_API int GWEN_DB_DeleteVar | ( | GWEN_DB_NODE * | n, |
const char * | path | ||
) |
Deletes the given variable by removing it and its values from the DB.
n | root of the DB |
path | path to the variable to remove |
GWENHYWFAR_API void GWEN_DB_Dump | ( | GWEN_DB_NODE * | n, |
int | insert | ||
) |
Dumps the content of the given DB to the given file (e.g. stderr).
n | node to dump |
insert | number of blanks to insert at every line |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_FindFirstGroup | ( | GWEN_DB_NODE * | n, |
const char * | name | ||
) |
Returns the first group node below the given one by name.
If there is no matching group node then NULL is returned. This can either mean that this node does not have any children or the only children are variables instead of groups or their is no group of the given name.
n | db node |
name | name to look for (joker and wildcards allowed) |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_FindFirstVar | ( | GWEN_DB_NODE * | n, |
const char * | name | ||
) |
Returns the first variable node below the given one by name.
If there is no matching variable node then NULL is returned. This can either mean that this node does not have any children or the only children are groups/values instead of variables or their is no variable of the given name.
n | db node |
name | name to look for (joker and wildcards allowed) |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_FindNextGroup | ( | GWEN_DB_NODE * | n, |
const char * | name | ||
) |
Returns the next group node following the given one, which has the same parent node, by name.
If there is no matching group node then NULL is returned. This can either mean that the parent node does not have any further children, or that the other children are variables instead of groups or that there is no group with the given name.
n | db node |
name | name to look for (joker and wildcards allowed) |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_FindNextVar | ( | GWEN_DB_NODE * | n, |
const char * | name | ||
) |
Returns the next variable node following the given one, which has the same parent node, by name.
If there is no matching variable node then NULL is returned. This can either mean that this node does not have any children or the only children are groups/values instead of variables or their is no variable of the given name.
n | db node |
name | name to look for (joker and wildcards allowed) |
GWENHYWFAR_API const void* GWEN_DB_GetBinValue | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
int | idx, | ||
const void * | defVal, | ||
unsigned int | defValSize, | ||
unsigned int * | returnValueSize | ||
) |
Returns the variable's retrieved value. The size of the binary data is written into the int pointer argument returnValueSize.
n | db node |
path | path and name of the variable |
idx | index number of the value to return |
defVal | default value to return in case there is no real value |
defValSize | size of the default value |
returnValueSize | pointer to a variable to receive the length of the data returned |
GWENHYWFAR_API const void* GWEN_DB_GetBinValueFromNode | ( | const GWEN_DB_NODE * | n, |
unsigned int * | size | ||
) |
GWENHYWFAR_API const char* GWEN_DB_GetCharValue | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
int | idx, | ||
const char * | defVal | ||
) |
Returns the variable's retrieved value.
n | db node |
path | path and name of the variable |
idx | index number of the value to return |
defVal | default value to return in case there is no real value |
GWENHYWFAR_API const char* GWEN_DB_GetCharValueFromNode | ( | const GWEN_DB_NODE * | n | ) |
Returns the value data of the given value node. If the given node is not a char-value node then 0 is returned.
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetFirstGroup | ( | GWEN_DB_NODE * | n | ) |
Returns the first group node below the given one.
If there is no group node then NULL is returned. This can either mean that this node does not have any children or the only children are variables instead of groups.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetFirstValue | ( | GWEN_DB_NODE * | n | ) |
Returns the first value below the given variable. If there is no value then NULL is returned.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetFirstVar | ( | GWEN_DB_NODE * | n | ) |
Returns the first variable below the given group. If there is no variable then NULL is returned.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetGroup | ( | GWEN_DB_NODE * | n, |
uint32_t | flags, | ||
const char * | path | ||
) |
This function either creates a new group, returns an existing one or returns an error if there is no group but the caller wanted one (depending on the flags given).
n | db node |
flags | see GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use. |
path | path and name of the group to be created/located |
GWENHYWFAR_API int GWEN_DB_GetIntValue | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
int | idx, | ||
int | defVal | ||
) |
Returns the variable's retrieved value.
n | db node |
path | path and name of the variable |
idx | index number of the value to return |
defVal | default value to return in case there is no real value |
GWENHYWFAR_API int GWEN_DB_GetIntValueFromNode | ( | const GWEN_DB_NODE * | n | ) |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetNextGroup | ( | GWEN_DB_NODE * | n | ) |
Returns the next group node following the given one, which has the same parent node.
This function works absolutely independently of the group nodes' names – the returned node may or may not have the same name as the specified node. The only guarantee is that the returned node will be a group node.
If there is no group node then NULL is returned. This can either mean that the parent node does not have any further children, or that the other children are variables instead of groups.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetNextValue | ( | GWEN_DB_NODE * | n | ) |
Returns the next value node following the given one, which has the same parent node.
If there is no value node then NULL is returned. This can either mean that the parent node does not have any further children, or that the other children aren't values.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetNextVar | ( | GWEN_DB_NODE * | n | ) |
Returns the next variable node following the given one, which has the same parent node.
This function works absolutely independently of the variable nodes' names – the returned node may or may not have the same name as the specified node. The only guarantee is that the returned node will be a variable node.
If there is no variable node then NULL is returned. This can either mean that the parent node does not have any further children, or that the other children are groups instead of variables.
n | db node |
GWENHYWFAR_API uint32_t GWEN_DB_GetNodeFlags | ( | const GWEN_DB_NODE * | n | ) |
Returns the node flags for the given db node. Please note that all modifications applied to a node will set the dirty flag in the node itself and all its parents. This allows to use this funcion here to check whether a DB has been modified.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetParentGroup | ( | GWEN_DB_NODE * | n | ) |
Returns the parent group of the given node.
GWENHYWFAR_API void* GWEN_DB_GetPtrValue | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
int | idx, | ||
void * | defVal | ||
) |
Returns the variable's retrieved value.
n | db node |
path | path and name of the variable |
idx | index number of the value to return |
defVal | default value to return in case there is no real value |
GWENHYWFAR_API GWEN_DB_NODE_TYPE GWEN_DB_GetValueType | ( | GWEN_DB_NODE * | n | ) |
Returns the type of the given value.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE_TYPE GWEN_DB_GetValueTypeByPath | ( | GWEN_DB_NODE * | n, |
const char * | p, | ||
unsigned int | i | ||
) |
GWENHYWFAR_API GWEN_DB_NODE_TYPE GWEN_DB_GetVariableType | ( | GWEN_DB_NODE * | n, |
const char * | p | ||
) |
Returns the type of the first value of the given variable
n | root node of the DB |
p | path of the variable to inspect |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_Group_dup | ( | const GWEN_DB_NODE * | n | ) |
Creates a deep copy of the given node. This copy will then be owned by the caller and MUST be freed after using it by calling GWEN_DB_Group_free().
n | db node |
GWENHYWFAR_API void GWEN_DB_Group_free | ( | GWEN_DB_NODE * | n | ) |
Frees a DB group. I.e. this is the destructor. This is needed to avoid memory leaks.
n | db node |
GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_Group_new | ( | const char * | name | ) |
Creates a new (empty) group with the given name. I.e. this is the constructor. When finished using this group, you should free it using GWEN_DB_Group_free() in order to avoid memory leaks.
name | name of the group to create |
GWENHYWFAR_API const char* GWEN_DB_GroupName | ( | GWEN_DB_NODE * | n | ) |
Returns the name of the given group.
GWENHYWFAR_API void GWEN_DB_GroupRename | ( | GWEN_DB_NODE * | n, |
const char * | newname | ||
) |
Renames the given group.
n | db node |
newname | new name for the group |
GWENHYWFAR_API unsigned int GWEN_DB_Groups_Count | ( | const GWEN_DB_NODE * | node | ) |
Returns the number of group nodes that are direct children of the given node. In other words, this is the number of group nodes that will be reached in the GWEN_DB_Groups_foreach() function.
GWENHYWFAR_API void* GWEN_DB_Groups_Foreach | ( | GWEN_DB_NODE * | node, |
GWEN_DB_NODES_CB | func, | ||
void * | user_data | ||
) |
Iterates through all group nodes that are direct children of the given node, calling the callback function 'func' on each group node. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL.
If no nodes that are groups are found as children, then this function will simply do nothing.
node | The group node whose children shall be iterated through. |
func | The function to be called with each group node. |
user_data | A pointer passed on to the function 'func'. |
GWENHYWFAR_API int GWEN_DB_InsertGroup | ( | GWEN_DB_NODE * | parent, |
GWEN_DB_NODE * | node | ||
) |
Adds the given group node as the new first child of the given parent group node.
The group name has no influence on what will happen in this function. In other words, if the parent group already has a child group with the same name as 'node', then after this function two child group nodes with the same name will exist.
parent | Some group node that will be the parent of the added node |
node | Group node to add |
GWENHYWFAR_API int GWEN_DB_IsGroup | ( | const GWEN_DB_NODE * | n | ) |
Predicate: Returns nonzero (TRUE) or zero (FALSE) if the given NODE is a Group or not. Usually these group nodes are the only nodes that the application gets in touch with.
n | db node |
GWENHYWFAR_API int GWEN_DB_IsValue | ( | const GWEN_DB_NODE * | n | ) |
Predicate: Returns nonzero (TRUE) or zero (FALSE) if the given NODE is a Value or not. Usually the Application does not get in touch with such Nodes but only with nodes that are Groups.
n | db node |
GWENHYWFAR_API int GWEN_DB_IsVariable | ( | const GWEN_DB_NODE * | n | ) |
Predicate: Returns nonzero (TRUE) or zero (FALSE) if the given NODE is a Variable or not. Usually the Application does not get in touch with such Nodes but only with nodes that are Groups.
n | db node |
GWENHYWFAR_API void GWEN_DB_ModifyBranchFlagsDown | ( | GWEN_DB_NODE * | n, |
uint32_t | newflags, | ||
uint32_t | mask | ||
) |
Modifies the flags of the given node and all its children according to the parameters given.
n | db node |
newflags | new flags to set (see GWEN_DB_NODE_FLAGS_DIRTY) |
mask | only those flags which are set in this mask are modified according to newflags |
GWENHYWFAR_API void GWEN_DB_ModifyBranchFlagsUp | ( | GWEN_DB_NODE * | n, |
uint32_t | newflags, | ||
uint32_t | mask | ||
) |
Modifies the flags of the given node and all its parents according to the parameters given.
n | db node |
newflags | new flags to set (see GWEN_DB_NODE_FLAGS_DIRTY) |
mask | only those flags which are set in this mask are modified according to newflags |
GWENHYWFAR_API int GWEN_DB_ReadFile | ( | GWEN_DB_NODE * | n, |
const char * | fname, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_ReadFileAs | ( | GWEN_DB_NODE * | n, |
const char * | fname, | ||
const char * | type, | ||
GWEN_DB_NODE * | params, | ||
uint32_t | dbflags | ||
) |
Imports a file into a DB using a GWEN_DBIO importer.
n | node to read into (becomes the root of the imported data) |
fname | name of the file to import |
type | GWEN_DBIO type |
params | parameters for the GWEN_DBIO importer (content depends on the importer, may even be NULL for some types) |
dbflags | flags to use while importing (see GWEN_DB_FLAGS_OVERWRITE_VARS and others) |
GWENHYWFAR_API int GWEN_DB_ReadFromFastBuffer | ( | GWEN_DB_NODE * | n, |
GWEN_FAST_BUFFER * | fb, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_ReadFromIo | ( | GWEN_DB_NODE * | n, |
GWEN_SYNCIO * | sio, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_ReadFromString | ( | GWEN_DB_NODE * | n, |
const char * | str, | ||
int | len, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_RemoveCharValue | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
const char * | val, | ||
int | senseCase | ||
) |
Removes the given char value from the given variable if it exists (depending on the arguments senseCase and check).
n | db node |
path | path and name of the variable |
val | The string value to be removed |
senseCase | if 0 then the case of the value is ignored while checking |
GWENHYWFAR_API int GWEN_DB_ReplaceVars | ( | GWEN_DB_NODE * | db, |
const char * | s, | ||
GWEN_BUFFER * | dbuf | ||
) |
Read the given string and replace every variable in that string ( noted as "$(varname)") with the value of the mentioned variable.
GWENHYWFAR_API int GWEN_DB_SetBinValue | ( | GWEN_DB_NODE * | n, |
uint32_t | flags, | ||
const char * | path, | ||
const void * | val, | ||
unsigned int | valSize | ||
) |
n | db node |
path | path and name of the variable |
flags | see GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use. |
val | The binary data that is copied into the DB. |
valSize | The number of bytes in the binary data value. |
GWENHYWFAR_API int GWEN_DB_SetCharValue | ( | GWEN_DB_NODE * | n, |
uint32_t | flags, | ||
const char * | path, | ||
const char * | val | ||
) |
n | db node |
flags | see GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use. |
path | path and name of the variable |
val | The string value that is copied into the DB |
GWENHYWFAR_API int GWEN_DB_SetCharValueFromInt | ( | GWEN_DB_NODE * | n, |
uint32_t | flags, | ||
const char * | path, | ||
int | val | ||
) |
n | db node |
flags | see GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use. |
path | path and name of the variable |
val | The integer value to be stored as string value in the DB |
GWENHYWFAR_API int GWEN_DB_SetCharValueInNode | ( | GWEN_DB_NODE * | n, |
const char * | s | ||
) |
Replaces the current value data of the given node by the new string.
GWENHYWFAR_API int GWEN_DB_SetIntValue | ( | GWEN_DB_NODE * | n, |
uint32_t | flags, | ||
const char * | path, | ||
int | val | ||
) |
n | db node |
flags | see GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use. |
path | path and name of the variable |
val | new value |
GWENHYWFAR_API void GWEN_DB_SetNodeFlags | ( | GWEN_DB_NODE * | n, |
uint32_t | flags | ||
) |
Modifies the node flags for the given db node
n | db node |
flags | flags to set (see GWEN_DB_NODE_FLAGS_DIRTY) |
GWENHYWFAR_API int GWEN_DB_SetPtrValue | ( | GWEN_DB_NODE * | n, |
uint32_t | flags, | ||
const char * | path, | ||
void * | val | ||
) |
n | db node |
path | path and name of the variable |
flags | see GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use. |
val | The pointer that is stored within the DB. |
GWENHYWFAR_API void GWEN_DB_UnlinkGroup | ( | GWEN_DB_NODE * | n | ) |
Unlinks a group (and thereby all its children) from its parent and brothers.
This function DOES NOT free the group, it just unlinks it. You can then use it with e.g. GWEN_DB_AddGroup or other functions to relink it at any other position of even in other DBs.
n | db node |
GWENHYWFAR_API int GWEN_DB_ValueExists | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
unsigned int | idx | ||
) |
Checks whether the given variable and value exists.
n | root of the DB |
path | path to the variable to check for |
idx | index number of the variable's value to check for |
GWENHYWFAR_API unsigned int GWEN_DB_Values_Count | ( | const GWEN_DB_NODE * | node | ) |
Returns the number of value nodes that are direct children of the given node. In other words, this is the number of value nodes that will be reached in the GWEN_DB_Values_foreach() function.
GWENHYWFAR_API void* GWEN_DB_Values_Foreach | ( | GWEN_DB_NODE * | node, |
GWEN_DB_NODES_CB | func, | ||
void * | user_data | ||
) |
Iterates through all value nodes that are direct children of the given node, calling the callback function 'func' on each value node. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL.
If no nodes that are values are found as children, then this function will simply do nothing.
node | The variable node whose children shall be iterated through. |
func | The function to be called with each group node. |
user_data | A pointer passed on to the function 'func'. |
GWENHYWFAR_API int GWEN_DB_VariableExists | ( | GWEN_DB_NODE * | n, |
const char * | path | ||
) |
Checks whether the given variable exists.
n | root of the DB |
path | path to the variable to check for |
GWENHYWFAR_API const char* GWEN_DB_VariableName | ( | GWEN_DB_NODE * | n | ) |
Returns the name of the variable specified by the given node.
n | db node specifying a variable (not a group !) |
GWENHYWFAR_API void GWEN_DB_VariableRename | ( | GWEN_DB_NODE * | n, |
const char * | newname | ||
) |
GWENHYWFAR_API unsigned int GWEN_DB_Variables_Count | ( | const GWEN_DB_NODE * | node | ) |
Returns the number of variable nodes that are direct children of the given node. In other words, this is the number of variable nodes that will be reached in the GWEN_DB_Variables_Foreach() function.
GWENHYWFAR_API void* GWEN_DB_Variables_Foreach | ( | GWEN_DB_NODE * | node, |
GWEN_DB_NODES_CB | func, | ||
void * | user_data | ||
) |
Iterates through all variable nodes that are direct children of the given node, calling the callback function 'func' on each variable node. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL.
If no nodes that are variables are found as children, then this function will simply do nothing.
node | The group node whose children shall be iterated through. |
func | The function to be called with each group node. |
user_data | A pointer passed on to the function 'func'. |
GWENHYWFAR_API int GWEN_DB_WriteFile | ( | GWEN_DB_NODE * | n, |
const char * | fname, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_WriteFileAs | ( | GWEN_DB_NODE * | n, |
const char * | fname, | ||
const char * | type, | ||
GWEN_DB_NODE * | params, | ||
uint32_t | dbflags | ||
) |
Exports a DB to a file using a GWEN_DBIO exporter.
n | node to write |
fname | name of the file to export to |
type | GWEN_DBIO type |
params | parameters for the GWEN_DBIO exporter (content depends on the exporter, may even be NULL for some types) |
dbflags | flags to use while exporting (see GWEN_DB_FLAGS_OVERWRITE_VARS and others) |
GWENHYWFAR_API int GWEN_DB_WriteToBuffer | ( | GWEN_DB_NODE * | n, |
GWEN_BUFFER * | buf, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_WriteToFastBuffer | ( | GWEN_DB_NODE * | node, |
GWEN_FAST_BUFFER * | fb, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_WriteToIo | ( | GWEN_DB_NODE * | node, |
GWEN_SYNCIO * | sio, | ||
uint32_t | dbflags | ||
) |
GWENHYWFAR_API int GWEN_DB_WriteVarValueToBuffer | ( | GWEN_DB_NODE * | n, |
const char * | path, | ||
int | index, | ||
GWEN_BUFFER * | dstBuf | ||
) |
n | db node |
path | path and name of the variable |
index | number of value to read (if there are multiple values in the variable, 0 being the first) |
dstBuf | buffer to write the value into |