src/xmlpatterns/expr/qdocumentcontentvalidator_p.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 //
  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_DocumentContentValidator_H
  53 #define Patternist_DocumentContentValidator_H
  54
  55 #include <private/qdynamiccontext_p.h>
  56 #include <private/qexpression_p.h>
  57 #include "qabstractxmlreceiver.h"
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Receives QAbstractXmlReceiver events and validates that they are correct,
  67      * before sending them on to a second QAbstractXmlReceiver.
  68      *
  69      * @ingroup Patternist_xdm
  70      * @author Frans Englich <frans.englich@nokia.com>
  71      * @todo Escape data
  72      */
  73     class DocumentContentValidator : public QAbstractXmlReceiver
  74     {
  75     public:
  76         /**
  77          * DocumentContentValidator does not own @p receiver.
  78          */
  79         DocumentContentValidator(QAbstractXmlReceiver *const receiver,
  80                                  const DynamicContext::Ptr &context,
  81                                  const Expression::ConstPtr &expr);
  82
  83         virtual void namespaceBinding(const QXmlName &nb);
  84         virtual void characters(const QStringRef &value);
  85         virtual void comment(const QString &value);
  86
  87         virtual void startElement(const QXmlName &name);
  88
  89         virtual void endElement();
  90
  91         virtual void attribute(const QXmlName &name,
  92                                const QStringRef &value);
  93
  94         virtual void processingInstruction(const QXmlName &name,
  95                                            const QString &value);
  96
  97         virtual void item(const Item &item);
  98
  99         virtual void startDocument();
 100         virtual void endDocument();
 101         virtual void atomicValue(const QVariant &value);
 102         virtual void startOfSequence();
 103         virtual void endOfSequence();
 104
 105     private:
 106         QAbstractXmlReceiver *const      m_receiver;
 107         const DynamicContext::Ptr       m_context;
 108         const Expression::ConstPtr      m_expr;
 109         xsInteger                       m_elementDepth;
 110     };
 111 }
 112
 113 QT_END_NAMESPACE
 114
 115 QT_END_HEADER
 116
 117 #endif