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_RemovalIterator_H
51#define Patternist_RemovalIterator_H
52
53#include <private/qitem_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59
60 /**
61 * @short Removes one items at a specified position from an input QAbstractXmlForwardIterator.
62 *
63 * RemoveIterator removes an item from a sequence at a certain position,
64 * while retaining the pull-based characteristic of being an QAbstractXmlForwardIterator itself. The
65 * RemovalIterator's constructor is passed an QAbstractXmlForwardIterator, the QAbstractXmlForwardIterator to
66 * remove from, and the position of the item to remove. When calling the RemovalIterator's
67 * functions, it acts as an ordinary QAbstractXmlForwardIterator, taking into account that
68 * one item is removed from the source QAbstractXmlForwardIterator.
69 *
70 * The RemovalIterator class contains the central business logic for implementing the
71 * <tt>fn:remove()</tt> function, whose definition therefore specifies the detailed behaviors
72 * of RemovalIterator.
73 *
74 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-remove">XQuery 1.0
75 * and XPath 2.0 Functions and Operators, 15.1.8 fn:remove</a>
76 * @author Frans Englich <frans.englich@nokia.com>
77 * @ingroup Patternist_iterators
78 */
79 class RemovalIterator : public Item::Iterator
80 {
81 public:
82
83 /**
84 * Creates an RemovalIterator.
85 *
86 * @param target the QAbstractXmlForwardIterator containing the sequence of items
87 * which the item at position @p position should be removed from.
88 * @param position the position of the item to remove. Must be
89 * 1 or larger.
90 */
91 RemovalIterator(const Item::Iterator::Ptr &target,
92 const xsInteger position);
93
94 virtual Item next();
95 virtual Item current() const;
96 virtual xsInteger position() const;
97
98 /**
99 * The QAbstractXmlForwardIterator's count is computed by subtracting one from the source
100 * QAbstractXmlForwardIterator's count.
101 */
102 virtual xsInteger count();
103
104 virtual Item::Iterator::Ptr copy() const;
105
106 private:
107 const Item::Iterator::Ptr m_target;
108 const xsInteger m_removalPos;
109 Item m_current;
110 xsInteger m_position;
111 };
112}
113
114QT_END_NAMESPACE
115
116#endif
117

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