package net.sf.saxon.style;
import net.sf.saxon.expr.Expression;
import net.sf.saxon.expr.Literal;
import net.sf.saxon.expr.StringLiteral;
import net.sf.saxon.instruct.Executable;
import net.sf.saxon.instruct.ResultDocument;
import net.sf.saxon.om.*;
import net.sf.saxon.sort.IntHashMap;
import net.sf.saxon.sort.IntHashSet;
import net.sf.saxon.sort.IntIterator;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.ItemType;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.value.EmptySequence;
import net.sf.saxon.value.Whitespace;
import java.util.HashSet;
import java.util.Properties;
/**
* An xsl:result-document element in the stylesheet. <BR>
* The xsl:result-document element takes an attribute href="filename". The filename will
* often contain parameters, e.g. {position()} to ensure that a different file is produced
* for each element instance. <BR>
* There is a further attribute "name" which determines the format of the
* output file, it identifies the name of an xsl:output element containing the output
* format details.
*/
public class XSLResultDocument extends StyleElement {
private static final HashSet fans = new HashSet(25); // formatting attribute names
static {
fans.add(StandardNames.METHOD);
fans.add(StandardNames.OUTPUT_VERSION);
fans.add(StandardNames.BYTE_ORDER_MARK);
fans.add(StandardNames.INDENT);
fans.add(StandardNames.ENCODING);
fans.add(StandardNames.MEDIA_TYPE);
fans.add(StandardNames.DOCTYPE_SYSTEM);
fans.add(StandardNames.DOCTYPE_PUBLIC);
fans.add(StandardNames.OMIT_XML_DECLARATION);
fans.add(StandardNames.STANDALONE);
fans.add(StandardNames.CDATA_SECTION_ELEMENTS);
fans.add(StandardNames.INCLUDE_CONTENT_TYPE);
fans.add(StandardNames.ESCAPE_URI_ATTRIBUTES);
fans.add(StandardNames.UNDECLARE_PREFIXES);
fans.add(StandardNames.NORMALIZATION_FORM);
fans.add(StandardNames.SAXON_NEXT_IN_CHAIN);
fans.add(StandardNames.SAXON_CHARACTER_REPRESENTATION);
fans.add(StandardNames.SAXON_INDENT_SPACES);
fans.add(StandardNames.SAXON_REQUIRE_WELL_FORMED);
fans.add(StandardNames.SAXON_SUPPRESS_INDENTATION);
}
private Expression href;
private StructuredQName formatQName; // used when format is a literal string
private Expression formatExpression; // used when format is an AVT
private int validationAction = Validation.STRIP;
private SchemaType schemaType = null;
private IntHashMap<Expression> serializationAttributes = new IntHashMap(10);
/**
* Determine whether this node is an instruction.
* @return true - it is an instruction
*/
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
*/
public boolean mayContainSequenceConstructor() {
return true;
}
/**
* Determine the type of item returned by this instruction (only relevant if
* it is an instruction). Default implementation returns Type.ITEM, indicating
* that we don't know, it might be anything. Returns null in the case of an element
* such as xsl:sort or xsl:variable that can appear in a sequence constructor but
* contributes nothing to the result sequence.
* @return the item type returned
*/
protected ItemType getReturnedItemType() {
return null;
}
public void prepareAttributes() throws XPathException {
AttributeCollection atts = getAttributeList();
String formatAttribute = null;
String hrefAttribute = null;
String validationAtt = null;
String typeAtt = null;
String useCharacterMapsAtt = null;
for (int a=0; a<atts.getLength(); a++) {
int nc = atts.getNameCode(a);
String f = getNamePool().getClarkName(nc);
if (f.equals(StandardNames.FORMAT)) {
formatAttribute = Whitespace.trim(atts.getValue(a));
} else if (f.equals(StandardNames.HREF)) {
hrefAttribute = Whitespace.trim(atts.getValue(a));
} else if (f.equals(StandardNames.VALIDATION)) {
validationAtt = Whitespace.trim(atts.getValue(a));
} else if (f.equals(StandardNames.TYPE)) {
typeAtt = Whitespace.trim(atts.getValue(a));
} else if (f.equals(StandardNames.USE_CHARACTER_MAPS)) {
useCharacterMapsAtt = Whitespace.trim(atts.getValue(a));
} else if (fans.contains(f) || f.startsWith("{")) {
// this is a serialization attribute
String val = Whitespace.trim(atts.getValue(a));
Expression exp = makeAttributeValueTemplate(val);
serializationAttributes.put(nc&0xfffff, exp);
} else {
checkUnknownAttribute(nc);
}
}
if (hrefAttribute==null) {
//href = StringValue.EMPTY_STRING;
} else {
href = makeAttributeValueTemplate(hrefAttribute);
}
if (formatAttribute!=null) {
formatExpression = makeAttributeValueTemplate(formatAttribute);
if (formatExpression instanceof StringLiteral) {
try {
formatQName = makeQName(((StringLiteral)formatExpression).getStringValue());
formatExpression = null;
} catch (NamespaceException err) {
compileError(err.getMessage(), "XTSE0280");
} catch (XPathException err) {
compileError(err.getMessage(), "XTDE1460");
}
}
}
if (validationAtt==null) {
validationAction = getContainingStylesheet().getDefaultValidation();
} else {
validationAction = Validation.getCode(validationAtt);
if (validationAction != Validation.STRIP && !getExecutable().isSchemaAware()) {
validationAction = Validation.STRIP;
compileError("To perform validation, a schema-aware XSLT processor is needed", "XTSE1660");
}
if (validationAction == Validation.INVALID) {
compileError("Invalid value of @validation attribute", "XTSE0020");
}
}
if (typeAtt!=null) {
if (!getExecutable().isSchemaAware()) {
compileError("The @type attribute is available only with a schema-aware XSLT processor", "XTSE1660");
}
schemaType = getSchemaType(typeAtt);
validationAction = Validation.BY_TYPE;
}
if (typeAtt != null && validationAtt != null) {
compileError("The @validation and @type attributes are mutually exclusive", "XTSE1505");
}
if (useCharacterMapsAtt != null) {
String s = XSLOutput.prepareCharacterMaps(this, useCharacterMapsAtt, new Properties());
serializationAttributes.put(
getNamePool().allocate("", "", StandardNames.USE_CHARACTER_MAPS),
new StringLiteral(s));
}
}
public void validate() throws XPathException {
if (href != null && !getPreparedStylesheet().getConfiguration().isAllowExternalFunctions()) {
compileError("xsl:result-document is disabled when extension functions are disabled");
}
href = typeCheck("href", href);
formatExpression = typeCheck("format", formatExpression);
IntIterator it = serializationAttributes.keyIterator();
while (it.hasNext()) {
int fp = it.next();
String displayName = getNamePool().getDisplayName(fp);
final Expression exp1 = serializationAttributes.get(fp);
final Expression exp2 = typeCheck(displayName, exp1);
if (exp1 != exp2) {
serializationAttributes.put(fp, exp2);
}
}
getExecutable().setCreatesSecondaryResult(true);
}
public Expression compile(Executable exec) throws XPathException {
Properties globalProps;
if (formatExpression == null) {
try {
globalProps = getPrincipalStylesheet().gatherOutputProperties(formatQName);
} catch (XPathException err) {
compileError("Named output format has not been defined", "XTDE1460");
return null;
}
} else {
globalProps = new Properties();
getPrincipalStylesheet().setNeedsDynamicOutputProperties(true);
}
// If no serialization method was specified, we can work it out statically if the
// first contained instruction is a literal result element. This saves effort at run-time.
int key = getNamePool().allocate("", "", StandardNames.METHOD);
if (formatExpression == null &&
globalProps.getProperty("method") == null &&
serializationAttributes.get(key) == null) {
AxisIterator kids = iterateAxis(Axis.CHILD);
NodeInfo first = (NodeInfo)kids.next();
if (first instanceof LiteralResultElement) {
if (first.getFingerprint() == getNamePool().allocate("", NamespaceConstant.XHTML, "html")) {
if (backwardsCompatibleModeIsEnabled()) {
globalProps.setProperty("method", "xml");
} else {
globalProps.setProperty("method", "xhtml");
}
} else if (first.getLocalPart().equalsIgnoreCase("html") && first.getURI().length() == 0) {
globalProps.setProperty("method", "html");
} else {
globalProps.setProperty("method", "xml");
}
}
}
Properties localProps = new Properties();
IntHashSet fixed = new IntHashSet(10);
boolean needsNamespaceContext = (formatExpression != null);
NamespaceResolver namespaceResolver = getStaticContext().getNamespaceResolver();
for (IntIterator it=serializationAttributes.keyIterator(); it.hasNext();) {
int fp = it.next();
Expression exp = serializationAttributes.get(fp);
if (exp instanceof StringLiteral) {
String s = ((StringLiteral)exp).getStringValue();
String lname = getNamePool().getLocalName(fp);
String uri = getNamePool().getURI(fp);
try {
ResultDocument.setSerializationProperty(localProps, uri, lname, s,
namespaceResolver, false, exec.getConfiguration());
fixed.add(fp);
} catch (XPathException e) {
if (NamespaceConstant.SAXON.equals(e.getErrorCodeNamespace())) {
compileWarning(e.getMessage(), e.getErrorCodeQName());
} else {
compileError(e);
}
}
} else {
String lname = getNamePool().getLocalName(fp);
if (lname.equals("method") || lname.equals("cdata-section-elements") ||
lname.equals("suppress-indentation")) {
needsNamespaceContext = true;
}
}
}
for (IntIterator it=fixed.iterator(); it.hasNext();) {
serializationAttributes.remove(it.next());
}
ResultDocument inst = new ResultDocument(globalProps,
localProps,
href,
formatExpression,
getBaseURI(),
validationAction,
schemaType,
serializationAttributes,
(needsNamespaceContext ? namespaceResolver : null));
Expression b = compileSequenceConstructor(exec, iterateAxis(Axis.CHILD), true);
if (b == null) {
b = new Literal(EmptySequence.getInstance());
}
inst.setContentExpression(b);
return inst;
}
}
//
// The contents of this file are subject to the Mozilla Public License Version 1.0 (the "License");
// you may not use this file except in compliance with the License. You may obtain a copy of the
// License at http://www.mozilla.org/MPL/
//
// Software distributed under the License is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the License for the specific language governing rights and limitations under the License.
//
// The Original Code is: all this file.
//
// The Initial Developer of the Original Code is Michael H. Kay.
//
// Portions created by (your name) are Copyright (C) (your legal entity). All Rights Reserved.
//
//