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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2016 The ManaPlus Developers
*
* This file is part of The ManaPlus Client.
*
* 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; either version 2 of the License, or
* any later version.
*
* 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef UTILS_XML_H
#define UTILS_XML_H
#include "enums/simpletypes/skiperror.h"
#include "enums/simpletypes/useresman.h"
#include <libxml/tree.h>
#include <libxml/xmlwriter.h>
#include <string>
#include "localconsts.h"
#define XmlNodePtr xmlNodePtr
#define XmlNodePtrConst xmlNode *const
#define XmlStrEqual(str1, str2) xmlStrEqual(str1, \
reinterpret_cast<const xmlChar*>(str2))
#define xmlNameEqual(node, str) xmlStrEqual((node)->name, \
reinterpret_cast<const xmlChar*>(str))
#define XmlTextWriterPtr xmlTextWriterPtr
#define xmlTypeEqual(node, typ) ((node)->type == (typ))
#define XmlHasProp(node, name) xmlHasProp(node, \
reinterpret_cast<const xmlChar*>(name))
#define XmlGetProp(node, name) xmlGetProp(node, \
reinterpret_cast<const xmlChar*>(name))
#define XmlTextWriterStartElement(writer, name) \
xmlTextWriterStartElement(writer, reinterpret_cast<const xmlChar*>(name))
#define XmlTextWriterWriteAttribute(writer, name, content) \
xmlTextWriterWriteAttribute(writer, \
reinterpret_cast<const xmlChar*>(name), \
reinterpret_cast<const xmlChar*>(content))
/**
* XML helper functions.
*/
namespace XML
{
/**
* A helper class for parsing an XML document, which also cleans it up
* again (RAII).
*/
class Document final
{
public:
/**
* Constructor that attempts to load the given file through the
* resource manager. Logs errors.
*/
Document(const std::string &filename,
const UseResman useResman,
const SkipError skipError);
/**
* Constructor that attempts to load an XML document from memory.
* Does not log errors.
*
* @param data the string to parse as XML
* @param size the length of the string in bytes
*/
Document(const char *const data, const int size);
A_DELETE_COPY(Document)
/**
* Destructor. Frees the loaded XML file.
*/
~Document();
/**
* Returns the root node of the document (or NULL if there was a
* load error).
*/
XmlNodePtr rootNode() A_WARN_UNUSED;
bool isLoaded() const
{ return mDoc != nullptr; }
bool isValid() const
{ return mIsValid; }
static bool validateXml(const std::string &fileName);
private:
xmlDocPtr mDoc;
bool mIsValid;
};
/**
* Gets an floating point property from an XmlNodePtr.
*/
double getFloatProperty(const XmlNodePtr node,
const char *const name,
double def) A_WARN_UNUSED;
/**
* Gets an integer property from an XmlNodePtr.
*/
int getProperty(const XmlNodePtr node,
const char *const name,
int def) A_WARN_UNUSED;
/**
* Gets an integer property from an XmlNodePtr.
*/
int getIntProperty(const XmlNodePtr node,
const char *const name,
int def,
const int min,
const int max) A_WARN_UNUSED;
/**
* Gets a string property from an XmlNodePtr.
*/
std::string getProperty(const XmlNodePtr node,
const char *const name,
const std::string &def) A_WARN_UNUSED;
/**
* Gets a translated string property from an XmlNodePtr.
*/
std::string langProperty(const XmlNodePtr node,
const char *const name,
const std::string &def) A_WARN_UNUSED;
/**
* Gets a boolean property from an XmlNodePtr.
*/
bool getBoolProperty(const XmlNodePtr node,
const char *const name,
const bool def) A_WARN_UNUSED;
/**
* Finds the first child node with the given name
*/
XmlNodePtr findFirstChildByName(const XmlNodePtrConst parent,
const char *const name) A_WARN_UNUSED;
void initXML();
void cleanupXML();
} // namespace XML
#define for_each_xml_child_node(var, parent) \
for (XmlNodePtr var = parent->xmlChildrenNode; var; var = var->next)
#endif // UTILS_XML_H
|
