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_ErrorFN_H |
51 | #define Patternist_ErrorFN_H |
52 | |
53 | #include <private/qfunctioncall_p.h> |
54 | |
55 | QT_BEGIN_NAMESPACE |
56 | |
57 | namespace QPatternist |
58 | { |
59 | |
60 | /** |
61 | * @short Implements the function <tt>fn:error()</tt>. |
62 | * |
63 | * <tt>fn:error()</tt> is a bit special in that its first argument varies between |
64 | * the different signatures. This is implemented by changing the function |
65 | * signature if the amount of arguments is one. |
66 | * |
67 | * <tt>fn:error()</tt> has as return type the peculiar "none" type, which is handled by NoneType. |
68 | * |
69 | * @ingroup Patternist_functions |
70 | * @see CommonSequenceTypes::none |
71 | * @see <a href="http://www.w3.org/TR/xpath-functions/#func-error">XQuery 1.0 and |
72 | * XPath 2.0 Functions and Operators, 3 The Error Function</a> |
73 | * @author Frans Englich <frans.englich@nokia.com> |
74 | */ |
75 | class ErrorFN : public FunctionCall |
76 | { |
77 | public: |
78 | virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const; |
79 | virtual FunctionSignature::Ptr signature() const; |
80 | }; |
81 | } |
82 | |
83 | QT_END_NAMESPACE |
84 | |
85 | #endif |
86 | |