GXmlAttribute.cpp
12.1 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
/***************************************************************************
* GXmlAttribute.cpp - XML attribute class implementation *
* ----------------------------------------------------------------------- *
* 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 GXmlAttribute.cpp
* @brief XML attribute class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GException.hpp"
#include "GTools.hpp"
#include "GXmlAttribute.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_VALUE "GXmlAttribute::value(std::string)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GXmlAttribute::GXmlAttribute(void)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] attr Element attribute.
***************************************************************************/
GXmlAttribute::GXmlAttribute(const GXmlAttribute& attr)
{
// Initialise members
init_members();
// Copy members
copy_members(attr);
// Return
return;
}
/***********************************************************************//**
* @brief Name-Value pair constructor
*
* @param[in] name Attribute name.
* @param[in] value Attribute value.
*
* Construct attribute form a p@ name and a @p value. Predefined entities
* (e.g. ") in attribute values are automatically converted into normal
* characters.
***************************************************************************/
GXmlAttribute::GXmlAttribute(const std::string& name, const std::string& value)
{
// Initialise members
init_members();
// Set attribute
this->name(name);
this->value(gammalib::xml2str(value));
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GXmlAttribute::~GXmlAttribute(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] attr Element attribute.
* @return Element attribute.
***************************************************************************/
GXmlAttribute& GXmlAttribute::operator=(const GXmlAttribute& attr)
{
// Execute only if object is not identical
if (this != &attr) {
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(attr);
} // endif: object was not identical
// Return
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear element attribute
*
* Resets element attribute to a clean initial state.
***************************************************************************/
void GXmlAttribute::clear(void)
{
// Free members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone element attribute
*
* @return Pointer to deep copy of an element attribute.
***************************************************************************/
GXmlAttribute* GXmlAttribute::clone(void) const
{
// Clone XML attribute
return new GXmlAttribute(*this);
}
/***********************************************************************//**
* @brief Write attribute into URL
*
* @param[in] url Unified Resource Locator.
*
* Writes the element attribute into the @p url. Special characters are
* automatically transformed into predefined entities (e.g. ").
***************************************************************************/
void GXmlAttribute::write(GUrl& url) const
{
// Get value without quotation marks
std::string value = m_value.substr(1, m_value.length()-2);
// Convert value to XML format
value = "\""+gammalib::str2xml(value)+"\"";
// Write attribute into URL
url.printf(" %s=%s", m_name.c_str(), value.c_str());
// Return
return;
}
/***********************************************************************//**
* @brief Print element attribute
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing element attribute.
***************************************************************************/
std::string GXmlAttribute::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append attribute to string
result.append(" "+m_name+"="+m_value);
} // endif: chatter was not silent
// Return
return result;
}
/***********************************************************************//**
* @brief Returns attribute value
*
* @return String containing the attribute value without hyphens.
*
* Returns the attribute value by stripping the hyphens.
***************************************************************************/
std::string GXmlAttribute::value(void) const
{
// Initialise attribute value
std::string value = "";
// Extract value by stripping hyphens
int n = m_value.length();
if (n > 2) {
value = m_value.substr(1, n-2);
}
// Return value
return value;
}
/***********************************************************************//**
* @brief Set attribute value
*
* @param[in] value Attribute value.
*
* @exception GException::xml_attribute_value
* Invalid XML attribute value.
*
* Sets the value of the attribute. The method automatically adds the proper
* hyphens to the value string if they do not exist.
***************************************************************************/
void GXmlAttribute::value(std::string value)
{
// Get length of value string
int n = value.length();
// Count hyphens and signal their presence at start/end
int n_hyphens1 = 0;
int n_hyphens2 = 0;
bool has_hyphens1 = (n >= 2 && value[0] == '\'' && value[n-1] == '\'');
bool has_hyphens2 = (n >= 2 && value[0] == '"' && value[n-1] == '"');
for (int i = 0; i < n; ++i) {
if (value[i] == '\'') n_hyphens1++;
if (value[i] == '"') n_hyphens2++;
}
// Case A: value has ' start and end hyphens. Keep value as is if no other
// ' hyphens are found. Otherwise, if more than 2 ' but no " hyphen is found
// then enclose the value in " hyphens. Finally, if more than 2 ' and at
// least one " hyphen is found we have an invalid value and throw an
// exception.
if (has_hyphens1) {
if (n_hyphens1 > 2 && n_hyphens2 == 0) {
value = "\"" + value + "\"";
}
else if (n_hyphens1 > 2 && n_hyphens2 > 0) {
throw GException::xml_attribute_value(G_VALUE, value);
}
}
// Case B: value has " start and end hyphens. Keep value as is if no other
// " hyphens are found. Otherwise, if more than 2 " but no ' hyphen is found
// then enclose the value in ' hyphens. Finally, if more than 2 " and at
// least one ' hyphen is found we have an invalid value and throw an
// exception.
else if (has_hyphens2) {
if (n_hyphens1 == 0 && n_hyphens2 > 2) {
value = "'" + value + "'";
}
else if (n_hyphens1 > 0 && n_hyphens2 > 2) {
throw GException::xml_attribute_value(G_VALUE, value);
}
}
// Case C: value has no start and end hyphens.
else {
if (n_hyphens1 >= 0 && n_hyphens2 == 0) {
value = "\"" + value + "\"";
}
else if (n_hyphens1 == 0 && n_hyphens2 > 0) {
value = "'" + value + "'";
}
else {
throw GException::xml_attribute_value(G_VALUE, value);
}
}
// Set value
m_value = value;
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GXmlAttribute::init_members(void)
{
// Initialise members
m_name.clear();
m_value.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] attr Element attribute.
***************************************************************************/
void GXmlAttribute::copy_members(const GXmlAttribute& attr)
{
// Copy attributes
m_name = attr.m_name;
m_value = attr.m_value;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GXmlAttribute::free_members(void)
{
// Return
return;
}