gwenhywfar 4.0.3
Defines | Typedefs | Enumerations

Database

Data Management And Parsing

This group contains the definition of a GWEN_DB database. More...

Defines

#define GWEN_DB_DEFAULT_LOCK_TIMEOUT   1000
#define GWEN_DB_LINE_MAXSIZE   1024

Typedefs

typedef struct GWEN_DB_NODE GWEN_DB_NODE

Enumerations

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
}

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_ALLOW_EMPTY_STREAM   0x00008000
#define GWEN_DB_FLAGS_OVERWRITE_VARS   0x00010000
#define GWEN_DB_FLAGS_OVERWRITE_GROUPS   0x00020000
#define GWEN_DB_FLAGS_QUOTE_VARNAMES   0x00040000
#define GWEN_DB_FLAGS_QUOTE_VALUES   0x00080000
#define GWEN_DB_FLAGS_WRITE_SUBGROUPS   0x00100000
#define GWEN_DB_FLAGS_DETAILED_GROUPS   0x00200000
#define GWEN_DB_FLAGS_INDEND   0x00400000
#define GWEN_DB_FLAGS_ADD_GROUP_NEWLINES   0x00800000
#define GWEN_DB_FLAGS_USE_COLON   0x01000000
#define GWEN_DB_FLAGS_UNTIL_EMPTY_LINE   0x02000000
#define GWEN_DB_FLAGS_OMIT_TYPES   0x04000000
#define GWEN_DB_FLAGS_APPEND_FILE   0x08000000
#define GWEN_DB_FLAGS_ESCAPE_CHARVALUES   0x10000000
#define GWEN_DB_FLAGS_UNESCAPE_CHARVALUES   0x10000000
#define GWEN_DB_FLAGS_LOCKFILE   0x20000000
#define GWEN_DB_FLAGS_INSERT   0x40000000
#define GWEN_DB_FLAGS_DOSMODE   0x80000000
#define GWEN_DB_FLAGS_DEFAULT
#define GWEN_DB_FLAGS_COMPACT
#define GWEN_DB_FLAGS_HTTP

Node Flags

#define GWEN_DB_NODE_FLAGS_DIRTY   0x00000001
#define GWEN_DB_NODE_FLAGS_VOLATILE   0x00000002
#define GWEN_DB_NODE_FLAGS_INHERIT_HASH_MECHANISM   0x00000004

Constructing, Destructing, Copying

GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_Group_new (const char *name)
GWENHYWFAR_API void GWEN_DB_Group_free (GWEN_DB_NODE *n)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_Group_dup (const GWEN_DB_NODE *n)

Iterating Through Groups

typedef void *(* GWEN_DB_NODES_CB )(GWEN_DB_NODE *node, void *user_data)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetFirstGroup (GWEN_DB_NODE *n)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetNextGroup (GWEN_DB_NODE *n)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_FindFirstGroup (GWEN_DB_NODE *n, const char *name)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_FindNextGroup (GWEN_DB_NODE *n, const char *name)
GWENHYWFAR_API void * GWEN_DB_Groups_Foreach (GWEN_DB_NODE *node, GWEN_DB_NODES_CB func, void *user_data)
GWENHYWFAR_API unsigned int GWEN_DB_Groups_Count (const GWEN_DB_NODE *node)

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 variable does not exist
  • the variable exists but has no values (should not occur)
  • the variable exists but the given value index is out of range (e.g. specifying index 1 with a variable that has only one value)
  • a string value is expected but the variable is not of that type. However, if you want an integer value but the variable only has a char value then the getter functions try to convert the char to an integer. Other conversions do not take place.
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):

  • char (simple null terminated C strings)
  • int (integer values)
  • bin (binary, user specified data)
Note:
The value returned by a getter function is only valid as long as the corresponding variable (node) exists.
So if you retrieve the value of a variable and delete the variable (or even the whole DB) afterwards the pointer becomes invalid and using it will most likely crash your program.
If you want to use such a value even after the corresponding variable has been deleted you need to make a copy.

GWENHYWFAR_API const char * GWEN_DB_GetCharValue (GWEN_DB_NODE *n, const char *path, int idx, const char *defVal)
GWENHYWFAR_API int GWEN_DB_SetCharValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, const char *val)
GWENHYWFAR_API int GWEN_DB_AddCharValue (GWEN_DB_NODE *n, const char *path, const char *val, int senseCase, int check)
GWENHYWFAR_API int GWEN_DB_RemoveCharValue (GWEN_DB_NODE *n, const char *path, const char *val, int senseCase)
GWENHYWFAR_API int GWEN_DB_GetIntValue (GWEN_DB_NODE *n, const char *path, int idx, int defVal)
GWENHYWFAR_API int GWEN_DB_SetIntValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, int val)
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 int GWEN_DB_SetBinValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, const void *val, unsigned int valSize)
GWENHYWFAR_API void * GWEN_DB_GetPtrValue (GWEN_DB_NODE *n, const char *path, int idx, void *defVal)
GWENHYWFAR_API int GWEN_DB_SetPtrValue (GWEN_DB_NODE *n, uint32_t flags, const char *path, void *val)

Group Handling

GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetGroup (GWEN_DB_NODE *n, uint32_t flags, const char *path)
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_AddGroup (GWEN_DB_NODE *parent, GWEN_DB_NODE *node)
GWENHYWFAR_API int GWEN_DB_InsertGroup (GWEN_DB_NODE *parent, GWEN_DB_NODE *node)
GWENHYWFAR_API int GWEN_DB_AddGroupChildren (GWEN_DB_NODE *n, GWEN_DB_NODE *nn)
GWENHYWFAR_API void GWEN_DB_UnlinkGroup (GWEN_DB_NODE *n)
GWENHYWFAR_API int GWEN_DB_DeleteGroup (GWEN_DB_NODE *n, const char *path)
GWENHYWFAR_API int GWEN_DB_ClearGroup (GWEN_DB_NODE *n, const char *path)
GWENHYWFAR_API int GWEN_DB_IsGroup (const GWEN_DB_NODE *n)
GWENHYWFAR_API uint32_t GWEN_DB_GetNodeFlags (const GWEN_DB_NODE *n)
GWENHYWFAR_API void GWEN_DB_SetNodeFlags (GWEN_DB_NODE *n, uint32_t flags)
GWENHYWFAR_API void GWEN_DB_ModifyBranchFlagsUp (GWEN_DB_NODE *n, uint32_t newflags, uint32_t mask)
GWENHYWFAR_API void GWEN_DB_ModifyBranchFlagsDown (GWEN_DB_NODE *n, uint32_t newflags, uint32_t mask)

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_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_ReadFile (GWEN_DB_NODE *n, const char *fname, 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_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_WriteFile (GWEN_DB_NODE *n, const char *fname, uint32_t dbflags)
GWENHYWFAR_API int GWEN_DB_WriteToBuffer (GWEN_DB_NODE *n, GWEN_BUFFER *buf, 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_WriteFileAs (GWEN_DB_NODE *n, const char *fname, const char *type, GWEN_DB_NODE *params, uint32_t dbflags)

Iterating Through Variables and variable handling

GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetFirstVar (GWEN_DB_NODE *n)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetNextVar (GWEN_DB_NODE *n)
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 void * GWEN_DB_Variables_Foreach (GWEN_DB_NODE *node, GWEN_DB_NODES_CB func, void *user_data)
GWENHYWFAR_API unsigned int GWEN_DB_Variables_Count (const GWEN_DB_NODE *node)
GWENHYWFAR_API GWEN_DB_NODE_TYPE GWEN_DB_GetVariableType (GWEN_DB_NODE *n, const char *p)
GWENHYWFAR_API int GWEN_DB_DeleteVar (GWEN_DB_NODE *n, const char *path)
GWENHYWFAR_API int GWEN_DB_VariableExists (GWEN_DB_NODE *n, const char *path)
GWENHYWFAR_API int GWEN_DB_ValueExists (GWEN_DB_NODE *n, const char *path, unsigned int idx)
GWENHYWFAR_API int GWEN_DB_IsVariable (const GWEN_DB_NODE *n)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_FindFirstVar (GWEN_DB_NODE *n, const char *name)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_FindNextVar (GWEN_DB_NODE *n, const char *name)

Iterating Through Values and value handling

GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetFirstValue (GWEN_DB_NODE *n)
GWENHYWFAR_API GWEN_DB_NODEGWEN_DB_GetNextValue (GWEN_DB_NODE *n)
GWENHYWFAR_API void * GWEN_DB_Values_Foreach (GWEN_DB_NODE *node, GWEN_DB_NODES_CB func, void *user_data)
GWENHYWFAR_API unsigned int GWEN_DB_Values_Count (const GWEN_DB_NODE *node)
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 const char * GWEN_DB_GetCharValueFromNode (const GWEN_DB_NODE *n)
GWENHYWFAR_API int GWEN_DB_SetCharValueInNode (GWEN_DB_NODE *n, const char *s)
GWENHYWFAR_API int GWEN_DB_GetIntValueFromNode (const GWEN_DB_NODE *n)
GWENHYWFAR_API const void * GWEN_DB_GetBinValueFromNode (const GWEN_DB_NODE *n, unsigned int *size)
GWENHYWFAR_API int GWEN_DB_IsValue (const GWEN_DB_NODE *n)

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)

Detailed Description

This group contains the definition of a GWEN_DB database.

A GWEN_DB database consists of a tree of GWEN_DB_NODE entries. Such a GWEN_DB_NODE node can either be a group node, or a variable node, or a value node. Usually an application programmer will only get in touch with group nodes. The application programmer can iterate through the group nodes with GWEN_DB_GetGroup(), GWEN_DB_Groups_foreach(), and can retrieve variable values with GWEN_DB_GetIntValue(), GWEN_DB_GetCharValue() and so on.

The following graph shows the internal structure of a GWEN_DB:

db2.png

Internal structure of a GWEN_DB


As you can see the GWEN_DB consists of multiple units called NODE. Every node has a pointer to:

Such a node can be either of the following:

Each group has a name. Depending on the GWEN_DB_FLAGS given when reading a GWEN_DB from a file or creating it, it may very well be possible to have multiple groups with the same name as children of the same root node. Again: Child group nodes with the same name may very well exist. This also applies to variable nodes.

For the interested reader, we again explain the difference of the three kinds of nodes. Depending on either of these cases, you can

  1. Iterate through groups or get a variable with e.g. GWEN_DB_GetNextGroup(), GWEN_DB_GetNextVar()
  2. Get the type of a variable with e.g. GWEN_DB_GetVariableType() -- the value of a variable is retrieved by the shortcut functions explained below.
  3. Get the type of a value with GWEN_DB_GetValueType(). Again the value itself is retrieved with the shortcut functions below.

To retrieve or set the value of such a variable, the following "shortcut" functions for all three supported typed exist: GWEN_DB_GetIntValue(), GWEN_DB_GetCharValue(), GWEN_DB_GetBinValue(). These functions only accept a group and a "path" to the desired variable.


Define Documentation

#define GWEN_DB_DEFAULT_LOCK_TIMEOUT   1000

Definition at line 216 of file db.h.

Referenced by GWEN_DB_WriteFile(), GWEN_DBIO_ExportToFile(), and GWEN_DBIO_ImportFromFile().

#define GWEN_DB_FLAGS_ADD_GROUP_NEWLINES   0x00800000

writes a newline to the stream after writing a group to improve the readability of the created file

Definition at line 137 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_ALLOW_EMPTY_STREAM   0x00008000

when reading a DB allow for empty streams (e.g. empty file)

Definition at line 119 of file db.h.

Referenced by GWEN_DB_ReadFromFastBuffer().

#define GWEN_DB_FLAGS_APPEND_FILE   0x08000000

appends data to an existing file instead of overwriting it

Definition at line 147 of file db.h.

Referenced by GWEN_DB_WriteFile(), and GWEN_DBIO_ExportToFile().

#define GWEN_DB_FLAGS_COMPACT
Value:

same like GWEN_DB_FLAGS_DEFAULT except that the produced file (when writing to a stream) is more compact (but less readable)

Definition at line 182 of file db.h.

#define GWEN_DB_FLAGS_DEFAULT
#define GWEN_DB_FLAGS_DETAILED_GROUPS   0x00200000

adds some comments when writing to a stream

Definition at line 131 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_DOSMODE   0x80000000

When writing a DB use DOS line termination (e.g. CR/LF) instead if unix mode (LF only)

Definition at line 165 of file db.h.

Referenced by GWEN_DB_ReadFromIo(), and GWEN_DB_WriteToIo().

#define GWEN_DB_FLAGS_ESCAPE_CHARVALUES   0x10000000

Char values are escaped when writing them to a file.

Definition at line 149 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_HTTP
Value:

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.

Definition at line 193 of file db.h.

#define GWEN_DB_FLAGS_INDEND   0x00400000

indents text according to the current path depth when writing to a stream to improve the readability of the created file

Definition at line 134 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_INSERT   0x40000000

When setting a value or getting a group insert newly created values/groups rather than appending them.

Definition at line 160 of file db.h.

Referenced by GWEN_DB_HandlePath(), GWEN_DB_SetBinValue(), GWEN_DB_SetCharValue(), GWEN_DB_SetIntValue(), GWEN_DB_SetPtrValue(), and GWEN_PathManager_InsertPath().

#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

Definition at line 155 of file db.h.

Referenced by GWEN_DB_WriteFile(), GWEN_DBIO_ExportToFile(), and GWEN_DBIO_ImportFromFile().

#define GWEN_DB_FLAGS_OMIT_TYPES   0x04000000

normally the type of a variable is written to the stream, too. This flag changes this behaviour

Definition at line 145 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_OVERWRITE_GROUPS   0x00020000
#define GWEN_DB_FLAGS_OVERWRITE_VARS   0x00010000
#define GWEN_DB_FLAGS_QUOTE_VALUES   0x00080000

quote values when writing them to a stream

Definition at line 127 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_QUOTE_VARNAMES   0x00040000

quote variable names when writing them to a stream

Definition at line 125 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#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)

Definition at line 152 of file db.h.

#define GWEN_DB_FLAGS_UNTIL_EMPTY_LINE   0x02000000

stops reading from a stream at empty lines

Definition at line 142 of file db.h.

Referenced by GWEN_DB_ReadFromFastBuffer().

#define GWEN_DB_FLAGS_USE_COLON   0x01000000

uses a colon (":") instead of an equation mark when reading/writing variable definitions

Definition at line 140 of file db.h.

Referenced by GWEN_DB_ReadFromFastBuffer(), and GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_FLAGS_WRITE_SUBGROUPS   0x00100000

allows writing of subgroups when writing to a stream

Definition at line 129 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().

#define GWEN_DB_LINE_MAXSIZE   1024

maximum size of a text line when reading/writing from/to streams

Definition at line 102 of file db.h.

#define GWEN_DB_NODE_FLAGS_DIRTY   0x00000001

is set then this node has been altered

Definition at line 207 of file db.h.

Referenced by GWEN_DB_Node_Append(), GWEN_DB_Node_Insert(), GWEN_DB_Node_Unlink(), and GWEN_PathManager_PathChanged().

#define GWEN_DB_NODE_FLAGS_INHERIT_HASH_MECHANISM   0x00000004

this is only valid for groups. It determines whether subgroups will inherit the hash mechanism set in the root node.

Definition at line 212 of file db.h.

#define GWEN_DB_NODE_FLAGS_VOLATILE   0x00000002

variable is volatile (will not be written)

Definition at line 209 of file db.h.

Referenced by GWEN_DB_WriteGroupToIoLayer().


Typedef Documentation

typedef struct GWEN_DB_NODE GWEN_DB_NODE

This is the type used to store a DB. Its contents are explicitly NOT part of the API.

A description of what can be done with this type can be found in db.h

Definition at line 226 of file db.h.

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().

Parameters:
nodeThe current node element
user_dataThe arbitrary data passed to the foreach function.
Returns:
NULL if the iteration should continue, or non-NULL if the iteration should stop and that value be returned.

Definition at line 376 of file db.h.


Enumeration Type Documentation

This specifies the type of a value stored in the DB.

Enumerator:
GWEN_DB_NodeType_Unknown 

type unknown

GWEN_DB_NodeType_Group 

group

GWEN_DB_NodeType_Var 

variable

GWEN_DB_NodeType_ValueChar 

simple, null terminated C-string

GWEN_DB_NodeType_ValueInt 

integer

GWEN_DB_NodeType_ValueBin 

binary, user defined data

GWEN_DB_NodeType_ValuePtr 

pointer , will not be stored or read to/from files

GWEN_DB_NodeType_ValueLast 

last value type

Definition at line 231 of file db.h.


Function Documentation

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).

Returns:
0 on success, nonzero on error
Parameters:
ndb node
pathpath and name of the variable
valThe string value that is copied into the DB
senseCaseif 0 then the case of the value is ignored while checking
checkif 1 then the variable will be checked for this value

Definition at line 926 of file db.c.

References DBG_DEBUG, DBG_VERBOUS, GWEN_DB_FLAGS_DEFAULT, GWEN_DB_GetFirstValue(), GWEN_DB_GetNode(), GWEN_DB_Node_Append(), GWEN_DB_NodeType_ValueChar, GWEN_DB_ValueChar_new(), GWEN_LOGDOMAIN, and GWEN_PATH_FLAGS_VARIABLE.

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.

Note:
This function takes over the ownership of the new group, so you MUST NOT free it afterwards.
Parameters:
parentSome group node that will be the parent of the added node
nodeGroup node to add

Definition at line 1324 of file db.c.

References DBG_ERROR, GWEN_DB_Node_Append(), GWEN_DB_NodeType_Group, and GWEN_LOGDOMAIN.

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.

Note:
This function does NOT take over ownership of the new group. The caller is still the owner of the given group.
Parameters:
ndb node
nnnode whose children are to be added (makes deep copies)

Definition at line 1364 of file db.c.

References DBG_ERROR, DBG_VERBOUS, GWEN_DB_Dump(), GWEN_DB_Node_Append(), GWEN_DB_Node_dup(), GWEN_DB_NodeType_Group, and GWEN_LOGDOMAIN.

Referenced by GWEN_Url_toDb().

GWENHYWFAR_API int GWEN_DB_ClearGroup ( GWEN_DB_NODE n,
const char *  path 
)

Frees all children of the given node thereby clearing it.

Returns:
0 on success, nonzero on error
Parameters:
ndb node
pathpath to the group under the given node to clear (if 0 then clear the given node)

Definition at line 837 of file db.c.

References DBG_VERBOUS, GWEN_DB_ClearNode(), GWEN_DB_GetNode(), GWEN_LOGDOMAIN, GWEN_PATH_FLAGS_NAMEMUSTEXIST, and GWEN_PATH_FLAGS_PATHMUSTEXIST.

Referenced by GWEN_Gui_CGui_SetPasswordStatus(), GWEN_SyncIo_Http_Read(), GWEN_SyncIo_Http_SetWriteIdle(), and CppGui::setPasswordStatus().

GWENHYWFAR_API int GWEN_DB_DeleteGroup ( GWEN_DB_NODE n,
const char *  path 
)

Locates and removes the group of the given name.

Returns:
0 on success, nonzero on error
Parameters:
ndb node
pathpath to the group to delete

Definition at line 816 of file db.c.

References DBG_VERBOUS, GWEN_DB_GetNode(), GWEN_DB_Node_free(), GWEN_DB_Node_Unlink(), GWEN_LOGDOMAIN, GWEN_PATH_FLAGS_NAMEMUSTEXIST, and GWEN_PATH_FLAGS_PATHMUSTEXIST.

Referenced by GWEN_PathManager_RemovePaths().

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.

Parameters:
nroot of the DB
pathpath to the variable to remove
Returns:
Zero on success, nonzero on error

Definition at line 794 of file db.c.

References DBG_VERBOUS, GWEN_DB_GetNode(), GWEN_DB_Node_free(), GWEN_DB_Node_Unlink(), GWEN_LOGDOMAIN, GWEN_PATH_FLAGS_NAMEMUSTEXIST, GWEN_PATH_FLAGS_PATHMUSTEXIST, and GWEN_PATH_FLAGS_VARIABLE.

Referenced by GWEN_Crypt_Token_Context_WriteDb(), and GWEN_MsgEngine_SetMode().

GWENHYWFAR_API void GWEN_DB_Dump ( GWEN_DB_NODE n,
int  insert 
)
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.

Parameters:
ndb node
namename to look for (joker and wildcards allowed)

Definition at line 1646 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Group, GWEN_LOGDOMAIN, GWEN_Text_ComparePattern(), and NULL.

Referenced by GWEN_PathManager_FindFile(), GWEN_PathManager_GetMatchingFilesRecursively(), GWEN_PathManager_GetPaths(), GWEN_PathManager_RemovePath(), and GWEN_PathManager_RemovePaths().

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.

Parameters:
ndb node
namename to look for (joker and wildcards allowed)

Definition at line 1687 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Group, GWEN_DB_NodeType_Var, GWEN_LOGDOMAIN, GWEN_Text_ComparePattern(), and NULL.

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.

Note:
This is one of the few functions where the returned node is not the child of the specified node, but instead it is the next node with the same parent node. In other words, this function is an exception. In most other functions the returned node is a child of the specified node.
Parameters:
ndb node
namename to look for (joker and wildcards allowed)

Definition at line 1666 of file db.c.

References DBG_ERROR, GWEN_DB_GetNextGroup(), GWEN_DB_NodeType_Group, GWEN_LOGDOMAIN, GWEN_Text_ComparePattern(), and NULL.

Referenced by GWEN_PathManager_FindFile(), GWEN_PathManager_GetMatchingFilesRecursively(), GWEN_PathManager_GetPaths(), GWEN_PathManager_RemovePath(), and GWEN_PathManager_RemovePaths().

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.

Note:
This is one of the few functions where the returned node is not the child of the specified node, but instead it is the next node with the same parent node. In other words, this function is an exception. In most other functions the returned node is a child of the specified node.
Parameters:
ndb node
namename to look for (joker and wildcards allowed)

Definition at line 1709 of file db.c.

References DBG_ERROR, GWEN_DB_GetNextVar(), GWEN_DB_NodeType_Var, GWEN_LOGDOMAIN, GWEN_Text_ComparePattern(), and NULL.

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.

Parameters:
ndb node
pathpath and name of the variable
idxindex number of the value to return
defValdefault value to return in case there is no real value
defValSizesize of the default value
returnValueSizepointer to a variable to receive the length of the data returned

Definition at line 1086 of file db.c.

References DBG_VERBOUS, GWEN_DB_GetValue(), GWEN_DB_NodeType_ValueBin, and GWEN_LOGDOMAIN.

Referenced by GWEN_Crypt_CryptAlgo_fromDb(), GWEN_Crypt_HashAlgo_fromDb(), GWEN_Crypt_KeyRsa__ReadMpi(), GWEN_Crypt_KeySym__fromDb(), GWEN_Crypt_KeySym_fromDb(), GWEN_MsgEngine__TransformValue(), and GWEN_MsgEngine__WriteElement().

GWENHYWFAR_API const void* GWEN_DB_GetBinValueFromNode ( const GWEN_DB_NODE n,
unsigned int *  size 
)

Definition at line 536 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_ValueBin, GWEN_LOGDOMAIN, and NULL.

GWENHYWFAR_API const char* GWEN_DB_GetCharValue ( GWEN_DB_NODE n,
const char *  path,
int  idx,
const char *  defVal 
)
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.

Definition at line 483 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_ValueChar, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_SyncIo_Http_WriteHeader(), GWEN_Url_toCommandString(), and GWEN_Url_toString().

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.

Parameters:
ndb node

Definition at line 346 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Group, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_DB_Groups_Foreach(), GWEN_MsgEngine__WriteGroup(), and GWEN_PathManager_RemovePaths().

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.

Parameters:
ndb node

Definition at line 426 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_ValueChar, GWEN_DB_NodeType_ValueLast, GWEN_DB_NodeType_Var, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_DB_AddCharValue(), GWEN_DB_GetVariableType(), GWEN_DB_RemoveCharValue(), GWEN_DB_Values_Foreach(), GWEN_SyncIo_Http_WriteHeader(), GWEN_Url_toCommandString(), and GWEN_Url_toString().

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.

Parameters:
ndb node

Definition at line 386 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Group, GWEN_DB_NodeType_Var, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_DB_Variables_Foreach(), GWEN_SyncIo_Http_WriteHeader(), GWEN_Url_toCommandString(), and GWEN_Url_toString().

GWENHYWFAR_API GWEN_DB_NODE* GWEN_DB_GetGroup ( GWEN_DB_NODE n,
uint32_t  flags,
const char *  path 
)
GWENHYWFAR_API int GWEN_DB_GetIntValue ( GWEN_DB_NODE n,
const char *  path,
int  idx,
int  defVal 
)
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.

Note:
This is one of the few functions where the returned node is not the child of the specified node, but instead it is the next node with the same parent node. In other words, this function is an exception. In most other functions the returned node is a child of the specified node.
Parameters:
ndb node

Definition at line 366 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Group, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_DB_FindNextGroup(), GWEN_DB_Groups_Foreach(), GWEN_MsgEngine__WriteGroup(), and GWEN_PathManager_RemovePaths().

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.

Note:
This is the only function where the returned node is not the child of the specified node, but instead it is the next node with the same parent node. In other words, this function is an exception. In all other functions the returned node is a child of the specified node.
Parameters:
ndb node

Definition at line 448 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_ValueChar, GWEN_DB_NodeType_ValueLast, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_DB_Values_Foreach().

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.

Note:
This is the only function where the returned node is not the child of the specified node, but instead it is the next node with the same parent node. In other words, this function is an exception. In all other functions the returned node is a child of the specified node.
Parameters:
ndb node

Definition at line 406 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Var, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_DB_FindNextVar(), GWEN_DB_Variables_Foreach(), GWEN_SyncIo_Http_WriteHeader(), GWEN_Url_toCommandString(), and GWEN_Url_toString().

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.

Returns:
current node flags for this node (see GWEN_DB_NODE_FLAGS_DIRTY)
Parameters:
ndb node

Definition at line 1593 of file db.c.

Referenced by GWEN_PathManager_PathChanged().

GWENHYWFAR_API void* GWEN_DB_GetPtrValue ( GWEN_DB_NODE n,
const char *  path,
int  idx,
void *  defVal 
)

Returns the variable's retrieved value.

Parameters:
ndb node
pathpath and name of the variable
idxindex number of the value to return
defValdefault value to return in case there is no real value

Definition at line 1153 of file db.c.

References DBG_VERBOUS, GWEN_DB_GetValue(), GWEN_DB_NodeType_ValuePtr, and GWEN_LOGDOMAIN.

GWENHYWFAR_API GWEN_DB_NODE_TYPE GWEN_DB_GetValueType ( GWEN_DB_NODE n)

Returns the type of the given value.

Parameters:
ndb node

Definition at line 469 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Unknown, GWEN_DB_NodeType_ValueChar, GWEN_DB_NodeType_ValueLast, and GWEN_LOGDOMAIN.

Referenced by GWEN_DB_GetValueTypeByPath(), GWEN_DB_GetVariableType(), and GWEN_SyncIo_Http_WriteHeader().

GWENHYWFAR_API GWEN_DB_NODE_TYPE GWEN_DB_GetValueTypeByPath ( GWEN_DB_NODE n,
const char *  p,
unsigned int  i 
)

Definition at line 1447 of file db.c.

References GWEN_DB_GetValue(), GWEN_DB_GetValueType(), and GWEN_DB_NodeType_Unknown.

Referenced by GWEN_MsgEngine__WriteElement().

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

Parameters:
nroot node of the DB
ppath of the variable to inspect

Definition at line 1431 of file db.c.

References GWEN_DB_FindVar(), GWEN_DB_GetFirstValue(), GWEN_DB_GetValueType(), and GWEN_DB_NodeType_Unknown.

Referenced by GWEN_MsgEngine__TransformValue().

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().

Parameters:
ndb node

Definition at line 335 of file db.c.

References DBG_ERROR, GWEN_DB_Node_dup(), GWEN_DB_NodeType_Group, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_Url_dup(), GWEN_Url_ReadDb(), and GWEN_Url_SetVars().

GWENHYWFAR_API void GWEN_DB_Group_free ( GWEN_DB_NODE n)
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.

Parameters:
namename of the group to create

Definition at line 131 of file db.c.

References GWEN_DB_Node_new(), GWEN_DB_NodeType_Group, and GWEN_Memory_strdup().

Referenced by CppGui::CppGui(), GWEN_Args_Check(), GWEN_Crypt_KeyRsa_dup(), GWEN_Crypt_KeyRsa_fromModExp(), GWEN_Crypt_KeyRsa_fromModPrivExp(), GWEN_DB_HandlePath(), GWEN_DB_Node_dup(), GWEN_Dialog_new(), GWEN_Gui_CGui_new(), GWEN_MsgEngine_new(), GWEN_MsgEngine_ReadMessage(), GWEN_PathManager_ModuleInit(), GWEN_SyncIo_Http_new(), GWEN_Url_fromCommandString(), GWEN_Url_fromString(), GWEN_Url_new(), and HtmlCtx_StartTag().

GWENHYWFAR_API const char* GWEN_DB_GroupName ( GWEN_DB_NODE n)

Returns the name of the given group.

Definition at line 1252 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Group, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_MsgEngine__WriteGroup().

GWENHYWFAR_API void GWEN_DB_GroupRename ( GWEN_DB_NODE n,
const char *  newname 
)

Renames the given group.

Parameters:
ndb node
newnamenew name for the group

Definition at line 1459 of file db.c.

References GWEN_DB_NodeType_Group, GWEN_Memory_dealloc(), and GWEN_Memory_strdup().

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.

Definition at line 1525 of file db.c.

References GWEN_DB_count_cb(), and GWEN_DB_Groups_Foreach().

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.

Parameters:
nodeThe group node whose children shall be iterated through.
funcThe function to be called with each group node.
user_dataA pointer passed on to the function 'func'.
Returns:
The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL.
Author:
Christian Stimming <stimming@tuhh.de>

Definition at line 1495 of file db.c.

References GWEN_DB_GetFirstGroup(), GWEN_DB_GetNextGroup(), and NULL.

Referenced by GWEN_DB_Groups_Count().

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.

Note:
This function takes over the ownership of the new group, so you MUST NOT free it afterwards.
Parameters:
parentSome group node that will be the parent of the added node
nodeGroup node to add

Definition at line 1344 of file db.c.

References DBG_ERROR, GWEN_DB_Node_Insert(), GWEN_DB_NodeType_Group, and GWEN_LOGDOMAIN.

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.

Parameters:
ndb node

Definition at line 1473 of file db.c.

References GWEN_DB_NodeType_Group.

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.

Parameters:
ndb node

Definition at line 1487 of file db.c.

References GWEN_DB_NodeType_ValueChar, and GWEN_DB_NodeType_ValueLast.

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.

Parameters:
ndb node

Definition at line 1480 of file db.c.

References GWEN_DB_NodeType_Var.

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.

Parameters:
ndb node
newflagsnew flags to set (see GWEN_DB_NODE_FLAGS_DIRTY)
maskonly those flags which are set in this mask are modified according to newflags

Definition at line 1625 of file db.c.

References GWEN_DB_ModifyBranchFlagsDown().

Referenced by GWEN_DB_ModifyBranchFlagsDown().

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.

Parameters:
ndb node
newflagsnew flags to set (see GWEN_DB_NODE_FLAGS_DIRTY)
maskonly those flags which are set in this mask are modified according to newflags

Definition at line 1608 of file db.c.

Referenced by GWEN_DB_Node_Append(), GWEN_DB_Node_Insert(), and GWEN_DB_Node_Unlink().

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.

Parameters:
nnode to read into (becomes the root of the imported data)
fnamename of the file to import
typeGWEN_DBIO type
paramsparameters for the GWEN_DBIO importer (content depends on the importer, may even be NULL for some types)
dbflagsflags to use while importing (see GWEN_DB_FLAGS_OVERWRITE_VARS and others)

Definition at line 122 of file dbrw.c.

References DBG_ERROR, DBG_INFO, GWEN_DBIO_GetPlugin(), GWEN_DBIO_Import(), GWEN_ERROR_NOT_SUPPORTED, GWEN_LOGDOMAIN, GWEN_SyncIo_AddFlags(), GWEN_SyncIo_Connect(), GWEN_SyncIo_Disconnect(), GWEN_SyncIo_File_CreationMode_OpenExisting, GWEN_SYNCIO_FILE_FLAGS_READ, GWEN_SyncIo_File_new(), and GWEN_SyncIo_free().

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).

Returns:
0 on success, nonzero on error
Parameters:
ndb node
pathpath and name of the variable
valThe string value to be removed
senseCaseif 0 then the case of the value is ignored while checking

Definition at line 973 of file db.c.

References DBG_DEBUG, DBG_VERBOUS, GWEN_DB_FLAGS_DEFAULT, GWEN_DB_GetFirstValue(), GWEN_DB_GetNode(), GWEN_DB_Node_free(), GWEN_DB_Node_Unlink(), GWEN_DB_NodeType_ValueChar, GWEN_LOGDOMAIN, and GWEN_PATH_FLAGS_VARIABLE.

GWENHYWFAR_API int GWEN_DB_SetBinValue ( GWEN_DB_NODE n,
uint32_t  flags,
const char *  path,
const void *  val,
unsigned int  valSize 
)
Parameters:
ndb node
pathpath and name of the variable
flagssee GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use.
valThe binary data that is copied into the DB.
valSizeThe number of bytes in the binary data value.
Returns:
0 on success, nonzero on error

Definition at line 1117 of file db.c.

References DBG_VERBOUS, GWEN_DB_ClearNode(), GWEN_DB_FLAGS_INSERT, GWEN_DB_FLAGS_OVERWRITE_VARS, GWEN_DB_GetNode(), GWEN_DB_Node_Append(), GWEN_DB_Node_Insert(), GWEN_DB_ValueBin_new(), GWEN_LOGDOMAIN, and GWEN_PATH_FLAGS_VARIABLE.

Referenced by GWEN_Crypt_CryptAlgo_toDb(), GWEN_Crypt_HashAlgo_toDb(), GWEN_Crypt_KeyRsa__WriteMpi(), GWEN_Crypt_KeyRsa_fromModExp(), GWEN_Crypt_KeyRsa_fromModPrivExp(), GWEN_Crypt_KeySym__toDb(), GWEN_Crypt_KeySym_toDb(), and GWEN_MsgEngine__ReadGroup().

GWENHYWFAR_API int GWEN_DB_SetCharValue ( GWEN_DB_NODE n,
uint32_t  flags,
const char *  path,
const char *  val 
)
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.

Returns:
0 if ok, error code otherwise

Definition at line 494 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_ValueChar, GWEN_ERROR_INVALID, GWEN_LOGDOMAIN, GWEN_Memory_dealloc(), and GWEN_Memory_strdup().

GWENHYWFAR_API int GWEN_DB_SetIntValue ( GWEN_DB_NODE n,
uint32_t  flags,
const char *  path,
int  val 
)
GWENHYWFAR_API void GWEN_DB_SetNodeFlags ( GWEN_DB_NODE n,
uint32_t  flags 
)

Modifies the node flags for the given db node

Parameters:
ndb node
flagsflags to set (see GWEN_DB_NODE_FLAGS_DIRTY)

Definition at line 1600 of file db.c.

GWENHYWFAR_API int GWEN_DB_SetPtrValue ( GWEN_DB_NODE n,
uint32_t  flags,
const char *  path,
void *  val 
)
Parameters:
ndb node
pathpath and name of the variable
flagssee GWEN_DB_FLAGS_OVERWRITE_VARS and others which can all be OR-combined to form the flags to use.
valThe pointer that is stored within the DB.
Returns:
0 on success, nonzero on error

Definition at line 1178 of file db.c.

References DBG_VERBOUS, GWEN_DB_ClearNode(), GWEN_DB_FLAGS_INSERT, GWEN_DB_FLAGS_OVERWRITE_VARS, GWEN_DB_GetNode(), GWEN_DB_Node_Append(), GWEN_DB_Node_Insert(), GWEN_DB_ValuePtr_new(), GWEN_LOGDOMAIN, and GWEN_PATH_FLAGS_VARIABLE.

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.

Parameters:
ndb node

Definition at line 1393 of file db.c.

References DBG_ERROR, GWEN_DB_Node_Unlink(), GWEN_DB_NodeType_Group, and GWEN_LOGDOMAIN.

Referenced by GWEN_PathManager_RemovePath(), GWEN_PathManager_RemovePaths(), and GWEN_PathManager_UndefinePath().

GWENHYWFAR_API int GWEN_DB_ValueExists ( GWEN_DB_NODE n,
const char *  path,
unsigned int  idx 
)

Checks whether the given variable and value exists.

Returns:
Zero if variable not found, nonzero otherwise
Parameters:
nroot of the DB
pathpath to the variable to check for
idxindex number of the variable's value to check for

Definition at line 1423 of file db.c.

References GWEN_DB_GetValue().

Referenced by GWEN_MsgEngine__WriteElement().

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.

Definition at line 1585 of file db.c.

References GWEN_DB_count_cb(), and GWEN_DB_Values_Foreach().

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.

Parameters:
nodeThe variable node whose children shall be iterated through.
funcThe function to be called with each group node.
user_dataA pointer passed on to the function 'func'.
Returns:
The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL.
Author:
Christian Stimming <stimming@tuhh.de>

Definition at line 1563 of file db.c.

References GWEN_DB_GetFirstValue(), GWEN_DB_GetNextValue(), and NULL.

Referenced by GWEN_DB_Values_Count().

GWENHYWFAR_API int GWEN_DB_VariableExists ( GWEN_DB_NODE n,
const char *  path 
)

Checks whether the given variable exists.

Returns:
Zero if variable not found, nonzero otherwise
Parameters:
nroot of the DB
pathpath to the variable to check for

Definition at line 1403 of file db.c.

References DBG_VERBOUS, GWEN_DB_GetNode(), GWEN_LOGDOMAIN, GWEN_PATH_FLAGS_NAMEMUSTEXIST, GWEN_PATH_FLAGS_PATHMUSTEXIST, and GWEN_PATH_FLAGS_VARIABLE.

Referenced by GWEN_Crypt_KeyRsa__DataFromDb(), and GWEN_MsgEngine__TransformValue().

GWENHYWFAR_API const char* GWEN_DB_VariableName ( GWEN_DB_NODE n)

Returns the name of the variable specified by the given node.

Parameters:
ndb node specifying a variable (not a group !)

Definition at line 1730 of file db.c.

References DBG_ERROR, GWEN_DB_NodeType_Var, GWEN_LOGDOMAIN, and NULL.

Referenced by GWEN_SyncIo_Http_WriteHeader(), GWEN_Url_toCommandString(), and GWEN_Url_toString().

GWENHYWFAR_API void GWEN_DB_VariableRename ( GWEN_DB_NODE n,
const char *  newname 
)

Definition at line 1741 of file db.c.

References GWEN_DB_NodeType_Var, GWEN_Memory_dealloc(), and GWEN_Memory_strdup().

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.

Definition at line 1555 of file db.c.

References GWEN_DB_count_cb(), and GWEN_DB_Variables_Foreach().

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.

Parameters:
nodeThe group node whose children shall be iterated through.
funcThe function to be called with each group node.
user_dataA pointer passed on to the function 'func'.
Returns:
The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL.
Author:
Christian Stimming <stimming@tuhh.de>

Definition at line 1533 of file db.c.

References GWEN_DB_GetFirstVar(), GWEN_DB_GetNextVar(), and NULL.

Referenced by GWEN_DB_Variables_Count().

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.

Parameters:
nnode to write
fnamename of the file to export to
typeGWEN_DBIO type
paramsparameters for the GWEN_DBIO exporter (content depends on the exporter, may even be NULL for some types)
dbflagsflags to use while exporting (see GWEN_DB_FLAGS_OVERWRITE_VARS and others)

Definition at line 158 of file dbrw.c.

References DBG_ERROR, DBG_INFO, GWEN_DBIO_ExportToFile(), GWEN_DBIO_GetPlugin(), GWEN_ERROR_NOT_SUPPORTED, and GWEN_LOGDOMAIN.

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 
)

Definition at line 494 of file dbrw.c.

References GWEN_DB_WriteGroupToIoLayer(), and GWEN_FASTBUFFER_FLUSH.

GWENHYWFAR_API int GWEN_DB_WriteToIo ( GWEN_DB_NODE node,
GWEN_SYNCIO sio,
uint32_t  dbflags 
)