claw.shenron.transformation

Class Transformation

java.lang.Object

claw.shenron.transformation.Transformation

Direct Known Subclasses:

BlockTransformation, ClawTransformation

public abstract class Transformation
extends java.lang.Object

A Transformation is an object capable of analyzing a possible code transformation to be applied and the steps to apply it to the intermediate representation. Normally, only derived classes of Transformation should be applied as the base class does not implement the core methods.

Author:

clementval

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Transformation() Transformation ctor for translation_unit triggered transformation.
protected	Transformation(AnalyzedPragma directive) Transformation ctor for directive triggered transformation.

Method Summary

Modifier and Type	Method and Description
boolean	abortOnFailedAnalysis() Tells whether the transformation should abort the translation if the analysis fails.
abstract boolean	analyze(XcodeProgram xcodeml, Translator translator) Analyze the possibility to apply the transformation.
abstract boolean	canBeTransformedWith(XcodeProgram xcodeml, Transformation other) Check whether the current transformation can be transformed together with the given transformation.
AnalyzedPragma	getDirective() Get the directive that triggered the transformation.
protected int	getStartLine() Get the line number where the pragma was found.
protected boolean	isTransformed() Get the information whether the transformation has been applied or not.
protected void	setStartLine(int lineno) Set the start line of the transformation.
abstract void	transform(XcodeProgram xcodeml, Translator translator, Transformation other) Apply the actual transformation.
protected void	transformed() Set the transformation as transformed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transformation

protected Transformation()

Transformation ctor for translation_unit triggered transformation.

Transformation

protected Transformation(AnalyzedPragma directive)

Transformation ctor for directive triggered transformation.

Parameters:

directive - The directive that triggered the transformation.

Method Detail

analyze

public abstract boolean analyze(XcodeProgram xcodeml,
                                Translator translator)

Analyze the possibility to apply the transformation. Gather information to be able to apply the transformation in when calling #transform.

Parameters:

xcodeml - The XcodeML on which the transformations are applied.

translator - The translator used to applied the transformations.

Returns:

True if analysis succeeded. False otherwise.

canBeTransformedWith

public abstract boolean canBeTransformedWith(XcodeProgram xcodeml,
                                             Transformation other)

Check whether the current transformation can be transformed together with the given transformation. Useful only for dependent transformation.

Parameters:

xcodeml - The XcodeML on which the transformations are applied.

other - The other transformation part of the dependent transformation.

Returns:

True if the two transformation can be transform together. False otherwise.

See Also:

DependentTransformationGroup

abortOnFailedAnalysis

public boolean abortOnFailedAnalysis()

Tells whether the transformation should abort the translation if the analysis fails. Default behavior is to abort.

Returns:

True if it aborts. False otherwise.

transform

public abstract void transform(XcodeProgram xcodeml,
                               Translator translator,
                               Transformation other)
                        throws java.lang.Exception

Apply the actual transformation.

Parameters:

xcodeml - The XcodeML on which the transformations are applied.

translator - The translator used to applied the transformations.

other - Only for dependent transformation. The other transformation part of the transformation.

Throws:

IllegalTransformationException - if the transformation cannot be applied.

java.lang.Exception

getDirective

public AnalyzedPragma getDirective()

Get the directive that triggered the transformation.

Returns:

The analyzed directive as a ClawPragma object.

getStartLine

protected int getStartLine()

Get the line number where the pragma was found.

Returns:

Line number of the pragma.

setStartLine

protected void setStartLine(int lineno)

Set the start line of the transformation. Normally, this is the line where the pragma was found.

Parameters:

lineno - An positive integer value representing the line number.

isTransformed

protected boolean isTransformed()

Get the information whether the transformation has been applied or not.

Returns:

True is the transformation has been applied. False otherwise.

transformed

protected void transformed()

Set the transformation as transformed.