1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
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.
52 #ifndef Patternist_IndexOfIterator_H
53 #define Patternist_IndexOfIterator_H
55 #include <private/qitem_p.h>
56 #include <private/qatomiccomparator_p.h>
57 #include <private/qcomparisonplatform_p.h>
58 #include <private/qdynamiccontext_p.h>
59 #include <private/qexpression_p.h>
68 * @short Forms an QAbstractXmlForwardIterator over a sequence of integers, which each is the position
69 * of where a search parameter appeared in another QAbstractXmlForwardIterator.
71 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-index-of">XQuery 1.0
72 * and XPath 2.0 Functions and Operators, 15.1.3 fn:index-of</a>
73 * @author Frans Englich <frans.englich@nokia.com>
74 * @ingroup Patternist_iterators
76 class IndexOfIterator : public Item::Iterator
77 , public ComparisonPlatform<IndexOfIterator, false>
78 , public SourceLocationReflection
83 * Creates an IndexOfIterator, whose next() function returns integers being
84 * the index positions of where @p searchParam was found in @p inputSequence.
86 * @param comp the AtomicComparator to be used for comparing values. This may be @c null,
87 * meaning the IndexOfIterator iterator will dynamically determine what comparator to use
88 * on an item per item basis, which is slower.
89 * @param searchParam the item which should be compared to the items in @p inputSequence.
90 * @param inputSequence the input sequence which indexes of the @p searchParam should
92 * @param context the usual DynamicContext
93 * @param expr the Expression that this IndexOfIterator is evaluating
94 * for. It is used for error reporting, via actualReflection().
96 IndexOfIterator(const Item::Iterator::Ptr &inputSequence,
97 const Item &searchParam,
98 const AtomicComparator::Ptr &comp,
99 const DynamicContext::Ptr &context,
100 const Expression::ConstPtr &expr);
103 virtual Item current() const;
104 virtual xsInteger position() const;
105 virtual Item::Iterator::Ptr copy() const;
107 inline AtomicComparator::Operator operatorID() const
109 return AtomicComparator::OperatorEqual;
112 virtual const SourceLocationReflection *actualReflection() const;
115 const Item::Iterator::Ptr m_seq;
116 const Item m_searchParam;
117 const DynamicContext::Ptr m_context;
118 const Expression::ConstPtr m_expr;
120 xsInteger m_position;