rapidxml_print.hpp
Go to the documentation of this file.
1 #ifndef RAPIDXML_PRINT_HPP_INCLUDED
2 #define RAPIDXML_PRINT_HPP_INCLUDED
3 
4 // Copyright (C) 2006, 2009 Marcin Kalicinski
5 // Version 1.13
6 // Revision $DateTime: 2009/05/13 01:46:17 $
8 
9 #include "rapidxml.hpp"
10 
11 // Only include streams if not disabled
12 #ifndef RAPIDXML_NO_STREAMS
13  #include <ostream>
14  #include <iterator>
15 #endif
16 
17 namespace rapidxml
18 {
19 
21  // Printing flags
22 
23  const int print_no_indenting = 0x1;
24 
26  // Internal
27 
29  namespace internal
30  {
31 
33  // Internal character operations
34 
35  // Copy characters from given range to given output iterator
36  template<class OutIt, class Ch>
37  inline OutIt copy_chars(const Ch *begin, const Ch *end, OutIt out)
38  {
39  while (begin != end)
40  *out++ = *begin++;
41  return out;
42  }
43 
44  // Copy characters from given range to given output iterator and expand
45  // characters into references (&lt; &gt; &apos; &quot; &amp;)
46  template<class OutIt, class Ch>
47  inline OutIt copy_and_expand_chars(const Ch *begin, const Ch *end, Ch noexpand, OutIt out)
48  {
49  while (begin != end)
50  {
51  if (*begin == noexpand)
52  {
53  *out++ = *begin; // No expansion, copy character
54  }
55  else
56  {
57  switch (*begin)
58  {
59  case Ch('<'):
60  *out++ = Ch('&'); *out++ = Ch('l'); *out++ = Ch('t'); *out++ = Ch(';');
61  break;
62  case Ch('>'):
63  *out++ = Ch('&'); *out++ = Ch('g'); *out++ = Ch('t'); *out++ = Ch(';');
64  break;
65  case Ch('\''):
66  *out++ = Ch('&'); *out++ = Ch('a'); *out++ = Ch('p'); *out++ = Ch('o'); *out++ = Ch('s'); *out++ = Ch(';');
67  break;
68  case Ch('"'):
69  *out++ = Ch('&'); *out++ = Ch('q'); *out++ = Ch('u'); *out++ = Ch('o'); *out++ = Ch('t'); *out++ = Ch(';');
70  break;
71  case Ch('&'):
72  *out++ = Ch('&'); *out++ = Ch('a'); *out++ = Ch('m'); *out++ = Ch('p'); *out++ = Ch(';');
73  break;
74  default:
75  *out++ = *begin; // No expansion, copy character
76  }
77  }
78  ++begin; // Step to next character
79  }
80  return out;
81  }
82 
83  // Fill given output iterator with repetitions of the same character
84  template<class OutIt, class Ch>
85  inline OutIt fill_chars(OutIt out, int n, Ch ch)
86  {
87  for (int i = 0; i < n; ++i)
88  *out++ = ch;
89  return out;
90  }
91 
92  // Find character
93  template<class Ch, Ch ch>
94  inline bool find_char(const Ch *begin, const Ch *end)
95  {
96  while (begin != end)
97  if (*begin++ == ch)
98  return true;
99  return false;
100  }
101 
103  // Internal printing operations
104  template<class OutIt, class Ch>
105  inline OutIt print_children(OutIt out, const xml_node<Ch> *node, int flags, int indent);
106  template<class OutIt, class Ch>
107  inline OutIt print_data_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
108  template<class OutIt, class Ch>
109  inline OutIt print_element_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
110  template<class OutIt, class Ch>
111  inline OutIt print_cdata_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
112  template<class OutIt, class Ch>
113  inline OutIt print_declaration_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
114  template<class OutIt, class Ch>
115  inline OutIt print_comment_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
116  template<class OutIt, class Ch>
117  inline OutIt print_doctype_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
118  template<class OutIt, class Ch>
119  inline OutIt print_pi_node(OutIt out, const xml_node<Ch> *node, int flags, int indent);
120 
121 
122  // Print node
123  template<class OutIt, class Ch>
124  inline OutIt print_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
125  {
126  // Print proper node type
127  switch (node->type())
128  {
129 
130  // Document
131  case node_document:
132  out = print_children(out, node, flags, indent);
133  break;
134 
135  // Element
136  case node_element:
137  out = print_element_node(out, node, flags, indent);
138  break;
139 
140  // Data
141  case node_data:
142  out = print_data_node(out, node, flags, indent);
143  break;
144 
145  // CDATA
146  case node_cdata:
147  out = print_cdata_node(out, node, flags, indent);
148  break;
149 
150  // Declaration
151  case node_declaration:
152  out = print_declaration_node(out, node, flags, indent);
153  break;
154 
155  // Comment
156  case node_comment:
157  out = print_comment_node(out, node, flags, indent);
158  break;
159 
160  // Doctype
161  case node_doctype:
162  out = print_doctype_node(out, node, flags, indent);
163  break;
164 
165  // Pi
166  case node_pi:
167  out = print_pi_node(out, node, flags, indent);
168  break;
169 
170  // Unknown
171  default:
172  assert(0);
173  break;
174  }
175 
176  // If indenting not disabled, add line break after node
177  if (!(flags & print_no_indenting))
178  *out = Ch('\n'), ++out;
179 
180  // Return modified iterator
181  return out;
182  }
183 
184  // Print children of the node
185  template<class OutIt, class Ch>
186  inline OutIt print_children(OutIt out, const xml_node<Ch> *node, int flags, int indent)
187  {
188  for (xml_node<Ch> *child = node->first_node(); child; child = child->next_sibling())
189  out = print_node(out, child, flags, indent);
190  return out;
191  }
192 
193  // Print attributes of the node
194  template<class OutIt, class Ch>
195  inline OutIt print_attributes(OutIt out, const xml_node<Ch> *node, int flags)
196  {
197  for (xml_attribute<Ch> *attribute = node->first_attribute(); attribute; attribute = attribute->next_attribute())
198  {
199  if (attribute->name() && attribute->value())
200  {
201  // Print attribute name
202  *out = Ch(' '), ++out;
203  out = copy_chars(attribute->name(), attribute->name() + attribute->name_size(), out);
204  *out = Ch('='), ++out;
205  // Print attribute value using appropriate quote type
206  if (find_char<Ch, Ch('"')>(attribute->value(), attribute->value() + attribute->value_size()))
207  {
208  *out = Ch('\''), ++out;
209  out = copy_and_expand_chars(attribute->value(), attribute->value() + attribute->value_size(), Ch('"'), out);
210  *out = Ch('\''), ++out;
211  }
212  else
213  {
214  *out = Ch('"'), ++out;
215  out = copy_and_expand_chars(attribute->value(), attribute->value() + attribute->value_size(), Ch('\''), out);
216  *out = Ch('"'), ++out;
217  }
218  }
219  }
220  return out;
221  }
222 
223  // Print data node
224  template<class OutIt, class Ch>
225  inline OutIt print_data_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
226  {
227  assert(node->type() == node_data);
228  if (!(flags & print_no_indenting))
229  out = fill_chars(out, indent, Ch('\t'));
230  out = copy_and_expand_chars(node->value(), node->value() + node->value_size(), Ch(0), out);
231  return out;
232  }
233 
234  // Print data node
235  template<class OutIt, class Ch>
236  inline OutIt print_cdata_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
237  {
238  assert(node->type() == node_cdata);
239  if (!(flags & print_no_indenting))
240  out = fill_chars(out, indent, Ch('\t'));
241  *out = Ch('<'); ++out;
242  *out = Ch('!'); ++out;
243  *out = Ch('['); ++out;
244  *out = Ch('C'); ++out;
245  *out = Ch('D'); ++out;
246  *out = Ch('A'); ++out;
247  *out = Ch('T'); ++out;
248  *out = Ch('A'); ++out;
249  *out = Ch('['); ++out;
250  out = copy_chars(node->value(), node->value() + node->value_size(), out);
251  *out = Ch(']'); ++out;
252  *out = Ch(']'); ++out;
253  *out = Ch('>'); ++out;
254  return out;
255  }
256 
257  // Print element node
258  template<class OutIt, class Ch>
259  inline OutIt print_element_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
260  {
261  assert(node->type() == node_element);
262 
263  // Print element name and attributes, if any
264  if (!(flags & print_no_indenting))
265  out = fill_chars(out, indent, Ch('\t'));
266  *out = Ch('<'), ++out;
267  out = copy_chars(node->name(), node->name() + node->name_size(), out);
268  out = print_attributes(out, node, flags);
269 
270  // If node is childless
271  if (node->value_size() == 0 && !node->first_node())
272  {
273  // Print childless node tag ending
274  *out = Ch('/'), ++out;
275  *out = Ch('>'), ++out;
276  }
277  else
278  {
279  // Print normal node tag ending
280  *out = Ch('>'), ++out;
281 
282  // Test if node contains a single data node only (and no other nodes)
283  xml_node<Ch> *child = node->first_node();
284  if (!child)
285  {
286  // If node has no children, only print its value without indenting
287  out = copy_and_expand_chars(node->value(), node->value() + node->value_size(), Ch(0), out);
288  }
289  else if (child->next_sibling() == 0 && child->type() == node_data)
290  {
291  // If node has a sole data child, only print its value without indenting
292  out = copy_and_expand_chars(child->value(), child->value() + child->value_size(), Ch(0), out);
293  }
294  else
295  {
296  // Print all children with full indenting
297  if (!(flags & print_no_indenting))
298  *out = Ch('\n'), ++out;
299  out = print_children(out, node, flags, indent + 1);
300  if (!(flags & print_no_indenting))
301  out = fill_chars(out, indent, Ch('\t'));
302  }
303 
304  // Print node end
305  *out = Ch('<'), ++out;
306  *out = Ch('/'), ++out;
307  out = copy_chars(node->name(), node->name() + node->name_size(), out);
308  *out = Ch('>'), ++out;
309  }
310  return out;
311  }
312 
313  // Print declaration node
314  template<class OutIt, class Ch>
315  inline OutIt print_declaration_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
316  {
317  // Print declaration start
318  if (!(flags & print_no_indenting))
319  out = fill_chars(out, indent, Ch('\t'));
320  *out = Ch('<'), ++out;
321  *out = Ch('?'), ++out;
322  *out = Ch('x'), ++out;
323  *out = Ch('m'), ++out;
324  *out = Ch('l'), ++out;
325 
326  // Print attributes
327  out = print_attributes(out, node, flags);
328 
329  // Print declaration end
330  *out = Ch('?'), ++out;
331  *out = Ch('>'), ++out;
332 
333  return out;
334  }
335 
336  // Print comment node
337  template<class OutIt, class Ch>
338  inline OutIt print_comment_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
339  {
340  assert(node->type() == node_comment);
341  if (!(flags & print_no_indenting))
342  out = fill_chars(out, indent, Ch('\t'));
343  *out = Ch('<'), ++out;
344  *out = Ch('!'), ++out;
345  *out = Ch('-'), ++out;
346  *out = Ch('-'), ++out;
347  out = copy_chars(node->value(), node->value() + node->value_size(), out);
348  *out = Ch('-'), ++out;
349  *out = Ch('-'), ++out;
350  *out = Ch('>'), ++out;
351  return out;
352  }
353 
354  // Print doctype node
355  template<class OutIt, class Ch>
356  inline OutIt print_doctype_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
357  {
358  assert(node->type() == node_doctype);
359  if (!(flags & print_no_indenting))
360  out = fill_chars(out, indent, Ch('\t'));
361  *out = Ch('<'), ++out;
362  *out = Ch('!'), ++out;
363  *out = Ch('D'), ++out;
364  *out = Ch('O'), ++out;
365  *out = Ch('C'), ++out;
366  *out = Ch('T'), ++out;
367  *out = Ch('Y'), ++out;
368  *out = Ch('P'), ++out;
369  *out = Ch('E'), ++out;
370  *out = Ch(' '), ++out;
371  out = copy_chars(node->value(), node->value() + node->value_size(), out);
372  *out = Ch('>'), ++out;
373  return out;
374  }
375 
376  // Print pi node
377  template<class OutIt, class Ch>
378  inline OutIt print_pi_node(OutIt out, const xml_node<Ch> *node, int flags, int indent)
379  {
380  assert(node->type() == node_pi);
381  if (!(flags & print_no_indenting))
382  out = fill_chars(out, indent, Ch('\t'));
383  *out = Ch('<'), ++out;
384  *out = Ch('?'), ++out;
385  out = copy_chars(node->name(), node->name() + node->name_size(), out);
386  *out = Ch(' '), ++out;
387  out = copy_chars(node->value(), node->value() + node->value_size(), out);
388  *out = Ch('?'), ++out;
389  *out = Ch('>'), ++out;
390  return out;
391  }
392 
393  }
395 
397  // Printing
398 
404  template<class OutIt, class Ch>
405  inline OutIt print(OutIt out, const xml_node<Ch> &node, int flags = 0)
406  {
407  return internal::print_node(out, &node, flags, 0);
408  }
409 
410 #ifndef RAPIDXML_NO_STREAMS
411 
417  template<class Ch>
418  inline std::basic_ostream<Ch> &print(std::basic_ostream<Ch> &out, const xml_node<Ch> &node, int flags = 0)
419  {
420  print(std::ostream_iterator<Ch>(out), node, flags);
421  return out;
422  }
423 
428  template<class Ch>
429  inline std::basic_ostream<Ch> &operator <<(std::basic_ostream<Ch> &out, const xml_node<Ch> &node)
430  {
431  return print(out, node);
432  }
433 
434 #endif
435 
436 }
437 
438 #endif
rapidxml::print_no_indenting
const int print_no_indenting
Printer flag instructing the printer to suppress indenting of XML. See print() function.
Definition: rapidxml_print.hpp:23
rapidxml::print
OutIt print(OutIt out, const xml_node< Ch > &node, int flags=0)
Definition: rapidxml_print.hpp:405
rapidxml::operator<<
std::basic_ostream< Ch > & operator<<(std::basic_ostream< Ch > &out, const xml_node< Ch > &node)
Definition: rapidxml_print.hpp:429
rapidxml::node_document
@ node_document
A document node. Name and value are empty.
Definition: rapidxml.hpp:145
rapidxml::node_element
@ node_element
An element node. Name contains element name. Value contains text of first data node.
Definition: rapidxml.hpp:146
rapidxml::xml_attribute
Definition: rapidxml.hpp:138
rapidxml::node_pi
@ node_pi
A PI node. Name contains target. Value contains instructions.
Definition: rapidxml.hpp:152
rapidxml
Definition: rapidxml.hpp:57
rapidxml::xml_node::first_node
xml_node< Ch > * first_node(const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
Definition: rapidxml.hpp:936
rapidxml::xml_node::type
node_type type() const
Definition: rapidxml.hpp:913
rapidxml::node_comment
@ node_comment
A comment node. Name is empty. Value contains comment text.
Definition: rapidxml.hpp:149
rapidxml::node_data
@ node_data
A data node. Name is empty. Value contains data text.
Definition: rapidxml.hpp:147
rapidxml::xml_node
Definition: rapidxml.hpp:137
rapidxml::node_doctype
@ node_doctype
A DOCTYPE node. Name is empty. Value contains DOCTYPE text.
Definition: rapidxml.hpp:151
rapidxml::node_declaration
@ node_declaration
A declaration node. Name and value are empty. Declaration parameters (version, encoding and standalon...
Definition: rapidxml.hpp:150
rapidxml.hpp
rapidxml::xml_node::first_attribute
xml_attribute< Ch > * first_attribute(const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
Definition: rapidxml.hpp:1025
rapidxml::node_cdata
@ node_cdata
A CDATA node. Name is empty. Value contains data text.
Definition: rapidxml.hpp:148
rapidxml::xml_node::next_sibling
xml_node< Ch > * next_sibling(const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
Definition: rapidxml.hpp:1004

mvsim
Author(s):
autogenerated on Wed May 28 2025 02:13:08