src/xmlpatterns/utils/qoutputvalidator_p.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 //
  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 Patternist_OutputValidator_H
  53 #define Patternist_OutputValidator_H
  54
  55 #include <QSet>
  56
  57 #include <private/qdynamiccontext_p.h>
  58 #include "qabstractxmlreceiver.h"
  59 #include <private/qsourcelocationreflection_p.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 namespace QPatternist
  66 {
  67     /**
  68      * @short Receives QAbstractXmlReceiver events and validates that they are correct,
  69      * before sending them on to a second QAbstractXmlReceiver.
  70      *
  71      * Currently, this is only checking that attributes appear before other
  72      * nodes.
  73      *
  74      * @ingroup Patternist_xdm
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      * @todo Escape data
  77      */
  78     class OutputValidator : public QAbstractXmlReceiver
  79                           , public DelegatingSourceLocationReflection
  80     {
  81     public:
  82         OutputValidator(QAbstractXmlReceiver *const receiver,
  83                         const DynamicContext::Ptr &context,
  84                         const SourceLocationReflection *const r,
  85                         const bool isXSLT);
  86
  87         virtual void namespaceBinding(const QXmlName &nb);
  88
  89         virtual void characters(const QStringRef &value);
  90         virtual void comment(const QString &value);
  91
  92         virtual void startElement(const QXmlName &name);
  93
  94         virtual void endElement();
  95
  96         virtual void attribute(const QXmlName &name,
  97                                const QStringRef &value);
  98
  99         virtual void processingInstruction(const QXmlName &name,
 100                                            const QString &value);
 101
 102         virtual void item(const Item &item);
 103
 104         virtual void startDocument();
 105         virtual void endDocument();
 106         virtual void atomicValue(const QVariant &value);
 107         virtual void endOfSequence();
 108         virtual void startOfSequence();
 109
 110     private:
 111         bool                        m_hasReceivedChildren;
 112         QAbstractXmlReceiver *const m_receiver;
 113         const DynamicContext::Ptr   m_context;
 114
 115         /**
 116          * Keeps the current received attributes, in order to check uniqueness.
 117          */
 118         QSet<QXmlName>              m_attributes;
 119         const bool                  m_isXSLT;
 120     };
 121 }
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif