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_InsertionIterator_H
51#define Patternist_InsertionIterator_H
52
53#include <private/qabstractxmlforwarditerator_p.h>
54#include <private/qitem_p.h>
55
56QT_BEGIN_NAMESPACE
57
58namespace QPatternist
59{
60 /**
61 * @short Conceptually inserts one QAbstractXmlForwardIterator into another, make two QAbstractXmlForwardIterator instances appear as one.
62 *
63 * An InsertionIterator represents a sequence that is the merge of two
64 * sequences, where one of the iterators is conceptually inserted at a
65 * given position. This is done while retaining the characteristic of being
66 * pull-based.
67 *
68 * InsertionIterator contains the logic for the implementation of the <tt>fn:insert-before()</tt>
69 * function, whose definition therefore specifies the detailed behaviors of the
70 * InsertionIterator.
71 *
72 * @see <a href="http://www.w3.org/TR/xpath-functions/#func-insert-before">XQuery 1.0
73 * and XPath 2.0 Functions and Operators, 15.1.7 fn:insert-before</a>
74 * @author Frans Englich <frans.englich@nokia.com>
75 * @ingroup Patternist_iterators
76 */
77 class InsertionIterator : public Item::Iterator
78 {
79 public:
80
81 /**
82 * Creates an InsertionIterator whose result is a merge of the
83 * iterator @p insertIterator into the iterator @p target at position @p
84 * position.
85 *
86 * @param target the iterator containing the items that the
87 * item in @p insertIterator will be inserted into.
88 * @param position the insertion position. Must be 1 or larger
89 * @param insertIterator the iterator containing the items to insert
90 * at position @p position
91 */
92 InsertionIterator(const Item::Iterator::Ptr &target,
93 const xsInteger position,
94 const Item::Iterator::Ptr &insertIterator);
95
96 virtual Item next();
97 virtual Item current() const;
98 virtual xsInteger position() const;
99 virtual xsInteger count();
100 virtual Item::Iterator::Ptr copy() const;
101
102 private:
103 const Item::Iterator::Ptr m_target;
104 const xsInteger m_insertPos;
105 const Item::Iterator::Ptr m_inserts;
106 Item m_current;
107 xsInteger m_position;
108 bool m_isInserting;
109 };
110}
111
112QT_END_NAMESPACE
113
114#endif
115

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