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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
#ifndef XMLELEMENTS_H
#define XMLELEMENTS_H
#include <string>
#include "Tools.h"
//----------------------------------------------------------------------------
class XMLVisitor;
class XMLConstVisitor;
//----------------------------------------------------------------------------
#define DECLARE_XML_VISITOR_API() \
void do_accept(XMLVisitor &v); \
void do_accept(XMLConstVisitor &v) const
//----------------------------------------------------------------------------
#define DECLARE_XML_VISITOR_API_BODY(C) \
void C::do_accept(XMLVisitor &v) { v.visit(this); } \
void C::do_accept(XMLConstVisitor &v) const { v.visit(this); }
//----------------------------------------------------------------------------
/**
* This is a base class for all XML elements.
*/
class XMLElement
{
protected:
//------------------------------------------------------------------------
XMLElement() {}
XMLElement(const std::string &name) : m_name(name) {}
public:
//------------------------------------------------------------------------
virtual ~XMLElement() = 0;
//------------------------------------------------------------------------
inline const std::string &getName() const { return m_name; }
//------------------------------------------------------------------------
inline void accept(XMLVisitor &v) { do_accept(v); }
inline void accept(XMLConstVisitor &v) const { do_accept(v); }
private:
//------------------------------------------------------------------------
virtual void do_accept(XMLVisitor &v) = 0;
virtual void do_accept(XMLConstVisitor &v) const = 0;
//------------------------------------------------------------------------
std::string m_name;
};
//----------------------------------------------------------------------------
/**
* This class represents a property of an XML node.
*/
class XMLProperty : public XMLElement
{
public:
//------------------------------------------------------------------------
XMLProperty(const std::string &name, const bool value);
XMLProperty(const std::string &name, const int value);
XMLProperty(const std::string &name, const unsigned value);
XMLProperty(const std::string &name, const char *value);
XMLProperty(const std::string &name, const std::string &value);
~XMLProperty();
//------------------------------------------------------------------------
XMLProperty *clone() const;
//------------------------------------------------------------------------
void setValue(const bool value);
void setValue(const int value);
void setValue(const unsigned value);
void setValue(const char *value);
void setValue(const std::string &value);
//------------------------------------------------------------------------
inline const std::string &getValue() const { return m_value; }
//------------------------------------------------------------------------
/**
* @return The value of this property as bool.
* @throw XMLException if the value cannot be converted to a bool.
*/
bool getAsBool() const;
/**
* @return The value of this property as int.
* @throw XMLException if the value cannot be converted to an int.
*/
int getAsInt() const;
/**
* @return The value of this property as unsigned.
* @throw XMLException if the value cannot be converted to an unsigned.
*/
unsigned getAsUnsigned() const;
private:
//------------------------------------------------------------------------
DECLARE_XML_VISITOR_API();
//------------------------------------------------------------------------
std::string m_value;
};
//----------------------------------------------------------------------------
/**
* This class represents a text within an XML node.
*/
class XMLText : public XMLElement
{
public:
//------------------------------------------------------------------------
XMLText(const std::string &text);
~XMLText();
//------------------------------------------------------------------------
inline void setText(const std::string &text) { m_text = text; }
inline const std::string &getText() const { return m_text; }
private:
//------------------------------------------------------------------------
DECLARE_XML_VISITOR_API();
//------------------------------------------------------------------------
std::string m_text;
};
//----------------------------------------------------------------------------
/**
* This class represents an XML node.
* It can contain XML properties and further XML nodes.
*/
class XMLNode : public XMLElement
{
public:
//------------------------------------------------------------------------
XMLNode();
XMLNode(const std::string &name);
~XMLNode();
//------------------------------------------------------------------------
void clear();
//------------------------------------------------------------------------
bool empty() const;
//------------------------------------------------------------------------
/**
* @param p The property to add to this node.
*/
void addProperty(XMLProperty *p);
/**
* @param p The property to remove from this node.
*/
void removeProperty(const XMLProperty *p);
/**
* @param name The name of the property to get.
* @return A pointer to the property with the given name.
* @throw XMLException if no such property exists.
*/
XMLProperty *getMandatoryProperty(const std::string &name);
/**
* @param name The name of the property to get.
* @return A const pointer to the property with the given name.
* @throw XMLException if no such property exists.
*/
const XMLProperty *getMandatoryProperty(const std::string &name) const;
/**
* @param name The name of the property to get.
* @return A pointer to the property with the given name,
* or NULL, if no such property exists.
*/
XMLProperty *getProperty(const std::string &name);
/**
* @param name The name of the property to get.
* @return A const pointer to the property with the given name,
* or NULL, if no such property exists.
*/
const XMLProperty *getProperty(const std::string &name) const;
/**
* @param name The name of the property to check for.
* @return true, if the property exists, else false.
*/
bool hasProperty(const std::string &name) const;
/**
* @return true, if this node has properties.
*/
bool hasProperties() const;
/**
* @return The number of properties in this node.
*/
size_t getNumberOfProperties() const;
//------------------------------------------------------------------------
/**
* @param t The text node to add to this node.
*/
void addText(XMLText *t);
/**
* @param t The text node to remove from this node.
*/
void removeText(const XMLText *t);
/**
* @return true, if a text node exists, else false.
*/
bool hasText() const;
/**
* @return A pointer to the text node.
* @throw XMLException if no text node exists.
*/
const std::string &getText() const;
//------------------------------------------------------------------------
/**
* @param n The node to add to this node.
*/
void addNode(XMLNode *n);
/**
* @param n The node to remove from this node.
*/
void removeNode(const XMLNode *n);
/**
* @param name The name of the node to get.
* @return A pointer to the node with the given name.
* @throw XMLException if no such node exists.
*/
XMLNode *getMandatoryNode(const std::string &name);
/**
* @param name The name of the node to get.
* @return A const pointer to the node with the given name.
* @throw XMLException if no such node exists.
*/
const XMLNode *getMandatoryNode(const std::string &name) const;
/**
* @param name The name of the node to get.
* @return A pointer to the node with the given name,
* or NULL, if no such node exists.
*/
XMLNode *getNode(const std::string &name);
/**
* @param name The name of the node to get.
* @return A const pointer to the node with the given name,
* or NULL, if no such node exists.
*/
const XMLNode *getNode(const std::string &name) const;
/**
* @return A pointer to the first node or NULL, if no child nodes exist.
*/
XMLNode *getFirstNode();
/**
* @return A pointer to the first node,
* or NULL, if no child nodes exist.
*/
const XMLNode *getFirstNode() const;
/**
* @param name The name of the node to pop.
* @return A pointer to the node with the given name,
* or NULL, if no such node exists.
*/
XMLNode *popNode(const std::string &name);
/**
* @return A pointer to the first node,
* or NULL, if no child nodes exist.
*/
XMLNode *popFirstNode();
/**
* @param name The name of the node to check for.
* @return true, if the node exists, else false.
*/
bool hasNode(const std::string &name) const;
/**
* @return true, if this node has child nodes.
*/
bool hasNodes() const;
/**
* @return The number of nodes in this node.
*/
size_t getNumberOfNodes() const;
//------------------------------------------------------------------------
/**
* @param name The name of the property to search for.
* @return The string value of the found property.
* @throw XMLException if no such property exists.
*/
const std::string &getStringProperty(const std::string &name) const;
/**
* @param name The name of the property to search for.
* @param defaultValue The default value to return,
* if the property doesn't exist.
* @return The string value of the found property,
* or the given default value, if the property doesn't exist.
*/
const std::string &getStringProperty(const std::string &name,
const std::string &defaultValue) const;
/**
* @param name The name of the property to search for.
* @return The bool value of the found property.
* @throw XMLException if no such property exists, or the propertie's
* value cannot be converted to a bool.
*/
bool getBoolProperty(const std::string &name) const;
/**
* @param name The name of the property to search for.
* @param defaultValue The default value to return,
* if the property doesn't exist.
* @return The bool value of the found property,
* or the given default value, if the property doesn't exist.
* @throw XMLException if the propertie's value cannot be converted
* to a bool.
*/
bool getBoolProperty(const std::string &name,
const bool defaultValue) const;
/**
* @param name The name of the property to search for.
* @return The int value of the found property.
* @throw XMLException if no such property exists, or the propertie's
* value cannot be converted to an int.
*/
int getIntProperty(const std::string &name) const;
/**
* @param name The name of the property to search for.
* @param defaultValue The default value to return,
* if the property doesn't exist.
* @return The int value of the found property,
* or the given default value, if the property doesn't exist.
* @throw XMLException if the propertie's value cannot be converted
* to an int.
*/
int getIntProperty(const std::string &name,
const int defaultValue) const;
/**
* @param name The name of the property to search for.
* @return The unsigned value of the found property.
* @throw XMLException if no such property exists, or the propertie's
* value cannot be converted to an unsigned.
*/
unsigned getUnsignedProperty(const std::string &name) const;
/**
* @param name The name of the property to search for.
* @param defaultValue The default value to return,
* if the property doesn't exist.
* @return The unsigned value of the found property,
* or the given default value, if the property doesn't exist.
* @throw XMLException if the propertie's value cannot be converted
* to an unsigned.
*/
unsigned getUnsignedProperty(const std::string &name,
const unsigned defaultValue) const;
//------------------------------------------------------------------------
void acceptAllProperties(XMLVisitor &v);
void acceptAllProperties(XMLConstVisitor &v) const;
//------------------------------------------------------------------------
void acceptAllNodes(XMLVisitor &v);
void acceptAllNodes(XMLConstVisitor &v) const;
//------------------------------------------------------------------------
void acceptAllChilds(XMLVisitor &v);
void acceptAllChilds(XMLConstVisitor &v) const;
private:
//------------------------------------------------------------------------
DECLARE_XML_VISITOR_API();
//------------------------------------------------------------------------
DECLARE_PIMPL;
};
#endif //XMLELEMENTS_H
|
