src/xmlpatterns/expr/qforclause_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/expr/qforclause_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,122 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+
+#ifndef Patternist_ForClause_H
+#define Patternist_ForClause_H
+
+#include "qpaircontainer_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+
+    /**
+     * @short Implements XPath 2.0's @c for expression.
+     *
+     * @see <a href="http://www.w3.org/TR/xpath20/#id-for-expressions">XML Path Language
+     * (XPath) 2.0, 3.7 For Expressions</a>
+     * @author Frans Englich <frans.englich@nokia.com>
+     * @ingroup Patternist_expressions
+     */
+    class ForClause : public PairContainer
+    {
+    public:
+        /**
+         * If @p positionSlot is -1, no positional variable will be used.
+         */
+        ForClause(const VariableSlotID varSlot,
+                  const Expression::Ptr &bindingSequence,
+                  const Expression::Ptr &returnExpression,
+                  const VariableSlotID positionSlot);
+
+        virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
+        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
+        virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
+
+        virtual SequenceType::Ptr staticType() const;
+        virtual SequenceType::List expectedOperandTypes() const;
+        virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
+                                          const SequenceType::Ptr &reqType);
+        virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
+        virtual QList<QExplicitlySharedDataPointer<OptimizationPass> > optimizationPasses() const;
+
+        inline Item mapToItem(const Item &item,
+                              const DynamicContext::Ptr &context) const;
+        virtual ID id() const;
+        inline Item::Iterator::Ptr mapToSequence(const Item &item,
+                                                 const DynamicContext::Ptr &context) const;
+
+        /**
+         * Sets m_allowsMany properly.
+         */
+        virtual Expression::Ptr compress(const StaticContext::Ptr &context);
+
+    private:
+        inline void riggPositionalVariable(const DynamicContext::Ptr &context,
+                                           const Item::Iterator::Ptr &source) const;
+        typedef QExplicitlySharedDataPointer<const ForClause> ConstPtr;
+        const VariableSlotID m_varSlot;
+        const VariableSlotID m_positionSlot;
+        /**
+         * Initialized to @c false. This default is always safe.
+         */
+        bool m_allowsMany;
+    };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif