1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_IndexOfIterator_H
51#define Patternist_IndexOfIterator_H
52
53#include <private/qitem_p.h>
54#include <private/qatomiccomparator_p.h>
55#include <private/qcomparisonplatform_p.h>
56#include <private/qdynamiccontext_p.h>
57#include <private/qexpression_p.h>
58
59QT_BEGIN_NAMESPACE
60
61namespace QPatternist
62{
63 /**
64 * @short Forms an QAbstractXmlForwardIterator over a sequence of integers, which each is the position
65 * of where a search parameter appeared in another QAbstractXmlForwardIterator.
66 *
67 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-index-of">XQuery 1.0
68 * and XPath 2.0 Functions and Operators, 15.1.3 fn:index-of</a>
69 * @author Frans Englich <frans.englich@nokia.com>
70 * @ingroup Patternist_iterators
71 */
72 class IndexOfIterator : public Item::Iterator
73 , public ComparisonPlatform<IndexOfIterator, false>
74 , public SourceLocationReflection
75 {
76 public:
77
78 /**
79 * Creates an IndexOfIterator, whose next() function returns integers being
80 * the index positions of where @p searchParam was found in @p inputSequence.
81 *
82 * @param comp the AtomicComparator to be used for comparing values. This may be @c null,
83 * meaning the IndexOfIterator iterator will dynamically determine what comparator to use
84 * on an item per item basis, which is slower.
85 * @param searchParam the item which should be compared to the items in @p inputSequence.
86 * @param inputSequence the input sequence which indexes of the @p searchParam should
87 * be returned for.
88 * @param context the usual DynamicContext
89 * @param expr the Expression that this IndexOfIterator is evaluating
90 * for. It is used for error reporting, via actualReflection().
91 */
92 IndexOfIterator(const Item::Iterator::Ptr &inputSequence,
93 const Item &searchParam,
94 const AtomicComparator::Ptr &comp,
95 const DynamicContext::Ptr &context,
96 const Expression::ConstPtr &expr);
97
98 virtual Item next();
99 virtual Item current() const;
100 virtual xsInteger position() const;
101 virtual Item::Iterator::Ptr copy() const;
102
103 inline AtomicComparator::Operator operatorID() const
104 {
105 return AtomicComparator::OperatorEqual;
106 }
107
108 virtual const SourceLocationReflection *actualReflection() const;
109
110 private:
111 const Item::Iterator::Ptr m_seq;
112 const Item m_searchParam;
113 const DynamicContext::Ptr m_context;
114 const Expression::ConstPtr m_expr;
115 Item m_current;
116 xsInteger m_position;
117 xsInteger m_seqPos;
118 };
119}
120
121QT_END_NAMESPACE
122
123#endif
124

source code of qtxmlpatterns/src/xmlpatterns/iterators/qindexofiterator_p.h