src/xmlpatterns/iterators/qindexofiterator_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/iterators/qindexofiterator_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,129 @@
+/****************************************************************************
+**
+** 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_IndexOfIterator_H
+#define Patternist_IndexOfIterator_H
+
+#include "qitem_p.h"
+#include "qatomiccomparator_p.h"
+#include "qcomparisonplatform_p.h"
+#include "qdynamiccontext_p.h"
+#include "qexpression_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short Forms an QAbstractXmlForwardIterator over a sequence of integers, which each is the position
+     * of where a search parameter appeared in another QAbstractXmlForwardIterator.
+     *
+     * @see <a href="http://www.w3.org/TR/xpath-functions/#func-index-of">XQuery 1.0
+     * and XPath 2.0 Functions and Operators, 15.1.3 fn:index-of</a>
+     * @author Frans Englich <frans.englich@nokia.com>
+     * @ingroup Patternist_iterators
+     */
+    class IndexOfIterator : public Item::Iterator
+                          , public ComparisonPlatform<IndexOfIterator, false>
+                          , public SourceLocationReflection
+    {
+    public:
+
+        /**
+         * Creates an IndexOfIterator, whose next() function returns integers being
+         * the index positions of where @p searchParam was found in @p inputSequence.
+         *
+         * @param comp the AtomicComparator to be used for comparing values. This may be @c null,
+         * meaning the IndexOfIterator iterator will dynamically determine what comparator to use
+         * on an item per item basis, which is slower.
+         * @param searchParam the item which should be compared to the items in @p inputSequence.
+         * @param inputSequence the input sequence which indexes of the @p searchParam should
+         * be returned for.
+         * @param context the usual DynamicContext
+         * @param expr the Expression that this IndexOfIterator is evaluating
+         * for. It is used for error reporting, via actualReflection().
+         */
+        IndexOfIterator(const Item::Iterator::Ptr &inputSequence,
+                        const Item &searchParam,
+                        const AtomicComparator::Ptr &comp,
+                        const DynamicContext::Ptr &context,
+                        const Expression::ConstPtr &expr);
+
+        virtual Item next();
+        virtual Item current() const;
+        virtual xsInteger position() const;
+        virtual Item::Iterator::Ptr copy() const;
+
+        inline AtomicComparator::Operator operatorID() const
+        {
+            return AtomicComparator::OperatorEqual;
+        }
+
+        virtual const SourceLocationReflection *actualReflection() const;
+
+    private:
+        const Item::Iterator::Ptr   m_seq;
+        const Item                  m_searchParam;
+        const DynamicContext::Ptr   m_context;
+        const Expression::ConstPtr  m_expr;
+        Item                        m_current;
+        xsInteger                   m_position;
+        xsInteger                   m_seqPos;
+    };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif