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_DocumentFN_H
51#define Patternist_DocumentFN_H
52
53#include <private/qfunctioncall_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59
60 /**
61 * @short Implements XSL-T's function <tt>fn:document()</tt>.
62 *
63 * @c fn:document() has no evaluation functions, because it rewrites
64 * itself to a set of expressions that is the implementation.
65 *
66 * The two-argument version:
67 *
68 * <tt>document($uris as item()*, $baseURINode as node()) as node()*</tt>
69 *
70 * is rewritten into:
71 *
72 * <tt>for $uri in distinct-values($uris)
73 * return doc(resolve-uri($uri, base-uri($baseURINode)))</tt>
74 *
75 * and the single version argument:
76 *
77 * <tt>document($uris as item()*) as node()*</tt>
78 *
79 * is rewritten into:
80 *
81 * <tt>for $uri in distinct-values($uris)
82 * return doc($uri)</tt>
83 *
84 * The distinct-values() call ensures the node deduplication and sorting,
85 * although it fails in the case that URIs resolve/directs in some way to
86 * the same document. Some of those cases can be solved by wrapping the
87 * whole expression with a node deduplication(conceptually the-for-loop/.).
88 * One advantage with distinct-values() over generating traditional node
89 * sorting/deduplication code is that the latter contains node sorting
90 * which is uecessary and can be hard to analyze away. distinct-values()
91 * doesn't have this problem due to its narrower task..
92 *
93 * This works without problems, assuming XTRE1160 is not raised and that
94 * the recover action instead is ignore. In the case XTRE1160 is raised,
95 * one must cater for this.
96 *
97 * In addition to this, both signatures has its first argument changed to
98 * type <tt>xs:string*</tt>, in order to generate atomization code.
99 *
100 * One notable thing is that the expression for $baseURINode, is moved
101 * inside a loop, and will be evaluated repeatedly, unless moved out as
102 * part of optimization.
103 *
104 * @ingroup Patternist_functions
105 * @author Frans Englich <frans.englich@nokia.com>
106 * @since 4.5
107 */
108 class DocumentFN : public FunctionCall
109 {
110 public:
111 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
112 const SequenceType::Ptr &reqType);
113 };
114}
115
116QT_END_NAMESPACE
117
118#endif
119

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