OpenJDK 27 · com.sun.org.apache.xalan.internal.xsltc.compiler.XSLTC

Field Summary

Modifier and Type	Field and Description
private String	_accessExternalDTD protocols allowed for external DTD references in source file and/or stylesheet.
private String	_accessExternalStylesheet protocols allowed for external references set by the stylesheet processing instruction, Import and Include element.
private Map<String, Integer>	_attributes
private int	_attributeSetSerial
private List<JavaClass>	_bcelClasses
private boolean	_callsNodeset
pack-priv CatalogFeatures	_catalogFeatures Catalog features
pack-priv int	_cdataChunkSize CDATA chunk size
private List<ByteArrayOutputStream>	_classes
private String	_className
private boolean	_debug
private File	_destDir
private Map<String, Integer>	_elements
private ClassLoader	_extensionClassLoader Extension function class loader variables
private final Map<String, Class<?>>	_externalExtensionFunctions HashMap with the loaded classes
private boolean	_hasIdCall
private int	_helperClassSerial
private boolean	_isSecureProcessing State of the secure processing feature.
private String	_jarFileName
private SourceLoader	_loader
private int	_modeSerial
private boolean	_multiDocument
private List<String>	_namesIndex
private List<String>	_namespaceIndex
private Map<String, Integer>	_namespacePrefixes
private Map<String, Integer>	_namespaces
private int	_nextGType
private int	_nextNSType
private int[]	_numberFieldIndexes
private int	_outputType
private boolean	_overrideDefaultParser
private String	_packageName
private Parser	_parser
private XMLReader	_reader
private int	_stepPatternSerial
private Stylesheet	_stylesheet
private int	_stylesheetSerial
private boolean	_templateInlining Set to true if template inlining is requested.
private final JdkXmlFeatures	_xmlFeatures
private XMLSecurityManager	_xmlSecurityManager
public static final int	BYTEARRAY_AND_FILE_OUTPUT
public static final int	BYTEARRAY_AND_JAR_OUTPUT
public static final int	BYTEARRAY_OUTPUT
public static final int	CLASSLOADER_OUTPUT
public static final int	JAR_OUTPUT
private List<StringBuilder>	m_characterData

Constructor Summary

Access	Constructor and Description
public	XSLTC(JdkXmlFeatures featureManager, boolean hasListener) XSLTC compiler constructor

Method Summary

Modifier and Type	Method and Description
public int	Returns: int offset at which character data will be stored addCharacterData(String String data to be added to char arrays. Pre-condition: `newData.length() ≤ 21845` newData) Add literal text to char arrays that will be used to store character data in the stylesheet.
public boolean	callsNodeset()
private String	classFileName(final String className) Convert for Java class name of local system file name.
public boolean	compile(URL An URL containing the input XSL stylesheet url) Compiles an XSL stylesheet pointed to by a URL
public boolean	compile(URL An URL containing the input XSL stylesheet url, String The name to assign to the translet class name) Compiles an XSL stylesheet pointed to by a URL
public boolean	Returns: 'true' if the compilation was successful compile(InputStream An InputStream that will pass in the stylesheet contents stream, String The name of the translet class to generate name) Compiles an XSL stylesheet passed in through an InputStream
public boolean	Returns: 'true' if the compilation was successful compile(InputSource An InputSource that will pass in the stylesheet contents input, String The name of the translet class to generate - can be null name) Compiles an XSL stylesheet passed in through an InputStream
public boolean	Returns: 'true' if the compilation was successful compile(List<URL> A List containing URLs pointing to the stylesheets stylesheets) Compiles a set of stylesheets pointed to by a List of URLs
public byte[][]	Returns: JVM bytecodes that represent translet class definition compile(String The name of the translet class to generate name, InputSource An InputSource that will pass in the stylesheet contents input, int The output type outputType) Compiles a stylesheet pointed to by a URL.
public byte[][]	Returns: JVM bytecodes that represent translet class definition compile(String The name of the translet class to generate name, InputSource An InputSource that will pass in the stylesheet contents input) Compiles a stylesheet pointed to by a URL.
public boolean	debug() Get current debugging message setting
public void	dumpClass(JavaClass clazz)
private String	entryName(File f) File separators are converted to forward slashes for ZIP files.
public byte[][]	Returns: JVM bytecodes that represent translet class definition getBytecodes() Returns an array of bytecode arrays generated by a compilation.
public String	Returns: String The character data to be stored in the corresponding `char[]`. getCharacterData(int The index of the `char[]`. Zero-based. index) Retrieve a string representation of the character data to be stored in the translet as a `char[]`.
public int	getCharacterDataCount() Get the number of char[] arrays, thus far, that will be created to store literal text in the stylesheet.
public String	getClassName() Get the class name for the generated translet.
public List<ErrorMsg>	Returns: A List containing all compile error messages getErrors() Get a list of all compile error messages
public Map<String, Class<?>>	getExternalExtensionFunctions()
public boolean	Returns: true if the feature is enabled, false otherwise getFeature(JdkXmlFeatures.XmlFeature name of the feature name) Return the value of the specified feature
public String	getHelperClassName() Returns a unique name for every helper class needed to execute a translet.
public String	getJarFileName()
public List<String>	getNamesIndex()
public List<String>	getNamespaceIndex()
public int[]	getNumberFieldIndexes()
private File	getOutputFile(String className) Generate an output File object to send the translet to
public Properties	getOutputProperties() Only for user by the internal TrAX implementation.
public Parser	getParser() Only for user by the internal TrAX implementation.
public Object	Returns: the value of the property getProperty(String the name of the property name) Return allowed protocols for accessing external stylesheet.
public Stylesheet	getStylesheet() Returns the top-level stylesheet
public boolean	getTemplateInlining() Return the state of the template inlining feature.
public List<ErrorMsg>	Returns: A List containing all compile error messages getWarnings() Get a list of all compile warning messages
public XMLReader	getXMLReader() Get the XMLReader to use for parsing the next input stylesheet
pack-priv boolean	hasExtensionClassLoader()
public boolean	hasIdCall()
public void	init() Initializes the compiler to compile a new stylesheet
public boolean	isMultiDocument()
public boolean	isSecureProcessing() Return the state of the secure processing feature.
pack-priv Class<?>	loadExternalFunction(String name)
public int	nextAttributeSetSerial()
public int	nextHelperClassSerial()
public int	nextModeSerial()
public int	nextStepPatternSerial()
public int	nextStylesheetSerial()
public void	outputToJar() Generate output JAR-file and packages
public void	printErrors() Print all compile error messages to standard output
public void	printWarnings() Print all compile warning messages to standard output
public int	registerAttribute(QName name) Registers an attribute and gives it a type so that it can be mapped to DOM attribute types at run-time.
public int	registerElement(QName name) Registers an element and gives it a type so that it can be mapped to DOM element types at run-time.
public int	registerNamespace(String namespaceURI) Registers a namespace and gives it a type so that it can be mapped to DOM namespace types at run-time.
public int	registerNamespacePrefix(QName name) Registers a namespace prefix and gives it a type so that it can be mapped to DOM namespace types at run-time.
private void	reset() Initializes the compiler to produce a new translet
protected void	setCallsNodeset(boolean flag) This method is called by the XPathParser when it encounters a call to the nodeset() extension function.
public void	setClassName(String The name to assign to the translet class className) Set the class name for the generated translet.
public void	setDebug(boolean debug) Turn debugging messages on/off
public boolean	setDestDirectory(String dstDirName) Set the destination directory for the translet.
private void	setExternalExtensionFunctions(String name, Class<?> clazz)
protected void	setHasIdCall(boolean flag)
public void	setJarFileName(String jarFileName) Set the name of an optional JAR-file to dump the translet and auxiliary classes to
protected void	setMultiDocument(boolean flag) This method is called by the XPathParser when it encounters a call to the document() function.
public void	setOutputType(int type) Only for user by the internal TrAX implementation.
public void	setPackageName(String packageName) Set an optional package name for the translet and auxiliary classes
public void	setPIParameters(String The media attribute to be matched. May be null, in which case the prefered templates will be used (i.e. alternate = no). media, String The value of the title attribute to match. May be null. title, String The value of the charset attribute to match. May be null. charset) Set the parameters to use to locate the correct <?xml-stylesheet ...?
public void	setProperty(String the name of the property name, Object the value of the property value) Set allowed protocols for accessing external stylesheet.
public void	setSecureProcessing(boolean flag) Set the state of the secure processing feature.
public void	setSourceLoader(SourceLoader The SourceLoader to use for include/import loader) Defines an external SourceLoader to provide the compiler with documents referenced in xsl:include/import
public void	setStylesheet(Stylesheet stylesheet) Set the top-level stylesheet
public void	setTemplateInlining(boolean templateInlining) Set a flag indicating if templates are to be inlined or not.
public void	setXMLReader(XMLReader XMLReader (SAX2 parser) to use reader) Set the XMLReader to use for parsing the next input stylesheet

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_accessExternalDTD	back to summary
private String _accessExternalDTD protocols allowed for external DTD references in source file and/or stylesheet.

_accessExternalStylesheet	back to summary
private String _accessExternalStylesheet protocols allowed for external references set by the stylesheet processing instruction, Import and Include element.

_attributes	back to summary
private Map<String, Integer> _attributes

_attributeSetSerial	back to summary
private int _attributeSetSerial

_bcelClasses	back to summary
private List<JavaClass> _bcelClasses

_callsNodeset	back to summary
private boolean _callsNodeset

_catalogFeatures	back to summary
pack-priv CatalogFeatures _catalogFeatures Catalog features

_cdataChunkSize	back to summary
pack-priv int _cdataChunkSize CDATA chunk size

_classes	back to summary
private List<ByteArrayOutputStream> _classes

_className	back to summary
private String _className

_debug	back to summary
private boolean _debug

_destDir	back to summary
private File _destDir

_elements	back to summary
private Map<String, Integer> _elements

_extensionClassLoader	back to summary
private ClassLoader _extensionClassLoader Extension function class loader variables

_externalExtensionFunctions	back to summary
private final Map<String, Class<?>> _externalExtensionFunctions HashMap with the loaded classes

_hasIdCall	back to summary
private boolean _hasIdCall

_helperClassSerial	back to summary
private int _helperClassSerial

_isSecureProcessing	back to summary
private boolean _isSecureProcessing State of the secure processing feature.

_jarFileName	back to summary
private String _jarFileName

_loader	back to summary
private SourceLoader _loader

_modeSerial	back to summary
private int _modeSerial

_multiDocument	back to summary
private boolean _multiDocument

_namesIndex	back to summary
private List<String> _namesIndex

_namespaceIndex	back to summary
private List<String> _namespaceIndex

_namespacePrefixes	back to summary
private Map<String, Integer> _namespacePrefixes

_namespaces	back to summary
private Map<String, Integer> _namespaces

_nextGType	back to summary
private int _nextGType

_nextNSType	back to summary
private int _nextNSType

_numberFieldIndexes	back to summary
private int[] _numberFieldIndexes

_outputType	back to summary
private int _outputType

_overrideDefaultParser	back to summary
private boolean _overrideDefaultParser

_packageName	back to summary
private String _packageName

_parser	back to summary
private Parser _parser

_reader	back to summary
private XMLReader _reader

_stepPatternSerial	back to summary
private int _stepPatternSerial

_stylesheet	back to summary
private Stylesheet _stylesheet

_stylesheetSerial	back to summary
private int _stylesheetSerial

_templateInlining	back to summary
private boolean _templateInlining Set to true if template inlining is requested. Template inlining used to be the default, but we have found that Hotspots does a better job with shorter methods, so the default is not to inline now.

_xmlFeatures	back to summary
private final JdkXmlFeatures _xmlFeatures

_xmlSecurityManager	back to summary
private XMLSecurityManager _xmlSecurityManager

BYTEARRAY_AND_FILE_OUTPUT	back to summary
public static final int BYTEARRAY_AND_FILE_OUTPUT

BYTEARRAY_AND_JAR_OUTPUT	back to summary
public static final int BYTEARRAY_AND_JAR_OUTPUT

BYTEARRAY_OUTPUT	back to summary
public static final int BYTEARRAY_OUTPUT

CLASSLOADER_OUTPUT	back to summary
public static final int CLASSLOADER_OUTPUT

JAR_OUTPUT	back to summary
public static final int JAR_OUTPUT

m_characterData	back to summary
private List<StringBuilder> m_characterData

Constructor Detail

XSLTC	back to summary
public XSLTC(JdkXmlFeatures featureManager, boolean hasListener) XSLTC compiler constructor

Method Detail

addCharacterData back to summary

public int addCharacterData(String newData)

Add literal text to char arrays that will be used to store character data in the stylesheet.

Parameters

newData:String: String data to be added to char arrays. Pre-condition: newData.length() ≤ 21845

Returns:int

int offset at which character data will be stored

callsNodeset	back to summary
public boolean callsNodeset()

classFileName	back to summary
private String classFileName(final String className) Convert for Java class name of local system file name. (Replace '.' with '/' on UNIX and replace '.' by '\' on Windows/DOS.)

compile

back to summary

public boolean compile(URL url)

Compiles an XSL stylesheet pointed to by a URL

Parameters

url:URL: An URL containing the input XSL stylesheet

compile

back to summary

public boolean compile(URL url, String name)

Compiles an XSL stylesheet pointed to by a URL

Parameters

url:URL: An URL containing the input XSL stylesheet
name:String: The name to assign to the translet class

compile

back to summary

public boolean compile(InputStream stream, String name)

Compiles an XSL stylesheet passed in through an InputStream

Parameters

stream:InputStream: An InputStream that will pass in the stylesheet contents
name:String: The name of the translet class to generate

Returns:boolean

'true' if the compilation was successful

compile

back to summary

public boolean compile(InputSource input, String name)

Compiles an XSL stylesheet passed in through an InputStream

Parameters

input:InputSource: An InputSource that will pass in the stylesheet contents
name:String: The name of the translet class to generate - can be null

Returns:boolean

'true' if the compilation was successful

compile

back to summary

public boolean compile(List<URL> stylesheets)

Compiles a set of stylesheets pointed to by a List of URLs

Parameters

stylesheets:List<URL>: A List containing URLs pointing to the stylesheets

Returns:boolean

'true' if the compilation was successful

compile

back to summary

public byte[][] compile(String name, InputSource input, int outputType)

Compiles a stylesheet pointed to by a URL. The result is put in a set of byte arrays. One byte array for each generated class.

Parameters

name:String: The name of the translet class to generate
input:InputSource: An InputSource that will pass in the stylesheet contents
outputType:int: The output type

Returns:byte[][]

JVM bytecodes that represent translet class definition

compile

back to summary

public byte[][] compile(String name, InputSource input)

Compiles a stylesheet pointed to by a URL. The result is put in a set of byte arrays. One byte array for each generated class.

Parameters

name:String: The name of the translet class to generate
input:InputSource: An InputSource that will pass in the stylesheet contents

Returns:byte[][]

JVM bytecodes that represent translet class definition

debug	back to summary
public boolean debug() Get current debugging message setting

dumpClass	back to summary
public void dumpClass(JavaClass clazz)

entryName	back to summary
private String entryName(File f) throws IOException File separators are converted to forward slashes for ZIP files.

getBytecodes

back to summary

public byte[][] getBytecodes()

Returns an array of bytecode arrays generated by a compilation.

Returns:byte[][]: JVM bytecodes that represent translet class definition

getCharacterData back to summary

public String getCharacterData(int index)

Retrieve a string representation of the character data to be stored in the translet as a char[]. There may be more than one such array required.

Parameters

index:int: The index of the char[]. Zero-based.

Returns:String

String The character data to be stored in the corresponding char[].

getCharacterDataCount	back to summary
public int getCharacterDataCount() Get the number of char[] arrays, thus far, that will be created to store literal text in the stylesheet.

getClassName	back to summary
public String getClassName() Get the class name for the generated translet.

getErrors

back to summary

public List<ErrorMsg> getErrors()

Get a list of all compile error messages

Returns:List<ErrorMsg>: A List containing all compile error messages

getExternalExtensionFunctions	back to summary
public Map<String, Class<?>> getExternalExtensionFunctions()

getFeature

back to summary

public boolean getFeature(JdkXmlFeatures.XmlFeature name)

Return the value of the specified feature

Parameters

name:JdkXmlFeatures.XmlFeature: name of the feature

Returns:boolean

true if the feature is enabled, false otherwise

getHelperClassName	back to summary
public String getHelperClassName() Returns a unique name for every helper class needed to execute a translet.

getJarFileName	back to summary
public String getJarFileName()

getNamesIndex	back to summary
public List<String> getNamesIndex()

getNamespaceIndex	back to summary
public List<String> getNamespaceIndex()

getNumberFieldIndexes	back to summary
public int[] getNumberFieldIndexes()

getOutputFile	back to summary
private File getOutputFile(String className) Generate an output File object to send the translet to

getOutputProperties	back to summary
public Properties getOutputProperties() Only for user by the internal TrAX implementation.

getParser	back to summary
public Parser getParser() Only for user by the internal TrAX implementation.

getProperty

back to summary

public Object getProperty(String name)

Return allowed protocols for accessing external stylesheet.

Parameters

name:String: the name of the property

Returns:Object

the value of the property

getStylesheet	back to summary
public Stylesheet getStylesheet() Returns the top-level stylesheet

getTemplateInlining	back to summary
public boolean getTemplateInlining() Return the state of the template inlining feature.

getWarnings

back to summary

public List<ErrorMsg> getWarnings()

Get a list of all compile warning messages

Returns:List<ErrorMsg>: A List containing all compile error messages

getXMLReader	back to summary
public XMLReader getXMLReader() Get the XMLReader to use for parsing the next input stylesheet

hasExtensionClassLoader	back to summary
pack-priv boolean hasExtensionClassLoader()

hasIdCall	back to summary
public boolean hasIdCall()

init	back to summary
public void init() Initializes the compiler to compile a new stylesheet

isMultiDocument	back to summary
public boolean isMultiDocument()

isSecureProcessing	back to summary
public boolean isSecureProcessing() Return the state of the secure processing feature.

loadExternalFunction	back to summary
pack-priv Class<?> loadExternalFunction(String name) throws ClassNotFoundException

nextAttributeSetSerial	back to summary
public int nextAttributeSetSerial()

nextHelperClassSerial	back to summary
public int nextHelperClassSerial()

nextModeSerial	back to summary
public int nextModeSerial()

nextStepPatternSerial	back to summary
public int nextStepPatternSerial()

nextStylesheetSerial	back to summary
public int nextStylesheetSerial()

outputToJar	back to summary
public void outputToJar() throws IOException Generate output JAR-file and packages

printErrors	back to summary
public void printErrors() Print all compile error messages to standard output

printWarnings	back to summary
public void printWarnings() Print all compile warning messages to standard output

registerAttribute	back to summary
public int registerAttribute(QName name) Registers an attribute and gives it a type so that it can be mapped to DOM attribute types at run-time.

registerElement	back to summary
public int registerElement(QName name) Registers an element and gives it a type so that it can be mapped to DOM element types at run-time.

registerNamespace	back to summary
public int registerNamespace(String namespaceURI) Registers a namespace and gives it a type so that it can be mapped to DOM namespace types at run-time.

registerNamespacePrefix	back to summary
public int registerNamespacePrefix(QName name) Registers a namespace prefix and gives it a type so that it can be mapped to DOM namespace types at run-time.

reset	back to summary
private void reset() Initializes the compiler to produce a new translet

setCallsNodeset	back to summary
protected void setCallsNodeset(boolean flag) This method is called by the XPathParser when it encounters a call to the nodeset() extension function. Implies multi document.

setClassName

back to summary

public void setClassName(String className)

Set the class name for the generated translet. This class name is overridden if multiple stylesheets are compiled in one go using the compile(List urls) method.

Parameters

className:String: The name to assign to the translet class

setDebug	back to summary
public void setDebug(boolean debug) Turn debugging messages on/off

setDestDirectory	back to summary
public boolean setDestDirectory(String dstDirName) Set the destination directory for the translet. The current working directory will be used by default.

setExternalExtensionFunctions	back to summary
private void setExternalExtensionFunctions(String name, Class<?> clazz)

setHasIdCall	back to summary
protected void setHasIdCall(boolean flag)

setJarFileName	back to summary
public void setJarFileName(String jarFileName) Set the name of an optional JAR-file to dump the translet and auxiliary classes to

setMultiDocument	back to summary
protected void setMultiDocument(boolean flag) This method is called by the XPathParser when it encounters a call to the document() function. Affects the DOM used by the translet.

setOutputType	back to summary
public void setOutputType(int type) Only for user by the internal TrAX implementation.

setPackageName	back to summary
public void setPackageName(String packageName) Set an optional package name for the translet and auxiliary classes

setPIParameters

back to summary

public void setPIParameters(String media, String title, String charset)

Set the parameters to use to locate the correct <?xml-stylesheet ...?> processing instruction in the case where the input document to the compiler (and parser) is an XML document.

Parameters

media:String: The media attribute to be matched. May be null, in which case the prefered templates will be used (i.e. alternate = no).
title:String: The value of the title attribute to match. May be null.
charset:String: The value of the charset attribute to match. May be null.

setProperty

back to summary

public void setProperty(String name, Object value)

Set allowed protocols for accessing external stylesheet.

Parameters

name:String: the name of the property
value:Object: the value of the property

setSecureProcessing	back to summary
public void setSecureProcessing(boolean flag) Set the state of the secure processing feature.

setSourceLoader

back to summary

public void setSourceLoader(SourceLoader loader)

Defines an external SourceLoader to provide the compiler with documents referenced in xsl:include/import

Parameters

loader:SourceLoader: The SourceLoader to use for include/import

setStylesheet	back to summary
public void setStylesheet(Stylesheet stylesheet) Set the top-level stylesheet

setTemplateInlining	back to summary
public void setTemplateInlining(boolean templateInlining) Set a flag indicating if templates are to be inlined or not. The default is to do inlining, but this causes problems when the stylesheets have a large number of templates (e.g. branch targets exceeding 64K or a length of a method exceeding 64K).

setXMLReader

back to summary

public void setXMLReader(XMLReader reader)

Set the XMLReader to use for parsing the next input stylesheet

Parameters

reader:XMLReader: XMLReader (SAX2 parser) to use

public final Class XSLTC

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail