1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef QXMLSERIALIZER_P_H
51#define QXMLSERIALIZER_P_H
52
53#include <QtCore/QIODevice>
54#include <QtCore/QStack>
55#include <QtCore/QTextCodec>
56#include <QtXmlPatterns/QXmlQuery>
57#include <QtXmlPatterns/QXmlNamePool>
58#include <QtXmlPatterns/QXmlSerializer>
59
60#include <private/qnamepool_p.h>
61#include <private/qabstractxmlreceiver_p.h>
62
63QT_BEGIN_NAMESPACE
64
65class QXmlSerializerPrivate : public QAbstractXmlReceiverPrivate
66{
67public:
68 QXmlSerializerPrivate(const QXmlQuery &q,
69 QIODevice *outputDevice);
70
71 QStack<QPair<QXmlName, bool> > hasClosedElement;
72 bool isPreviousAtomic;
73 QXmlSerializer::State state;
74 const QPatternist::NamePool::Ptr np;
75
76 /**
77 * This member worries me a bit. We never use it but nevertheless
78 * it is pushed and pops linear to startElement() and endElement().
79 * An optimization would be to at least merge it with hasClosedElement,
80 * but even better to push it on demand. That is, namespaceBinding()
81 * pushes it up to the tree depth first when it is needed.
82 */
83 QStack<QVector<QXmlName> > namespaces;
84
85 QIODevice * device;
86 const QTextCodec * codec;
87 QTextCodec::ConverterState converterState;
88 /**
89 * Name cache. Since encoding QStrings are rather expensive
90 * operations to do, and we on top of that would have to do
91 * it each time a name appears, we here map names to their
92 * encoded equivalents.
93 *
94 * This means that when writing out large documents, the serialization
95 * of names after a while is reduced to a hash lookup and passing an
96 * existing byte array.
97 *
98 * We use QXmlName::Code as key as opposed to merely QName, because the
99 * prefix is of significance.
100 */
101 QHash<QXmlName::Code, QByteArray> nameCache;
102 const QXmlQuery query;
103
104 inline void write(const char c);
105
106private:
107 enum Constants
108 {
109 EstimatedTreeDepth = 10,
110
111 /**
112 * We use a high count to avoid rehashing. We can afford it since we
113 * only allocate one hash for this.
114 */
115 EstimatedNameCount = 60
116 };
117};
118
119void QXmlSerializerPrivate::write(const char c)
120{
121 device->putChar(c);
122}
123QT_END_NAMESPACE
124
125#endif
126

source code of qtxmlpatterns/src/xmlpatterns/api/qxmlserializer_p.h