src/xmlpatterns/iterators/qdeduplicateiterator_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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