ptolemy.backtrack.eclipse.ast

Class Transformer

java.lang.Object

ptolemy.backtrack.eclipse.ast.Transformer

public class Transformer
extends java.lang.Object

A tool to transform Java source programs to support backtracking. This transformation is done by first analyzing the Java programs, and then refactoring the program based on the information collected in the analysis phase.

Since:

Ptolemy II 5.1

Version:

$Id$

Author:

Thomas Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Field Summary

Fields

Modifier and Type	Field and Description
static TransformRule[]	RULES The refactoring rules to be sequentially applied to the source code.

Method Summary

Modifier and Type	Method and Description
protected void	_afterTraverse() Call the afterTraverse of all the refactoring rules.
protected void	_beforeTraverse() Call the beforeTraverse of all the refactoring rules.
protected static void	_outputConfig() Output XML configuration to the pre-defined file (specified with "-config" argument in main(String[])).
protected void	_outputSource(java.io.Writer writer, java.lang.String fileName) Output the Java source from the current AST with ASTFormatter.
protected void	_parse() Parse the Java source and retrieve the AST.
protected void	_startTransform() Start the transformation by first parsing the source with _parse(), then call _beforeTraverse(), then traverse the AST with TypeAnalyzer visitor, and finally call _afterTraverse().
static void	main(java.lang.String[] args) Transform a set of files into backtracking-enabled ones.
static int	parseArguments(java.lang.String[] args, int position) Parse the command-line arguments starting from the given position.
static void	transform(java.lang.String fileName, org.eclipse.jdt.core.dom.CompilationUnit ast, java.io.Writer writer, java.lang.String[] classPaths, java.lang.String[] crossAnalyzedTypes) Transform the AST with given class paths, and output the result to the writer.
static void	transform(java.lang.String fileName, java.io.Writer writer) Transform the Java source in the file given by its name with no explicit class path, and output the result to the writer.
static void	transform(java.lang.String fileName, java.io.Writer writer, java.lang.String[] classPaths) Transform the Java source in the file given by its name with given class paths, and output the result to the writer.
static void	transform(java.lang.String fileName, java.io.Writer writer, java.lang.String[] classPaths, java.lang.String[] crossAnalyzedTypes) Transform the Java source in the file given by its name with given class paths, and output the result to the writer.

Methods inherited from class java.lang.Object

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

Field Detail

RULES

public static TransformRule[] RULES

The refactoring rules to be sequentially applied to the source code.

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Transform a set of files into backtracking-enabled ones. The set of files is given by an array of strings as their names, or the names of the directories that contain them. If a string in the array is a file name, it is refactored and the output is printed out; if it is the name of a directory, all Java files in the directory and its sub-directories are looked up and refactored in the same way.

Parameters:

args - The array of file names or names of directories.

Throws:

java.lang.Exception - If any exception occures.

parseArguments

public static int parseArguments(java.lang.String[] args,
                                 int position)

Parse the command-line arguments starting from the given position. If one or more argument corresponds to an option, proper actions are performed to record that option. The position is adjusted to the next file name or option and returned.

Parameters:

args - The command-line arguments.

position - The starting position.

Returns:

The new position.

transform

public static void transform(java.lang.String fileName,
                             org.eclipse.jdt.core.dom.CompilationUnit ast,
                             java.io.Writer writer,
                             java.lang.String[] classPaths,
                             java.lang.String[] crossAnalyzedTypes)
                      throws java.io.IOException,
                             ASTMalformedException

Transform the AST with given class paths, and output the result to the writer.

If a output directory is set with the -output command-line argument, the output is written to a Java source file with that directory as the root directory. The given writer is not used in that case.

Parameters:

fileName - The Java file name.

ast - The AST to be refactored.

writer - The writer where output is written.

classPaths - The class paths.

crossAnalyzedTypes - The array of names of types to be added to the visitor's cross-analyzed types list.

Throws:

java.io.IOException - If IO exception occurs when reading from the Java file or riting to the output.

ASTMalformedException - If the Java source is illegal.

See Also:

transform(String, Writer)

transform

public static void transform(java.lang.String fileName,
                             java.io.Writer writer)
                      throws java.io.IOException,
                             ASTMalformedException

Transform the Java source in the file given by its name with no explicit class path, and output the result to the writer. This is the same as calling transform(fileName, writer, null).

Parameters:

fileName - The Java file name.

writer - The writer where output is written.

Throws:

java.io.IOException - If IO exception occurs when reading from the Java file or riting to the output.

ASTMalformedException - If the Java source is illegal.

See Also:

transform(String, Writer, String[])

transform

public static void transform(java.lang.String fileName,
                             java.io.Writer writer,
                             java.lang.String[] classPaths)
                      throws java.io.IOException,
                             ASTMalformedException

Transform the Java source in the file given by its name with given class paths, and output the result to the writer.

If a output directory is set with the -output command-line argument, the output is written to a Java source file with that directory as the root directory. The given writer is not used in that case.

Parameters:

fileName - The Java file name.

writer - The writer where output is written.

classPaths - The class paths.

Throws:

java.io.IOException - If IO exception occurs when reading from the Java file or riting to the output.

ASTMalformedException - If the Java source is illegal.

See Also:

transform(String, Writer)

transform

public static void transform(java.lang.String fileName,
                             java.io.Writer writer,
                             java.lang.String[] classPaths,
                             java.lang.String[] crossAnalyzedTypes)
                      throws java.io.IOException,
                             ASTMalformedException

Transform the Java source in the file given by its name with given class paths, and output the result to the writer.

If a output directory is set with the -output command-line argument, the output is written to a Java source file with that directory as the root directory. The given writer is not used in that case.

Parameters:

fileName - The Java file name.

writer - The writer where output is written.

classPaths - The class paths.

crossAnalyzedTypes - The array of names of types to be added to the visitor's cross-analyzed types list.

Throws:

java.io.IOException - If IO exception occurs when reading from the Java file or riting to the output.

ASTMalformedException - If the Java source is illegal.

See Also:

transform(String, Writer)

_afterTraverse

protected void _afterTraverse()

Call the afterTraverse of all the refactoring rules. For each rule, the afterTraverse is called after the AST is traversed. The rule may clean up states or finalize the transformation.

_beforeTraverse

protected void _beforeTraverse()

Call the beforeTraverse of all the refactoring rules. For each rule, the beforeTraverse is called before the AST is traversed. The rule may set up handlers for special events in the traversal.

_outputConfig

protected static void _outputConfig()
                             throws java.lang.Exception

Output XML configuration to the pre-defined file (specified with "-config" argument in main(String[])).

Throws:

java.lang.Exception - If any error occurs.

_outputSource

protected void _outputSource(java.io.Writer writer,
                             java.lang.String fileName)
                      throws java.io.IOException

Output the Java source from the current AST with ASTFormatter.

Parameters:

writer - The writer where the output is written to.

fileName - The file name of the writer.

Throws:

java.io.IOException - If error occurs while writing to the writer.

_parse

protected void _parse()
               throws java.io.IOException,
                      ASTMalformedException

Parse the Java source and retrieve the AST. If a source file name is given, the file is read and parsed; if the source is given in the form of char[], it is directly passed to the parser.

Throws:

java.io.IOException - If a file name is given, but exception occurs when reading from the file.

ASTMalformedException - If the source is illegal.

_startTransform

protected void _startTransform()
                        throws java.io.IOException,
                               ASTMalformedException

Start the transformation by first parsing the source with _parse(), then call _beforeTraverse(), then traverse the AST with TypeAnalyzer visitor, and finally call _afterTraverse().

Throws:

java.io.IOException - If a file name is given, but exception occurs when reading from the file.

ASTMalformedException - If the source is illegal.

See Also:

_afterTraverse(), _beforeTraverse(), _parse()