gwenhywfar  4.8.0beta
Typedefs | Enumerations
XML Node
XML Tree

Typedefs

typedef struct GWEN__XMLNODE GWEN_XMLNODE
typedef struct
GWEN_XMLNODE_NAMESPACE 
GWEN_XMLNODE_NAMESPACE

Enumerations

enum  GWEN_XMLNODE_TYPE { GWEN_XMLNodeTypeTag = 0, GWEN_XMLNodeTypeData, GWEN_XMLNodeTypeComment }

Read Flags

#define GWEN_XML_FLAGS_HANDLE_COMMENTS   0x0001
#define GWEN_XML_FLAGS_INDENT   0x0002
#define GWEN_XML_FLAGS_HANDLE_OPEN_HTMLTAGS   0x0004
#define GWEN_XML_FLAGS_NO_CONDENSE   0x0008
#define GWEN_XML_FLAGS_KEEP_CNTRL   0x0010
#define GWEN_XML_FLAGS_KEEP_BLANKS   0x0020
#define GWEN_XML_FLAGS_SIMPLE   0x0040
#define GWEN_XML_FLAGS_HANDLE_HEADERS   0x0080
#define GWEN_XML_FLAGS_TOLERANT_ENDTAGS   0x0100
#define GWEN_XML_FLAGS_HANDLE_NAMESPACES   0x0200
#define GWEN_XML_FLAGS_DEFAULT

Path flags for GWEN_XMLNode_SetCharValueByPath etc

#define GWEN_XML_PATH_FLAGS_OVERWRITE_VALUES   0x00010000

Constructors and Destructors

GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_new (GWEN_XMLNODE_TYPE t, const char *data)
GWENHYWFAR_API void GWEN_XMLNode_free (GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_freeAll (GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_dup (const GWEN_XMLNODE *n)

Managing Headers

Headers are special tags in XML files which describe the document (such as <?xml?> or <!DOCTYPE>).

If the flag GWEN_XML_FLAGS_HANDLE_HEADERS is on upon reading of files these special toplevel tags are added to the current node's header list instead of the normal children node list.

If the same flag is given when writing files the header tags of the given root node are written to the output stream before its children.

Header nodes are identified as nodes whose name begins with '?' or '!'.

GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetHeader (const GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_AddHeader (GWEN_XMLNODE *root, GWEN_XMLNODE *nh)
GWENHYWFAR_API void GWEN_XMLNode_DelHeader (GWEN_XMLNODE *root, GWEN_XMLNODE *nh)
GWENHYWFAR_API void GWEN_XMLNode_ClearHeaders (GWEN_XMLNODE *root)

Managing Properties/Attributes

A property (in XML notation this is called attribute) is given within a tag (in XML notation this is called element), like in this example:

<tag property="1" />
GWENHYWFAR_API const char * GWEN_XMLNode_GetProperty (const GWEN_XMLNODE *n, const char *name, const char *defaultValue)
GWENHYWFAR_API void GWEN_XMLNode_SetProperty (GWEN_XMLNODE *n, const char *name, const char *value)
GWENHYWFAR_API int GWEN_XMLNode_GetIntProperty (const GWEN_XMLNODE *n, const char *name, int defaultValue)
GWENHYWFAR_API void GWEN_XMLNode_SetIntProperty (GWEN_XMLNODE *n, const char *name, int value)
GWENHYWFAR_API void GWEN_XMLNode_CopyProperties (GWEN_XMLNODE *tn, const GWEN_XMLNODE *sn, int overwrite)

Type And Data

GWENHYWFAR_API GWEN_XMLNODE_TYPE GWEN_XMLNode_GetType (const GWEN_XMLNODE *n)
GWENHYWFAR_API const char * GWEN_XMLNode_GetData (const GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_SetData (GWEN_XMLNODE *n, const char *data)
GWENHYWFAR_API const char * GWEN_XMLNode_GetNamespace (const GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_SetNamespace (GWEN_XMLNODE *n, const char *s)

Usage Counter

The usage counter of a node is only used by applications, not by Gwenhywfar itself. So if the application does not set this counter it will always be zero.

An application could use this counter to check whether a given node is still in use by some parts of the application in order to free unused nodes.

GWENHYWFAR_API void GWEN_XMLNode_IncUsage (GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_DecUsage (GWEN_XMLNODE *n)
GWENHYWFAR_API uint32_t GWEN_XMLNode_GetUsage (const GWEN_XMLNODE *n)

Iterating Through an XML Tree

GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_Next (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetChild (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetParent (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetFirstTag (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetNextTag (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetFirstData (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetNextData (const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_FindFirstTag (const GWEN_XMLNODE *n, const char *tname, const char *pname, const char *pvalue)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_FindNextTag (const GWEN_XMLNODE *n, const char *tname, const char *pname, const char *pvalue)
GWENHYWFAR_API int GWEN_XMLNode_IsChildOf (const GWEN_XMLNODE *parent, const GWEN_XMLNODE *child)
GWENHYWFAR_API int GWEN_XMLNode_GetXPath (const GWEN_XMLNODE *n1, const GWEN_XMLNODE *n2, GWEN_BUFFER *nbuf)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_GetNodeByXPath (GWEN_XMLNODE *n, const char *path, uint32_t flags)

Managing Nodes

GWENHYWFAR_API void GWEN_XMLNode_AddChild (GWEN_XMLNODE *n, GWEN_XMLNODE *child)
GWENHYWFAR_API void GWEN_XMLNode_UnlinkChild (GWEN_XMLNODE *n, GWEN_XMLNODE *child)
GWENHYWFAR_API void GWEN_XMLNode_RemoveChildren (GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_AddChildrenOnly (GWEN_XMLNODE *n, GWEN_XMLNODE *nn, int copythem)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_FindNode (const GWEN_XMLNODE *n, GWEN_XMLNODE_TYPE t, const char *data)

Reading And Writing From/To Streams

GWENHYWFAR_API int GWEN_XMLNode_NormalizeNameSpaces (GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_StripNamespaces (GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_Globalize (GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_GlobalizeWithList (GWEN_XMLNODE *n, GWEN_XMLNODE_NAMESPACE_LIST *l, uint32_t *pLastId)
GWENHYWFAR_API int GWEN_XML_ReadFromFastBuffer (GWEN_XML_CONTEXT *ctx, GWEN_FAST_BUFFER *fb)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromIo (GWEN_XML_CONTEXT *ctx, GWEN_SYNCIO *io)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromFile (GWEN_XML_CONTEXT *ctx, const char *fname)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromString (GWEN_XML_CONTEXT *ctx, const char *text)
GWENHYWFAR_API int GWEN_XML_ReadFile (GWEN_XMLNODE *n, const char *filepath, uint32_t flags)
GWENHYWFAR_API GWEN_XMLNODEGWEN_XMLNode_fromString (const char *s, int len, uint32_t flags)
GWENHYWFAR_API int GWEN_XMLNode_WriteToStream (const GWEN_XMLNODE *n, GWEN_XML_CONTEXT *ctx, GWEN_SYNCIO *sio)
GWENHYWFAR_API int GWEN_XMLNode_WriteFile (const GWEN_XMLNODE *n, const char *fname, uint32_t flags)
GWENHYWFAR_API int GWEN_XMLNode_toBuffer (const GWEN_XMLNODE *n, GWEN_BUFFER *buf, uint32_t flags)
GWENHYWFAR_API
GWEN_XMLNODE_NAMESPACE_LIST * 
GWEN_XMLNode_GetNameSpaces (const GWEN_XMLNODE *n)
GWENHYWFAR_API
GWEN_XMLNODE_NAMESPACE
GWEN_XMLNode_FindNameSpaceByName (const GWEN_XMLNODE *n, const char *s)
GWENHYWFAR_API
GWEN_XMLNODE_NAMESPACE
GWEN_XMLNode_FindNameSpaceByUrl (const GWEN_XMLNODE *n, const char *s)
GWENHYWFAR_API void GWEN_XMLNode_AddNameSpace (GWEN_XMLNODE *n, const GWEN_XMLNODE_NAMESPACE *ns)

Handling Tags As Variables

These functions are only kept for compatibility reasons. You should use functions like GWEN_XMLNode_GetCharValueByPath() instead.

These functions look for a tag, read their first data element and return it as if it was a DB variable. This simplifies access to simple tags containing simple data tags only. E.g. if your XML structure is this:

<test>
<X> 15 </X>
<Y> 10 </Y>
</test>

... then you can access the value of X with the following call:

x=GWEN_XMLNode_GetIntValue(testNode, "X", 0);

If the given variables do not exist or have no value then the also given default value will be returned.

GWENHYWFAR_API const char * GWEN_XMLNode_GetCharValue (const GWEN_XMLNODE *n, const char *name, const char *defValue)
GWENHYWFAR_API void GWEN_XMLNode_SetCharValue (GWEN_XMLNODE *n, const char *name, const char *value)
GWENHYWFAR_API const char * GWEN_XMLNode_GetLocalizedCharValue (const GWEN_XMLNODE *n, const char *name, const char *defValue)
GWENHYWFAR_API int GWEN_XMLNode_GetIntValue (const GWEN_XMLNODE *n, const char *name, int defValue)
GWENHYWFAR_API void GWEN_XMLNode_SetIntValue (GWEN_XMLNODE *n, const char *name, int value)

Handling Tags As Variables Using Paths

These functions look for a tag, read their first data element and return it as if it was a DB variable. This simplifies access to simple tags containing simple data tags only. E.g. if your XML structure is this:

<test>
<X> 15 </X>
<Y> 10 </Y>
</test>

... then you can access the value of X with the following call:

x=GWEN_XMLNode_GetIntValue(testNode, "X", 0);

If the given variables do not exist or have no value then the also given default value will be returned.

In addition to functions like GWEN_XMLNode_SetCharValue you can use full paths here.

GWENHYWFAR_API const char * GWEN_XMLNode_GetCharValueByPath (GWEN_XMLNODE *n, const char *path, const char *defValue)
GWENHYWFAR_API int GWEN_XMLNode_SetCharValueByPath (GWEN_XMLNODE *n, uint32_t flags, const char *name, const char *value)
GWENHYWFAR_API int GWEN_XMLNode_GetIntValueByPath (GWEN_XMLNODE *n, const char *name, int defValue)
GWENHYWFAR_API int GWEN_XMLNode_SetIntValueByPath (GWEN_XMLNODE *n, uint32_t flags, const char *name, int value)

Debugging

GWENHYWFAR_API void GWEN_XMLNode_Dump (const GWEN_XMLNODE *n, int ind)

Detailed Description

Macro Definition Documentation

#define GWEN_XML_FLAGS_DEFAULT
Value:
(\
GWEN_XML_FLAGS_INDENT | \
GWEN_XML_FLAGS_HANDLE_COMMENTS\
)

combination of other flags resembling the default flags

Definition at line 110 of file xml.h.

Referenced by GWEN_Dialog_ReadXmlFile(), and GWEN_LoadPluginDescrsByType().

#define GWEN_XML_FLAGS_HANDLE_COMMENTS   0x0001

if set then comments are read. Otherwise they are ignored when reading a file

Definition at line 60 of file xml.h.

Referenced by GWEN_XMLNode__WriteToStream().

#define GWEN_XML_FLAGS_HANDLE_HEADERS   0x0080

apply special treatment to toplevel header tags (such as <?xml>)

Definition at line 94 of file xml.h.

Referenced by GWEN_Dialog_ReadXmlFile(), GWEN_LoadPluginDescrsByType(), GWEN_XmlCtxStore_StartTag(), and GWEN_XMLNode_WriteToStream().

#define GWEN_XML_FLAGS_HANDLE_NAMESPACES   0x0200

Definition at line 105 of file xml.h.

Referenced by GWEN_XmlCtxStore_AddAttr(), and GWEN_XMLNode__WriteToStream().

#define GWEN_XML_FLAGS_HANDLE_OPEN_HTMLTAGS   0x0004

Let the parser accept some HTML which are known to be unclosed (e.g. the tag "BR" in HTML tags is never closed). If not set a "BR" tag without a corresponding "/BR" will produce an error.

Definition at line 73 of file xml.h.

Referenced by GWEN_LoadPluginDescrsByType().

#define GWEN_XML_FLAGS_INDENT   0x0002

Indent lines according to node level when writing nodes. This increases the readability of the resulting file.

Definition at line 66 of file xml.h.

Referenced by GWEN_XMLNode__WriteToStream().

#define GWEN_XML_FLAGS_KEEP_BLANKS   0x0020

Definition at line 87 of file xml.h.

Referenced by GWEN_XmlCtxStore_AddData().

#define GWEN_XML_FLAGS_KEEP_CNTRL   0x0010

If set then control characters (such as CR, LF) will not be removed from data.

Definition at line 85 of file xml.h.

Referenced by GWEN_XmlCtxStore_AddData().

#define GWEN_XML_FLAGS_NO_CONDENSE   0x0008

If set then data will not be condensed (e.g. multiple spaces will not be replaced by a single one).

Definition at line 79 of file xml.h.

Referenced by GWEN_XmlCtxStore_AddData().

#define GWEN_XML_FLAGS_SIMPLE   0x0040

Definition at line 89 of file xml.h.

Referenced by GWEN_XMLNode__WriteToStream().

#define GWEN_XML_FLAGS_TOLERANT_ENDTAGS   0x0100

If this flag is given this module will be more tolerant when encountering and end element (e.g. </html>). If the name of the end element does not match the currently open element then the element to be closed is searched above the currently open element. This works around problems with malformed XML files.

Definition at line 103 of file xml.h.

Referenced by GWEN_PluginDescription__GetLocalizedLongDescrByFormat(), GWEN_PluginDescription__GetLongDescrByFormat(), and GWEN_XmlCtxStore_StartTag().

#define GWEN_XML_PATH_FLAGS_OVERWRITE_VALUES   0x00010000

Definition at line 125 of file xml.h.

Referenced by GWEN_XMLNode_SetCharValueByPath().

Typedef Documentation

typedef struct GWEN__XMLNODE GWEN_XMLNODE

The abstract type XMLNODE. Each node is one node in the document tree and can represent different things, see GWEN_XMLNODE_TYPE.

Definition at line 147 of file xml.h.

Definition at line 148 of file xml.h.

Enumeration Type Documentation

The possible types of a GWEN_XMLNODE.

Enumerator:
GWEN_XMLNodeTypeTag 

A node can be a tag (in XML notation these are called elements).

GWEN_XMLNodeTypeData 

A node can be some data.

GWEN_XMLNodeTypeComment 

A node can be some XML comment.

Definition at line 134 of file xml.h.

Function Documentation

GWENHYWFAR_API int GWEN_XML_ReadFile ( GWEN_XMLNODE n,
const char *  filepath,
uint32_t  flags 
)
GWENHYWFAR_API int GWEN_XML_ReadFromFastBuffer ( GWEN_XML_CONTEXT ctx,
GWEN_FAST_BUFFER fb 
)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromFile ( GWEN_XML_CONTEXT ctx,
const char *  fname 
)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromIo ( GWEN_XML_CONTEXT ctx,
GWEN_SYNCIO io 
)

Reads a single element (and all its sub-elements) from an IO layer.

Definition at line 881 of file xmlrw.c.

References DBG_INFO, GWEN_FastBuffer_free(), GWEN_FastBuffer_new(), GWEN_LOGDOMAIN, GWEN_XML__ReadAllFromIo(), GWEN_XML_BUFFERSIZE, and GWEN_XML_ReadFromFastBuffer().

GWENHYWFAR_API int GWEN_XMLContext_ReadFromString ( GWEN_XML_CONTEXT ctx,
const char *  text 
)
GWENHYWFAR_API void GWEN_XMLNode_AddChild ( GWEN_XMLNODE n,
GWEN_XMLNODE child 
)

Adds a node as a child to another one. This function does not make deep copies. Instead it takes over ownership of the new child.

Parameters
nnode to which the new node is to be added (i.e. the node which becomes the parent of the second argument)
childchild which is to be added (this function takes over ownership of that node, so you MUST NOT free the node yourself)

Definition at line 398 of file xml.c.

Referenced by GWEN_MsgEngine__ListElement(), GWEN_MsgEngine__ListGroup(), GWEN_MsgEngine_AddDefinitions(), GWEN_XmlCtxStore_AddData(), GWEN_XmlCtxStore_StartTag(), GWEN_XMLNode_AddChildrenOnly(), GWEN_XMLNode_dup(), GWEN_XMLNode_HandlePath(), GWEN_XMLNode_SetCharValue(), and GWEN_XMLNode_SetCharValueByPath().

GWENHYWFAR_API void GWEN_XMLNode_AddChildrenOnly ( GWEN_XMLNODE n,
GWEN_XMLNODE nn,
int  copythem 
)

Adds the children of the second argument as new children to the first one.

Parameters
nnode which is to become parent of the second argument's children
nnnode whose children are to be moved.
copythemif 0 then the children will be moved (leaving the node of the second argument without children), otherwise deep copies will be made and the node from the second argument will not be altered. co

Definition at line 406 of file xml.c.

References GWEN_XMLNode_AddChild(), GWEN_XMLNode_dup(), GWEN_XMLNode_GetChild(), GWEN_XMLNode_Next(), and GWEN_XMLNode_UnlinkChild().

GWENHYWFAR_API void GWEN_XMLNode_AddHeader ( GWEN_XMLNODE root,
GWEN_XMLNODE nh 
)

Adds a node as a header to the given root node.

Definition at line 1211 of file xml.c.

Referenced by GWEN_XmlCtxStore_StartTag(), and GWEN_XMLNode_dup().

GWENHYWFAR_API void GWEN_XMLNode_AddNameSpace ( GWEN_XMLNODE n,
const GWEN_XMLNODE_NAMESPACE ns 
)

Definition at line 1281 of file xml.c.

References GWEN_XMLNode_NameSpace_dup().

Referenced by GWEN_XmlCtxStore_AddAttr().

GWENHYWFAR_API void GWEN_XMLNode_ClearHeaders ( GWEN_XMLNODE root)

Clears the given root nodes' list of headers. All the tags in the header list are also freed.

Definition at line 1227 of file xml.c.

GWENHYWFAR_API void GWEN_XMLNode_CopyProperties ( GWEN_XMLNODE tn,
const GWEN_XMLNODE sn,
int  overwrite 
)

This function copies the properties/attributes of one tag/element to another one.

Parameters
tndestination node (must be a tag/element)
snsource node (must be a tag/element)
overwriteif !=0 then existing properties/attributes in the destination node will be overwritten.

Definition at line 555 of file xml.c.

References GWEN_Memory_dealloc(), GWEN_Memory_strdup(), GWEN_XMLProperty_add(), and GWEN_XMLProperty_dup().

Referenced by GWEN_MsgEngine__ListGroup().

GWENHYWFAR_API void GWEN_XMLNode_DecUsage ( GWEN_XMLNODE n)

Definition at line 333 of file xml.c.

References DBG_WARN, and GWEN_LOGDOMAIN.

GWENHYWFAR_API void GWEN_XMLNode_DelHeader ( GWEN_XMLNODE root,
GWEN_XMLNODE nh 
)

Removes a node from the given root nodes' header list. The header node is just removed from the list, not freed !

Definition at line 1219 of file xml.c.

GWENHYWFAR_API void GWEN_XMLNode_Dump ( const GWEN_XMLNODE n,
int  ind 
)
GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_dup ( const GWEN_XMLNODE n)
GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_FindFirstTag ( const GWEN_XMLNODE n,
const char *  tname,
const char *  pname,
const char *  pvalue 
)

Searches for the first matching tag/element below the given one. Lets say you have the following XML file:

<DEVICES>
<DEVICE id="dev1" />
<DEVICE id="dev2" />
</DEVICES>

If you are looking for a device called "dev2" then you should call this function like this:

tag=GWEN_XMLNode_FindFirstTag(root, "DEVICE", "id", "dev2");
Returns
pointer to the tag/element if found, 0 otherwise
Parameters
ntag/element below which to search
tnametag/element name (e.g. if the tag is "<TESTTAG>" then the tag name is "TESTTAG"). Wildcards (like "*") are allowed.
pnamename of the property/attribute to check (if 0 then no property/attribute comparison takes place). No wildcards allowed.
pvalueoptional value of the property/attribute to compare against, wildcards allowed.

Definition at line 695 of file xml.c.

References GWEN_XMLNode_FindTag(), and GWEN_XMLNode_GetFirstTag().

Referenced by GWEN_Dialog__ReadXmlWidget(), GWEN_Dialog_ReadXmlFile(), GWEN_LoadPluginDescrsByType(), GWEN_MsgEngine__GetGroup(), GWEN_PluginDescription__GetLocalizedLongDescrByFormat(), GWEN_PluginDescription__GetLongDescrByFormat(), GWEN_XMLNode_GetCharValue(), GWEN_XMLNode_GetLocalizedCharValue(), GWEN_XMLNode_GetXPath(), and GWEN_XMLNode_HandlePath().

GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE* GWEN_XMLNode_FindNameSpaceByName ( const GWEN_XMLNODE n,
const char *  s 
)

Definition at line 1241 of file xml.c.

References GWEN_XMLNode_NameSpace_GetName(), and NULL.

GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE* GWEN_XMLNode_FindNameSpaceByUrl ( const GWEN_XMLNODE n,
const char *  s 
)

Definition at line 1261 of file xml.c.

References GWEN_XMLNode_NameSpace_GetUrl(), and NULL.

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_FindNextTag ( const GWEN_XMLNODE n,
const char *  tname,
const char *  pname,
const char *  pvalue 
)

Searches for the next matching tag/element after the given one one the same level (i.e. the returned element has the same parent node as the given element).

Definition at line 712 of file xml.c.

References GWEN_XMLNode_FindTag(), and GWEN_XMLNode_GetNextTag().

Referenced by GWEN_Dialog__ReadXmlWidget(), GWEN_PluginDescription__GetLocalizedLongDescrByFormat(), GWEN_PluginDescription__GetLongDescrByFormat(), GWEN_XMLNode_GetCharValue(), GWEN_XMLNode_GetLocalizedCharValue(), GWEN_XMLNode_GetXPath(), and GWEN_XMLNode_HandlePath().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_FindNode ( const GWEN_XMLNODE n,
GWEN_XMLNODE_TYPE  t,
const char *  data 
)

This is a very primitive function. It looks for a node of the given type and data matching the given one (case-insensitive) below the given node (i.e. if a node is returned it will be a child of the given one).

Definition at line 513 of file xml.c.

References DBG_DEBUG, GWEN_LOGDOMAIN, GWEN_XMLNode_GetChild(), and GWEN_XMLNode_Next().

Referenced by GWEN_MsgEngine_AddDefinitions().

GWENHYWFAR_API void GWEN_XMLNode_free ( GWEN_XMLNODE n)
GWENHYWFAR_API void GWEN_XMLNode_freeAll ( GWEN_XMLNODE n)

Free the given node and all nodes besides this one. Hmm, this function should not be public, I think I will move it to xml_p.h.

Definition at line 166 of file xml.c.

References GWEN_XMLNode_free().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_fromString ( const char *  s,
int  len,
uint32_t  flags 
)
GWENHYWFAR_API const char* GWEN_XMLNode_GetCharValue ( const GWEN_XMLNODE n,
const char *  name,
const char *  defValue 
)
Parameters
nNode which is expected to contain a node of the specified name
namename of the node below n to be looked up
defValuedefault value to return if the tag did not exist

Definition at line 729 of file xml.c.

References GWEN_XMLNode_FindFirstTag(), GWEN_XMLNode_FindNextTag(), and GWEN_XMLNode_GetFirstData().

Referenced by GWEN_Crypt_Token_Context_ReadXml(), GWEN_PluginDescription_new(), and GWEN_XMLNode_GetIntValue().

GWENHYWFAR_API const char* GWEN_XMLNode_GetCharValueByPath ( GWEN_XMLNODE n,
const char *  path,
const char *  defValue 
)

Return the string value of an element below the given one, specified by an XPath.

Parameters
nNode which is expected to contain the specified path
pathXPath to lookup below the node n
defValuedefault value to return if the tag did not exist

Definition at line 873 of file xml.c.

References GWEN_XMLNode_GetFirstData(), and GWEN_XMLNode_GetNodeByXPath().

Referenced by GWEN_XMLNode_GetIntValueByPath().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetChild ( const GWEN_XMLNODE n)

INTERNAL. Descends in the XML tree to the first GWEN_XMLNODE below the given node. The returned node may be a tag/element node, or a property/attribute node, or a data node. You will probably prefer to use GWEN_XMLNode_GetFirstTag() instead of this function.

Returns
The first children tag/element, or NULL if none exists.

Definition at line 386 of file xml.c.

Referenced by GWEN_MsgEngine__findInValues(), GWEN_MsgEngine__ListGroup(), GWEN_MsgEngine__ReadGroup(), GWEN_MsgEngine__ShowGroup(), GWEN_MsgEngine__WriteGroup(), GWEN_MsgEngine_AddDefinitions(), GWEN_MsgEngine_FindNodeByProperty(), GWEN_MsgEngine_FindNodeByPropertyStrictProto(), GWEN_XMLNode__WriteToStream(), GWEN_XMLNode_AddChildrenOnly(), GWEN_XMLNode_Dump(), GWEN_XMLNode_FindNode(), GWEN_XMLNode_GetFirstOfType(), and GWEN_XMLNode_WriteToStream().

GWENHYWFAR_API const char* GWEN_XMLNode_GetData ( const GWEN_XMLNODE n)
GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetFirstData ( const GWEN_XMLNODE n)

Descends in the XML tree to the first children data node below the given node.

Different from GWEN_XMLNode_GetChild() this function only looks for another data node and not for a (more general) node.

Returns
The first children data node, or NULL if none exists.

Definition at line 646 of file xml.c.

References GWEN_XMLNode_GetFirstOfType(), and GWEN_XMLNodeTypeData.

Referenced by GWEN_MsgEngine__GetInline(), GWEN_StringList2_fromXml(), GWEN_XMLNode_GetCharValue(), GWEN_XMLNode_GetCharValueByPath(), and GWEN_XMLNode_GetLocalizedCharValue().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetFirstTag ( const GWEN_XMLNODE n)

Descends in the XML tree to the first children tag (in XML notation they are called elements) below the given node.

Different from GWEN_XMLNode_GetChild() this function only looks for another tag/element and not for a (more general) node. You will probably prefer this function instead of GWEN_XMLNode_GetChild().

Returns
The first children tag/element, or NULL if none exists.

Definition at line 629 of file xml.c.

References GWEN_XMLNode_GetFirstOfType(), and GWEN_XMLNodeTypeTag.

Referenced by GWEN_MsgEngine__GetGroup(), GWEN_StringList2_fromXml(), GWEN_XMLNode__CheckNameSpaceDecls1(), GWEN_XMLNode__CheckNameSpaceDecls3(), GWEN_XMLNode__SetNameSpaces(), and GWEN_XMLNode_FindFirstTag().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetHeader ( const GWEN_XMLNODE n)

Returns the first header tag of the given node. Use GWEN_XMLNode_Next to get the next header tag.

Definition at line 1204 of file xml.c.

Referenced by GWEN_XMLNode_WriteToStream().

GWENHYWFAR_API int GWEN_XMLNode_GetIntProperty ( const GWEN_XMLNODE n,
const char *  name,
int  defaultValue 
)

Same as GWEN_XMLNode_GetProperty, but it tries to parse the property as an integer value.

Definition at line 251 of file xml.c.

GWENHYWFAR_API int GWEN_XMLNode_GetIntValue ( const GWEN_XMLNODE n,
const char *  name,
int  defValue 
)

Internally calls GWEN_XMLNode_GetCharValue and interpretes the data as an integer which is then returned.

Parameters
nNode which is expected to contain a node of the specified name
namename of the node below n to be looked up
defValuedefault value to return if the tag did not exist

Definition at line 818 of file xml.c.

References GWEN_XMLNode_GetCharValue().

Referenced by GWEN_Crypt_Token_Context_ReadXml().

GWENHYWFAR_API int GWEN_XMLNode_GetIntValueByPath ( GWEN_XMLNODE n,
const char *  name,
int  defValue 
)

Return the integer value of an element below the given one, specified by an XPath.

Parameters
nNode which is expected to contain the specified path
pathXPath to lookup below the node n
defValuedefault value to return if the tag did not exist

Definition at line 915 of file xml.c.

References GWEN_XMLNode_GetCharValueByPath(), and NULL.

GWENHYWFAR_API const char* GWEN_XMLNode_GetLocalizedCharValue ( const GWEN_XMLNODE n,
const char *  name,
const char *  defValue 
)

This function does the same as GWEN_XMLNode_GetCharValue, but it looks for an element with the attribute "lang" which matches the currently selected locale (e.g. "lang=de" for Germany). If there is no localized version of the given element then the first element of that name is used (withouth "lang" attribute). Therefore XML documents used with this function should contain unlocalized elements along with localized ones to provide a fallback.

Parameters
nNode which is expected to contain a node of the specified name
namename of the node below n to be looked up
defValuedefault value to return if the tag did not exist

Definition at line 751 of file xml.c.

References DBG_DEBUG, GWEN_I18N_GetCurrentLocaleList(), GWEN_LOGDOMAIN, GWEN_StringList_FirstEntry(), GWEN_StringListEntry_Data(), GWEN_StringListEntry_Next(), GWEN_XMLNode_FindFirstTag(), GWEN_XMLNode_FindNextTag(), and GWEN_XMLNode_GetFirstData().

GWENHYWFAR_API const char* GWEN_XMLNode_GetNamespace ( const GWEN_XMLNODE n)

Definition at line 368 of file xml.c.

GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE_LIST* GWEN_XMLNode_GetNameSpaces ( const GWEN_XMLNODE n)

Definition at line 1234 of file xml.c.

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetNextData ( const GWEN_XMLNODE n)

Iterates on the same level in the XML tree from the given data node to the next one on the same level (i.e. the returned element has the same parent node as the given element). An XML element may have multiple data nodes as children, and you use this function to iterate through all of them.

Different from GWEN_XMLNode_Next() this function only looks for another data node and not for a (more general) node.

Returns
The next data node on the same level, or NULL if no more data node exists.

Definition at line 652 of file xml.c.

References GWEN_XMLNode_GetNextOfType(), GWEN_XMLNode_Next(), and GWEN_XMLNodeTypeData.

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetNextTag ( const GWEN_XMLNODE n)

Iterates on the same level in the XML tree from the given tag (in XML notation they are called elements) to the next one on the same level (i.e. the returned element has the same parent node as the given element).

Different from GWEN_XMLNode_Next() this function only looks for another tag/element and not for a (more general) node. You will probably prefer this function instead of GWEN_XMLNode_Next().

Returns
The next tag/element on the same level, or NULL if no more element exists.

Definition at line 635 of file xml.c.

References GWEN_XMLNode_GetNextOfType(), GWEN_XMLNode_Next(), and GWEN_XMLNodeTypeTag.

Referenced by GWEN_MsgEngine__GetGroup(), GWEN_StringList2_fromXml(), GWEN_XMLNode__CheckNameSpaceDecls1(), GWEN_XMLNode__CheckNameSpaceDecls3(), GWEN_XMLNode__SetNameSpaces(), GWEN_XMLNode_FindNextTag(), and GWEN_XMLNode_FindTag().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetNodeByXPath ( GWEN_XMLNODE n,
const char *  path,
uint32_t  flags 
)

Locates a tag by its XPath. Currently attributes are not allowed, and the flag GWEN_PATH_FLAGS_VARIABLE is not supported. Supported types of XPaths are:

  • /element[1]/element[2]
  • ../../element[5]

and so on. As you can see index numbers are supported. You should not use this function to create a node but rather for node lookups.

Definition at line 1193 of file xml.c.

References GWEN_Path_HandleWithIdx(), and GWEN_XMLNode_HandlePath().

Referenced by GWEN_XMLNode_GetCharValueByPath(), and GWEN_XMLNode_SetCharValueByPath().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_GetParent ( const GWEN_XMLNODE n)

Returns the parent node of the given node, or NULL if it already is the root node.

Definition at line 392 of file xml.c.

Referenced by GWEN_MsgEngine_GetGroup(), GWEN_MsgEngine_GetHighestTrustLevel(), GWEN_MsgEngine_SearchForProperty(), GWEN_XmlCtxStore_EndTag(), and GWEN_XmlCtxStore_StartTag().

GWENHYWFAR_API const char* GWEN_XMLNode_GetProperty ( const GWEN_XMLNODE n,
const char *  name,
const char *  defaultValue 
)
GWENHYWFAR_API GWEN_XMLNODE_TYPE GWEN_XMLNode_GetType ( const GWEN_XMLNODE n)
GWENHYWFAR_API uint32_t GWEN_XMLNode_GetUsage ( const GWEN_XMLNODE n)

Definition at line 344 of file xml.c.

GWENHYWFAR_API int GWEN_XMLNode_GetXPath ( const GWEN_XMLNODE n1,
const GWEN_XMLNODE n2,
GWEN_BUFFER nbuf 
)
GWENHYWFAR_API int GWEN_XMLNode_Globalize ( GWEN_XMLNODE n)

Definition at line 237 of file xmlglobalize.c.

References DBG_INFO, GWEN_LOGDOMAIN, and GWEN_XMLNode_GlobalizeWithList().

GWENHYWFAR_API int GWEN_XMLNode_GlobalizeWithList ( GWEN_XMLNODE n,
GWEN_XMLNODE_NAMESPACE_LIST *  l,
uint32_t *  pLastId 
)
GWENHYWFAR_API void GWEN_XMLNode_IncUsage ( GWEN_XMLNODE n)

Definition at line 326 of file xml.c.

GWENHYWFAR_API int GWEN_XMLNode_IsChildOf ( const GWEN_XMLNODE parent,
const GWEN_XMLNODE child 
)

Checks whether the second node is a child of the first one.

Returns
0 if statement is not true, !=0 otherwise

Definition at line 964 of file xml.c.

Referenced by GWEN_XMLNode_GetXPath().

GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_new ( GWEN_XMLNODE_TYPE  t,
const char *  data 
)
GWENHYWFAR_API GWEN_XMLNODE* GWEN_XMLNode_Next ( const GWEN_XMLNODE n)

INTERNAL. Iterates on the same level in the XML tree from the given node to the next one on the same level (i.e. the returned node has the same parent node as the given element). The returned node may be a tag/element node, or a property/attribute node, or a data node. You will probably prefer to use GWEN_XMLNode_GetNextTag() instead of this function.

Returns
The next node on the same level, or NULL if no more element exists.

Definition at line 437 of file xml.c.

Referenced by GWEN_MsgEngine__findInValues(), GWEN_MsgEngine__ListGroup(), GWEN_MsgEngine__ReadGroup(), GWEN_MsgEngine__ShowGroup(), GWEN_MsgEngine__WriteGroup(), GWEN_MsgEngine_AddDefinitions(), GWEN_MsgEngine_FindNodeByProperty(), GWEN_MsgEngine_FindNodeByPropertyStrictProto(), GWEN_XMLNode__WriteToStream(), GWEN_XMLNode_AddChildrenOnly(), GWEN_XMLNode_Dump(), GWEN_XMLNode_dup(), GWEN_XMLNode_FindNode(), GWEN_XMLNode_GetFirstOfType(), GWEN_XMLNode_GetNextData(), GWEN_XMLNode_GetNextOfType(), GWEN_XMLNode_GetNextTag(), and GWEN_XMLNode_WriteToStream().

GWENHYWFAR_API int GWEN_XMLNode_NormalizeNameSpaces ( GWEN_XMLNODE n)

This function removes unnecessary namespaces from the given node and all nodes below.

Definition at line 1673 of file xml.c.

References DBG_INFO, GWEN_LOGDOMAIN, GWEN_StringList2_free(), GWEN_StringList2_new(), GWEN_XMLNode__CheckNameSpaceDecls1(), GWEN_XMLNode__CheckNameSpaceDecls3(), and GWEN_XMLNode_GetProperty().

GWENHYWFAR_API void GWEN_XMLNode_RemoveChildren ( GWEN_XMLNODE n)

Unlinks and frees all children of the given node.

Definition at line 548 of file xml.c.

Referenced by GWEN_MsgEngine_ListMessage().

GWENHYWFAR_API void GWEN_XMLNode_SetCharValue ( GWEN_XMLNODE n,
const char *  name,
const char *  value 
)
GWENHYWFAR_API int GWEN_XMLNode_SetCharValueByPath ( GWEN_XMLNODE n,
uint32_t  flags,
const char *  name,
const char *  value 
)
GWENHYWFAR_API void GWEN_XMLNode_SetData ( GWEN_XMLNODE n,
const char *  data 
)

Set the character data of the given node to the given value. This function will create a deep copy of the character data.

Definition at line 357 of file xml.c.

References GWEN_Memory_dealloc(), and GWEN_Memory_strdup().

GWENHYWFAR_API void GWEN_XMLNode_SetIntProperty ( GWEN_XMLNODE n,
const char *  name,
int  value 
)

Same as GWEN_XMLNode_SetProperty, but for integer values.

Definition at line 315 of file xml.c.

References GWEN_XMLNode__SetProperty().

GWENHYWFAR_API void GWEN_XMLNode_SetIntValue ( GWEN_XMLNODE n,
const char *  name,
int  value 
)

Definition at line 834 of file xml.c.

References GWEN_XMLNode_SetCharValue().

Referenced by GWEN_Crypt_Token_Context_WriteXml().

GWENHYWFAR_API int GWEN_XMLNode_SetIntValueByPath ( GWEN_XMLNODE n,
uint32_t  flags,
const char *  name,
int  value 
)

Definition at line 894 of file xml.c.

References DBG_INFO, GWEN_LOGDOMAIN, and GWEN_XMLNode_SetCharValueByPath().

GWENHYWFAR_API void GWEN_XMLNode_SetNamespace ( GWEN_XMLNODE n,
const char *  s 
)

Definition at line 375 of file xml.c.

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

GWENHYWFAR_API void GWEN_XMLNode_SetProperty ( GWEN_XMLNODE n,
const char *  name,
const char *  value 
)

Sets the value of a property/attribute. This property/attribute will be created if it does not exist and overwritten if it does.

Parameters
nnode (must be a tag/element)
namename of the property/attribute
valuenew value of the property/attribute

Definition at line 308 of file xml.c.

References GWEN_XMLNode__SetProperty().

Referenced by GWEN_MsgEngine__ListElement(), GWEN_MsgEngine__ListGroup(), and GWEN_XmlCtxStore_AddAttr().

GWENHYWFAR_API int GWEN_XMLNode_StripNamespaces ( GWEN_XMLNODE n)
GWENHYWFAR_API int GWEN_XMLNode_toBuffer ( const GWEN_XMLNODE n,
GWEN_BUFFER buf,
uint32_t  flags 
)
GWENHYWFAR_API void GWEN_XMLNode_UnlinkChild ( GWEN_XMLNODE n,
GWEN_XMLNODE child 
)

Unlinks the given child node from its parent without freeing it. This function relinquishes the ownership of the child to the caller who thereby becomes responsible for freeing this node.

Parameters
nnode which is suspected to be the parent of the second argument
childnode which is to be unlinked

Definition at line 539 of file xml.c.

Referenced by GWEN_XMLNode_AddChildrenOnly().

GWENHYWFAR_API int GWEN_XMLNode_WriteFile ( const GWEN_XMLNODE n,
const char *  fname,
uint32_t  flags 
)
GWENHYWFAR_API int GWEN_XMLNode_WriteToStream ( const GWEN_XMLNODE n,
GWEN_XML_CONTEXT ctx,
GWEN_SYNCIO sio 
)