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