edu.illinois.cs.cogcomp.lbjava

Class TranslateToJava

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.Pass

edu.illinois.cs.cogcomp.lbjava.TranslateToJava

public class TranslateToJava
extends Pass

This pass generates Java code from an AST, but does not perform any training.

Author:

Nick Rizzolo

Field Summary

Fields

Modifier and Type	Field and Description
static String	disclaimer The commented message appearing at the top of all generated files.

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.Pass

ast, canAddErrorsAndWarnings, fatalError, root

Constructor Summary

Constructors

Constructor and Description
TranslateToJava(AST ast) Associates an AST with this pass.

Method Summary

Modifier and Type	Method and Description
static void	compressAndPrint(StringBuffer buffer, PrintStream out) Compress the textual representation of an ASTNode, convert to ASCII hexadecimal, and write the result to the specified stream.
void	generateBoundedQuantifier(QuantifiedConstraintExpression e) AtLeastQuantifierExpressions and AtMostQuantifierExpressions generate their code through this method.
static void	generateHashingMethods(PrintStream out, String name) Generates the equals(Object) method, which evaluates to true whenever the two objects are of the same type.
static void	generateLearnerBody(PrintStream out, LearningClassifierExpression lce) Generate the code that overrides certain methods of Learner to check types and call themselves on the unique instance; also declares other methods and fields of the classifier's implementation.
static StringBuffer	generateTypeChecking(String indent, String name, String type, boolean array, String input, int line, String exampleName, boolean preExtracted) Generates the code appearing at the beginning of, for example, many classifiers' Classifier.classify(Object) methods that checks to see if that input Object has the appropriate type.
String	getMethodBody() Gives access to the methodBody member variable so that this pass can be invoked selectively on some subset of a method body.
static String	makeTypeReadable(String name) The value returned by the Class.getName() method is not recognizable as a type by javac if the given class is an array; this method produces a representation that is recognizable by javac.
static PrintStream	open(CodeGenerator node) Create a PrintStream that writes to a Java file corresponding to the specified CodeGenerator.
static PrintStream	open(String name) Create a PrintStream that writes to the specified file.
void	run(Argument a) Runs this pass on all nodes of the indicated type.
void	run(ArrayCreationExpression e) Runs this pass on all nodes of the indicated type.
void	run(ArrayInitializer e) Runs this pass on all nodes of the indicated type.
void	run(ArrayType t) Runs this pass on all nodes of the indicated type.
void	run(AssertStatement s) Runs this pass on all nodes of the indicated type.
void	run(Assignment e) Runs this pass on all nodes of the indicated type.
void	run(AST ast) Runs this pass on all nodes of the indicated type.
void	run(AtLeastQuantifierExpression e) Runs this pass on all nodes of the indicated type.
void	run(AtMostQuantifierExpression e) Runs this pass on all nodes of the indicated type.
void	run(BinaryConstraintExpression e) Runs this pass on all nodes of the indicated type.
void	run(BinaryExpression be) Runs this pass on all nodes of the indicated type.
void	run(Block b) Runs this pass on all nodes of the indicated type.
void	run(BreakStatement s) Runs this pass on all nodes of the indicated type.
void	run(CastExpression e) Runs this pass on all nodes of the indicated type.
void	run(CatchClause c) Runs this pass on all nodes of the indicated type.
void	run(CatchList l) Runs this pass on all nodes of the indicated type.
void	run(ClassifierName cn) Code is only generated for a ClassifierName when it is the only ClassifierExpression on the right hand side of the arrow (and there really shouldn't be a reason that a programmer would want to write such a declaration, but if he does, it will work).
void	run(CodedClassifier cc) Generates code for all nodes of the indicated type.
void	run(CompositeGenerator cg) Generates code for all nodes of the indicated type.
void	run(Conditional e) Runs this pass on all nodes of the indicated type.
void	run(Conjunction c) Generates code for all nodes of the indicated type.
void	run(Constant e) Runs this pass on all nodes of the indicated type.
void	run(ConstraintDeclaration cd) Generates code for all nodes of the indicated type.
void	run(ConstraintEqualityExpression e) Runs this pass on all nodes of the indicated type.
void	run(ConstraintInvocation e) Runs this pass on all nodes of the indicated type.
void	run(ConstraintStatementExpression e) Runs this pass on all nodes of the indicated type.
void	run(ContinueStatement s) Runs this pass on all nodes of the indicated type.
void	run(DoStatement s) Runs this pass on all nodes of the indicated type.
void	run(ExistentialQuantifierExpression e) Runs this pass on all nodes of the indicated type.
void	run(ExpressionList l) Runs this pass on all nodes of the indicated type.
void	run(ExpressionStatement s) Runs this pass on all nodes of the indicated type.
void	run(FieldAccess e) Runs this pass on all nodes of the indicated type.
void	run(ForStatement s) Runs this pass on all nodes of the indicated type.
void	run(IfStatement s) Runs this pass on all nodes of the indicated type.
void	run(IncrementExpression e) Runs this pass on all nodes of the indicated type.
void	run(InferenceDeclaration.HeadFinder h) Runs this pass on all nodes of the indicated type.
void	run(InferenceDeclaration in) Generates code for all nodes of the indicated type.
void	run(InferenceInvocation ii) Generates code for all nodes of the indicated type.
void	run(InstanceCreationExpression e) Runs this pass on all nodes of the indicated type.
void	run(InstanceofExpression e) Runs this pass on all nodes of the indicated type.
void	run(LabeledStatement s) Runs this pass on all nodes of the indicated type.
void	run(LearningClassifierExpression lce) Generates code for all nodes of the indicated type.
void	run(MethodInvocation e) Runs this pass on all nodes of the indicated type.
void	run(Name n) Runs this pass on all nodes of the indicated type.
void	run(NegatedConstraintExpression e) Runs this pass on all nodes of the indicated type.
void	run(Operator o) Runs this pass on all nodes of the indicated type.
void	run(ParameterSet e) Runs this pass on all nodes of the indicated type.
void	run(PrimitiveType t) Runs this pass on all nodes of the indicated type.
void	run(ReferenceType t) Runs this pass on all nodes of the indicated type.
void	run(ReturnStatement s) Runs this pass on all nodes of the indicated type.
void	run(SenseStatement ss) Runs this pass on all nodes of the indicated type.
void	run(StatementList l) Runs this pass on all nodes of the indicated type.
void	run(SubscriptVariable e) Runs this pass on all nodes of the indicated type.
void	run(SwitchGroup g) Runs this pass on all nodes of the indicated type.
void	run(SwitchGroupList l) Runs this pass on all nodes of the indicated type.
void	run(SwitchLabel l) Runs this pass on all nodes of the indicated type.
void	run(SwitchLabelList l) Runs this pass on all nodes of the indicated type.
void	run(SwitchStatement s) Runs this pass on all nodes of the indicated type.
void	run(SynchronizedStatement s) Runs this pass on all nodes of the indicated type.
void	run(ThrowStatement s) Runs this pass on all nodes of the indicated type.
void	run(TryStatement s) Runs this pass on all nodes of the indicated type.
void	run(UnaryExpression e) Runs this pass on all nodes of the indicated type.
void	run(UniversalQuantifierExpression e) Runs this pass on all nodes of the indicated type.
void	run(VariableDeclaration s) Runs this pass on all nodes of the indicated type.
void	run(WhileStatement s) Runs this pass on all nodes of the indicated type.
void	setCurrentCG(CodeGenerator cg) Sets the current code generator for this translator.
void	setIndent(int i) Sets the indentation level.
static String	signature(Method m, int modifiers, Class returned, String name, Class[] parameters) This method generates a string signature of the given method.
static void	typeCheckClassifyArray(PrintStream out, String name, Type input, int line) Generates code that overrides the Classifier.classify(Object[]) method so that it checks the types of its arguments.
static void	typeReturningMethods(PrintStream out, Type input, ClassifierReturnType output) Generate code that overrides the methods of Classifier that return type information.

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.Pass

printErrorsAndWarnings, reportError, reportWarning, run, run, run, run, run, run, run, run, run, run, run, run, run, run, run, run, run, run, runOnChildren, setRoot

Methods inherited from class java.lang.Object

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

Field Detail

disclaimer

public static final String disclaimer

The commented message appearing at the top of all generated files.

See Also:

Constant Field Values

Constructor Detail

TranslateToJava

public TranslateToJava(AST ast)

Associates an AST with this pass.

Parameters:

ast - The AST to associate with this pass.

Method Detail

setCurrentCG

public void setCurrentCG(CodeGenerator cg)

Sets the current code generator for this translator.

Parameters:

cg - The new current code generator.

setIndent

public void setIndent(int i)

Sets the indentation level.

Parameters:

i - The new indentation level.

getMethodBody

public String getMethodBody()

Gives access to the methodBody member variable so that this pass can be invoked selectively on some subset of a method body.

Returns:

The contents of methodBody in a String.

open

public static PrintStream open(CodeGenerator node)

Create a PrintStream that writes to a Java file corresponding to the specified CodeGenerator.

Parameters:

node - The code producing node.

Returns:

The stream, or null if it couldn't be created.

open

public static PrintStream open(String name)

Create a PrintStream that writes to the specified file.

Parameters:

name - The name of the file to open.

Returns:

The stream, or null if it couldn't be created.

generateLearnerBody

public static void generateLearnerBody(PrintStream out,
                                       LearningClassifierExpression lce)

Generate the code that overrides certain methods of Learner to check types and call themselves on the unique instance; also declares other methods and fields of the classifier's implementation. The explicitly overridden methods are:

• getInputType()
• getOutputType()
• allowableValues()
• learn(Object)
• learn(Object[])
• classify(Object)
• classify(Object[])

In addition, any methods defined by any subclass of Learner down to the super class of this learner are overridden to call the super class's implementation on the unique instance.

Parameters:

out - The stream to write to.

lce - The LearningClassifierExpression representing the learner.

signature

public static String signature(Method m,
                               int modifiers,
                               Class returned,
                               String name,
                               Class[] parameters)

This method generates a string signature of the given method. The arguments other than m are supplied as arguments for efficiency reasons, since this method is only called by one other method.

Parameters:

m - The method object.

modifiers - The integer representation of the method's modifiers.

returned - The return type of the method.

name - The name of the method.

parameters - The parameter types of the method.

Returns:

A string description of the method suitable for comparison with the elements of the noOverride array.

See Also:

generateLearnerBody(PrintStream,LearningClassifierExpression)

makeTypeReadable

public static String makeTypeReadable(String name)

The value returned by the Class.getName() method is not recognizable as a type by javac if the given class is an array; this method produces a representation that is recognizable by javac. This method also replaces '$' characters with '.' characters, under the assumption that '$' only appears in the name of an inner class.

Parameters:

name - The name of a class as produced by Class.getName().

Returns:

A string representation of the class recognizable by javac.

typeReturningMethods

public static void typeReturningMethods(PrintStream out,
                                        Type input,
                                        ClassifierReturnType output)

Generate code that overrides the methods of Classifier that return type information. The methods overridden are:

• getInputType()
• getOutputType()
• allowableValues()

Parameters:

out - The stream to write to.

input - The input type of the classifier whose code this is.

output - The return type of the classifier whose code this is.

typeCheckClassifyArray

public static void typeCheckClassifyArray(PrintStream out,
                                          String name,
                                          Type input,
                                          int line)

Generates code that overrides the Classifier.classify(Object[]) method so that it checks the types of its arguments.

Parameters:

out - The stream to write to.

name - The name of the classifier whose code this is.

input - The input type of the classifier whose code this is.

line - The line number on which this classifier is defined.

generateHashingMethods

public static void generateHashingMethods(PrintStream out,
                                          String name)

Generates the equals(Object) method, which evaluates to true whenever the two objects are of the same type. This method should not be called when generating code for a InferenceDeclaration.

Parameters:

out - The stream to write to.

name - The name of the node whose equals(Object) method is being generated.

generateTypeChecking

public static StringBuffer generateTypeChecking(String indent,
                                                String name,
                                                String type,
                                                boolean array,
                                                String input,
                                                int line,
                                                String exampleName,
                                                boolean preExtracted)

Generates the code appearing at the beginning of, for example, many classifiers' Classifier.classify(Object) methods that checks to see if that input Object has the appropriate type.

Parameters:

indent - The whitespace indentation in the generated code.

name - The name of the CodeGenerator whose input is being checked.

type - The type of CodeGenerator whose input is being checked (capitalized).

array - Whether or not the method being type checked takes an array of the input type.

input - The correct input type of the CodeGenerator.

line - The line number on which the CodeGenerator appears.

exampleName - The name of the example variable.

preExtracted - Whether or not the generated code should allow object arrays containing indexed features, as a learner can take as input.

Returns:

The generated code.

compressAndPrint

public static void compressAndPrint(StringBuffer buffer,
                                    PrintStream out)

Compress the textual representation of an ASTNode, convert to ASCII hexadecimal, and write the result to the specified stream.

Parameters:

buffer - The text representation to be written.

out - The stream to write to.

run

public void run(AST ast)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

ast - The node to process.

run

public void run(ClassifierName cn)

Code is only generated for a ClassifierName when it is the only ClassifierExpression on the right hand side of the arrow (and there really shouldn't be a reason that a programmer would want to write such a declaration, but if he does, it will work).

Overrides:

run in class Pass

Parameters:

cn - The node to process.

run

public void run(CodedClassifier cc)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

cc - The node to process.

run

public void run(CompositeGenerator cg)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

cg - The node to process.

run

public void run(InferenceInvocation ii)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

ii - The node to process.

run

public void run(LearningClassifierExpression lce)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

lce - The node to process.

run

public void run(Conjunction c)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

c - The node to process.

run

public void run(ConstraintDeclaration cd)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

cd - The node to process.

run

public void run(InferenceDeclaration in)

Generates code for all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

in - The node to process.

run

public void run(InferenceDeclaration.HeadFinder h)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

h - The node to process.

run

public void run(Block b)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

b - The node to process.

run

public void run(StatementList l)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

l - The node to process.

run

public void run(AssertStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(BreakStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(ContinueStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(ExpressionStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(ForStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(IfStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(LabeledStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(ReturnStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(SenseStatement ss)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

ss - The node to process.

run

public void run(SwitchStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(SynchronizedStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(ThrowStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(TryStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(VariableDeclaration s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(WhileStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(DoStatement s)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

s - The node to process.

run

public void run(SwitchGroupList l)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

l - The node to process.

run

public void run(SwitchGroup g)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

g - The node to process.

run

public void run(SwitchLabelList l)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

l - The node to process.

run

public void run(SwitchLabel l)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

l - The node to process.

run

public void run(CatchList l)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

l - The node to process.

run

public void run(CatchClause c)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

c - The node to process.

run

public void run(Argument a)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

a - The node to process.

run

public void run(ConstraintStatementExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(BinaryConstraintExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(NegatedConstraintExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(ConstraintEqualityExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(ConstraintInvocation e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(UniversalQuantifierExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(ExistentialQuantifierExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

generateBoundedQuantifier

public void generateBoundedQuantifier(QuantifiedConstraintExpression e)

AtLeastQuantifierExpressions and AtMostQuantifierExpressions generate their code through this method.

Parameters:

e - The node to process.

run

public void run(AtLeastQuantifierExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(AtMostQuantifierExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(ExpressionList l)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

l - The node to process.

run

public void run(ArrayCreationExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(ArrayInitializer e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(CastExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(Conditional e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(Constant e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(ParameterSet e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(InstanceofExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(Assignment e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(IncrementExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(InstanceCreationExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(MethodInvocation e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(BinaryExpression be)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

be - The node to process.

run

public void run(UnaryExpression e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(FieldAccess e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(SubscriptVariable e)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

e - The node to process.

run

public void run(Name n)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

n - The node to process.

run

public void run(ArrayType t)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

t - The node to process.

run

public void run(PrimitiveType t)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

t - The node to process.

run

public void run(ReferenceType t)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

t - The node to process.

run

public void run(Operator o)

Runs this pass on all nodes of the indicated type.

Overrides:

run in class Pass

Parameters:

o - The node to process.