src/xmlpatterns/iterators/qsingletoniterator_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_SingletonIterator_H
  53 #define Patternist_SingletonIterator_H
  54
  55 #include <QtXmlPatterns/private/qabstractxmlforwarditerator_p.h>
  56
  57 #include <QtXmlPatterns/private/qprimitives_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short An QAbstractXmlForwardIterator over exactly one item.
  67      *
  68      * SingletonIterator's constructor takes one value which is
  69      * the item it forms an QAbstractXmlForwardIterator over. Other QAbstractXmlForwardIterator instances can
  70      * also form an QAbstractXmlForwardIterator with one in length, but by that SingletonIterator
  71      * has this as it only task, it means it is efficient at it.
  72      *
  73      * Having to represent single items in Iterators is relatively common.
  74      *
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      * @ingroup Patternist_iterators
  77      */
  78     template<typename T>
  79     class SingletonIterator : public QAbstractXmlForwardIterator<T>
  80     {
  81     public:
  82         /**
  83          * Creates an iterator over @p item.
  84          *
  85          * @note item may not be @c null. Use the EmptyIterator for
  86          * the empty sequence
  87          */
  88         SingletonIterator(const T &item) : m_item(item),
  89                                            m_position(0)
  90         {
  91             Q_ASSERT(!qIsForwardIteratorEnd(item));
  92         }
  93
  94         virtual T next()
  95         {
  96             switch(m_position)
  97             {
  98                 case 0:
  99                 {
 100                     ++m_position;
 101                     return m_item;
 102                 }
 103                 case 1:
 104                 {
 105                     m_position = -1;
 106                     return T();
 107                 }
 108                 default:
 109                 {
 110                     Q_ASSERT(m_position == -1);
 111                     return T();
 112                 }
 113             }
 114         }
 115
 116         virtual T current() const
 117         {
 118             if(m_position == 1)
 119                 return m_item;
 120             else
 121                 return T();
 122         }
 123
 124         virtual xsInteger position() const
 125         {
 126             return m_position;
 127         }
 128
 129         /**
 130          * @returns a copy of this instance, rewinded to the beginning.
 131          */
 132         virtual typename QAbstractXmlForwardIterator<T>::Ptr toReversed()
 133         {
 134             return typename QAbstractXmlForwardIterator<T>::Ptr(new SingletonIterator<T>(m_item));
 135         }
 136
 137         /**
 138          * @returns always 1
 139          */
 140         virtual xsInteger count()
 141         {
 142             return 1;
 143         }
 144
 145         virtual typename QAbstractXmlForwardIterator<T>::Ptr copy() const
 146         {
 147             return typename QAbstractXmlForwardIterator<T>::Ptr(new SingletonIterator(m_item));
 148         }
 149
 150     private:
 151         const T m_item;
 152         qint8 m_position;
 153     };
 154
 155     /**
 156      * @short An object generator for SingletonIterator.
 157      *
 158      * makeSingletonIterator() is a convenience function for avoiding specifying
 159      * the full template instantiation for SingletonIterator. Conceptually, it
 160      * is identical to Qt's qMakePair().
 161      *
 162      * @relates SingletonIterator
 163      */
 164     template<typename T>
 165     inline
 166     typename SingletonIterator<T>::Ptr
 167     makeSingletonIterator(const T &item)
 168     {
 169         return typename SingletonIterator<T>::Ptr(new SingletonIterator<T>(item));
 170     }
 171 }
 172
 173 QT_END_NAMESPACE
 174
 175 QT_END_HEADER
 176
 177 #endif