/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-2016 The eXist Project
* http://exist-db.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.exist.xquery;
import java.lang.reflect.Constructor;
import java.util.List;
import org.exist.dom.QName;
import org.exist.xquery.parser.XQueryAST;
import org.exist.xquery.util.Error;
import org.exist.xquery.util.ExpressionDumper;
import org.exist.xquery.util.Messages;
import org.exist.xquery.value.Item;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;
/**
* Abstract base class for all built-in and user-defined functions.
* <p>
* Built-in functions just extend this class. A new function instance
* will be created for each function call. Subclasses <b>have</b> to
* provide a function signature to the constructor.
* <p>
* User-defined functions extend class {@link org.exist.xquery.UserDefinedFunction},
* which is again a subclass of Function. They will not be called directly, but through a
* {@link org.exist.xquery.FunctionCall} object, which checks the type and cardinality of
* all arguments and takes care that the current execution context is saved properly.
*
* @author wolf
*/
public abstract class Function extends PathExpr {
// Declare it in Namespaces instead? /ljo
public final static String BUILTIN_FUNCTION_NS =
"http://www.w3.org/2005/xpath-functions";
// The signature of the function.
protected FunctionSignature mySignature;
// The parent expression from which this function is called.
private Expression parent;
/**
* Flag to indicate if argument types are statically checked.
* This is set to true by default (meaning: no further checks needed).
* Method {@link #setArguments(java.util.List)} will set it to false
* (unless overwritten), thus enforcing a check.
*/
protected boolean argumentsChecked = true;
/**
* Internal constructor. Subclasses should <b>always</b> call this and
* pass the current context and their function signature.
*
* @param context
* @param signature
*/
protected Function(final XQueryContext context, final FunctionSignature signature) {
super(context);
this.mySignature = signature;
}
protected Function(final XQueryContext context) {
super(context);
}
/**
* Returns the module to which this function belongs
*/
protected Module getParentModule() {
return context.getModule(mySignature.getName().getNamespaceURI());
}
@Override
public int returnsType() {
if (mySignature == null) {
return Type.ITEM;
} // Type is not known yet
if (mySignature.getReturnType() == null) {
throw new IllegalArgumentException("Return type for function " +
mySignature.getName() + " is not defined");
}
return mySignature.getReturnType().getPrimaryType();
}
@Override
public int getCardinality() {
if (mySignature.getReturnType() == null) {
throw new IllegalArgumentException("Return type for function " +
mySignature.getName() + " is not defined");
}
return mySignature.getReturnType().getCardinality();
}
/**
* Create a built-in function from the specified class.
*
* @return the created function or null if the class could not be initialized.
*/
public static Function createFunction(final XQueryContext context, final XQueryAST ast,
final FunctionDef def) throws XPathException {
if (def == null) {
throw new XPathException(ast.getLine(), ast.getColumn(), "Class for function is null");
}
final Class<? extends Function> fclass = def.getImplementingClass();
if (fclass == null) {
throw new XPathException(ast.getLine(), ast.getColumn(), "Class for function is null");
}
try {
Object initArgs[] = {context};
Class<?> constructorArgs[] = {XQueryContext.class};
Constructor<?> construct = null;
try {
construct = fclass.getConstructor(constructorArgs);
} catch (final NoSuchMethodException e) {
//Don't ignore ? -pb
}
//Not found: check if the constructor takes two arguments
if (construct == null) {
constructorArgs = new Class[2];
constructorArgs[0] = XQueryContext.class;
constructorArgs[1] = FunctionSignature.class;
construct = fclass.getConstructor(constructorArgs);
if (construct == null) {
throw new XPathException(ast.getLine(), ast.getColumn(), "Constructor not found");
}
initArgs = new Object[2];
initArgs[0] = context;
initArgs[1] = def.getSignature();
}
final Object obj = construct.newInstance(initArgs);
if (obj instanceof Function) {
((Function) obj).setLocation(ast.getLine(), ast.getColumn());
return (Function) obj;
} else {
throw new XPathException(ast.getLine(), ast.getColumn(),
"Function object does not implement interface function");
}
} catch (final Exception e) {
LOG.debug(e.getMessage(), e);
throw new XPathException(ast.getLine(), ast.getColumn(),
"Function implementation class " + fclass.getName() + " not found");
}
}
/**
* Set the parent expression of this function, i.e. the
* expression from which the function is called.
*
* @param parent
*/
public void setParent(final Expression parent) {
this.parent = parent;
}
/**
* Returns the expression from which this function gets called.
*/
@Override
public Expression getParent() {
return parent;
}
/**
* Set the (static) arguments for this function from a list of expressions.
* <p>
* This will also trigger a check on the type and cardinality of the
* passed argument expressions. By default, the method sets the
* argumentsChecked property to false, thus triggering the analyze method to
* perform a type check.
* <p>
* Classes overwriting this method are typically optimized functions and will
* handle type checks for arguments themselves.
*
* @param arguments
* @throws XPathException
*/
public void setArguments(final List<Expression> arguments) throws XPathException {
if ((!mySignature.isOverloaded()) && arguments.size() != mySignature.getArgumentCount()) {
throw new XPathException(this, ErrorCodes.XPST0017,
"Number of arguments of function " + getName() + " doesn't match function signature (expected " +
mySignature.getArgumentCount() + ", got " + arguments.size() + ')');
}
steps.clear();
for (final Expression argument : arguments) {
steps.add(argument.simplify());
}
argumentsChecked = false;
}
/**
* @throws XPathException
*/
protected void checkArguments() throws XPathException {
if (!argumentsChecked) {
final SequenceType[] argumentTypes = mySignature.getArgumentTypes();
SequenceType argType = null;
for (int i = 0; i < getArgumentCount(); i++) {
if (argumentTypes != null && i < argumentTypes.length) {
argType = argumentTypes[i];
}
final Expression next = checkArgument(getArgument(i), argType, i + 1);
steps.set(i, next);
}
}
argumentsChecked = true;
}
/**
* Statically check an argument against the sequence type specified in
* the signature.
*
* @param expr
* @param type
* @return The passed expression
* @throws XPathException
*/
protected Expression checkArgument(Expression expr, final SequenceType type, final int argPosition)
throws XPathException {
if (type == null || expr instanceof Placeholder) {
return expr;
}
// check cardinality if expected cardinality is not zero or more
boolean cardinalityMatches =
expr instanceof VariableReference ||
type.getCardinality() == Cardinality.ZERO_OR_MORE;
if (!cardinalityMatches) {
cardinalityMatches =
(expr.getCardinality() | type.getCardinality()) == type.getCardinality();
if (!cardinalityMatches) {
if (expr.getCardinality() == Cardinality.ZERO
&& (type.getCardinality() & Cardinality.ZERO) == 0) {
throw new XPathException(this,
ErrorCodes.XPTY0004,
Messages.getMessage(Error.FUNC_EMPTY_SEQ_DISALLOWED,
Integer.valueOf(argPosition), ExpressionDumper.dump(expr)));
}
}
}
expr = new DynamicCardinalityCheck(context, type.getCardinality(), expr,
new Error(Error.FUNC_PARAM_CARDINALITY, argPosition, mySignature));
// check return type if both types are not Type.ITEM
int returnType = expr.returnsType();
if (returnType == Type.ANY_TYPE || returnType == Type.EMPTY) {
returnType = Type.ITEM;
}
boolean typeMatches = type.getPrimaryType() == Type.ITEM;
typeMatches = Type.subTypeOf(returnType, type.getPrimaryType());
if (typeMatches && cardinalityMatches) {
if (type.getNodeName() != null) {
expr = new DynamicNameCheck(context,
new NameTest(type.getPrimaryType(), type.getNodeName()), expr);
}
return expr;
}
//Loose argument check : we may move this, or a part hereof, to UntypedValueCheck
if (context.isBackwardsCompatible()) {
if (Type.subTypeOf(type.getPrimaryType(), Type.STRING)) {
if (!Type.subTypeOf(returnType, Type.ATOMIC)) {
expr = new Atomize(context, expr);
returnType = Type.ATOMIC;
}
expr = new AtomicToString(context, expr);
returnType = Type.STRING;
} else if (type.getPrimaryType() == Type.NUMBER
|| Type.subTypeOf(type.getPrimaryType(), Type.DOUBLE)) {
if (!Type.subTypeOf(returnType, Type.ATOMIC)) {
expr = new Atomize(context, expr);
returnType = Type.ATOMIC;
}
expr = new UntypedValueCheck(context, type.getPrimaryType(), expr,
new Error(Error.FUNC_PARAM_TYPE, String.valueOf(argPosition), mySignature));
returnType = type.getPrimaryType();
}
//If the required type is an atomic type, convert the argument to an atomic
if (Type.subTypeOf(type.getPrimaryType(), Type.ATOMIC)) {
if (!Type.subTypeOf(returnType, Type.ATOMIC)) {
expr = new Atomize(context, expr);
}
if (!(type.getPrimaryType() == Type.ATOMIC)) {
expr = new UntypedValueCheck(context, type.getPrimaryType(),
expr, new Error(Error.FUNC_PARAM_TYPE, String.valueOf(argPosition), mySignature));
}
returnType = expr.returnsType();
}
//Strict argument check : we may move this, or a part hereof, to UntypedValueCheck
} else {
//If the required type is an atomic type, convert the argument to an atomic
if (Type.subTypeOf(type.getPrimaryType(), Type.ATOMIC)) {
if (!Type.subTypeOf(returnType, Type.ATOMIC)) {
expr = new Atomize(context, expr);
}
expr = new UntypedValueCheck(context, type.getPrimaryType(),
expr, new Error(Error.FUNC_PARAM_TYPE, String.valueOf(argPosition), mySignature));
returnType = expr.returnsType();
}
}
if (returnType != Type.ITEM && !Type.subTypeOf(returnType, type.getPrimaryType())) {
if (!(Type.subTypeOf(type.getPrimaryType(), returnType) ||
//Because () is seen as a node
(Cardinality.checkCardinality(type.getCardinality(), Cardinality.ZERO) && returnType == Type.NODE))) {
LOG.debug(ExpressionDumper.dump(expr));
throw new XPathException(this, Messages.getMessage(Error.FUNC_PARAM_TYPE_STATIC,
String.valueOf(argPosition), mySignature, type.toString(), Type.getTypeName(returnType)));
}
}
if (!typeMatches) {
if (type.getNodeName() != null) {
expr = new DynamicNameCheck(context,
new NameTest(type.getPrimaryType(), type.getNodeName()), expr);
} else {
expr = new DynamicTypeCheck(context, type.getPrimaryType(), expr);
}
}
return expr;
}
@Override
public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
// statically check the argument list
checkArguments();
// call analyze for each argument
inPredicate = (contextInfo.getFlags() & IN_PREDICATE) > 0;
unordered = (contextInfo.getFlags() & UNORDERED) > 0;
contextId = contextInfo.getContextId();
contextInfo.setParent(this);
for (int i = 0; i < getArgumentCount(); i++) {
final AnalyzeContextInfo argContextInfo = new AnalyzeContextInfo(contextInfo);
getArgument(i).analyze(argContextInfo);
}
}
public abstract Sequence eval(final Sequence contextSequence, final Item contextItem)
throws XPathException;
public Sequence[] getArguments(Sequence contextSequence, final Item contextItem)
throws XPathException {
if (contextItem != null) {
contextSequence = contextItem.toSequence();
}
final int argCount = getArgumentCount();
final Sequence[] args = new Sequence[argCount];
for (int i = 0; i < argCount; i++) {
args[i] = getArgument(i).eval(contextSequence, contextItem);
}
return args;
}
/**
* Get an argument expression by its position in the
* argument list.
*
* @param pos
*/
public Expression getArgument(final int pos) {
return getExpression(pos);
}
/**
* Get the number of arguments passed to this function.
*
* @return number of arguments
*/
public int getArgumentCount() {
return steps.size();
}
@Override
public void setPrimaryAxis(final int axis) {
}
/**
* Return the name of this function.
*
* @return name of this function
*/
public QName getName() {
return mySignature.getName();
}
/**
* Get the signature of this function.
*
* @return signature of this function
*/
public FunctionSignature getSignature() {
return mySignature;
}
public boolean isCalledAs(final String localName) {
return localName.equals(mySignature.getName().getLocalPart());
}
@Override
public int getDependencies() {
return Dependency.CONTEXT_ITEM | Dependency.CONTEXT_SET;
}
@Override
public void dump(final ExpressionDumper dumper) {
dumper.display(getName());
dumper.display('(');
boolean moreThanOne = false;
for (final Expression e : steps) {
if (moreThanOne) {
dumper.display(", ");
}
moreThanOne = true;
e.dump(dumper);
}
dumper.display(')');
}
@Override
public String toString() {
final StringBuilder result = new StringBuilder();
result.append(getName());
result.append('(');
boolean moreThanOne = false;
for (final Expression step : steps) {
if (moreThanOne) {
result.append(", ");
}
moreThanOne = true;
result.append(step.toString());
}
result.append(')');
return result.toString();
}
@Override
public void accept(final ExpressionVisitor visitor) {
visitor.visitBuiltinFunction(this);
}
@Override
public Expression simplify() {
return this;
}
public final static class Placeholder extends AbstractExpression {
public Placeholder(final XQueryContext context) {
super(context);
}
@Override
public void analyze(final AnalyzeContextInfo contextInfo)
throws XPathException {
}
@Override
public void dump(final ExpressionDumper dumper) {
dumper.display('?');
}
@Override
public Sequence eval(final Sequence contextSequence, final Item contextItem)
throws XPathException {
throw new XPathException(this, ErrorCodes.EXXQDY0001, "Internal error: function argument placeholder not expanded.");
}
@Override
public int returnsType() {
return Type.ITEM;
}
}
}