GXmlNode.cpp
12.4 KB
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
/***************************************************************************
* GXmlNode.cpp - Abstract XML node base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2012 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* 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 3 of the License, or *
* (at your option) 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/>. *
* *
***************************************************************************/
/**
* @file GXmlNode.cpp
* @brief Abstract XML node base class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GException.hpp"
#include "GXmlNode.hpp"
#include "GXmlElement.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_APPEND "GXmlNode::append(GXmlNode*)"
#define G_CHILD1 "GXmlNode* GXmlNode::child(int)"
#define G_ELEMENT1 "GXmlNode* GXmlNode::element(int)"
#define G_ELEMENT2 "GXmlNode* GXmlNode::element(std::string&, int)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GXmlNode::GXmlNode(void)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] node XML node.
***************************************************************************/
GXmlNode::GXmlNode(const GXmlNode& node)
{
// Initialise members
init_members();
// Copy members
copy_members(node);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GXmlNode::~GXmlNode(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] node XML node.
***************************************************************************/
GXmlNode& GXmlNode::operator= (const GXmlNode& node)
{
// Execute only if object is not identical
if (this != &node) {
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(node);
} // endif: object was not identical
// Return
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Append child node to node
*
* @param[in] node Child node.
*
* @exception GException::file_open_error
* Unable to open XML file (write access requested).
***************************************************************************/
void GXmlNode::append(GXmlNode* node)
{
// Make sure that node is not a document (only the root document is
// allowed to exist in a XML document
if (node->type() == NT_DOCUMENT) {
throw GException::xml_bad_node_type(G_APPEND, "GXmlDocument",
"Only the root node is of type GXmlDocument.");
}
// Append node
m_nodes.push_back(node);
// Return
return;
}
/***********************************************************************//**
* @brief Return number of children of node
***************************************************************************/
int GXmlNode::children(void) const
{
// Return number of nodes
return m_nodes.size();
}
/***********************************************************************//**
* @brief Return pointer on child node
*
* @param[in] index Index of node (0,1,2,...)
*
* @exception GException::out_of_range
* Node index is out of range.
***************************************************************************/
GXmlNode* GXmlNode::child(int index) const
{
// If index is outside boundary then throw an error
if (index < 0 || index >= children()) {
throw GException::out_of_range(G_CHILD1, index, 0, children()-1);
}
// Return node
return m_nodes[index];
}
/***********************************************************************//**
* @brief Return number of child elements in node
*
* The number of child elements is the number of nodes of type NT_ELEMENT.
***************************************************************************/
int GXmlNode::elements(void) const
{
// Compute number of child elements in node
int elements = 0;
for (int i = 0; i < children(); ++i) {
if (child(i)->type() == NT_ELEMENT) {
elements++;
}
}
// Return number of child elements
return elements;
}
/***********************************************************************//**
* @brief Return number of child elements of given name in node
*
* @param[in] name Name of child elements.
*
* The number of child elements is the number of nodes of type NT_ELEMENT
* that have the same name as is specified by the argument.
***************************************************************************/
int GXmlNode::elements(const std::string& name) const
{
// Compute number of child elements in node
int elements = 0;
for (int i = 0; i < children(); ++i) {
if (child(i)->type() == NT_ELEMENT) {
if (static_cast<GXmlElement*>(child(i))->name() == name) {
elements++;
}
}
}
// Return number of child elements
return elements;
}
/***********************************************************************//**
* @brief Return pointer on child element
*
* @param[in] index Index of child element (0,1,2,...)
*
* @exception GException::out_of_range
* Child element index is out of range.
***************************************************************************/
GXmlNode* GXmlNode::element(int index) const
{
// If index is outside boundary then throw an error
if (index < 0 || index >= elements()) {
throw GException::out_of_range(G_ELEMENT1, index, 0, elements()-1);
}
// Compute number of child elements in node
GXmlNode* element = NULL;
int elements = 0;
for (int i = 0; i < children(); ++i) {
if (child(i)->type() == NT_ELEMENT) {
if (elements == index) {
element = child(i);
break;
}
elements++;
}
}
// Return child element
return element;
}
/***********************************************************************//**
* @brief Return pointer on child element of a given name
*
* @param[in] name Name of child elements.
* @param[in] index Index of child element (0,1,2,...)
*
* @exception GException::xml_name_not_found
* Child element name not found.
* @exception GException::out_of_range
* Child element index is out of range.
***************************************************************************/
GXmlNode* GXmlNode::element(const std::string& name, int index) const
{
// Determine number of child elements
int n = elements(name);
// Signal if no children exist
if (n < 1) {
throw GException::xml_name_not_found(G_ELEMENT2, name);
}
// If index is outside boundary then throw an error
if (index < 0 || index >= n) {
throw GException::out_of_range(G_ELEMENT2, index, 0, n-1);
}
// Compute number of child elements in node
GXmlNode* element = NULL;
int elements = 0;
for (int i = 0; i < children(); ++i) {
if (child(i)->type() == NT_ELEMENT) {
if (static_cast<GXmlElement*>(child(i))->name() == name) {
if (elements == index) {
element = child(i);
break;
}
elements++;
}
}
}
// Return child element
return element;
}
/***********************************************************************//**
* @brief Print comment in string
***************************************************************************/
std::string GXmlNode::print(void) const
{
// Set result string
std::string result = print(0);
// Return
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GXmlNode::init_members(void)
{
// Initialise members
m_nodes.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] node Object from which members which should be copied.
***************************************************************************/
void GXmlNode::copy_members(const GXmlNode& node)
{
// Copy nodes
m_nodes.clear();
for (int i = 0; i < node.m_nodes.size(); ++i) {
m_nodes.push_back((node.m_nodes[i]->clone()));
}
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
*
* As container classes that hold pointers need to handle themselves the
* proper deallocation of memory, we loop here over all pointers and make
* sure that we deallocate the associated nodes.
***************************************************************************/
void GXmlNode::free_members(void)
{
// Free memory for all nodes
for (int i = 0; i < m_nodes.size(); ++i) {
delete m_nodes[i];
m_nodes[i] = NULL;
}
// Return
return;
}