src/xmlpatterns/iterators/qinsertioniterator_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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 ** 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_InsertionIterator_H
  53 #define Patternist_InsertionIterator_H
  54
  55 #include "qabstractxmlforwarditerator_p.h"
  56 #include "qitem_p.h"
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Conceptually inserts one QAbstractXmlForwardIterator into another, make two QAbstractXmlForwardIterator instances appear as one.
  66      *
  67      * An InsertionIterator represents a sequence that is the merge of two
  68      * sequences, where one of the iterators is conceptually inserted at a
  69      * given position. This is done while retaining the characteristic of being
  70      * pull-based.
  71      *
  72      * InsertionIterator contains the logic for the implementation of the <tt>fn:insert-before()</tt>
  73      * function, whose definition therefore specifies the detailed behaviors of the
  74      * InsertionIterator.
  75      *
  76      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-insert-before">XQuery 1.0
  77      * and XPath 2.0 Functions and Operators, 15.1.7 fn:insert-before</a>
  78      * @author Frans Englich <frans.englich@nokia.com>
  79      * @ingroup Patternist_iterators
  80      */
  81     class InsertionIterator : public Item::Iterator
  82     {
  83     public:
  84
  85         /**
  86          * Creates an InsertionIterator whose result is a merge of the
  87          * iterator @p insertIterator into the iterator @p target at position @p
  88          * position.
  89          *
  90          * @param target the iterator containing the items that the
  91          * item in @p insertIterator will be inserted into.
  92          * @param position the insertion position. Must be 1 or larger
  93          * @param insertIterator the iterator containing the items to insert
  94          * at position @p position
  95          */
  96         InsertionIterator(const Item::Iterator::Ptr &target,
  97                           const xsInteger position,
  98                           const Item::Iterator::Ptr &insertIterator);
  99
 100         virtual Item next();
 101         virtual Item current() const;
 102         virtual xsInteger position() const;
 103         virtual xsInteger count();
 104         virtual Item::Iterator::Ptr copy() const;
 105
 106     private:
 107         const Item::Iterator::Ptr m_target;
 108         const xsInteger m_insertPos;
 109         const Item::Iterator::Ptr m_inserts;
 110         Item m_current;
 111         xsInteger m_position;
 112         bool m_isInserting;
 113     };
 114 }
 115
 116 QT_END_NAMESPACE
 117
 118 QT_END_HEADER
 119
 120 #endif