src/xmlpatterns/iterators/qemptyiterator_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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_EmptyIterator_H
       
    53 #define Patternist_EmptyIterator_H
       
    54 
       
    55 #include "qabstractxmlforwarditerator_p.h"
       
    56 #include "qprimitives_p.h"
       
    57 
       
    58 QT_BEGIN_HEADER
       
    59 
       
    60 QT_BEGIN_NAMESPACE
       
    61 
       
    62 namespace QPatternist
       
    63 {
       
    64 
       
    65     /**
       
    66      * @short An QAbstractXmlForwardIterator which always is empty.
       
    67      *
       
    68      * EmptyIterator is an QAbstractXmlForwardIterator over the type @c T, which always is empty. Other
       
    69      * iterators can also be empty(or, at least behave as they are empty), but this
       
    70      * class is special designed for this purpose and is therefore fast.
       
    71      *
       
    72      * EmptyIterator's constructor is protected, instances is retrieved from CommonValues.
       
    73      *
       
    74      * @author Frans Englich <frans.englich@nokia.com>
       
    75      * @ingroup Patternist_iterators
       
    76      */
       
    77     template<typename T> class EmptyIterator : public QAbstractXmlForwardIterator<T>
       
    78     {
       
    79     public:
       
    80         /**
       
    81          * @returns always a default constructed value, T().
       
    82          */
       
    83         virtual T next()
       
    84         {
       
    85             return T();
       
    86         }
       
    87 
       
    88         /**
       
    89          * @returns always a default constructed value, T().
       
    90          */
       
    91         virtual T current() const
       
    92         {
       
    93             return T();
       
    94         }
       
    95 
       
    96         /**
       
    97          * @returns always 0.
       
    98          */
       
    99         virtual xsInteger position() const
       
   100         {
       
   101             return 0;
       
   102         }
       
   103 
       
   104         /**
       
   105          * @returns always @c this, the reverse of <tt>()</tt> is <tt>()</tt>.
       
   106          */
       
   107         virtual typename QAbstractXmlForwardIterator<T>::Ptr toReversed()
       
   108         {
       
   109             return typename QAbstractXmlForwardIterator<T>::Ptr(const_cast<EmptyIterator<T> *>(this));
       
   110         }
       
   111 
       
   112         /**
       
   113          * @returns always 0
       
   114          */
       
   115         virtual xsInteger count()
       
   116         {
       
   117             return 0;
       
   118         }
       
   119 
       
   120         /**
       
   121          * @returns @c this
       
   122          */
       
   123         virtual typename QAbstractXmlForwardIterator<T>::Ptr copy() const
       
   124         {
       
   125             return typename QAbstractXmlForwardIterator<T>::Ptr(const_cast<EmptyIterator *>(this));
       
   126         }
       
   127 
       
   128     protected:
       
   129         friend class CommonValues;
       
   130     };
       
   131 
       
   132     template<typename T>
       
   133     static inline
       
   134     typename QAbstractXmlForwardIterator<T>::Ptr
       
   135     makeEmptyIterator()
       
   136     {
       
   137         return typename QAbstractXmlForwardIterator<T>::Ptr(new EmptyIterator<T>());
       
   138     }
       
   139 
       
   140 }
       
   141 
       
   142 QT_END_NAMESPACE
       
   143 
       
   144 QT_END_HEADER
       
   145 
       
   146 #endif