source: trunk/src/xmlpatterns/iterators/qitemmappingiterator_p.h@ 883

Last change on this file since 883 was 846, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

File size: 7.2 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
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_ItemMappingIterator_H
53#define Patternist_ItemMappingIterator_H
54
55#include "qabstractxmlforwarditerator_p.h"
56#include "qdynamiccontext_p.h"
57
58QT_BEGIN_HEADER
59
60QT_BEGIN_NAMESPACE
61
62namespace QPatternist
63{
64 /**
65 * @short Proxies another QAbstractXmlForwardIterator, and for each item, returns the
66 * Item returned from a mapping function.
67 *
68 * ItemMappingIterator is practical when the items in an QAbstractXmlForwardIterator needs to
69 * be translated to another sequence, while still doing it in a pipe-lined
70 * fashion.
71 *
72 * This is achieved by that ItemMappingIterator's constructor takes
73 * an instance of a class, that must have the following member:
74 *
75 * @code
76 * TResult::Ptr mapToItem(const TSource &item,
77 * const Context &context) const
78 * @endcode
79 *
80 * For each item in the QAbstractXmlForwardIterator ItemMappingIterator proxies, this function is
81 * called and its return value becomes the return value of the ItemMappingIterator. If the
82 * mapping function returns null, ItemMappingIterator maps the next item in the source sequence
83 * such that a contiguous sequence of items is returned.
84 *
85 * Declaring the mapToItem() function as inline, can be a good way to improve performance.
86 *
87 * @see SequenceMappingIterator
88 * @author Frans Englich <[email protected]>
89 * @ingroup Patternist_iterators
90 */
91 template<typename TResult, typename TSource, typename TMapper, typename Context = DynamicContext::Ptr>
92 class ItemMappingIterator : public QAbstractXmlForwardIterator<TResult>
93 {
94 public:
95 /**
96 * Constructs an ItemMappingIterator.
97 *
98 * @param mapper the object that has the mapToItem() sequence.
99 * @param iterator the QAbstractXmlForwardIterator whose items should be mapped.
100 * @param context the context that will be passed to the map function.
101 * May be null.