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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QXMLSERIALIZER_H
#define QXMLSERIALIZER_H
#include <QtXmlPatterns/QAbstractXmlReceiver>
QT_BEGIN_NAMESPACE
class QIODevice;
class QTextCodec;
class QXmlQuery;
class QXmlSerializerPrivate;
class Q_XMLPATTERNS_EXPORT QXmlSerializer : public QAbstractXmlReceiver
{
public:
QXmlSerializer(const QXmlQuery &query,
QIODevice *outputDevice);
virtual void namespaceBinding(const QXmlName &nb);
virtual void characters(const QStringRef &value);
virtual void comment(const QString &value);
virtual void startElement(const QXmlName &name);
virtual void endElement();
virtual void attribute(const QXmlName &name,
const QStringRef &value);
virtual void processingInstruction(const QXmlName &name,
const QString &value);
virtual void atomicValue(const QVariant &value);
virtual void startDocument();
virtual void endDocument();
virtual void startOfSequence();
virtual void endOfSequence();
QIODevice *outputDevice() const;
void setCodec(const QTextCodec *codec);
const QTextCodec *codec() const;
/* The members below are internal, not part of the public API, and
* unsupported. Using them leads to undefined behavior. */
virtual void item(const QPatternist::Item &item);
protected:
QXmlSerializer(QAbstractXmlReceiverPrivate *d);
private:
inline bool isBindingInScope(const QXmlName nb) const;
/**
* Where in the document the QXmlSerializer is currently working.
*/
enum State
{
/**
* Before the document element. This is the XML prolog where the
* XML declaration, and possibly comments and processing
* instructions are found.
*/
BeforeDocumentElement,
/**
* This is inside the document element, at any level.
*/
InsideDocumentElement
};
/**
* If the current state is neither BeforeDocumentElement or
* AfterDocumentElement.
*/
inline bool atDocumentRoot() const;
/**
* Closes any open element start tag. Must be called before outputting
* any element content.
*/
inline void startContent();
/**
* Escapes content intended as text nodes for elements.
*/
void writeEscaped(const QString &toEscape);
/**
* Identical to writeEscaped(), but also escapes quotes.
*/
inline void writeEscapedAttribute(const QString &toEscape);
/**
* Writes out @p name.
*/
inline void write(const QXmlName &name);
inline void write(const char *const chars);
/**
* Encodes and writes out @p content.
*/
inline void write(const QString &content);
Q_DECLARE_PRIVATE(QXmlSerializer)
};
QT_END_NAMESPACE
#endif
|
