GXmlDocument.hpp
7.04 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
/***************************************************************************
* GXmlDocument.hpp - XML document node class definition *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2016 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 GXmlDocument.hpp
* @brief XML document node class interface definition
* @author Juergen Knodlseder
*/
#ifndef GXMLDOCUMENT_HPP
#define GXMLDOCUMENT_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GUrl.hpp"
#include "GFilename.hpp"
#include "GXmlNode.hpp"
#include "GXmlAttribute.hpp"
/***********************************************************************//**
* @class GXmlDocument
*
* @brief XML document node class
*
* This class implements the root node of an XML document. The root node is
* a Processing Instruction which contains the following attributes:
* - @p version
* - @p encoding
* - @p standalone
*
* All three attributes are systematically written.
***************************************************************************/
class GXmlDocument : public GXmlNode {
public:
// Constructors and destructors
GXmlDocument(void);
GXmlDocument(const GXmlDocument& node);
virtual ~GXmlDocument(void);
// Operators
GXmlDocument& operator=(const GXmlDocument& node);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GXmlDocument* clone(void) const;
virtual std::string classname(void) const;
virtual void write(GUrl& url, const int& indent = 0) const;
virtual NodeType type(void) const;
virtual std::string print(const GChatter& chatter = NORMAL,
const int& indent = 0) const;
// Methods
const GFilename& filename(void) const;
std::string version(void) const;
std::string encoding(void) const;
std::string standalone(void) const;
void filename(const GFilename& filename);
void version(const std::string& version);
void encoding(const std::string& encoding);
void standalone(const std::string& standalone);
protected:
// Protected methods
void init_members(void);
void copy_members(const GXmlDocument& node);
void free_members(void);
// Protected data members
GFilename m_filename; //!< Name of XML file
GXmlAttribute m_version; //!< XML version ("1.0", "1.1")
GXmlAttribute m_encoding; //!< Encoding (e.g. "UTF-8")
GXmlAttribute m_standalone; //!< Standalone ("yes", "no")
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GXmlDocument").
***************************************************************************/
inline
std::string GXmlDocument::classname(void) const
{
return ("GXmlDocument");
}
/***********************************************************************//**
* @brief Return filename
*
* @return Filename of XML document.
***************************************************************************/
inline
const GFilename& GXmlDocument::filename(void) const
{
return (m_filename);
}
/***********************************************************************//**
* @brief Return version
*
* @return Version string.
***************************************************************************/
inline
std::string GXmlDocument::version(void) const
{
return (m_version.value());
}
/***********************************************************************//**
* @brief Return encoding
*
* @return Encoding string.
***************************************************************************/
inline
std::string GXmlDocument::encoding(void) const
{
return (m_encoding.value());
}
/***********************************************************************//**
* @brief Return standalone
*
* @return Standalone value string.
***************************************************************************/
inline
std::string GXmlDocument::standalone(void) const
{
return (m_standalone.value());
}
/***********************************************************************//**
* @brief Set filename
*
* @param[in] filename Filename of XML document.
***************************************************************************/
inline
void GXmlDocument::filename(const GFilename& filename)
{
m_filename = filename;
return;
}
/***********************************************************************//**
* @brief Set version
*
* @param[in] version Version string.
***************************************************************************/
inline
void GXmlDocument::version(const std::string& version)
{
m_version.value(version);
return;
}
/***********************************************************************//**
* @brief Set encoding
*
* @param[in] encoding Encoding string.
***************************************************************************/
inline
void GXmlDocument::encoding(const std::string& encoding)
{
m_encoding.value(encoding);
return;
}
/***********************************************************************//**
* @brief Set standalone
*
* @param[in] standalone Standalone value string.
***************************************************************************/
inline
void GXmlDocument::standalone(const std::string& standalone)
{
m_standalone.value(standalone);
return;
}
/***********************************************************************//**
* @brief Return XML node type
*
* @return XML node type (NT_DOCUMENT).
***************************************************************************/
inline
GXmlNode::NodeType GXmlDocument::type(void) const
{
return (NT_DOCUMENT);
}
#endif /* GXMLDOCUMENT_HPP */