GXmlComment.cpp
9.73 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
/***************************************************************************
* GXmlComment.cpp - XML comment node class implementation *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2011 by Jurgen Knodlseder *
* ----------------------------------------------------------------------- *
* *
* 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 *
* (at your option) any later version. *
* *
***************************************************************************/
/**
* @file GXmlComment.cpp
* @brief XML comment node class implementation
* @author J. Knodlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
//#include <stdio.h> // fopen, fgets, fclose, etc...
#include <iostream>
#include <cstdio> // fopen, fgets, fclose, etc...
#include "GException.hpp"
#include "GXmlComment.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_PARSE "GXmlComment::parse(std::string&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GXmlComment::GXmlComment(void) : GXmlNode()
{
// Initialise private members for clean destruction
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] node Object from which the instance should be built.
***************************************************************************/
GXmlComment::GXmlComment(const GXmlComment& node) : GXmlNode(node)
{
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(node);
// Return
return;
}
/***********************************************************************//**
* @brief Segment constructor
*
* @param[in] text Text for instance building.
***************************************************************************/
GXmlComment::GXmlComment(const std::string& segment) : GXmlNode()
{
// Initialise private members for clean destruction
init_members();
// Parse segment
parse(segment);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GXmlComment::~GXmlComment(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] node Object which should be assigned.
***************************************************************************/
GXmlComment& GXmlComment::operator= (const GXmlComment& node)
{
// Execute only if object is not identical
if (this != &node) {
// Copy base class members
this->GXmlNode::operator=(node);
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(node);
} // endif: object was not identical
// Return
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear object.
*
* This method properly resets the object to an initial state.
***************************************************************************/
void GXmlComment::clear(void)
{
// Free class members (base and derived classes, derived class first)
free_members();
this->GXmlNode::free_members();
// Initialise members
this->GXmlNode::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Write comment into file
*
* @param[in] fptr File pointer.
***************************************************************************/
void GXmlComment::write(FILE* fptr, int indent) const
{
// Write comment into file
for (int k = 0; k < indent; ++k)
fprintf(fptr, " ");
fprintf(fptr, "<!--%s-->\n", m_comment.c_str());
// Return
return;
}
/***********************************************************************//**
* @brief Print comment in output stream
*
* @param[in] os Output stream into which the node will be printed.
***************************************************************************/
void GXmlComment::print(std::ostream& os, int indent) const
{
// Put comment into output stream
for (int k = 0; k < indent; ++k)
os << " ";
os << "GXmlComment::" << m_comment;
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GXmlComment::init_members(void)
{
// Initialise members
m_comment.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] node Object from which members which should be copied.
***************************************************************************/
void GXmlComment::copy_members(const GXmlComment& node)
{
// Copy attributes
m_comment = node.m_comment;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GXmlComment::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Clone class
***************************************************************************/
GXmlComment* GXmlComment::clone(void) const
{
return new GXmlComment(*this);
}
/***********************************************************************//**
* @brief Parse comment segment string
*
* @param[in] segement Segment string.
*
* @exception GException::xml_syntax_error
* XML syntax error.
*
* Parse the segment string and extract the comment.
*
* @TODO Check validity of characters in comment string
***************************************************************************/
void GXmlComment::parse(const std::string& segment)
{
// Initialise comment string
m_comment.clear();
// Get length of segment
int n = segment.length();
// Do nothing if string is empty
if (n > 0) {
// If string starts with brackets then check that the brackets are
// valid comment brackets
if (segment[0] == '<') {
if (n < 7 || (segment.compare(0,4,"<!--") != 0) &&
(segment.compare(n-3,3,"-->") != 0))
throw GException::xml_syntax_error(G_PARSE, segment,
"invalid comment brackets");
else
m_comment = segment.substr(4, n-7);
}
else
m_comment = segment;
//TODO Check validity of characters comment string
} // endif: string is not empty
// Return
return;
}
/*==========================================================================
= =
= Friends =
= =
==========================================================================*/