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
|
/* -*- C++ -*-
This file is part of KIllustrator.
Copyright (C) 1998 Kai-Uwe Sattler (kus@iti.cs.uni-magdeburg.de)
modified for kvoctrain by Ewald Arnold kvoctrain@ewald-arnold.dein April ´99
*/
#ifndef XmlWriter_h_
#define XmlWriter_h_
#if defined(stack)
#undef stack
#endif
#include <stack>
#include <vector>
using namespace std;
#include "koxml_config.h"
class KOXML_OSTREAM;
/**
* The XMLWriter class provides support for writing XML streams.
* It contains methods for output XML elements with attributes.
*
* Sample code:
* <pre>
* KOXML_OSTREAM os (fname);
* XmlWriter xml (os); // writes the XML header
*
* xml.startTag ("head"); // writes <head>
*
* // write <layout format="a4" orientation="landscape">
* xml.startTag ("layout", false);
* xml.addAttribute ("format", "a4");
* xml.addAttribute ("orientation", "landscape");
* xml.closeTag (true);
* </pre>
*
* @short A helper class for writing XML.
* @author Kai-Uwe Sattler (kus@iti.cs.uni-magdeburg.de), modifications: Ewald Arnold (kvoctrain@ewald-arnold.de)
* @version 2000/07/02
*/
class XmlWriter {
public:
/**
* Create a XmlWriter instance for the given output stream.
*
* @param os The open output stream for writing.
*/
XmlWriter (KOXML_OSTREAM& os);
/**
* Desctructor.
*/
~XmlWriter ();
/**
* Write an element with the given ID to the XML stream. Attributes
* can be added later.
*
* @param id The element ID.
* @param closeIt If @p true the tag is closed by >,
* otherwise not.
* @param empty If @p true an empty element is written, which
* is closed by />.
* @param eol If @p true an eol char is appended
* even if autoendl is false
*/
void startTag (KOXML_STRING id, bool closeIt = true, bool empty = false, bool eol = false);
/**
* Write the end tag according to the given element ID or to the
* last opened element.
*
* @param id The element ID. If @p "" the last opened
* element is ended. (default).
* @param eol If @p true an eol char is appended
* even if autoendl is false
*/
void endTag (KOXML_STRING id = "", bool eol = false);
/**
* flag, indicating to automatically append end-of-line character after
* closing bracket
*
* @param autoflag If @p true, append eol character. Otherwise caller has to do it
*/
void setAutoEndl (const bool autoflag = true);
/**
* append end-of-line char to stream
*/
void endline ();
/**
* Close the current open element.
*
* @param empty If @p true an empty element is closed.
* @param eol If @p true an eol char is appended
* even if autoendl is false
*/
void closeTag (bool empty = false, bool eol = false);
/**
* Add an attribute with the given value to the current element.
* This method doesn't check, if an element is open.
*
* @param name The attribute name.
* @param value The string value of the attribute.
*/
void addAttribute (KOXML_STRING name, const KOXML_STRING& value);
/**
* Add an attribute with the given value to the current element.
* This method doesn't check, if an element is open.
*
* @param name The attribute name.
* @param value The integer value of the attribute.
*/
void addAttribute (KOXML_STRING name, int value);
/**
* Add an attribute with the given value to the current element.
* This method doesn't check, if an element is open.
*
* @param name The attribute name.
* @param value The float value od the attribute.
*/
void addAttribute (KOXML_STRING name, float value);
/**
* Add an attribute with the given value to the current element.
* This method doesn't check, if an element is open.
*
* @param name The attribute name.
* @param value The double value of the attribute.
*/
void addAttribute (KOXML_STRING name, double value);
/**
* Write text to the XML stream. The method encodes the special
* characters @p <, @p > and @p &.
*
* @param s The text.
*/
void writeText (KOXML_STRING s);
/**
* Write a tag to the XML stream.
*
* @param s The tag without the brackets.
*/
void writeTag (KOXML_STRING s);
/**
* indents next text string with some spaces
*
* @param i number of spaces to indent
*/
void indent (int i);
/**
* Flush the XML output stream.
*/
void flush ();
#ifndef KOXML_USE_STL
/**
* Get the raw output stream.
*/
inline TQIODevice *stream () { return strm.device(); }
#endif
private:
stack<KOXML_STRING, vector<KOXML_STRING> > lastTags;
KOXML_OSTREAM &strm;
bool autoendl;
bool isapo;
KOXML_CHAR apo;
};
#endif
|
