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_AbstractFunctionFactory_H
51#define Patternist_AbstractFunctionFactory_H
52
53#include <private/qcommonnamespaces_p.h>
54#include <private/qfunctionfactory_p.h>
55#include <private/qfunctionsignature_p.h>
56
57QT_BEGIN_NAMESPACE
58
59namespace QPatternist
60{
61
62 /**
63 * @short Supplies convenience code for the function factories.
64 *
65 * @ingroup Patternist_functions
66 * @see XPath10CoreFunctions
67 * @see XPath20CoreFunctions
68 * @see XSLT10CoreFunctions
69 * @author Vincent Ricard <magic@magicninja.org>
70 */
71 class AbstractFunctionFactory : public FunctionFactory
72 {
73 public:
74 virtual Expression::Ptr createFunctionCall(const QXmlName name,
75 const Expression::List &arguments,
76 const StaticContext::Ptr &context,
77 const SourceLocationReflection *const r);
78
79 virtual FunctionSignature::Hash functionSignatures() const;
80
81 protected:
82 /**
83 * This function is responsible for creating the actual Expression, corresponding
84 * to @p localName and the function signature @p sign. It is called by
85 * createFunctionCall(), once it have been determined the function actually
86 * exists and have the correct arity.
87 *
88 * This function will only be called for names in the @c fn namespace.
89 */
90 virtual Expression::Ptr retrieveExpression(const QXmlName name,
91 const Expression::List &args,
92 const FunctionSignature::Ptr &sign) const = 0;
93
94 inline
95 FunctionSignature::Ptr addFunction(const QXmlName::LocalNameCode localName,
96 const FunctionSignature::Arity minArgs,
97 const FunctionSignature::Arity maxArgs,
98 const SequenceType::Ptr &returnType,
99 const Expression::Properties props)
100 {
101 return addFunction(localName,
102 minArgs,
103 maxArgs,
104 returnType,
105 id: Expression::IDIgnorableExpression,
106 props);
107 }
108
109 FunctionSignature::Ptr addFunction(const QXmlName::LocalNameCode &localName,
110 const FunctionSignature::Arity minArgs,
111 const FunctionSignature::Arity maxArgs,
112 const SequenceType::Ptr &returnType,
113 const Expression::ID id = Expression::IDIgnorableExpression,
114 const Expression::Properties props = Expression::Properties(),
115 const StandardNamespaces::ID ns = StandardNamespaces::fn)
116 {
117 const QXmlName name(ns, localName);
118
119 const FunctionSignature::Ptr s(new FunctionSignature(name, minArgs, maxArgs,
120 returnType, props, id));
121
122 m_signatures.insert(akey: name, avalue: s);
123 return s;
124 }
125
126 static inline QXmlName::LocalNameCode argument(const NamePool::Ptr &np, const char *const name)
127 {
128 return np->allocateLocalName(ln: QLatin1String(name));
129 }
130
131 FunctionSignature::Hash m_signatures;
132
133 private:
134 /**
135 * @short Determines whether @p arity is a valid number of
136 * arguments for the function with signature @p sign.
137 *
138 * If it is not, a static error with error code ReportContext::XPST0017
139 * is issued via @p context.
140 */
141 void verifyArity(const FunctionSignature::Ptr &sign,
142 const StaticContext::Ptr &context,
143 const xsInteger arity,
144 const SourceLocationReflection *const r) const;
145
146 };
147}
148
149QT_END_NAMESPACE
150
151#endif
152

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