1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
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.
52 #ifndef Patternist_ToCodepointsIterator_H
53 #define Patternist_ToCodepointsIterator_H
55 #include <private/qitem_p.h>
64 * @short Represents a stream of Unicode codepoints, which are computed from a string.
66 * ToCodepointsIterator takes in its constructor a string, whose Unicode characters'
67 * codepoints it forms an QAbstractXmlForwardIterator over.
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
75 class ToCodepointsIterator : public Item::Iterator
79 * Constructs a ToCodepointsIterator.
81 * @param string the string to retrieve Unicode codepoints from. Can not be
84 ToCodepointsIterator(const QString &string);
86 virtual Item current() const;
87 virtual xsInteger position() const;
88 virtual xsInteger count();
89 virtual Item::Iterator::Ptr copy() const;
92 const QString m_string;