1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_SequenceGeneratingFNs_H
51#define Patternist_SequenceGeneratingFNs_H
52
53#include <private/qanyuri_p.h>
54#include <private/qcontextnodechecker_p.h>
55#include <private/qstaticbaseuricontainer_p.h>
56
57/**
58 * @file
59 * @short Contains classes implementing the functions found in
60 * <a href="http://www.w3.org/TR/xpath-functions/#fns-that-generate-sequences">XQuery 1.0 and
61 * XPath 2.0 Functions and Operators, 15.5 Functions and Operators that Generate Sequences</a>.
62 *
63 * @ingroup Patternist_functions
64 */
65
66QT_BEGIN_NAMESPACE
67
68namespace QPatternist
69{
70 /**
71 * @short Implements the function <tt>fn:id()</tt>.
72 *
73 * @ingroup Patternist_functions
74 * @author Frans Englich <frans.englich@nokia.com>
75 */
76 class IdFN : public ContextNodeChecker
77 {
78 public:
79 IdFN();
80 typedef QPair<DynamicContext::Ptr, const QAbstractXmlNodeModel *> IDContext;
81
82 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
83
84 inline Item mapToItem(const QString &id,
85 const IDContext &context) const;
86
87 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
88 const SequenceType::Ptr &reqType);
89
90 private:
91 typedef QExplicitlySharedDataPointer<const IdFN> ConstPtr;
92 bool m_hasCreatedSorter;
93 };
94
95 /**
96 * @short Implements the function <tt>fn:idref()</tt>.
97 *
98 * @ingroup Patternist_functions
99 * @author Frans Englich <frans.englich@nokia.com>
100 */
101 class IdrefFN : public ContextNodeChecker
102 {
103 public:
104 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
105 };
106
107 /**
108 * @short Implements the function <tt>fn:doc()</tt>.
109 *
110 * @ingroup Patternist_functions
111 * @author Frans Englich <frans.englich@nokia.com>
112 */
113 class DocFN : public StaticBaseUriContainer
114 {
115 public:
116 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
117
118 /**
119 * The implementation of this function is placed in a different compilation unit,
120 * namely qsequencefns.cpp, to workaround a compiler bug on
121 * solaris-cc-64, suspected to be related to the instantiation of QUrl::toQUrl().
122 *
123 * @see <a
124 * 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,
125 * multiply-defined label for template instance, bug 6532605</a>
126 */
127 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
128 const SequenceType::Ptr &reqType);
129 virtual SequenceType::Ptr staticType() const;
130
131 private:
132 SequenceType::Ptr m_type;
133 };
134
135 /**
136 * @short Implements the function <tt>fn:doc-available()</tt>.
137 *
138 * @ingroup Patternist_functions
139 * @author Frans Englich <frans.englich@nokia.com>
140 */
141 class DocAvailableFN : public StaticBaseUriContainer
142 {
143 public:
144 virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
145 };
146
147 /**
148 * @short Implements the function <tt>fn:collection()</tt>.
149 *
150 * @ingroup Patternist_functions
151 * @author Frans Englich <frans.englich@nokia.com>
152 */
153 class CollectionFN : public FunctionCall
154 {
155 public:
156 virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
157 };
158}
159
160QT_END_NAMESPACE
161
162#endif
163

source code of qtxmlpatterns/src/xmlpatterns/functions/qsequencegeneratingfns_p.h