src/xmlpatterns/api/qabstractxmlreceiver.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QABSTRACTXMLRECEIVER_H
  43 #define QABSTRACTXMLRECEIVER_H
  44
  45 #include <QtCore/QVariant>
  46 #include <QtCore/QScopedPointer>
  47 #include <QtXmlPatterns/QXmlNodeModelIndex>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53
  54 class QAbstractXmlReceiverPrivate;
  55 class QXmlName;
  56
  57 namespace QPatternist
  58 {
  59     class Item;
  60 }
  61
  62 class Q_XMLPATTERNS_EXPORT QAbstractXmlReceiver
  63 {
  64 public:
  65     QAbstractXmlReceiver();
  66
  67     virtual ~QAbstractXmlReceiver();
  68
  69     virtual void startElement(const QXmlName &name) = 0;
  70     virtual void endElement() = 0;
  71     virtual void attribute(const QXmlName &name,
  72                            const QStringRef &value) = 0;
  73     virtual void comment(const QString &value) = 0;
  74     virtual void characters(const QStringRef &value) = 0;
  75     virtual void startDocument() = 0;
  76     virtual void endDocument() = 0;
  77
  78     virtual void processingInstruction(const QXmlName &target,
  79                                        const QString &value) = 0;
  80
  81     virtual void atomicValue(const QVariant &value) = 0;
  82     virtual void namespaceBinding(const QXmlName &name) = 0;
  83     virtual void startOfSequence() = 0;
  84     virtual void endOfSequence() = 0;
  85
  86     /* The members below are internal, not part of the public API, and
  87      * unsupported. Using them leads to undefined behavior. */
  88     virtual void whitespaceOnly(const QStringRef &value);
  89     virtual void item(const QPatternist::Item &item);
  90
  91 protected:
  92     QAbstractXmlReceiver(QAbstractXmlReceiverPrivate *d);
  93     QScopedPointer<QAbstractXmlReceiverPrivate> d_ptr;
  94
  95     void sendAsNode(const QPatternist::Item &outputItem);
  96 private:
  97     template<const QXmlNodeModelIndex::Axis axis>
  98     void sendFromAxis(const QXmlNodeModelIndex &node);
  99     Q_DISABLE_COPY(QAbstractXmlReceiver)
 100 };
 101
 102 QT_END_NAMESPACE
 103
 104 QT_END_HEADER
 105
 106 #endif