src/xmlpatterns/api/qxmlserializer.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QXMLSERIALIZER_H
  43 #define QXMLSERIALIZER_H
  44
  45 #include <QtXmlPatterns/QAbstractXmlReceiver>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51
  52 class QIODevice;
  53 class QTextCodec;
  54 class QXmlQuery;
  55 class QXmlSerializerPrivate;
  56
  57 class Q_XMLPATTERNS_EXPORT QXmlSerializer : public QAbstractXmlReceiver
  58 {
  59 public:
  60     QXmlSerializer(const QXmlQuery &query,
  61                    QIODevice *outputDevice);
  62
  63     virtual void namespaceBinding(const QXmlName &nb);
  64
  65     virtual void characters(const QStringRef &value);
  66     virtual void comment(const QString &value);
  67
  68     virtual void startElement(const QXmlName &name);
  69
  70     virtual void endElement();
  71
  72     virtual void attribute(const QXmlName &name,
  73                            const QStringRef &value);
  74
  75     virtual void processingInstruction(const QXmlName &name,
  76                                        const QString &value);
  77
  78     virtual void atomicValue(const QVariant &value);
  79
  80     virtual void startDocument();
  81     virtual void endDocument();
  82     virtual void startOfSequence();
  83     virtual void endOfSequence();
  84
  85     QIODevice *outputDevice() const;
  86
  87     void setCodec(const QTextCodec *codec);
  88     const QTextCodec *codec() const;
  89
  90     /* The members below are internal, not part of the public API, and
  91      * unsupported. Using them leads to undefined behavior. */
  92     virtual void item(const QPatternist::Item &item);
  93 protected:
  94     QXmlSerializer(QAbstractXmlReceiverPrivate *d);
  95
  96 private:
  97     inline bool isBindingInScope(const QXmlName nb) const;
  98
  99     /**
 100      * Where in the document the QXmlSerializer is currently working.
 101      */
 102     enum State
 103     {
 104         /**
 105          * Before the document element. This is the XML prolog where the
 106          * XML declaration, and possibly comments and processing
 107          * instructions are found.
 108          */
 109         BeforeDocumentElement,
 110
 111         /**
 112          * This is inside the document element, at any level.
 113          */
 114         InsideDocumentElement
 115     };
 116
 117     /**
 118      * If the current state is neither BeforeDocumentElement or
 119      * AfterDocumentElement.
 120      */
 121     inline bool atDocumentRoot() const;
 122
 123     /**
 124      * Closes any open element start tag. Must be called before outputting
 125      * any element content.
 126      */
 127     inline void startContent();
 128
 129     /**
 130      * Escapes content intended as text nodes for elements.
 131      */
 132     void writeEscaped(const QString &toEscape);
 133
 134     /**
 135      * Identical to writeEscaped(), but also escapes quotes.
 136      */
 137     inline void writeEscapedAttribute(const QString &toEscape);
 138
 139     /**
 140      * Writes out @p name.
 141      */
 142     inline void write(const QXmlName &name);
 143
 144     inline void write(const char *const chars);
 145     /**
 146      * Encodes and writes out @p content.
 147      */
 148     inline void write(const QString &content);
 149
 150     Q_DECLARE_PRIVATE(QXmlSerializer)
 151 };
 152
 153 QT_END_NAMESPACE
 154
 155 QT_END_HEADER
 156
 157 #endif