aboutsummaryrefslogtreecommitdiff
path: root/sxml.h
blob: c2ac7e8e9f382757d766ae8c33c3b845a6fd7e76 (plain)
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
/*
 * This file is part of sxml - stupid XML generator
 *
 * Copyright (c) 2011 Oskari Timperi
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute
 * it freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must
 * not claim that you wrote the original software. If you use this
 * software in a product, an acknowledgment in the product documentation
 * would be appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must
 * not be misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source
 * distribution.
 */

#ifndef SXML_H
#define SXML_H

#include <string>
#include <sstream>
#include <map>
#include <vector>

namespace sxml {

class node;
class element;
class comment;

typedef std::vector<node *> node_list;

//! Base class for nodes, e.g. an element, a comment, text, ...
class node
{
    public:

    //! Constructs an empty node. If parent is not NULL, the constructed node
    //! is added to the given parent as a child.
    explicit node(node *parent = NULL);

    //! Copy constructor.
    node(const node &n);

    //! Destructor. Frees the children of this node.
    virtual ~node();

    //! Returns a string representation of this node. Derived classes should
    //! implement this.
    virtual std::string to_string(bool nice , int indent = 0) const;

    //! Adds a child node to this node. Takes the ownership of the given
    //! node. Returns a pointer to the child.
    node *add_child(node *child);

    //! Adds an element with the given tag to this node. Returns a pointer to
    //! the element node.
    element *add_element(const std::string &tag);

    //! Adds a comment to this node. Returns a pointer to the comment node.
    comment *add_comment(const std::string &text);

    protected:

    //! Returns a list of children in this node.
    const node_list &children() const;

    //! Clones this node. The cloned node has clones of all the children of
    //! the original. The cloned node doesn't have a parent.
    virtual node *clone();

    //! Clone the children of this node. The children do not have a parent set.
    node_list clone_children() const;

    //! Is this node modified? Derived classes can use this information for
    //! caching.
    bool modified() const;

    //! Set the modified status of this node. If modified is true and the node
    //! has a parent, set_modified() also calls the parents set_modified().
    void set_modified(bool modified) const;

    private:

    //! Pointer to the parent node.
    node *m_parent;

    //! List of the children.
    node_list m_children;

    //! Is this node modified.
    mutable bool m_modified;
};

//! A node used for comments.
class comment: public node
{
    public:

    explicit comment(node *parent = NULL);
    explicit comment(const std::string &text, node *parent = NULL);

    virtual std::string to_string(bool nice = false, int indent = 0) const;

    private:

    std::string m_text;
};

class element: public node
{
    public:

    //! Constructs an empty element (i.e., no name,
    //! children, attributes) with the specified parent.
    explicit element(node *parent = NULL);

    //! Constructs an element with the specified name and parent.
    explicit element(const std::string &name, node *parent = NULL);

    //! Copy constructor.
    element(const element &elem);

    virtual ~element();

    //! Creates a textual representation of the element. If nice
    //! is true, the returned string is formatted with indentations
    //! and newlines.
    virtual std::string to_string(bool nice = false, int indent = 0) const;

    //! Set the text for this element. An element can either have text
    //! or children. If an element has both, children take precedence
    //! when calling to_string(). Returns a pointer to this element.
    template<class T> element *set_text(const T &text);

    //! Set an attribute for this element with the specified name and
    //! value. Returns a pointer to this element.
    template<class T> element *set_attr(const std::string &name,
                                        const T &value);

    private:

    typedef std::map<std::string, std::string> attribute_map;

    attribute_map m_attributes;

    std::string m_name;
    std::string m_text;

    mutable std::string m_cached;
};

template<class T> element *element::set_text(const T &text)
{
    std::string s;
    std::stringstream ss(s);
    ss << text;

    return set_text<std::string>(ss.str());
}

template<> element *element::set_text<>(const std::string &text);

template<class T> element *element::set_attr(const std::string &name,
                                             const T &value)
{
    std::string s;
    std::stringstream ss(s);
    ss << value;

    return set_attr<std::string>(name, ss.str());
}

template<> element *element::set_attr(const std::string &name,
                                      const std::string &value);

} // namespace sxml

#endif // SXML_H