net.sf.saxon.style.XSLCopy 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.style;
import net.sf.saxon.expr.*;
import net.sf.saxon.expr.instruct.*;
import net.sf.saxon.expr.parser.RoleDiagnostic;
import net.sf.saxon.lib.Validation;
import net.sf.saxon.om.AttributeInfo;
import net.sf.saxon.om.NodeName;
import net.sf.saxon.om.StructuredQName;
import net.sf.saxon.pattern.NodeKindTest;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.value.SequenceType;
import net.sf.saxon.value.Whitespace;
import java.util.function.Supplier;
/**
* Handler for xsl:copy elements in stylesheet.
*/
public class XSLCopy extends StyleElement {
private String use; // value of use-attribute-sets attribute
private StructuredQName[] attributeSets = null;
private boolean copyNamespaces = true;
private boolean inheritNamespaces = true;
private int validationAction = Validation.PRESERVE;
private SchemaType schemaType = null;
private Expression select = null;
private boolean selectSpecified = false;
/**
* Determine whether this node is an instruction.
*
* @return true - it is an instruction
*/
@Override
public boolean isInstruction() {
return true;
}
/**
* Determine whether this type of element is allowed to contain a template-body
*
* @return true: yes, it may contain a template-body
*/
@Override
protected boolean mayContainSequenceConstructor() {
return true;
}
@Override
protected void prepareAttributes() {
String copyNamespacesAtt = null;
String validationAtt = null;
String typeAtt = null;
String inheritAtt = null;
AttributeInfo selectAtt = null;
for (AttributeInfo att : attributes()) {
NodeName attName = att.getNodeName();
String f = attName.getDisplayName();
String value = att.getValue();
switch (f) {
case "use-attribute-sets":
use = value;
break;
case "copy-namespaces":
copyNamespacesAtt = Whitespace.trim(value);
break;
case "select":
selectAtt = att;
break;
case "type":
typeAtt = Whitespace.trim(value);
break;
case "validation":
validationAtt = Whitespace.trim(value);
break;
case "inherit-namespaces":
inheritAtt = Whitespace.trim(value);
break;
default:
checkUnknownAttribute(attName);
break;
}
}
if (copyNamespacesAtt != null) {
copyNamespaces = processBooleanAttribute("copy-namespaces", copyNamespacesAtt);
}
if (typeAtt != null && validationAtt != null) {
compileError("The type and validation attributes must not both be specified", "XTSE1505");
}
if (validationAtt != null) {
validationAction = validateValidationAttribute(validationAtt);
} else {
validationAction = getDefaultValidation();
}
if (typeAtt != null) {
schemaType = getSchemaType(typeAtt);
if (!isSchemaAware()) {
compileError("The @type attribute is available only with a schema-aware XSLT processor", "XTSE1660");
}
validationAction = Validation.BY_TYPE;
}
if (inheritAtt != null) {
inheritNamespaces = processBooleanAttribute("inherit-namespaces", inheritAtt);
}
if (selectAtt != null) {
select = makeExpression(selectAtt.getValue(), selectAtt);
selectSpecified = true;
}
}
@Override
public void validate(ComponentDeclaration decl) throws XPathException {
if (use != null) {
// get the names of referenced attribute sets
attributeSets = getUsedAttributeSets(use);
}
if (select == null) {
select = new ContextItemExpression();
select.setLocation(allocateLocation());
}
}
@Override
public Expression compile(Compilation exec, ComponentDeclaration decl) throws XPathException {
select = typeCheck("select", select);
try {
Supplier role =
() -> new RoleDiagnostic(RoleDiagnostic.INSTRUCTION, "xsl:copy/select", 0, "XTTE3180");
select = getConfiguration().getTypeChecker(false).staticTypeCheck(select, SequenceType.OPTIONAL_ITEM,
role, makeExpressionVisitor());
} catch (XPathException err) {
compileError(err);
}
Expression content = compileSequenceConstructor(exec, decl, true);
if (attributeSets != null) {
Expression use = UseAttributeSet.makeUseAttributeSets(attributeSets, this);
// The use-attribute-sets is ignored unless the context item is an element node. So we
// wrap the UseAttributeSet instructions in a conditional to perform a run-time test
Expression condition = new InstanceOfExpression(
new ContextItemExpression(),
SequenceType.makeSequenceType(NodeKindTest.ELEMENT, StaticProperty.EXACTLY_ONE));
Expression choice = Choose.makeConditional(condition, use);
if (content == null) {
content = choice;
} else {
content = Block.makeBlock(choice, content);
content.setLocation(
allocateLocation());
}
}
if (content == null) {
content = Literal.makeEmptySequence();
}
Copy inst = new Copy(//select,
//selectSpecified,
copyNamespaces,
inheritNamespaces,
schemaType,
validationAction);
inst.setContentExpression(content);
if (selectSpecified) {
return new ForEach(select, inst);
} else {
return inst;
}
}
}