gwenhywfar  4.15.2beta
xml.h
Go to the documentation of this file.
1 /***************************************************************************
2  begin : Sat Jun 28 2003
3  copyright : (C) 2003-2010 by Martin Preuss
4  email : martin@libchipcard.de
5 
6  ***************************************************************************
7  * *
8  * This library is free software; you can redistribute it and/or *
9  * modify it under the terms of the GNU Lesser General Public *
10  * License as published by the Free Software Foundation; either *
11  * version 2.1 of the License, or (at your option) any later version. *
12  * *
13  * This library is distributed in the hope that it will be useful, *
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16  * Lesser General Public License for more details. *
17  * *
18  * You should have received a copy of the GNU Lesser General Public *
19  * License along with this library; if not, write to the Free Software *
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21  * MA 02111-1307 USA *
22  * *
23  ***************************************************************************/
24 
25 #ifndef GWENHYWFAR_XML_H
26 #define GWENHYWFAR_XML_H
27 
29 #include <gwenhywfar/stringlist.h>
30 #include <gwenhywfar/types.h>
31 #include <gwenhywfar/list2.h>
32 #include <gwenhywfar/syncio.h>
33 
34 #include <stdio.h>
35 
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
46 
51 
52 
56 
60 #define GWEN_XML_FLAGS_HANDLE_COMMENTS 0x0001
61 
66 #define GWEN_XML_FLAGS_INDENT 0x0002
67 
73 #define GWEN_XML_FLAGS_HANDLE_OPEN_HTMLTAGS 0x0004
74 
79 #define GWEN_XML_FLAGS_NO_CONDENSE 0x0008
80 
85 #define GWEN_XML_FLAGS_KEEP_CNTRL 0x0010
86 
87 #define GWEN_XML_FLAGS_KEEP_BLANKS 0x0020
88 
89 #define GWEN_XML_FLAGS_SIMPLE 0x0040
90 
94 #define GWEN_XML_FLAGS_HANDLE_HEADERS 0x0080
95 
103 #define GWEN_XML_FLAGS_TOLERANT_ENDTAGS 0x0100
104 
105 #define GWEN_XML_FLAGS_HANDLE_NAMESPACES 0x0200
106 
110 #define GWEN_XML_FLAGS_DEFAULT \
111  (\
112  GWEN_XML_FLAGS_INDENT | \
113  GWEN_XML_FLAGS_HANDLE_COMMENTS\
114  )
115 
124 
125 #define GWEN_XML_PATH_FLAGS_OVERWRITE_VALUES 0x00010000
126 
134 typedef enum {
142 }
144 
148 typedef struct GWEN__XMLNODE GWEN_XMLNODE;
150 
153 
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 
161 #include <gwenhywfar/xmlctx.h>
162 #include <gwenhywfar/fastbuffer.h>
163 
164 
165 #ifdef __cplusplus
166 extern "C" {
167 #endif
168 
169 
170 
176 GWEN_XMLNODE *GWEN_XMLNode_new(GWEN_XMLNODE_TYPE t, const char *data);
177 
183 
191 
197 
221 
228 
234 
241 
248 
273 const char *GWEN_XMLNode_GetProperty(const GWEN_XMLNODE *n,
274  const char *name,
275  const char *defaultValue);
276 
286  const char *name,
287  const char *value);
288 
294 int GWEN_XMLNode_GetIntProperty(const GWEN_XMLNODE *n, const char *name,
295  int defaultValue);
296 
302  const char *name, int value);
303 
315  const GWEN_XMLNODE *sn,
316  int overwrite);
325 GWEN_XMLNODE_TYPE GWEN_XMLNode_GetType(const GWEN_XMLNODE *n);
326 
329 const char *GWEN_XMLNode_GetData(const GWEN_XMLNODE *n);
330 
334 void GWEN_XMLNode_SetData(GWEN_XMLNODE *n, const char *data);
335 
337 const char *GWEN_XMLNode_GetNamespace(const GWEN_XMLNODE *n);
338 
340 void GWEN_XMLNode_SetNamespace(GWEN_XMLNODE *n, const char *s);
341 
361 
364 
366 uint32_t GWEN_XMLNode_GetUsage(const GWEN_XMLNODE *n);
385 
395 
400 
411 
425 
435 
449 
477  const char *tname,
478  const char *pname,
479  const char *pvalue);
480 
488  const char *tname,
489  const char *pname,
490  const char *pvalue);
491 
497 int GWEN_XMLNode_IsChildOf(const GWEN_XMLNODE *parent,
498  const GWEN_XMLNODE *child);
499 
501 int GWEN_XMLNode_GetXPath(const GWEN_XMLNODE *n1,
502  const GWEN_XMLNODE *n2,
503  GWEN_BUFFER *nbuf);
504 
519  const char *path,
520  uint32_t flags);
521 
522 
530 
541 
551 
557 
570  int copythem);
571 
579  GWEN_XMLNODE_TYPE t,
580  const char *data);
588 
595 
596 
597 
600 
601 
604 
605 
609  uint32_t *pLastId);
610 
611 
614 
620 
622 int GWEN_XMLContext_ReadFromFile(GWEN_XML_CONTEXT *ctx, const char *fname);
623 
625 int GWEN_XMLContext_ReadFromString(GWEN_XML_CONTEXT *ctx, const char *text);
626 
627 
633 int GWEN_XML_ReadFile(GWEN_XMLNODE *n, const char *filepath, uint32_t flags);
634 
637  int len,
638  uint32_t flags);
639 
645  GWEN_XML_CONTEXT *ctx,
646  GWEN_SYNCIO *sio);
647 
653  const char *fname,
654  uint32_t flags);
655 
657 int GWEN_XMLNode_toBuffer(const GWEN_XMLNODE *n, GWEN_BUFFER *buf, uint32_t flags);
658 
659 
660 
661 
664 
667  const char *s);
668 
671  const char *s);
672 
675 
676 
677 
705 
716 const char *GWEN_XMLNode_GetCharValue(const GWEN_XMLNODE *n,
717  const char *name,
718  const char *defValue);
719 
722  const char *name,
723  const char *value);
724 
739  const char *name,
740  const char *defValue);
741 
751  const char *name,
752  int defValue);
753 
756  const char *name,
757  int value);
758 
786 
795  const char *path,
796  const char *defValue);
797 
799 int GWEN_XMLNode_SetCharValueByPath(GWEN_XMLNODE *n, uint32_t flags,
800  const char *name,
801  const char *value);
802 
811  const char *name,
812  int defValue);
813 
815 int GWEN_XMLNode_SetIntValueByPath(GWEN_XMLNODE *n, uint32_t flags,
816  const char *name,
817  int value);
818 
827 
832 void GWEN_XMLNode_Dump(const GWEN_XMLNODE *n, int ind);
835  /* defgroup */
836 
837 
845 
847 
848 
855 
861  GWEN_XMLNODE *n);
862 
869 
874 void GWEN_XMLNode_Path_Dump(GWEN_XMLNODE_PATH *np); /* defgroup */ /* defgroup (all)*/
877 
878 
879 
882  const char *url);
883 
886 
889 
892 
895 
896 
897 #ifdef __cplusplus
898 }
899 #endif
900 
901 
902 
903 #endif
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetHeader(const GWEN_XMLNODE *n)
GWENHYWFAR_API uint32_t GWEN_XMLNode_GetUsage(const GWEN_XMLNODE *n)
struct GWEN_XMLNODE_NAMESPACE GWEN_XMLNODE_NAMESPACE
Definition: xml.h:149
GWENHYWFAR_API void GWEN_XMLNode_AddHeader(GWEN_XMLNODE *root, GWEN_XMLNODE *nh)
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 const char * GWEN_XMLNode_GetProperty(const GWEN_XMLNODE *n, const char *name, const char *defaultValue)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetNextData(const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE * GWEN_XMLNode_FindNameSpaceByName(const GWEN_XMLNODE *n, const char *s)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_FindNextTag(const GWEN_XMLNODE *n, const char *tname, const char *pname, const char *pvalue)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetFirstData(const GWEN_XMLNODE *n)
GWENHYWFAR_API const char * GWEN_XMLNode_NameSpace_GetName(const GWEN_XMLNODE_NAMESPACE *ns)
GWENHYWFAR_API void GWEN_XMLNode_SetProperty(GWEN_XMLNODE *n, const char *name, const char *value)
GWENHYWFAR_API int GWEN_XML_ReadFile(GWEN_XMLNODE *n, const char *filepath, uint32_t flags)
GWENHYWFAR_API void GWEN_XMLNode_Path_Dump(GWEN_XMLNODE_PATH *np)
GWENHYWFAR_API void GWEN_XMLNode_Dump(const GWEN_XMLNODE *n, int ind)
GWENHYWFAR_API int GWEN_XMLNode_IsChildOf(const GWEN_XMLNODE *parent, const GWEN_XMLNODE *child)
GWENHYWFAR_API void GWEN_XMLNode_RemoveChildren(GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_SetCharValue(GWEN_XMLNODE *n, const char *name, const char *value)
GWENHYWFAR_API int GWEN_XMLNode_WriteToStream(const GWEN_XMLNODE *n, GWEN_XML_CONTEXT *ctx, GWEN_SYNCIO *sio)
struct GWEN_XMLNODE_PATH GWEN_XMLNODE_PATH
Definition: xml.h:846
GWENHYWFAR_API void GWEN_XMLNode_AddNameSpace(GWEN_XMLNODE *n, const GWEN_XMLNODE_NAMESPACE *ns)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_new(GWEN_XMLNODE_TYPE t, const char *data)
GWENHYWFAR_API void GWEN_XMLNode_CopyProperties(GWEN_XMLNODE *tn, const GWEN_XMLNODE *sn, int overwrite)
GWENHYWFAR_API void GWEN_XMLNode_SetData(GWEN_XMLNODE *n, const char *data)
GWENHYWFAR_API int GWEN_XMLNode_GetIntValue(const GWEN_XMLNODE *n, const char *name, int defValue)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetChild(const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_FindFirstTag(const GWEN_XMLNODE *n, const char *tname, const char *pname, const char *pvalue)
GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE * GWEN_XMLNode_FindNameSpaceByUrl(const GWEN_XMLNODE *n, const char *s)
GWENHYWFAR_API void GWEN_XMLNode_DelHeader(GWEN_XMLNODE *root, GWEN_XMLNODE *nh)
struct GWEN_SYNCIO GWEN_SYNCIO
Definition: syncio.h:40
GWENHYWFAR_API int GWEN_XMLNode_GetIntProperty(const GWEN_XMLNODE *n, const char *name, int defaultValue)
GWENHYWFAR_API GWEN_XMLNODE_TYPE GWEN_XMLNode_GetType(const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODE_PATH * GWEN_XMLNode_Path_new(void)
GWENHYWFAR_API const char * GWEN_XMLNode_GetCharValue(const GWEN_XMLNODE *n, const char *name, const char *defValue)
GWENHYWFAR_API int GWEN_XMLNode_SetIntValueByPath(GWEN_XMLNODE *n, uint32_t flags, const char *name, int value)
#define GWEN_LIST2_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list2.h:56
GWENHYWFAR_API int GWEN_XML_ReadFromFastBuffer(GWEN_XML_CONTEXT *ctx, GWEN_FAST_BUFFER *fb)
GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE * GWEN_XMLNode_NameSpace_dup(const GWEN_XMLNODE_NAMESPACE *ns)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetNextTag(const GWEN_XMLNODE *n)
GWENHYWFAR_API const char * GWEN_XMLNode_GetNamespace(const GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromFile(GWEN_XML_CONTEXT *ctx, const char *fname)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_Path_Surface(GWEN_XMLNODE_PATH *np)
GWENHYWFAR_API GWEN_XMLNODE_NAMESPACE * GWEN_XMLNode_NameSpace_new(const char *name, const char *url)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetNodeByXPath(GWEN_XMLNODE *n, const char *path, uint32_t flags)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_Next(const GWEN_XMLNODE *n)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_FindNode(const GWEN_XMLNODE *n, GWEN_XMLNODE_TYPE t, const char *data)
GWENHYWFAR_API void GWEN_XMLNode_SetNamespace(GWEN_XMLNODE *n, const char *s)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_fromString(const char *s, int len, uint32_t flags)
GWENHYWFAR_API int GWEN_XMLNode_WriteFile(const GWEN_XMLNODE *n, const char *fname, uint32_t flags)
GWENHYWFAR_API void GWEN_XMLNode_free(GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_UnlinkChild(GWEN_XMLNODE *n, GWEN_XMLNODE *child)
struct GWEN_BUFFER GWEN_BUFFER
A dynamically resizeable text buffer.
Definition: buffer.h:41
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetParent(const GWEN_XMLNODE *n)
#define GWENHYWFAR_API
Definition: gwenhywfarapi.h:67
GWENHYWFAR_API void GWEN_XMLNode_DecUsage(GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_GetXPath(const GWEN_XMLNODE *n1, const GWEN_XMLNODE *n2, GWEN_BUFFER *nbuf)
GWENHYWFAR_API void GWEN_XMLNode_SetIntProperty(GWEN_XMLNODE *n, const char *name, int value)
#define GWEN_LIST_FUNCTION_LIB_DEFS(t, pr, decl)
Definition: list1.h:349
GWEN_XMLNODE_TYPE
Definition: xml.h:134
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_GetFirstTag(const GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_SetCharValueByPath(GWEN_XMLNODE *n, uint32_t flags, const char *name, const char *value)
GWENHYWFAR_API const char * GWEN_XMLNode_GetData(const GWEN_XMLNODE *n)
GWENHYWFAR_API const char * GWEN_XMLNode_GetLocalizedCharValue(const GWEN_XMLNODE *n, const char *name, const char *defValue)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromString(GWEN_XML_CONTEXT *ctx, const char *text)
GWENHYWFAR_API int GWEN_XMLContext_ReadFromIo(GWEN_XML_CONTEXT *ctx, GWEN_SYNCIO *io)
This file contains some macros concerning lists.
GWENHYWFAR_API const char * GWEN_XMLNode_NameSpace_GetUrl(const GWEN_XMLNODE_NAMESPACE *ns)
GWENHYWFAR_API GWEN_XMLNODE_PATH * GWEN_XMLNode_Path_dup(const GWEN_XMLNODE_PATH *np)
GWENHYWFAR_API GWEN_XMLNODE * GWEN_XMLNode_dup(const GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_Path_Dive(GWEN_XMLNODE_PATH *np, GWEN_XMLNODE *n)
GWENHYWFAR_API int GWEN_XMLNode_GetIntValueByPath(GWEN_XMLNODE *n, const char *name, int defValue)
GWENHYWFAR_API int GWEN_XMLNode_NormalizeNameSpaces(GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_ClearHeaders(GWEN_XMLNODE *root)
GWENHYWFAR_API const char * GWEN_XMLNode_GetCharValueByPath(GWEN_XMLNODE *n, const char *path, const char *defValue)
GWENHYWFAR_API void GWEN_XMLNode_AddChildrenOnly(GWEN_XMLNODE *n, GWEN_XMLNODE *nn, int copythem)
GWENHYWFAR_API void GWEN_XMLNode_Path_free(GWEN_XMLNODE_PATH *np)
GWENHYWFAR_API int GWEN_XMLNode_Globalize(GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_IncUsage(GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_NameSpace_free(GWEN_XMLNODE_NAMESPACE *ns)
struct GWEN__XMLNODE GWEN_XMLNODE
Definition: xml.h:148
struct GWEN_XML_CONTEXT GWEN_XML_CONTEXT
Definition: xmlctx.h:39
GWENHYWFAR_API int GWEN_XMLNode_GlobalizeWithList(GWEN_XMLNODE *n, GWEN_XMLNODE_NAMESPACE_LIST *l, uint32_t *pLastId)
GWENHYWFAR_API int GWEN_XMLNode_StripNamespaces(GWEN_XMLNODE *n)
GWENHYWFAR_API void GWEN_XMLNode_AddChild(GWEN_XMLNODE *n, GWEN_XMLNODE *child)
GWENHYWFAR_API void GWEN_XMLNode_SetIntValue(GWEN_XMLNODE *n, const char *name, int value)
GWENHYWFAR_API void GWEN_XMLNode_freeAll(GWEN_XMLNODE *n)