src/xmlpatterns/iterators/qdistinctiterator_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_DistinctIterator_H
  53 #define Patternist_DistinctIterator_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 Filters another sequence by removing duplicates such that the items are unique.
  72      *
  73      * DistinctIterator takes an input sequence, and returns a sequence where each
  74      * item is unique. Thus, DistinctIterator removes the duplicates of items
  75      * in a sequence. DistinctIterator is central in the implementation of the
  76      * <tt>fn:distinct-values()</tt> function.
  77      *
  78      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-distinct-values">XQuery 1.0
  79      * and XPath 2.0 Functions and Operators, 15.1.6 fn:distinct-values</a>
  80      * @author Frans Englich <frans.englich@nokia.com>
  81      * @ingroup Patternist_iterators
  82      */
  83     class DistinctIterator : public Item::Iterator
  84                            , public ComparisonPlatform<DistinctIterator, false>
  85                            , public SourceLocationReflection
  86     {
  87     public:
  88         /**
  89          * Creates a DistinctIterator.
  90          * @param comp the AtomicComparator to be used for comparing values. This may be @c null,
  91          * meaning the IndexOfIterator iterator will dynamically determine what comparator to use
  92          * @param seq the sequence whose duplicates should be filtered out
  93          * @param context the usual context, used for error reporting and by AtomicComparators.
  94          * @param expression the Expression that this DistinctIterator is
  95          * evaluating for. It is used for error reporting, via
  96          * actualReflection().
  97          */
  98         DistinctIterator(const Item::Iterator::Ptr &seq,
  99                          const AtomicComparator::Ptr &comp,
 100                          const Expression::ConstPtr &expression,
 101                          const DynamicContext::Ptr &context);
 102
 103         virtual Item next();
 104         virtual Item current() const;
 105         virtual xsInteger position() const;
 106         virtual Item::Iterator::Ptr copy() const;
 107         virtual const SourceLocationReflection *actualReflection() const;
 108
 109         inline AtomicComparator::Operator operatorID() const
 110         {
 111             return AtomicComparator::OperatorEqual;
 112         }
 113
 114     private:
 115         const Item::Iterator::Ptr   m_seq;
 116         const DynamicContext::Ptr   m_context;
 117         const Expression::ConstPtr  m_expr;
 118         Item                        m_current;
 119         xsInteger                   m_position;
 120         Item::List                  m_processed;
 121     };
 122 }
 123
 124 QT_END_NAMESPACE
 125
 126 QT_END_HEADER
 127
 128 #endif