94b3574195bdfd01652cdf236e54d55a6b3f1c3d
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / iterators / qdeduplicateiterator_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_DeduplicateIterator_H
53 #define Patternist_DeduplicateIterator_H
54
55 #include <QList>
56
57 #include <private/qexpression_p.h>
58 #include <private/qitem_p.h>
59 #include <private/qatomiccomparator_p.h>
60 #include <private/qcomparisonplatform_p.h>
61 #include <private/qsourcelocationreflection_p.h>
62
63 QT_BEGIN_HEADER
64
65 QT_BEGIN_NAMESPACE
66
67 namespace QPatternist
68 {
69
70     /**
71      * @short Performs deduplication of the nodes on its source list.
72      *
73      * @note The nodes in the source list must be in document order.
74      *
75      * @author Frans Englich <frans.englich@nokia.com>
76      * @ingroup Patternist_iterators
77      */
78     class DeduplicateIterator : public ListIterator<Item>
79     {
80     public:
81         DeduplicateIterator(const Item::List &source);
82
83         virtual Item next();
84         virtual Item::Iterator::Ptr copy() const;
85         virtual xsInteger count();
86
87     private:
88         /**
89          * m_position in ListIteratorPlatform is the position that we
90          * show to the outside through position) but do not correspond
91          * to the position in m_list, since we skip entries in that one.
92          *
93          * However, this guy, m_listPos, is the position into m_list.
94          */
95         int m_listPos;
96     };
97 }
98
99 QT_END_NAMESPACE
100
101 QT_END_HEADER
102
103 #endif