GXmlNode.hpp
6.14 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
/***************************************************************************
* GXmlNode.hpp - Abstract XML node base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2014 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.hpp
* @brief Abstract XML node base class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GXMLNODE_HPP
#define GXMLNODE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GContainer.hpp"
#include "GUrl.hpp"
/* __ Forward declarations _______________________________________________ */
class GXmlElement;
/***********************************************************************//**
* @class GXmlNode
*
* @brief Abstract XML node base class
*
* This class defines the interface for all XML nodes. Each XML node can be
* the container for a number of child nodes. The GXmlNode class is thus
* designed as a container class that holds a list of pointers of type
* GXmlNode. This allows implementing an arbitrary complex tree structure.
*
* The only member of this class is a list of XML node pointers. GXmlNode
* handles the proper allocation and deallocation of the node memory.
*
* Most methods are identical to those of the GXml class. Please refer to
* the documentation of this class for a description of the methods.
***************************************************************************/
class GXmlNode : public GContainer {
public:
// Constructors and destructors
GXmlNode(void);
GXmlNode(const GXmlNode& node);
virtual ~GXmlNode(void);
// Operators
GXmlNode& operator=(const GXmlNode& node);
GXmlNode* operator[](const int& index);
const GXmlNode* operator[](const int& index) const;
// Public enumerators
enum NodeType {
NT_DOCUMENT,
NT_ELEMENT,
NT_COMMENT,
NT_UNKNOWN,
NT_TEXT,
NT_DECLARATION,
NT_PI,
NT_TYPECOUNT
};
// Methods
virtual void clear(void) = 0;
virtual GXmlNode* clone(void) const = 0;
virtual std::string classname(void) const = 0;
virtual int size(void) const;
virtual bool is_empty(void) const;
virtual GXmlNode* set(const int& index, const GXmlNode& node);
virtual GXmlNode* append(const GXmlNode& node);
virtual GXmlElement* append(const std::string& segment);
virtual GXmlNode* insert(const int& index, const GXmlNode& node);
virtual void remove(const int& index);
virtual void reserve(const int& num);
virtual void extend(const GXmlNode& node);
virtual int elements(void) const;
virtual int elements(const std::string& name) const;
virtual GXmlElement* element(const int& index);
virtual const GXmlElement* element(const int& index) const;
virtual GXmlElement* element(const std::string& name);
virtual const GXmlElement* element(const std::string& name) const;
virtual GXmlElement* element(const std::string& name, const int& index);
virtual const GXmlElement* element(const std::string& name, const int& index) const;
virtual void write(GUrl& url, const int& indent) const = 0;
virtual NodeType type(void) const = 0;
virtual std::string print(const GChatter& chatter = NORMAL,
const int& indent = 0) const = 0;
virtual std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GXmlNode& node);
void free_members(void);
int extract_index(std::string& tag) const;
// Protected data members
std::vector<GXmlNode*> m_nodes; //!< Pointer to child nodes
};
/***********************************************************************//**
* @brief Return number of child nodes
*
* @return Number of child nodes in node.
***************************************************************************/
inline
int GXmlNode::size(void) const
{
return m_nodes.size();
}
/***********************************************************************//**
* @brief Signals if node has no child nodes
*
* @return True if node has no child nodes.
***************************************************************************/
inline
bool GXmlNode::is_empty(void) const
{
return m_nodes.empty();
}
/***********************************************************************//**
* @brief Reserve space for child nodes
*
* @param[in] num Number of child nodes for which space should be reserved.
***************************************************************************/
inline
void GXmlNode::reserve(const int& num)
{
m_nodes.reserve(num);
return;
}
#endif /* GXMLNODE_HPP */