1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/* eurephia_xml.h -- Generic helper functions for XML parsing
*
* GPLv2 only - Copyright (C) 2008 - 2012
* David Sommerseth <dazo@users.sourceforge.net>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; version 2
* of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
/**
* @file eurephia_xml.h
* @author David Sommerseth <dazo@users.sourceforge.net>
* @date 2008-12-15
*
* @brief Generic XML parser functions
*
*/
#ifndef EUREPHIA_XML_H_
# define EUREPHIA_XML_H_
/**
* Result types used by eurephiaXML_ResultMsg()
*/
typedef enum _exmlResultType { exmlRESULT = 1, /**< Operation successful. Additional info might be available*/
exmlERROR /**< Operation failed. Error message must be enclosed */
} exmlResultType;
#include <stdarg.h>
#ifdef HAVE_LIBXML2
#include <libxml/tree.h>
/**
* Structure which is used when parsing eurephia Result XML documents
*/
typedef struct _eurephiaRESULT {
exmlResultType resultType; /**< Indicates what kind of result we received */
const char *message; /**< String containing the result message */
xmlNode *details; /**< A result message can attach an XML node with even more
detailed information */
} eurephiaRESULT;
/**
* Simple iterator macro for iterating xmlNode pointers
*
* @param start Pointer to an xmlNode where to start iterating
* @param itn An xmlNode pointer which will be used for the iteration.
*/
#define foreach_xmlnode(start, itn) for( itn = start; itn != NULL; itn = itn->next )
void xmlReplaceChars(xmlChar *str, char s, char r);
char *xmlGetAttrValue(xmlAttr *properties, const char *key);
xmlNode *xmlFindNode(xmlNode *node, const char *key);
int eurephiaXML_CreateDoc(eurephiaCTX *ctx, int format, const char *rootname, xmlDoc **doc, xmlNode **root_n);
xmlNode *eurephiaXML_getRoot(eurephiaCTX *ctx, xmlDoc *doc, const char *nodeset, int min_format);
xmlDoc *eurephiaXML_ResultMsg(eurephiaCTX *ctx, exmlResultType type, xmlNode *info_n, const char *fmt, ... );
unsigned int eurephiaXML_IsResultMsg(eurephiaCTX *ctx, xmlDoc *resxml);
eurephiaRESULT *eurephiaXML_ParseResultMsg(eurephiaCTX *ctx, xmlDoc *resxml);
inline char *xmlExtractContent(xmlNode *n);
inline char *xmlGetNodeContent(xmlNode *node, const char *key);
#endif /* HAVE_LIBXML2 */
#endif /* !EUREPHIA_XML_H_ */
|
