1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
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_SequenceGeneratingFNs_H
53 #define Patternist_SequenceGeneratingFNs_H
55 #include <private/qanyuri_p.h>
56 #include <private/qcontextnodechecker_p.h>
57 #include <private/qstaticbaseuricontainer_p.h>
61 * @short Contains classes implementing the functions found in
62 * <a href="http://www.w3.org/TR/xpath-functions/#fns-that-generate-sequences">XQuery 1.0 and
63 * XPath 2.0 Functions and Operators, 15.5 Functions and Operators that Generate Sequences</a>.
65 * @ingroup Patternist_functions
75 * @short Implements the function <tt>fn:id()</tt>.
77 * @ingroup Patternist_functions
78 * @author Frans Englich <frans.englich@nokia.com>
80 class IdFN : public ContextNodeChecker
84 typedef QPair<DynamicContext::Ptr, const QAbstractXmlNodeModel *> IDContext;
86 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
88 inline Item mapToItem(const QString &id,
89 const IDContext &context) const;
91 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
92 const SequenceType::Ptr &reqType);
95 typedef QExplicitlySharedDataPointer<const IdFN> ConstPtr;
96 bool m_hasCreatedSorter;
100 * @short Implements the function <tt>fn:idref()</tt>.
102 * @ingroup Patternist_functions
103 * @author Frans Englich <frans.englich@nokia.com>
105 class IdrefFN : public ContextNodeChecker
108 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
112 * @short Implements the function <tt>fn:doc()</tt>.
114 * @ingroup Patternist_functions
115 * @author Frans Englich <frans.englich@nokia.com>
117 class DocFN : public StaticBaseUriContainer
120 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
123 * The implementation of this function is placed in a different compilation unit,
124 * namely qsequencefns.cpp, to workaround a compiler bug on
125 * solaris-cc-64, suspected to be related to the instantiation of QUrl::toQUrl().
128 * href="http://onesearch.sun.com/search/onesearch/index.jsp?qt=6532605&site=sunsolve&otf=ss&col=support-sunsolve&otf=sunsolve&site=ss&col=search-sunsolve">Sun,
129 * multiply-defined label for template instance, bug 6532605</a>
131 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
132 const SequenceType::Ptr &reqType);
133 virtual SequenceType::Ptr staticType() const;
136 SequenceType::Ptr m_type;
140 * @short Implements the function <tt>fn:doc-available()</tt>.
142 * @ingroup Patternist_functions
143 * @author Frans Englich <frans.englich@nokia.com>
145 class DocAvailableFN : public StaticBaseUriContainer
148 virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
152 * @short Implements the function <tt>fn:collection()</tt>.
154 * @ingroup Patternist_functions
155 * @author Frans Englich <frans.englich@nokia.com>
157 class CollectionFN : public FunctionCall
160 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;