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
|
/*
Ousía
Copyright (C) 2014 Benjamin Paaßen, Andreas Stöckel
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 XML.hpp
*
* This header provides XML classes to build an XML tree as well as functions
* to serialize that XMl tree to text. We do not support the full XML
* specification (like described here: http://www.w3.org/TR/REC-xml/ ) but only
* a small subset. This subset is defined by the following context-free grammar:
*
* NODE := ELEMENT | string
* ELEMENT := START NODES END
* NODES := NODE NODES | epsilon
* START := < name ATTRIBUTES >
* ATTRIBUTES := ATTRIBUTE ATTRIBUTES | epsilon
* ATTRIBUTE := key = "value"
* END := </ name >
*
* where the Axiom of a document is "Element". Note that we accept only a
* singular root element and no primitive text at root level. Attributes are
* key-value pairs of strings. Start and end tag name have to match.
*
* @author Benjamin Paaßen (bpaassen@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_XML_HPP_
#define _OUSIA_XML_HPP_
#include <map>
#include <ostream>
#include <vector>
#include <core/common/Rtti.hpp>
#include <core/managed/Managed.hpp>
#include <core/managed/ManagedContainer.hpp>
namespace ousia {
namespace xml {
class Element;
/**
* Node is the common super-class of actual elements (tag-bounded) and text.
* It specifies the pure virtual serialize() function that the subclasses
* implement.
*/
class Node : public Managed {
private:
Owned<Element> parent;
public:
Node(Manager &mgr, Handle<Element> parent)
: Managed(mgr), parent(acquire(parent)){};
/**
* This method writes an XML doctype and the XML representing the current
* node, including all children, to the given output stream.
* @param out is the output stream the serialized data shall be
* written to.
* @param doctype enables you to add a prefix specifying the doctype.
* @param pretty is a flag that manipulates whether newlines and tabs are
* used.
*/
void serialize(std::ostream &out,
const std::string &doctype = "<?xml version=\"1.0\"?>",
bool pretty = true);
/**
* This method just writes the XML representation of this node to the
* output stream.
*
* @param out the output stream the serialized data shall be written
* to.
* @param tabdepth the current tabdepth for prettier output.
* @param pretty is a flag that manipulates whether newlines and tabs are
* used.
*/
virtual void doSerialize(std::ostream &out, unsigned int tabdepth,
bool pretty) = 0;
/**
* @return the parent XML element of this node.
*/
Rooted<Element> getParent() const { return parent; }
};
/**
* An element in XML is defined as by the W3C:
*
* http://www.w3.org/TR/REC-xml/#sec-starttags
*
* For as an element necessarily has a name. It may have key-value pairs as
* attributes, where each key is unique (which is enforced by std::map).
* Additionally it might have other Nodes as children.
*/
class Element : public Node {
private:
ManagedVector<Node> children;
public:
const std::string name;
std::map<std::string, std::string> attributes;
Element(Manager &mgr, Handle<Element> parent, std::string name)
: Node(mgr, parent), children(this), name(std::move(name))
{
}
Element(Manager &mgr, Handle<Element> parent, std::string name,
std::map<std::string, std::string> attributes)
: Node(mgr, parent),
children(this),
name(std::move(name)),
attributes(std::move(attributes))
{
}
/**
* This writes the following to the output stream:
* * The start tag of this element including name and attributes
* * The serialized data of all children as ordered by the vector.
* * The end tag of this element.
*
*/
void doSerialize(std::ostream &out, unsigned int tabdepth,
bool pretty) override;
const ManagedVector<Node> &getChildren() const { return children; }
void addChild(Handle<Node> child) { children.push_back(child); }
void addChildren(std::vector<Handle<Node>> c)
{
children.insert(children.end(), c.begin(), c.end());
}
};
class Text : public Node {
public:
const std::string text;
Text(Manager &mgr, Handle<Element> parent, std::string text)
: Node(mgr, parent), text(std::move(text))
{
}
/**
* This just writes the text to the output.
*
*/
void doSerialize(std::ostream &out, unsigned int tabdepth,
bool pretty) override;
};
}
namespace RttiTypes {
extern const Rtti<xml::Node> XMLNode;
extern const Rtti<xml::Element> XMLElement;
extern const Rtti<xml::Text> XMLText;
}
}
#endif
|
