ptolemy.backtrack.eclipse.ast.transform

Class ConstructorTransformer

java.lang.Object

ptolemy.backtrack.eclipse.ast.transform.AbstractTransformer

ptolemy.backtrack.eclipse.ast.transform.ConstructorTransformer

All Implemented Interfaces:

ClassHandler, ConstructorHandler, CrossAnalysisHandler, MethodDeclarationHandler

public class ConstructorTransformer
extends AbstractTransformer
implements ConstructorHandler, ClassHandler, CrossAnalysisHandler, MethodDeclarationHandler

The constructor transformer to transform Java source programs into new programs that support backtracking.

When the type analyzer detects constructor declarations or a constructor invocations, it calls back methods in this class to further handle them. This transformer simply adds an extra method call to certain constructor invocations to modify the checkpoint objects of the newly created objects.

Normally, when a new object is created as an instance of a refactored class, its checkpoint object is default to an empty checkpoint object. The checkpoint object then monitors the newly created object only. When the extra call is placed on the newly created object, its checkpoint object is set to be the same as the object that issues the call.

Since:

Ptolemy II 5.1

Version:

$Id: ConstructorTransformer.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Thomas Feng

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	HANDLE_SPECIAL_TYPE_MAPPINGS Whether to map special types to new types.
static java.util.Hashtable<java.lang.String,java.lang.String>	SPECIAL_TYPE_MAPPING Mapping from names of special types to the names of types used to substitute them.

Fields inherited from class ptolemy.backtrack.eclipse.ast.transform.AbstractTransformer

ASSIGN_PREFIX, BACKUP_PREFIX, CHECKPOINT_NAME, CHECKPOINT_RECORD_NAME, GET_CHECKPOINT_NAME, SET_CHECKPOINT_NAME

Constructor Summary

Constructors

Constructor and Description
ConstructorTransformer()

Method Summary

Modifier and Type	Method and Description
void	enter(org.eclipse.jdt.core.dom.AnonymousClassDeclaration node, TypeAnalyzerState state) Enter an anonymous class declaration.
void	enter(org.eclipse.jdt.core.dom.FieldDeclaration node, TypeAnalyzerState state) Enter a field declaration.
void	enter(org.eclipse.jdt.core.dom.MethodDeclaration node, TypeAnalyzerState state) Enter a method declaration.
void	enter(org.eclipse.jdt.core.dom.TypeDeclaration node, TypeAnalyzerState state) Enter a type declaration.
void	exit(org.eclipse.jdt.core.dom.AnonymousClassDeclaration node, TypeAnalyzerState state) Exit an anonymous class declaration.
void	exit(org.eclipse.jdt.core.dom.FieldDeclaration node, TypeAnalyzerState state) Exit a field declaration.
void	exit(org.eclipse.jdt.core.dom.MethodDeclaration node, TypeAnalyzerState state) Exit a method declaration.
void	exit(org.eclipse.jdt.core.dom.TypeDeclaration node, TypeAnalyzerState state) Exit a type declaration.
void	handle(org.eclipse.jdt.core.dom.ClassInstanceCreation node, TypeAnalyzerState state) Handle a class instance creation.
void	handle(org.eclipse.jdt.core.dom.MethodDeclaration node, TypeAnalyzerState state) Handle a method declaration.
void	handle(org.eclipse.jdt.core.dom.SuperConstructorInvocation node, TypeAnalyzerState state) Handle a super constructor invocation.
void	handle(TypeAnalyzerState state) Fix the refactoring result when the set of cross-analyzed types changes.

Methods inherited from class ptolemy.backtrack.eclipse.ast.transform.AbstractTransformer

_getAssignMethodName, _getBackupMethodName, addToLists, createName, createType, getClassName, getClassName, hasMethod, hasMethod, indexOf, isFieldDuplicated, lastIndexOf, removeNode, replaceNode

Methods inherited from class java.lang.Object

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

Field Detail

HANDLE_SPECIAL_TYPE_MAPPINGS

public static final boolean HANDLE_SPECIAL_TYPE_MAPPINGS

Whether to map special types to new types.

See Also:

SPECIAL_TYPE_MAPPING, Constant Field Values

SPECIAL_TYPE_MAPPING

public static final java.util.Hashtable<java.lang.String,java.lang.String> SPECIAL_TYPE_MAPPING

Mapping from names of special types to the names of types used to substitute them. During type analysis, when an object is seen to be declared as an instance of a special type (such as java.util.Random), its declaring class is substituted to be the corresponding backtracking-enabled type (such as ptolemy.backtrack.util.java.util.Random).

Constructor Detail

ConstructorTransformer

public ConstructorTransformer()

Method Detail

enter

public void enter(org.eclipse.jdt.core.dom.AnonymousClassDeclaration node,
                  TypeAnalyzerState state)

Enter an anonymous class declaration.

Specified by:

enter in interface ClassHandler

Parameters:

node - The AST node of the anonymous class declaration.

state - The current state of the type analyzer.

enter

public void enter(org.eclipse.jdt.core.dom.FieldDeclaration node,
                  TypeAnalyzerState state)

Enter a field declaration.

Specified by:

enter in interface ConstructorHandler

Parameters:

node - The AST node of the field declaration.

state - The current state of the type analyzer.

enter

public void enter(org.eclipse.jdt.core.dom.MethodDeclaration node,
                  TypeAnalyzerState state)

Enter a method declaration.

Specified by:

enter in interface MethodDeclarationHandler

Parameters:

node - The AST node of the method declaration.

state - The current state of the type analyzer.

enter

public void enter(org.eclipse.jdt.core.dom.TypeDeclaration node,
                  TypeAnalyzerState state)

Enter a type declaration.

Specified by:

enter in interface ClassHandler

Parameters:

node - The AST node of the type declaration.

state - The current state of the type analyzer.

exit

public void exit(org.eclipse.jdt.core.dom.AnonymousClassDeclaration node,
                 TypeAnalyzerState state)

Exit an anonymous class declaration.

Specified by:

exit in interface ClassHandler

Parameters:

node - The AST node of the anonymous class declaration.

state - The current state of the type analyzer.

exit

public void exit(org.eclipse.jdt.core.dom.FieldDeclaration node,
                 TypeAnalyzerState state)

Exit a field declaration.

Specified by:

exit in interface ConstructorHandler

Parameters:

node - The AST node of the field declaration.

state - The current state of the type analyzer.

exit

public void exit(org.eclipse.jdt.core.dom.MethodDeclaration node,
                 TypeAnalyzerState state)

Exit a method declaration.

Specified by:

exit in interface MethodDeclarationHandler

Parameters:

node - The AST node of the method declaration.

state - The current state of the type analyzer.

exit

public void exit(org.eclipse.jdt.core.dom.TypeDeclaration node,
                 TypeAnalyzerState state)

Exit a type declaration.

Specified by:

exit in interface ClassHandler

Parameters:

node - The AST node of the type declaration.

state - The current state of the type analyzer.

handle

public void handle(org.eclipse.jdt.core.dom.ClassInstanceCreation node,
                   TypeAnalyzerState state)

Handle a class instance creation. If the instance is not created in a method, it is not static, and the class that it belongs to is refactored, a new method call is added to it. The checkpoint object of the new instance is set to be the same as the object that creates it.

Specified by:

handle in interface ConstructorHandler

Parameters:

node - The AST node of the class instance creation.

state - The current state of the type analyzer.

handle

public void handle(org.eclipse.jdt.core.dom.MethodDeclaration node,
                   TypeAnalyzerState state)

Handle a method declaration. Nothing is done in this method.

Specified by:

handle in interface ConstructorHandler

Parameters:

node - The AST node of the method declaration.

state - The current state of the type analyzer.

handle

public void handle(org.eclipse.jdt.core.dom.SuperConstructorInvocation node,
                   TypeAnalyzerState state)

Handle a super constructor invocation. Nothing is done in this method.

Specified by:

handle in interface ConstructorHandler

Parameters:

node - The AST node of the super constructor invocation.

state - The current state of the type analyzer.

handle

public void handle(TypeAnalyzerState state)

Fix the refactoring result when the set of cross-analyzed types changes.

The set of cross-analyzed types defines the growing set of types that are analyzed in a run. Special care is taken for cross-analyzed types because they are monitored by checkpoint objects, and checkpoint-related extra methods are added to them. Unfortunately, it is not possible to know all the cross-analyzed types at the beginning. It is then necessary to fix the refactoring result when more cross-analyzed types are discovered later.

Specified by:

handle in interface CrossAnalysisHandler

Parameters:

state - The current state of the type analyzer.

See Also:

TypeAnalyzerState.getCrossAnalyzedTypes()