src/xmlpatterns/expr/qforclause_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_ForClause_H
  53 #define Patternist_ForClause_H
  54
  55 #include <private/qpaircontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63
  64     /**
  65      * @short Implements XPath 2.0's @c for expression.
  66      *
  67      * @see <a href="http://www.w3.org/TR/xpath20/#id-for-expressions">XML Path Language
  68      * (XPath) 2.0, 3.7 For Expressions</a>
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      * @ingroup Patternist_expressions
  71      */
  72     class ForClause : public PairContainer
  73     {
  74     public:
  75         /**
  76          * If @p positionSlot is -1, no positional variable will be used.
  77          */
  78         ForClause(const VariableSlotID varSlot,
  79                   const Expression::Ptr &bindingSequence,
  80                   const Expression::Ptr &returnExpression,
  81                   const VariableSlotID positionSlot);
  82
  83         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  84         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  85         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
  86
  87         virtual SequenceType::Ptr staticType() const;
  88         virtual SequenceType::List expectedOperandTypes() const;
  89         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  90                                           const SequenceType::Ptr &reqType);
  91         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  92         virtual QList<QExplicitlySharedDataPointer<OptimizationPass> > optimizationPasses() const;
  93
  94         inline Item mapToItem(const Item &item,
  95                               const DynamicContext::Ptr &context) const;
  96         virtual ID id() const;
  97         inline Item::Iterator::Ptr mapToSequence(const Item &item,
  98                                                  const DynamicContext::Ptr &context) const;
  99
 100         /**
 101          * Sets m_allowsMany properly.
 102          */
 103         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
 104
 105     private:
 106         inline void riggPositionalVariable(const DynamicContext::Ptr &context,
 107                                            const Item::Iterator::Ptr &source) const;
 108         typedef QExplicitlySharedDataPointer<const ForClause> ConstPtr;
 109         const VariableSlotID m_varSlot;
 110         const VariableSlotID m_positionSlot;
 111         /**
 112          * Initialized to @c false. This default is always safe.
 113          */
 114         bool m_allowsMany;
 115     };
 116 }
 117
 118 QT_END_NAMESPACE
 119
 120 QT_END_HEADER
 121
 122 #endif