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