net.sf.saxon.functions.IntegratedFunctionLibrary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2022 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.functions;
import net.sf.saxon.expr.Expression;
import net.sf.saxon.expr.StaticContext;
import net.sf.saxon.lib.ExtensionFunctionCall;
import net.sf.saxon.lib.ExtensionFunctionDefinition;
import net.sf.saxon.om.Function;
import net.sf.saxon.om.StructuredQName;
import net.sf.saxon.trans.SymbolicName;
import net.sf.saxon.trans.XPathException;
import java.util.HashMap;
import java.util.List;
/**
* A library of integrated function calls, that is, user-written extension functions implemented
* as instances of the class IntegratedFunction.
*/
public class IntegratedFunctionLibrary implements FunctionLibrary {
private HashMap functions =
new HashMap<>();
/**
* Register an integrated function with this function library
*
* @param function the implementation of the function (or set of functions)
*/
public void registerFunction(ExtensionFunctionDefinition function) {
functions.put(function.getFunctionQName(), function);
}
/**
* Bind an extension function, given the URI and local parts of the function name,
* and the list of expressions supplied as arguments. This method is called at compile
* time.
*
* @param functionName the QName and arity of the function being called
* @param staticArgs The expressions supplied statically in arguments to the function call.
* The length of this array represents the arity of the function. The intention is
* that the static type of the arguments (obtainable via getItemType() and getCardinality()) may
* be used as part of the binding algorithm. In some cases it may be possible for the function
* to be pre-evaluated at compile time, for example if these expressions are all constant values.
* The conventions of the XPath language demand that the results of a function depend only on the
* values of the expressions supplied as arguments, and not on the form of those expressions. For
* example, the result of f(4) is expected to be the same as f(2+2). The actual expression is supplied
* here to enable the binding mechanism to select the most efficient possible implementation (including
* compile-time pre-evaluation where appropriate).
* @param env The static context of the function call
* @param reasons If no matching function is found by the function library, it may add
* a diagnostic explanation to this list explaining why none of the available
* functions could be used.
* @return An object representing the function to be called, if one is found;
* null if no function was found matching the required name and arity.
*/
@Override
public Expression bind(SymbolicName.F functionName, Expression[] staticArgs, StaticContext env, List reasons) {
ExtensionFunctionDefinition defn = functions.get(functionName.getComponentName());
if (defn == null) {
return null;
}
return makeFunctionCall(defn, staticArgs);
}
public static Expression makeFunctionCall(ExtensionFunctionDefinition defn, Expression[] staticArgs) {
ExtensionFunctionCall f = defn.makeCallExpression();
f.setDefinition(defn);
IntegratedFunctionCall fc = new IntegratedFunctionCall(defn.getFunctionQName(), f);
fc.setArguments(staticArgs);
return fc;
}
/**
* Test whether a function with a given name and arity is available; if so, return a function
* item that can be dynamically called.
* This supports the function-lookup() function in XPath 3.0.
*
* @param functionName the qualified name of the function being called
* @param staticContext the static context to be used by the function, in the event that
* it is a system function with dependencies on the static context
* @return if a function of this name and arity is available for calling, then a corresponding
* function item; or null if the function does not exist
* @throws net.sf.saxon.trans.XPathException
* in the event of certain errors, for example attempting to get a function
* that is private
*/
@Override
public Function getFunctionItem(SymbolicName.F functionName, StaticContext staticContext) throws XPathException {
ExtensionFunctionDefinition defn = functions.get(functionName.getComponentName());
if (defn == null) {
return null;
}
try {
return defn.asFunction();
// ExtensionFunctionCall f = defn.makeCallExpression();
// FunctionItemType type = new SpecificFunctionType(
// defn.getArgumentTypes(), defn.getResultType(defn.getArgumentTypes()));
// return new CallableFunction(functionName, f, type);
} catch (Exception err) {
throw new XPathException("Failed to create call to extension function " + functionName.getComponentName().getDisplayName(), err);
}
}
/**
* Test whether a function with a given name and arity is available
* This supports the function-available() function in XSLT.
*
* @param functionName the qualified name of the function being called
* @param languageLevel the XPath language level, times 10 (31 = XPath 3.1)
* @return true if a function of this name and arity is available for calling
*/
@Override
public boolean isAvailable(SymbolicName.F functionName, int languageLevel) {
ExtensionFunctionDefinition defn = functions.get(functionName.getComponentName());
int arity = functionName.getArity();
return defn != null && defn.getMaximumNumberOfArguments() >= arity && defn.getMinimumNumberOfArguments() <= arity;
}
/**
* This method creates a copy of a FunctionLibrary: if the original FunctionLibrary allows
* new functions to be added, then additions to this copy will not affect the original, or
* vice versa.
*
* @return a copy of this function library. This must be an instance of the original class.
*/
@Override
public FunctionLibrary copy() {
IntegratedFunctionLibrary lib = new IntegratedFunctionLibrary();
// Type parameters needed for C#
lib.functions = copyHashMap(functions);
return lib;
}
private HashMap copyHashMap(HashMap functions) {
// Separate method for C# type inference
return new HashMap<>(functions);
}
}