1 | /****************************************************************************
|
---|
2 | **
|
---|
3 | ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
|
---|
4 | ** All rights reserved.
|
---|
5 | ** Contact: Nokia Corporation ([email protected])
|
---|
6 | **
|
---|
7 | ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
|
---|
8 | **
|
---|
9 | ** $QT_BEGIN_LICENSE:LGPL$
|
---|
10 | ** Commercial Usage
|
---|
11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
---|
12 | ** accordance with the Qt Commercial License Agreement provided with the
|
---|
13 | ** Software or, alternatively, in accordance with the terms contained in
|
---|
14 | ** a written agreement between you and Nokia.
|
---|
15 | **
|
---|
16 | ** GNU Lesser General Public License Usage
|
---|
17 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
---|
18 | ** General Public License version 2.1 as published by the Free Software
|
---|
19 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
---|
20 | ** packaging of this file. Please review the following information to
|
---|
21 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
---|
22 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
---|
23 | **
|
---|
24 | ** In addition, as a special exception, Nokia gives you certain additional
|
---|
25 | ** rights. These rights are described in the Nokia Qt LGPL Exception
|
---|
26 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
---|
27 | **
|
---|
28 | ** GNU General Public License Usage
|
---|
29 | ** Alternatively, this file may be used under the terms of the GNU
|
---|
30 | ** General Public License version 3.0 as published by the Free Software
|
---|
31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
---|
32 | ** packaging of this file. Please review the following information to
|
---|
33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
---|
34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
---|
35 | **
|
---|
36 | ** If you have questions regarding the use of this file, please contact
|
---|
37 | ** Nokia at [email protected].
|
---|
38 | ** $QT_END_LICENSE$
|
---|
39 | **
|
---|
40 | ****************************************************************************/
|
---|
41 |
|
---|
42 | //
|
---|
43 | // W A R N I N G
|
---|
44 | // -------------
|
---|
45 | //
|
---|
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.
|
---|
49 | //
|
---|
50 | // We mean it.
|
---|
51 |
|
---|
52 | #ifndef Patternist_FunctionSignature_H
|
---|
53 | #define Patternist_FunctionSignature_H
|
---|
54 |
|
---|
55 | template<typename Key, typename Value> class QHash;
|
---|
56 | template<typename T> class QList;
|
---|
57 |
|
---|
58 | #include <QSharedData>
|
---|
59 |
|
---|
60 | #include "qcalltargetdescription_p.h"
|
---|
61 | #include "qexpression_p.h"
|
---|
62 | #include "qfunctionargument_p.h"
|
---|
63 | #include "qpatternistlocale_p.h"
|
---|
64 | #include "qprimitives_p.h"
|
---|
65 |
|
---|
66 | QT_BEGIN_HEADER
|
---|
67 |
|
---|
68 | QT_BEGIN_NAMESPACE
|
---|
69 |
|
---|
70 | namespace QPatternist
|
---|
71 | {
|
---|
72 |
|
---|
73 | /**
|
---|
74 | * @short Represents the signature of an XPath function.
|
---|
75 | *
|
---|
76 | * FunctionSignature represents and allows inspection of a function signature,
|
---|
77 | * such as <tt>fn:string-join($arg1 as xs:string*, $arg2 as xs:string) as xs:string</tt>.
|
---|
78 | * No XPath related languages allows polymorphism on the type of the arguments, only the
|
---|
79 | * amount(arity) of the arguments. For example, <tt>fn:string() as xs:string</tt> and
|
---|
80 | * <tt>fn:string($arg as item()?) as xs:string</tt> can happily co-exist, but
|
---|
81 | * <tt>fn:string($arg as item()?) as xs:string</tt> and
|
---|
82 | * <tt>fn:string($arg as xs:anyAtomicType?) as xs:string</tt> would be an error. This
|
---|
83 | * fact is reflected by FunctionSignature that if minimumArguments() and maximumArguments()
|
---|
84 | * are not equal, it means that this FunctionSignature represents several
|
---|
85 | * function signatures.
|
---|
86 | *
|
---|
87 | * @ingroup Patternist_functions
|
---|
88 | * @see <a href="http://www.w3.org/TR/xpath-functions/#func-signatures">XQuery 1.0 and
|
---|
89 | * XPath 2.0 Functions and Operators, 1.4 Function Signatures and Descriptions</a>
|
---|
90 | * @see <a href="http://en.wikipedia.org/wiki/Arity">Wikipedia, the free encyclopedia, Arity</a>
|
---|
91 | * @author Frans Englich <[email protected]>
|
---|
92 | */
|
---|
93 | class Q_AUTOTEST_EXPORT FunctionSignature : public CallTargetDescription
|
---|
94 | {
|
---|
95 | public:
|
---|
96 | enum
|
---|
97 | {
|
---|
98 | /**
|
---|
99 | * Flags the function as allowing an unlimited amount of arguments.
|
---|
100 | */
|
---|
|
---|