de.uka.ilkd.key.java.recoderext

Class ClassInitializeMethodBuilder

java.lang.Object

recoder.kit.Transformation

recoder.kit.TwoPassTransformation

de.uka.ilkd.key.java.recoderext.RecoderModelTransformer

de.uka.ilkd.key.java.recoderext.ClassInitializeMethodBuilder

public class ClassInitializeMethodBuilder
extends RecoderModelTransformer

Each class is prepared before it is initialised. The preparation of a class consists of pre-initialising the class fields with their default values. This class creates the implicit method <clprepare> responsible for the class preparation.

Nested Class Summary

Nested classes/interfaces inherited from class de.uka.ilkd.key.java.recoderext.RecoderModelTransformer

RecoderModelTransformer.FinalOuterVarsCollector, RecoderModelTransformer.TransformerCache

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_INITIALIZE_IDENTIFIER
private java.util.HashMap<TypeDeclaration,ASTList<Statement>>	class2initializers maps a class to its static NON CONSTANT fields
private java.util.HashMap<ClassDeclaration,TypeReference>	class2super maps a class to its superclass
private ClassType	javaLangObject

Fields inherited from class de.uka.ilkd.key.java.recoderext.RecoderModelTransformer

cache, services

Fields inherited from class recoder.kit.Transformation

EQUIVALENCE, IDENTITY, NO_PROBLEM

Constructor Summary

Constructors

Constructor and Description
ClassInitializeMethodBuilder(CrossReferenceServiceConfiguration services, RecoderModelTransformer.TransformerCache cache) Creates an instance of the class preparation method model transformer.

Method Summary

Modifier and Type	Method and Description
ProblemReport	analyze()
protected CopyAssignment	assign(Expression left, Expression right) creates a recoder copy assignment
private Catch	createCatchClause(java.lang.String caughtType, java.lang.String caughtParam, Throw t) creates the following catch clause catch (caughtType caughtParam) { <classInitializationInProgress>=false; <classClassErroneous>=true; t; }
private MethodDeclaration	createInitializeMethod(TypeDeclaration td) creates the static method <clprepare> for the given type declaration
private StatementBlock	createInitializeMethodBody(TypeDeclaration td) creates the body of the initialize method
private Try	createInitializerExecutionTryBlock(TypeDeclaration td) around the initializers there is a try block that catches eventually thrown errors or exceptions and handles them in a special way
private PackageReference	createJavaLangPackageReference() creates the package reference java.lang
private ASTList<Statement>	fieldInitializersToAssignments(FieldDeclaration fd) iterates throuh the given field declaration and creates for each specification that contains an initializer a corresponding copy assignment.
private ASTList<Statement>	getInitializers(TypeDeclaration typeDeclaration) retrieves all static non constant fields and returns a list of copy assignment pre-initialising them with their default values some special settings for implicit fields are performed here as well
private boolean	isConstantField(FieldSpecification spec) returns true if the given fieldspecification denotes a constant field.
protected void	makeExplicit(TypeDeclaration td) entry method for the constructor normalform builder
protected PassiveExpression	passiveFieldReference(Identifier id) creates passive field reference access

Methods inherited from class de.uka.ilkd.key.java.recoderext.RecoderModelTransformer

attach, attribute, classDeclarations, containingClass, containingMethod, declare, declare, getAllSupertypes, getDefaultValue, getId, getLocalClass2FinalVar, getUnits, isVisible, makeExplicit, transform

Methods inherited from class recoder.kit.TwoPassTransformation

execute

Methods inherited from class recoder.kit.Transformation

attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attach, attachAsArgument, attachAsArgument, attachAsArgument, attachAsArgument, attachAsArgument, attachAsArgument, attachAsArgument, attachAsArgument, attachAsBody, attachAsCondition, attachAsGuard, attachAsInitializer, attachAsLabel, attachAsMessage, attachAsPrefix, attachAsPrefix, attachAsPrefix, attachAsPrefix, attachAsUpdate, detach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttach, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsArgument, doAttachAsBody, doAttachAsCondition, doAttachAsGuard, doAttachAsInitializer, doAttachAsLabel, doAttachAsMessage, doAttachAsPrefix, doAttachAsPrefix, doAttachAsPrefix, doAttachAsPrefix, doAttachAsUpdate, doDetach, doReplace, getChangeHistory, getCrossReferenceSourceInfo, getNameInfo, getProblemReport, getProgramFactory, getServiceConfiguration, getSourceFileRepository, getSourceInfo, replace, rollback, setProblemReport, setServiceConfiguration, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_INITIALIZE_IDENTIFIER

public static final java.lang.String CLASS_INITIALIZE_IDENTIFIER

See Also:

Constant Field Values

class2initializers

private java.util.HashMap<TypeDeclaration,ASTList<Statement>> class2initializers

maps a class to its static NON CONSTANT fields

class2super

private java.util.HashMap<ClassDeclaration,TypeReference> class2super

maps a class to its superclass

javaLangObject

private ClassType javaLangObject

Constructor Detail

ClassInitializeMethodBuilder

public ClassInitializeMethodBuilder(CrossReferenceServiceConfiguration services,
                                    RecoderModelTransformer.TransformerCache cache)

Creates an instance of the class preparation method model transformer. Information about the current recoder model can be accessed via the given service configuration. The implicit preparation method is created and added for all classes, which are declared in one of the given compilation units.

Parameters:

services - the CrossReferenceServiceConfiguration with the information about the recoder model

cache - a cache object that stores information which is needed by and common to many transformations. it includes the compilation units, the declared classes, and information for local classes.

Method Detail

isConstantField

private boolean isConstantField(FieldSpecification spec)

returns true if the given fieldspecification denotes a constant field. A constant field is declared as final and static and initialised with a time constant, which is not prepared or initialised here. ATTENTION: this is a derivation from the JLS but the obtained behaviour is equivalent as we only consider completely compiled programs and not partial compilations. The reason for preparation and initialisation of comnpile time constant fields is due to binary compatibility reasons.

createJavaLangPackageReference

private PackageReference createJavaLangPackageReference()

creates the package reference java.lang

fieldInitializersToAssignments

private ASTList<Statement> fieldInitializersToAssignments(FieldDeclaration fd)

iterates throuh the given field declaration and creates for each specification that contains an initializer a corresponding copy assignment. Thereby only non constant fields are considered.

getInitializers

private ASTList<Statement> getInitializers(TypeDeclaration typeDeclaration)

retrieves all static non constant fields and returns a list of copy assignment pre-initialising them with their default values some special settings for implicit fields are performed here as well

Parameters:

typeDeclaration - the ClassDeclaration whose fields have to be prepared

Returns:

the list of copy assignments

analyze

public ProblemReport analyze()

Overrides:

analyze in class TwoPassTransformation

passiveFieldReference

protected PassiveExpression passiveFieldReference(Identifier id)

creates passive field reference access

assign

protected CopyAssignment assign(Expression left,
                                Expression right)

creates a recoder copy assignment

Overrides:

assign in class RecoderModelTransformer

createCatchClause

private Catch createCatchClause(java.lang.String caughtType,
                                java.lang.String caughtParam,
                                Throw t)

creates the following catch clause catch (caughtType caughtParam) { <classInitializationInProgress>=false; <classClassErroneous>=true; t; }

createInitializerExecutionTryBlock

private Try createInitializerExecutionTryBlock(TypeDeclaration td)

around the initializers there is a try block that catches eventually thrown errors or exceptions and handles them in a special way

createInitializeMethodBody

private StatementBlock createInitializeMethodBody(TypeDeclaration td)

creates the body of the initialize method

createInitializeMethod

private MethodDeclaration createInitializeMethod(TypeDeclaration td)

creates the static method <clprepare> for the given type declaration

Parameters:

td - the TypeDeclaration to which the new created method will be attached

Returns:

the created class preparation method

makeExplicit

protected void makeExplicit(TypeDeclaration td)

entry method for the constructor normalform builder

Specified by:

makeExplicit in class RecoderModelTransformer

Parameters:

td - the TypeDeclaration