jaxx.compiler
Class JAXXCompiler

java.lang.Object
  jaxx.compiler.JAXXCompiler

public class JAXXCompiler
extends Object

Compiles JAXX files into Java classes.

use JAXXCompilerFinalizer ... todo finish javadoc

Field Summary

protected File	baseDir Base directory used for path resolution (normally the directory in which the .jaxx file resides).
protected DataBindingHelper	bindingHelper Binding Util
protected StringBuffer	bodyCode Extra code to be added to the class body.
protected ClassLoader	classLoader ClassLoader which searches the user-specified class path in addition to the normal class path
protected CompilerConfiguration	configuration configuration of the compiler
protected CompiledObjectDecorator	defaultDecorator default decodator to use if none specified
protected Document	document Parsed XML of src file.
protected JAXXEngine	engine engine which references this compiler (can be null if compiler is standalone)
protected Map<EventHandler,String>	eventHandlerMethodNames Map of event handler method names used in compiler
protected Map<String,Map<ClassDescriptor,List<EventHandler>>>	eventHandlers Maps objects (expressed in Java code) to event listener classes (e.g.
protected boolean	failed flag to detect if an error occurs while compiling jaxx file
protected DefaultObjectHandler	firstPassClassTagHandler The unique object handler used in first pass
protected IDHelper	idHelper to generate ids
protected Map<CompiledObject,String>	ids Maps objects to their ID strings.
protected Set<String>	importedClasses Contains strings of the form "javax.swing.Timer"
protected Set<String>	importedPackages Contains strings of the form "javax.swing."
protected StringBuffer	initializer Extra code to be added to the instance initializer.
protected List<Runnable>	initializers A list of Runnables which will be run after the first compilation pass.
static int	INLINE_THRESHOLD Maximum length of an inlinable creation method.
protected List<Rule>	inlineStyles Contains all attributes defined inline on class tags.
protected JavaFile	javaFile the file to be generated
static String	JAXX_INTERNAL_NAMESPACE
static String	JAXX_NAMESPACE
protected StringBuffer	lateInitializer Extra code to be added at the end of the instance initializer.
protected static String	lineSeparator Line separator cached value
protected static org.apache.commons.logging.Log	log Logger
protected boolean	mainDeclared true if a main() method has been declared in a script
protected Map<String,CompiledObject>	objects Maps object ID strings to the objects themselves.
protected Stack<CompiledObject>	openComponents Keeps track of open components (components still having children added).
protected String	outputClassName Name of class being compiled.
protected CompiledObject	root Object corresponding to the root tag in the document.
protected ScriptManager	scriptManager
protected Stack<File>	sourceFiles Used for error reporting purposes, so we can report the right source file.
protected File	src jaxx file being compiled.
static boolean	STRICT_CHECKS True to throw exceptions when we encounter unresolvable classes, false to ignore.
protected Stylesheet	stylesheet Combination of all stylesheets registered using registerStylesheet(jaxx.runtime.css.Stylesheet).
protected SymbolTable	symbolTable table of symbols for this compiler
protected Stack<Element>	tagsBeingCompiled Used for error reporting purposes, so we can report the right line number.

Constructor Summary

JAXXCompiler(JAXXEngine engine, File baseDir, File src, String outputClassName, CompilerConfiguration configuration, List<String> defaultImports)
Creates a new JAXXCompiler.

Method Summary

void	addDependencyClass(String className)
void	addImport(String text)
void	addInlineStyle(CompiledObject object, String propertyName, boolean dataBinding)
void	addScriptField(FieldDescriptor field)
void	addScriptMethod(MethodDescriptor method)
void	addSimpleField(JavaField javaField)
void	appendBodyCode(String code)
void	appendInitializerCode(String code)
void	appendLateInitializer(String code)
void	applyStylesheets()
String	checkJavaCode(String javaCode) Verifies that a snippet of Java code parses correctly.
void	checkOverride(CompiledObject object)
boolean	checkReference(Element tag, String reference, boolean strict, String attribute) Check that a reference exists in symbol table on second compil pass
void	clear()
void	closeComponent(CompiledObject component)
protected void	compileFirstPass()
void	compileFirstPass(Element tag)
protected void	compileSecondPass()
void	compileSecondPass(Element tag)
static String	escapeJavaString(String raw) Escapes a string using standard Java escape sequences, generally in preparation to including it in a string literal in a compiled Java file.
void	finalizeCompiler(Iterable<JAXXCompilerFinalizer> finalizers)
void	generate(JavaFileGenerator generator)
String	getAutoId(String name)
File	getBaseDir()
DataBindingHelper	getBindingHelper()
StringBuffer	getBodyCode()
static String	getCanonicalName(Class<?> clazz)
static String	getCanonicalName(ClassDescriptor clazz)
static String	getCanonicalName(CompiledObject compiled)
ClassLoader	getClassLoader() Returns a ClassLoader which searches the user-specified class path in addition to the normal system class path.
CompiledObject	getCompiledObject(String id)
CompilerConfiguration	getConfiguration()
JAXXEngine	getEngine()
String	getEventHandlerMethodName(EventHandler handler)
Map<String,Map<ClassDescriptor,List<EventHandler>>>	getEventHandlers()
String[]	getExtraInterfaces()
String	getGenericType()
IDHelper	getIdHelper()
Set<String>	getImportedClasses()
Set<String>	getImportedPackages()
StringBuffer	getInitializer()
JavaFile	getJavaFile()
JAXXObjectDescriptor	getJAXXObjectDescriptor()
StringBuffer	getLateInitializer()
static String	getLineSeparator() Returns the system line separator string.
Iterator<CompiledObject>	getObjectCreationOrder()
Map<String,CompiledObject>	getObjects()
CompiledObject	getOpenComponent()
String	getOutputClassName()
CompiledObject	getRootObject()
static SAXParser	getSAXParser()
FieldDescriptor	getScriptField(String fieldName)
FieldDescriptor[]	getScriptFields()
ScriptManager	getScriptManager()
MethodDescriptor	getScriptMethod(String methodName)
MethodDescriptor[]	getScriptMethods()
Stack<File>	getSourceFiles()
Stylesheet	getStylesheet()
String	getSuperGenericType()
SymbolTable	getSymbolTable()
String	getUniqueId(Object object)
boolean	hasMethod(String methodName)
boolean	inlineCreation(CompiledObject object)
boolean	isAbstractClass()
boolean	isFailed()
boolean	isMainDeclared()
void	openComponent(CompiledObject component)
void	openComponent(CompiledObject component, String constraints)
void	openInvisibleComponent(CompiledObject component)
static Document	parseDocument(InputStream in)
String	preprocessScript(String script)
void	registerCompiledObject(CompiledObject object)
void	registerEventHandler(EventHandler handler)
void	registerInitializer(Runnable r) Registers a Runnable which will be executed after the first compilation pass is complete.
void	registerScript(String script)
void	registerScript(String script, File sourceFile)
void	registerStylesheet(Stylesheet stylesheet)
void	reportError(CompilerException ex)
void	reportError(Element tag, String error)
void	reportError(Element tag, String error, int lineOffset)
void	reportError(int lineNumber, String error)
void	reportError(String error)
void	reportError(String extraMessage, CompilerException ex)
void	reportWarning(Element tag, String warning, int lineOffset)
void	reportWarning(String warning)
void	runInitializers()
void	setAbstractClass(boolean abstractClass)
void	setExtraInterfaces(String[] extraInterfaces)
void	setGenericType(String genericType)
void	setMainDeclared(boolean mainDeclared)
void	setSuperGenericType(String superGenericType)
static File	URLtoFile(String urlString)
static File	URLtoFile(URL url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.apache.commons.logging.Log log

Logger

STRICT_CHECKS

public static final boolean STRICT_CHECKS

True to throw exceptions when we encounter unresolvable classes, false to ignore. This is currently set to false until JAXX has full support for inner classes (including enumerations), because currently they don't always resolve (but will generally run without error anyway).

See Also:

Constant Field Values

JAXX_NAMESPACE

public static final String JAXX_NAMESPACE

See Also:

Constant Field Values

JAXX_INTERNAL_NAMESPACE

public static final String JAXX_INTERNAL_NAMESPACE

See Also:

Constant Field Values

INLINE_THRESHOLD

public static final int INLINE_THRESHOLD

Maximum length of an inlinable creation method.

See Also:

Constant Field Values

lineSeparator

protected static String lineSeparator

Line separator cached value

firstPassClassTagHandler

protected final DefaultObjectHandler firstPassClassTagHandler

The unique object handler used in first pass

failed

protected boolean failed

flag to detect if an error occurs while compiling jaxx file

root

protected CompiledObject root

Object corresponding to the root tag in the document.

importedPackages

protected Set<String> importedPackages

Contains strings of the form "javax.swing."

importedClasses

protected Set<String> importedClasses

Contains strings of the form "javax.swing.Timer"

openComponents

protected Stack<CompiledObject> openComponents

Keeps track of open components (components still having children added).

idHelper

protected final IDHelper idHelper

to generate ids

bindingHelper

protected final DataBindingHelper bindingHelper

Binding Util

symbolTable

protected SymbolTable symbolTable

table of symbols for this compiler

baseDir

protected File baseDir

Base directory used for path resolution (normally the directory in which the .jaxx file resides).

src

protected File src

jaxx file being compiled.

document

protected Document document

Parsed XML of src file.

outputClassName

protected String outputClassName

Name of class being compiled.

scriptManager

protected ScriptManager scriptManager

stylesheet

protected Stylesheet stylesheet

Combination of all stylesheets registered using registerStylesheet(jaxx.runtime.css.Stylesheet).

inlineStyles

protected List<Rule> inlineStyles

Contains all attributes defined inline on class tags.

eventHandlers

protected Map<String,Map<ClassDescriptor,List<EventHandler>>> eventHandlers

Maps objects (expressed in Java code) to event listener classes (e.g. MouseListener) to Lists of EventHandlers. The final list contains all event handlers of a particular type attached to a particular object (again, as represented by a Java expression).

eventHandlerMethodNames

protected Map<EventHandler,String> eventHandlerMethodNames

Map of event handler method names used in compiler

classLoader

protected ClassLoader classLoader

ClassLoader which searches the user-specified class path in addition to the normal class path

initializers

protected List<Runnable> initializers

A list of Runnables which will be run after the first compilation pass. This is primarily used to trigger the creation of CompiledObjects, which cannot be created during the first pass and must be created in document order.

initializer

protected StringBuffer initializer

Extra code to be added to the instance initializer.

lateInitializer

protected StringBuffer lateInitializer

Extra code to be added at the end of the instance initializer.

bodyCode

protected StringBuffer bodyCode

Extra code to be added to the class body.

mainDeclared

protected boolean mainDeclared

true if a main() method has been declared in a script

javaFile

protected JavaFile javaFile

the file to be generated

configuration

protected CompilerConfiguration configuration

configuration of the compiler

tagsBeingCompiled

protected Stack<Element> tagsBeingCompiled

Used for error reporting purposes, so we can report the right line number.

sourceFiles

protected Stack<File> sourceFiles

Used for error reporting purposes, so we can report the right source file.

objects

protected Map<String,CompiledObject> objects

Maps object ID strings to the objects themselves. These are created during the second compilation pass.

ids

protected Map<CompiledObject,String> ids

Maps objects to their ID strings. These are created during the second compilation pass.

defaultDecorator

protected CompiledObjectDecorator defaultDecorator

default decodator to use if none specified

engine

protected final JAXXEngine engine

engine which references this compiler (can be null if compiler is standalone)

Constructor Detail

JAXXCompiler

public JAXXCompiler(JAXXEngine engine,
                    File baseDir,
                    File src,
                    String outputClassName,
                    CompilerConfiguration configuration,
                    List<String> defaultImports)

Creates a new JAXXCompiler.

Parameters:

engine - engine which use the compiler (could be null if not attach to any engine)

baseDir - classpath location

src - location of file to run

outputClassName - the out file name

configuration - configuration to pass to javac

defaultImports - list of default imports to add to java files

Method Detail

runInitializers

public void runInitializers()

registerInitializer

public void registerInitializer(Runnable r)

Registers a Runnable which will be executed after the first compilation pass is complete.

Parameters:

r - runnable to register

compileFirstPass

public void compileFirstPass(Element tag)
                      throws IOException

Throws:

IOException

compileSecondPass

public void compileSecondPass(Element tag)
                       throws IOException

Throws:

IOException

compileFirstPass

protected void compileFirstPass()
                         throws IOException

Throws:

IOException

compileSecondPass

protected void compileSecondPass()
                          throws IOException

Throws:

IOException

openComponent

public void openComponent(CompiledObject component)
                   throws CompilerException

Throws:

CompilerException

openComponent

public void openComponent(CompiledObject component,
                          String constraints)
                   throws CompilerException

Throws:

CompilerException

openInvisibleComponent

public void openInvisibleComponent(CompiledObject component)

getOpenComponent

public CompiledObject getOpenComponent()

closeComponent

public void closeComponent(CompiledObject component)

registerCompiledObject

public void registerCompiledObject(CompiledObject object)

getCompiledObject

public CompiledObject getCompiledObject(String id)

inlineCreation

public boolean inlineCreation(CompiledObject object)

checkOverride

public void checkOverride(CompiledObject object)
                   throws CompilerException

Throws:

CompilerException

getBindingHelper

public DataBindingHelper getBindingHelper()

registerEventHandler

public void registerEventHandler(EventHandler handler)

getEventHandlerMethodName

public String getEventHandlerMethodName(EventHandler handler)

addScriptField

public void addScriptField(FieldDescriptor field)

addScriptMethod

public void addScriptMethod(MethodDescriptor method)

registerScript

public void registerScript(String script)
                    throws CompilerException

Throws:

CompilerException

registerScript

public void registerScript(String script,
                           File sourceFile)
                    throws CompilerException

Throws:

CompilerException

preprocessScript

public String preprocessScript(String script)
                        throws CompilerException

Throws:

CompilerException

applyStylesheets

public void applyStylesheets()

registerStylesheet

public void registerStylesheet(Stylesheet stylesheet)

addInlineStyle

public void addInlineStyle(CompiledObject object,
                           String propertyName,
                           boolean dataBinding)

reportWarning

public void reportWarning(String warning)

reportWarning

public void reportWarning(Element tag,
                          String warning,
                          int lineOffset)

reportError

public void reportError(String error)

reportError

public void reportError(CompilerException ex)

reportError

public void reportError(String extraMessage,
                        CompilerException ex)

reportError

public void reportError(Element tag,
                        String error)

reportError

public void reportError(Element tag,
                        String error,
                        int lineOffset)

reportError

public void reportError(int lineNumber,
                        String error)

getObjects

public Map<String,CompiledObject> getObjects()

getEventHandlers

public Map<String,Map<ClassDescriptor,List<EventHandler>>> getEventHandlers()

getConfiguration

public CompilerConfiguration getConfiguration()

getOutputClassName

public String getOutputClassName()

getBaseDir

public File getBaseDir()

getImportedClasses

public Set<String> getImportedClasses()

getImportedPackages

public Set<String> getImportedPackages()

getObjectCreationOrder

public Iterator<CompiledObject> getObjectCreationOrder()

getRootObject

public CompiledObject getRootObject()

getSourceFiles

public Stack<File> getSourceFiles()

getScriptManager

public ScriptManager getScriptManager()

getSymbolTable

public SymbolTable getSymbolTable()

getStylesheet

public Stylesheet getStylesheet()

getScriptFields

public FieldDescriptor[] getScriptFields()

getScriptField

public FieldDescriptor getScriptField(String fieldName)

getScriptMethods

public MethodDescriptor[] getScriptMethods()

getScriptMethod

public MethodDescriptor getScriptMethod(String methodName)

isFailed

public boolean isFailed()

getIdHelper

public IDHelper getIdHelper()

getClassLoader

public ClassLoader getClassLoader()

Returns a ClassLoader which searches the user-specified class path in addition to the normal system class path.

Returns:

ClassLoader to use while resolving class references

getJAXXObjectDescriptor

public JAXXObjectDescriptor getJAXXObjectDescriptor()

getInitializer

public StringBuffer getInitializer()

getLateInitializer

public StringBuffer getLateInitializer()

getBodyCode

public StringBuffer getBodyCode()

isMainDeclared

public boolean isMainDeclared()

setMainDeclared

public void setMainDeclared(boolean mainDeclared)

appendInitializerCode

public void appendInitializerCode(String code)

appendBodyCode

public void appendBodyCode(String code)

appendLateInitializer

public void appendLateInitializer(String code)

hasMethod

public boolean hasMethod(String methodName)

addImport

public void addImport(String text)

addDependencyClass

public void addDependencyClass(String className)

checkJavaCode

public String checkJavaCode(String javaCode)

Verifies that a snippet of Java code parses correctly. A warning is generated if the string has enclosing curly braces.

Parameters:

javaCode - the Java code snippet to test

Returns:

a "cooked" version of the string which has enclosing curly braces removed.

Throws:

CompilerException - if the code cannot be parsed

checkReference

public boolean checkReference(Element tag,
                              String reference,
                              boolean strict,
                              String attribute)

Check that a reference exists in symbol table on second compil pass

Parameters:

tag - the current tag

reference - the required reference

strict - flag to report an error if reference was not found

attribute - (if not null reference the attribute where is defined the reference)

Returns:

true if reference was found, false otherwise and add an error in compiler

getAutoId

public String getAutoId(String name)

getUniqueId

public String getUniqueId(Object object)

setExtraInterfaces

public void setExtraInterfaces(String[] extraInterfaces)

getExtraInterfaces

public String[] getExtraInterfaces()

isAbstractClass

public boolean isAbstractClass()

setAbstractClass

public void setAbstractClass(boolean abstractClass)

getGenericType

public String getGenericType()

setGenericType

public void setGenericType(String genericType)

getSuperGenericType

public String getSuperGenericType()

setSuperGenericType

public void setSuperGenericType(String superGenericType)

addSimpleField

public void addSimpleField(JavaField javaField)

getJavaFile

public JavaFile getJavaFile()

finalizeCompiler

public void finalizeCompiler(Iterable<JAXXCompilerFinalizer> finalizers)
                      throws Exception

Throws:

Exception

generate

public void generate(JavaFileGenerator generator)
              throws IOException

Throws:

IOException

getLineSeparator

public static String getLineSeparator()

Returns the system line separator string.

Returns:

the string used to separate lines

getCanonicalName

public static String getCanonicalName(Class<?> clazz)

getCanonicalName

public static String getCanonicalName(ClassDescriptor clazz)

getCanonicalName

public static String getCanonicalName(CompiledObject compiled)

escapeJavaString

public static String escapeJavaString(String raw)

Escapes a string using standard Java escape sequences, generally in preparation to including it in a string literal in a compiled Java file.

Parameters:

raw - the raw string to be escape

Returns:

a string in which all 'dangerous' characters have been replaced by equivalent Java escape sequences

URLtoFile

public static File URLtoFile(URL url)

URLtoFile

public static File URLtoFile(String urlString)

getSAXParser

public static SAXParser getSAXParser()

parseDocument

public static Document parseDocument(InputStream in)
                              throws IOException,
                                     SAXException

Throws:

IOException

SAXException

getEngine

public JAXXEngine getEngine()

clear

public void clear()