1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 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 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    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 QT_MODULE(XmlPatterns)

    52 

    53 class QIODevice;

    54 class QTextCodec;

    55 class QXmlQuery;

    56 class QXmlSerializerPrivate;

    57 

    58 class Q_XMLPATTERNS_EXPORT QXmlSerializer : public QAbstractXmlReceiver

    59 {

    60 public:

    61     QXmlSerializer(const QXmlQuery &query,

    62                    QIODevice *outputDevice);

    63 

    64     virtual void namespaceBinding(const QXmlName &nb);

    65 

    66     virtual void characters(const QStringRef &value);

    67     virtual void comment(const QString &value);

    68 

    69     virtual void startElement(const QXmlName &name);

    70 

    71     virtual void endElement();

    72 

    73     virtual void attribute(const QXmlName &name,

    74                            const QStringRef &value);

    75 

    76     virtual void processingInstruction(const QXmlName &name,

    77                                        const QString &value);

    78 

    79     virtual void atomicValue(const QVariant &value);

    80 

    81     virtual void startDocument();

    82     virtual void endDocument();

    83     virtual void startOfSequence();

    84     virtual void endOfSequence();

    85 

    86     QIODevice *outputDevice() const;

    87 

    88     void setCodec(const QTextCodec *codec);

    89     const QTextCodec *codec() const;

    90 

    91     /* The members below are internal, not part of the public API, and

    92      * unsupported. Using them leads to undefined behavior. */

    93     virtual void item(const QPatternist::Item &item);

    94 protected:

    95     QXmlSerializer(QAbstractXmlReceiverPrivate *d);

    96 

    97 private:

    98     inline bool isBindingInScope(const QXmlName nb) const;

    99 

   100     /**

   101      * Where in the document the QXmlSerializer is currently working.

   102      */

   103     enum State

   104     {

   105         /**

   106          * Before the document element. This is the XML prolog where the

   107          * XML declaration, and possibly comments and processing

   108          * instructions are found.

   109          */

   110         BeforeDocumentElement,

   111 

   112         /**

   113          * This is inside the document element, at any level.

   114          */

   115         InsideDocumentElement

   116     };

   117 

   118     /**

   119      * If the current state is neither BeforeDocumentElement or

   120      * AfterDocumentElement.

   121      */

   122     inline bool atDocumentRoot() const;

   123 

   124     /**

   125      * Closes any open element start tag. Must be called before outputting

   126      * any element content.

   127      */

   128     inline void startContent();

   129 

   130     /**

   131      * Escapes content intended as text nodes for elements.

   132      */

   133     void writeEscaped(const QString &toEscape);

   134 

   135     /**

   136      * Identical to writeEscaped(), but also escapes quotes.

   137      */

   138     inline void writeEscapedAttribute(const QString &toEscape);

   139 

   140     /**

   141      * Writes out @p name.

   142      */

   143     inline void write(const QXmlName &name);

   144 

   145     inline void write(const char *const chars);

   146     /**

   147      * Encodes and writes out @p content.

   148      */

   149     inline void write(const QString &content);

   150 

   151     Q_DECLARE_PRIVATE(QXmlSerializer)

   152 };

   153 

   154 QT_END_NAMESPACE

   155 

   156 QT_END_HEADER

   157 

   158 #endif