net.sf.saxon.expr.SimpleExpression 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-2023 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.expr;
import net.sf.saxon.event.Outputter;
import net.sf.saxon.event.ReceiverOption;
import net.sf.saxon.expr.elab.*;
import net.sf.saxon.expr.oper.OperandArray;
import net.sf.saxon.expr.parser.RebindingMap;
import net.sf.saxon.om.*;
import net.sf.saxon.trace.ExpressionPresenter;
import net.sf.saxon.trans.SaxonErrorCode;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.transpile.CSharpReplaceBody;
import net.sf.saxon.type.ItemType;
import net.sf.saxon.type.Type;
import java.util.Arrays;
/**
* An abstract implementation of Expression designed to make it easy to implement new expressions,
* in particular, expressions to support extension instructions.
* An implementation of this class must supply the {@link Callable#call(XPathContext, net.sf.saxon.om.Sequence[])}
* method to evaluate the expression and return its result.
*/
public abstract class SimpleExpression extends Expression implements Callable {
private OperandArray operanda;
/**
* Constructor
*/
public SimpleExpression() {
}
/**
* Set the data structure for the operands of this expression. This must be created during initialisation of the
* expression and must not be subsequently changed
* @param operanda the data structure for expression operands
*/
protected void setOperanda(OperandArray operanda) {
this.operanda = operanda;
}
/**
* Get the data structure holding the operands of this expression.
* @return the data structure holding expression operands
*/
protected OperandArray getOperanda() {
return operanda;
}
@Override
public Iterable operands() {
return operanda;
}
/**
* Set the immediate sub-expressions of this expression.
*
* @param sub an array containing the sub-expressions of this expression
*/
public void setArguments(Expression[] sub) {
if (getOperanda() != null && getOperanda().getNumberOfOperands() > 0) {
throw new IllegalArgumentException("Cannot replace existing argument array");
}
Expression[] sub2 = Arrays.copyOf(sub, sub.length);
OperandRole[] roles = new OperandRole[sub.length];
Arrays.fill(roles, OperandRole.NAVIGATE);
setOperanda(new OperandArray(this, sub2, roles));
}
/**
* Copy an expression. This makes a deep copy.
*
* @return the copy of the original expression
* @param rebindings variables that need to be re-bound
*/
/*@NotNull*/
@Override
public Expression copy(RebindingMap rebindings) {
SimpleExpression se2 = simpleCopy();
Expression[] a2 = new Expression[operanda.getNumberOfOperands()];
int i = 0;
for (Operand o : operands()) {
a2[i++] = o.getChildExpression().copy(rebindings);
}
OperandArray o2 = new OperandArray(se2, a2, operanda.getRoles());
se2.setOperanda(o2);
return se2;
}
@CSharpReplaceBody(code="return (net.sf.saxon.expr.SimpleExpression)this.MemberwiseClone();")
public SimpleExpression simpleCopy() {
try {
return getClass().newInstance();
} catch (InstantiationException | IllegalAccessException e) {
throw new UnsupportedOperationException(getClass().getName() + ".copy()");
}
}
/**
* Helper method for subclasses to implement the copy() operation: this method can be applied
* to the new expression to copy operands from the old expressions
* @param se1 the expression being copied
* @return the target object of this method (for convenience)
*/
protected SimpleExpression copyOperandsFrom(SimpleExpression se1) {
Expression[] a2 = new Expression[se1.operanda.getNumberOfOperands()];
int i = 0;
for (Operand o : se1.operands()) {
a2[i++] = o.getChildExpression().copy(new RebindingMap());
}
OperandArray o2 = new OperandArray(this, a2, se1.operanda.getRoles());
setOperanda(o2);
return this;
}
/**
* Determine the data type of the items returned by this expression. This implementation
* returns "item()", which can be overridden in a subclass.
*
* @return the data type
*/
/*@NotNull*/
@Override
public ItemType getItemType() {
return Type.ITEM_TYPE;
}
/**
* Determine the static cardinality of the expression. This implementation
* returns "zero or more", which can be overridden in a subclass.
*/
@Override
protected int computeCardinality() {
if ((getImplementationMethod() & Expression.EVALUATE_METHOD) == 0) {
return StaticProperty.ALLOWS_ONE_OR_MORE;
} else {
return StaticProperty.ALLOWS_ZERO_OR_ONE;
}
}
/**
* Evaluate an expression as a single item. This always returns either a single Item or
* null (denoting the empty sequence). No conversion is done. This method should not be
* used unless the static type of the expression is a subtype of "item" or "item?": that is,
* it should not be called if the expression may return a sequence. There is no guarantee that
* this condition will be detected.
*
* @param context The context in which the expression is to be evaluated
* @return the node or atomic value that results from evaluating the
* expression; or null to indicate that the result is an empty
* sequence
* @throws XPathException if any dynamic error occurs evaluating the
* expression
*/
@Override
public final Item evaluateItem(XPathContext context) throws XPathException {
return call(context, evaluateArguments(context)).head();
}
/**
* Return an Iterator to iterate over the values of a sequence. The value of every
* expression can be regarded as a sequence, so this method is supported for all
* expressions. This default implementation handles iteration for expressions that
* return singleton values: for non-singleton expressions, the subclass must
* provide its own implementation.
*
* @param context supplies the context for evaluation
* @return a SequenceIterator that can be used to iterate over the result
* of the expression
* @throws XPathException if any dynamic error occurs evaluating the
* expression
*/
/*@NotNull*/
@Override
public final SequenceIterator iterate(XPathContext context) throws XPathException {
return call(context, evaluateArguments(context)).iterate();
}
/**
* Process the instruction, without returning any tail calls
*
* @param output the destination for the result
* @param context The dynamic context, giving access to the current node,
*/
@Override
public final void process(Outputter output, XPathContext context) throws XPathException {
SequenceIterator iter = call(context, evaluateArguments(context)).iterate();
SequenceTool.supply(iter, (ItemConsumer) it -> output.append(it, getLocation(), ReceiverOption.ALL_NAMESPACES));
}
/**
* Internal method to evaluate the arguments prior to calling the generic call() method
*
* @param context the XPath dynamic context
* @return the values of the (evaluated) arguments
* @throws XPathException if a dynamic error occurs
*/
private Sequence[] evaluateArguments(XPathContext context) throws XPathException {
Sequence[] iters =
SequenceTool.makeSequenceArray(getOperanda().getNumberOfOperands());
int i=0;
for (Operand o : operands()) {
iters[i++] = SequenceTool.toLazySequence(o.getChildExpression().iterate(context));
}
return iters;
}
/**
* Diagnostic print of expression structure. The abstract expression tree
* is written to the supplied output destination.
*/
@Override
public void export(ExpressionPresenter destination) throws XPathException {
throw new XPathException("In general, stylesheets using extension instructions cannot be exported",
SaxonErrorCode.SXST0072);
}
/**
* Return a distinguishing name for the expression, for use in diagnostics.
* By default the class name is used.
*
* @return a distinguishing name for the expression (defaults to the name of the implementation class)
*/
public String getExpressionType() {
return getClass().getName();
}
@Override
public Elaborator getElaborator() {
return new SimpleExpressionElaborator();
}
public static class SimpleExpressionElaborator extends PushElaborator {
@Override
public PushEvaluator elaborateForPush() {
SimpleExpression expr = (SimpleExpression)getExpression();
return (output, context) -> {
expr.process(output, context);
return null;
};
}
@SuppressWarnings("Convert2MethodRef")
@Override
public PullEvaluator elaborateForPull() {
SimpleExpression expr = (SimpleExpression) getExpression();
return context -> expr.iterate(context);
}
@SuppressWarnings("Convert2MethodRef")
@Override
public ItemEvaluator elaborateForItem() {
SimpleExpression expr = (SimpleExpression) getExpression();
return context -> expr.evaluateItem(context);
}
}
}