1182fa781239f4be47322f592a9333140d3b8a50
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / iterators / qintersectiterator_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16 **
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20 **
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
28 **
29 ** Other Usage
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 //
43 //  W A R N I N G
44 //  -------------
45 //
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.
49 //
50 // We mean it.
51
52 #ifndef Patternist_IntersectIterator_H
53 #define Patternist_IntersectIterator_H
54
55 #include <private/qitem_p.h>
56
57 QT_BEGIN_HEADER
58
59 QT_BEGIN_NAMESPACE
60
61 namespace QPatternist
62 {
63     /**
64      * @short Implements the @c intersect operator. That is, the computation
65      * of the intersection between two sequences of nodes.
66      *
67      * The @c intersect operator can be seen as logical @c AND of the two sets.
68      *
69      * @ingroup Patternist_iterators
70      */
71     class IntersectIterator : public Item::Iterator
72     {
73     public:
74         /**
75          * It is assumed that @p it1 and @p it2 are in document order and
76          * without duplicates.
77          */
78         IntersectIterator(const Item::Iterator::Ptr &it1,
79                           const Item::Iterator::Ptr &it2);
80
81         virtual Item next();
82         virtual Item current() const;
83         virtual xsInteger position() const;
84         virtual Item::Iterator::Ptr copy() const;
85
86     private:
87         inline Item closedExit()
88         {
89             m_position = -1;
90             m_current = Item();
91             return Item();
92         }
93
94         const Item::Iterator::Ptr   m_it1;
95         const Item::Iterator::Ptr   m_it2;
96         Item                        m_current;
97         xsInteger                   m_position;
98         Item                        m_node1;
99         Item                        m_node2;
100     };
101 }
102
103 QT_END_NAMESPACE
104
105 QT_END_HEADER
106
107 #endif