src/xmlpatterns/iterators/qremovaliterator_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_RemovalIterator_H
  53 #define Patternist_RemovalIterator_H
  54
  55 #include <private/qitem_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63
  64     /**
  65      * @short Removes one items at a specified position from an input QAbstractXmlForwardIterator.
  66      *
  67      * RemoveIterator removes an item from a sequence at a certain position,
  68      * while retaining the pull-based characteristic of being an QAbstractXmlForwardIterator itself. The
  69      * RemovalIterator's constructor is passed an QAbstractXmlForwardIterator, the QAbstractXmlForwardIterator to
  70      * remove from, and the position of the item to remove. When calling the RemovalIterator's
  71      * functions, it acts as an ordinary QAbstractXmlForwardIterator, taking into account that
  72      * one item is removed from the source QAbstractXmlForwardIterator.
  73      *
  74      * The RemovalIterator class contains the central business logic for implementing the
  75      * <tt>fn:remove()</tt> function, whose definition therefore specifies the detailed behaviors
  76      * of RemovalIterator.
  77      *
  78      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-remove">XQuery 1.0
  79      * and XPath 2.0 Functions and Operators, 15.1.8 fn:remove</a>
  80      * @author Frans Englich <frans.englich@nokia.com>
  81      * @ingroup Patternist_iterators
  82      */
  83     class RemovalIterator : public Item::Iterator
  84     {
  85     public:
  86
  87         /**
  88          * Creates an RemovalIterator.
  89          *
  90          * @param target the QAbstractXmlForwardIterator containing the sequence of items
  91          * which the item at position @p position should be removed from.
  92          * @param position the position of the item to remove. Must be
  93          * 1 or larger.
  94          */
  95         RemovalIterator(const Item::Iterator::Ptr &target,
  96                         const xsInteger position);
  97
  98         virtual Item next();
  99         virtual Item current() const;
 100         virtual xsInteger position() const;
 101
 102         /**
 103          * The QAbstractXmlForwardIterator's count is computed by subtracting one from the source
 104          * QAbstractXmlForwardIterator's count.
 105          */
 106         virtual xsInteger count();
 107
 108         virtual Item::Iterator::Ptr copy() const;
 109
 110     private:
 111         const Item::Iterator::Ptr m_target;
 112         const xsInteger m_removalPos;
 113         Item m_current;
 114         xsInteger m_position;
 115     };
 116 }
 117
 118 QT_END_NAMESPACE
 119
 120 QT_END_HEADER
 121
 122 #endif