src/xmlpatterns/iterators/qtocodepointsiterator_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_ToCodepointsIterator_H
  53 #define Patternist_ToCodepointsIterator_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 Represents a stream of Unicode codepoints, which are computed from a string.
  65      *
  66      * ToCodepointsIterator takes in its constructor a string, whose Unicode characters'
  67      * codepoints it forms an QAbstractXmlForwardIterator over.
  68      *
  69      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-string-to-codepoints">XQuery 1.0
  70      * and XPath 2.0 Functions and Operators, 7.2.2 fn:string-to-codepoints</a>
  71      * @see StringToCodepointsFN
  72      * @author Frans Englich <frans.englich@nokia.com>
  73      * @ingroup Patternist_iterators
  74      */
  75     class ToCodepointsIterator : public Item::Iterator
  76     {
  77     public:
  78         /**
  79          * Constructs a ToCodepointsIterator.
  80          *
  81          * @param string the string to retrieve Unicode codepoints from. Can not be
  82          * empty.
  83          */
  84         ToCodepointsIterator(const QString &string);
  85         virtual Item next();
  86         virtual Item current() const;
  87         virtual xsInteger position() const;
  88         virtual xsInteger count();
  89         virtual Item::Iterator::Ptr copy() const;
  90
  91     private:
  92         const QString m_string;
  93         const int m_len;
  94         Item m_current;
  95         xsInteger m_position;
  96     };
  97 }
  98
  99 QT_END_NAMESPACE
 100
 101 QT_END_HEADER
 102
 103 #endif