1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#ifndef Patternist_FunctionFactory_H
#define Patternist_FunctionFactory_H
#include <QHash>
#include <QSharedData>
#include "qexpression_p.h"
#include "qfunctionsignature_p.h"
#include "qprimitives_p.h"
#include "qxmlname.h"
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short An entry point for looking up and creating FunctionCall instances.
*
* @ingroup Patternist_functions
* @see <a href ="http://www.w3.org/TR/xpath-functions/">XQuery 1.0
* and XPath 2.0 Functions and Operators</a>
* @see <a href="http://www.w3.org/TR/xpath20/#dt-function-signature">XML Path
* Language (XPath) 2.0, Definition: Function signatures</a>
* @author Frans Englich <frans.englich@nokia.com>
*/
class FunctionFactory : public QSharedData
{
public:
typedef QExplicitlySharedDataPointer<FunctionFactory> Ptr;
typedef QList<FunctionFactory::Ptr> List;
virtual ~FunctionFactory();
/**
* Creates a function call implementation.
*
* A FunctionFactory represents a set of functions, which it
* is able to instantiate and to serve FunctionSignatures for. Conventionally,
* a FunctionFactory per namespace exists.
*
* @note This function should not issue any error unless it is absolutely
* confident that the error cannot be fixed in another way. For example, in
* some cases it might be that a function is available in another FunctionFactory
* and it would therefore be wrong to issue an error signalling that no function
* by that @p name exists, but leave that to the callee.
* @param name the name of the function to create. In Clark syntax, this could
* for example be {http://www.w3.org/2005/04/xpath-functions}lower-case
* @param arguments the function's operands
* @param context the usual StaticContext which supplies compile time data
* and reporting functionality.
* @param r the SourceLocationReflection that identifies the callsite.
* @returns an instance of Expression which is the function implementation
* for @p name. Or, a static error was raised.
*/
virtual Expression::Ptr createFunctionCall(const QXmlName name,
const Expression::List &arguments,
const StaticContext::Ptr &context,
const SourceLocationReflection *const r) = 0;
/**
* Determines whether a function with the name @p name and arity @p arity
* is available. The implementation operates on the result of
* retrieveFunctionSignature() to determine the result.
*
* @param np the NamePool.
* @param name the name of the function. For example fn:string-join.
* @param arity the number of arguments the function must have.
*/
virtual bool isAvailable(const NamePool::Ptr &np,
const QXmlName name,
const xsInteger arity);
virtual FunctionSignature::Hash functionSignatures() const = 0;
/**
* Determines whether this FunctionFactory contains the function signature
* @p signature.
*
* The implementation uses functionSignatures().
*/
bool hasSignature(const FunctionSignature::Ptr &signature) const;
protected:
/**
* @short This constructor cannot be removed, because it can't be synthesized, for
* some reason.
*/
inline FunctionFactory()
{
}
/**
* This is a convenience function for sub-classes. It retrieves the
* function signature for function with name @p name.
*
* According to the specifications are function signatures identified by their
* name and arity, but currently is the arity not part of the signature.
*
* If no function could be found for the given name, @c null is returned.
*/
virtual FunctionSignature::Ptr retrieveFunctionSignature(const NamePool::Ptr &np, const QXmlName name) = 0;
private:
Q_DISABLE_COPY(FunctionFactory)
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif
|
