src/xmlpatterns/iterators/qsubsequenceiterator_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_SubsequenceIterator_H
  53 #define Patternist_SubsequenceIterator_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      * @short Picks out a slice from another QAbstractXmlForwardIterator, specified by a start and end position.
  65      *
  66      * SubsequenceIterator allows a "slice", a subsequence, from an QAbstractXmlForwardIterator to
  67      * be extracted. The SubsequenceIterator's constructor takes a source QAbstractXmlForwardIterator,
  68      * a start position, and the length of the subsequence to be extracted.
  69      *
  70      * SubsequenceIterator contains the central business logic to implement
  71      * the <tt>fn:subsequence()</tt> function. The detailed behavior, such as how it behaves
  72      * if the source QAbstractXmlForwardIterator is empty or if the specified subsequence stretches
  73      * beyond the source QAbstractXmlForwardIterator, is therefore consistent with the definition of
  74      * the <tt>fn:subsequence()</tt> function.
  75      *
  76      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-subsequence">XQuery 1.0
  77      * and XPath 2.0 Functions and Operators, 15.1.10 fn:subsequence</a>
  78      * @author Frans Englich <frans.englich@nokia.com>
  79      * @ingroup Patternist_iterators
  80      */
  81     class SubsequenceIterator : public Item::Iterator
  82     {
  83     public:
  84         /**
  85          * Creates a SubsequenceIterator that extracts a subsequence from the sequence
  86          * in @p iterator, as specified by the @p start position and @p length parameter.
  87          *
  88          * @param iterator the iterator which the subsequence should
  89          * be extracted from
  90          * @param start the start position of extraction. Must be 1 or larger.
  91          * @param length the length of the subsequence to extract. If it is
  92          * -1, to the end is returned. The value must be -1 or 1 or larger.
  93          */
  94         SubsequenceIterator(const Item::Iterator::Ptr &iterator,
  95                             const xsInteger start,
  96                             const xsInteger length);
  97
  98         virtual Item next();
  99         virtual Item current() const;
 100         virtual xsInteger position() const;
 101         virtual Item::Iterator::Ptr copy() const;
 102
 103     private:
 104         xsInteger m_position;
 105         Item m_current;
 106         const Item::Iterator::Ptr m_it;
 107         xsInteger m_counter;
 108         const xsInteger m_start;
 109         const xsInteger m_len;
 110         const xsInteger m_stop;
 111     };
 112 }
 113
 114 QT_END_NAMESPACE
 115
 116 QT_END_HEADER
 117
 118 #endif