<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:47 GMT 2011 -->
<TITLE>
com.saxonica.bytecode.util
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="com.saxonica.bytecode.util";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/saxonica/bytecode/map/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/config/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/bytecode/util/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package com.saxonica.bytecode.util
</H2>
This package contains utility classes supporting the generation of bytecode and the interface with the
ASM library.
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/MessageBuilder.html" title="interface in com.saxonica.bytecode.util">MessageBuilder</A></B></TD>
<TD>Helper interface MeassageBuilder.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/AnnotatedTraceClassVisitor.html" title="class in com.saxonica.bytecode.util">AnnotatedTraceClassVisitor</A></B></TD>
<TD>Subclass of TraceClassVisitor to enable the bytecode listings to be customized</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/AnnotatedTraceMethodVisitor.html" title="class in com.saxonica.bytecode.util">AnnotatedTraceMethodVisitor</A></B></TD>
<TD>Subclass of the TraceMethodVisitor to customize the bytecode listings</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/Audit.html" title="class in com.saxonica.bytecode.util">Audit</A></B></TD>
<TD>Development aid to check that all Expression classes are compilable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/ByteCodeTrace.html" title="class in com.saxonica.bytecode.util">ByteCodeTrace</A></B></TD>
<TD>Calls to this class are inserted into the bytecode for debugging purposes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/Callback.html" title="class in com.saxonica.bytecode.util">Callback</A></B></TD>
<TD>A convenient place to put static methods that will be called from generated byte code</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/CompilerClassMapper.html" title="class in com.saxonica.bytecode.util">CompilerClassMapper</A></B></TD>
<TD>For each class of expression found on the expression tree, deliver a corresponding instance of the
helper class used to generate Java code for the expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/CompilerService.html" title="class in com.saxonica.bytecode.util">CompilerService</A></B></TD>
<TD>Controlling/service class for compilation of expressions to Java bytecode</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/CompilerService.GeneratedClassInfo.html" title="class in com.saxonica.bytecode.util">CompilerService.GeneratedClassInfo</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/CompilerService.StaticSubClasses.html" title="class in com.saxonica.bytecode.util">CompilerService.StaticSubClasses</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/CompilerService.StaticVariableInfo.html" title="class in com.saxonica.bytecode.util">CompilerService.StaticVariableInfo</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/GeneratedMethodInfo.html" title="class in com.saxonica.bytecode.util">GeneratedMethodInfo</A></B></TD>
<TD>Information about the current method whose bytecode is being generated</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/GeneratedMethodInfo.LocalSlotInfo.html" title="class in com.saxonica.bytecode.util">GeneratedMethodInfo.LocalSlotInfo</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/Generator.html" title="class in com.saxonica.bytecode.util">Generator</A></B></TD>
<TD>This class is an extension of the ASM-supplied GeneratorAdapter library, containing additional
utility and shortcut methods for bytecode generation</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/LabelInfo.html" title="class in com.saxonica.bytecode.util">LabelInfo</A></B></TD>
<TD>An ASM label object with some control information to enable better diagnostics</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/LoopBodyGenerator.html" title="class in com.saxonica.bytecode.util">LoopBodyGenerator</A></B></TD>
<TD>LoopBodyGenerator is code to generate the body of a loop, for example of a ForExpression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/MessageFromStack.html" title="class in com.saxonica.bytecode.util">MessageFromStack</A></B></TD>
<TD>Helper class to generate a run-time exception using a message that is present at the top of the bytecode stack</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/MessageTemplate.html" title="class in com.saxonica.bytecode.util">MessageTemplate</A></B></TD>
<TD>Helper class to build messages with a predefined prefix string, then runtime text, followed by predefined suffix string</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/NamedLabel.html" title="class in com.saxonica.bytecode.util">NamedLabel</A></B></TD>
<TD>Subclass of the ASM Label class that adds a diagnostic name to the label; this enables more intelligible bytecode
to be output for diagnostics</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/OnEmpty.html" title="class in com.saxonica.bytecode.util">OnEmpty</A></B></TD>
<TD>The OnEmpty class represents an action to be taken by the bytecode generator when compiling an expression
to return a "primitive" (unboxed) value such as a double float int long or String (treated as primitive for this
purpose).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/OnEmpty.ReturnEmptyString.html" title="class in com.saxonica.bytecode.util">OnEmpty.ReturnEmptyString</A></B></TD>
<TD>The ReturnNull subclass indicates that when an expression evaluates to the empty sequence, the value should
be returned as a zero-length string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/OnEmpty.ReturnNull.html" title="class in com.saxonica.bytecode.util">OnEmpty.ReturnNull</A></B></TD>
<TD>The ReturnNull subclass indicates that when an expression evaluates to the empty sequence, the value should
be returned as a Java null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/OnEmpty.UnwindAndJump.html" title="class in com.saxonica.bytecode.util">OnEmpty.UnwindAndJump</A></B></TD>
<TD>The UnwindAndJump subclass causes the code generator, when an expression evaluates to the empty sequence,
to generate a "goto" instruction to a defined label; but before executing the jump, the stack will be unwound
to a known position.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/bytecode/util/CannotCompileException.html" title="class in com.saxonica.bytecode.util">CannotCompileException</A></B></TD>
<TD>Exception indicating that constructs were encountered in the expression tree that
cannot be compiled to bytecode</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.saxonica.bytecode.util Description
</H2>
<P>
<p>This package contains utility classes supporting the generation of bytecode and the interface with the
ASM library.</p>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
28 November 2011</i></p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/saxonica/bytecode/map/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/config/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/bytecode/util/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
