cetus.hir

Class IRTools

java.lang.Object

cetus.hir.IRTools

public final class IRTools
extends java.lang.Object

IRTools provides tools that perform search/replace in the IR tree.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkConsistency(Traversable t) Checks the consistency of the IR subtree rooted at t.
static <T extends PragmaAnnotation> java.util.List<T>	collectPragmas(Traversable t, java.lang.Class<T> pragma_cls, java.lang.String key) Returns a list of pragma annotations that contain the specified string keys and are attached to annotatable objects within the traversable object t.
static boolean	containsBinary(Traversable t, BinaryOperator op) Checks if the traversable object contains the specified type of binary operations.
static boolean	containsClass(Traversable t, java.lang.Class<? extends Traversable> type) Checks if the traversable object contains the specified type of object.
static boolean	containsClasses(Traversable t, java.util.Set<java.lang.Class<? extends Traversable>> types) Checks if the traversable object contains the specified types of object.
static boolean	containsExpression(Traversable t, Expression e) Searches the IR tree beginning at t for the Expression e.
static boolean	containsExpressions(Traversable t, java.util.Collection<? extends Expression> es) Searches the IR tree beginning at t for any expressions in the given collection of expressions.
static boolean	containsFunctionCall(Traversable t) Returns true if there is a FunctionCall within the traversable.
static boolean	containsSideEffect(Traversable t) Returns true if the traversable contains any side effects that change the program state.
static boolean	containsSymbol(Traversable t, Symbol var) Checks if the specified traversable object contains any identifier derived from the given symbol var.
static boolean	containsSymbols(java.util.Set<Symbol> vars, java.util.Set<Symbol> symbols) Simple check method for existence of intersection between the two given sets of symbols.
static boolean	containsSymbols(Traversable t, java.util.Set<Symbol> vars) Checks if the specified traversable object contains any identifier derived from the given set of symbols vars.
static boolean	containsUnary(Traversable t, UnaryOperator op) Checks if the traversable object contains the specified type of unary operations.
static int	countExpressions(Traversable t, Expression e) Counts the number of times that the Expression e appears in the IR tree t.
static Expression	findExpression(Traversable t, Expression e) Finds the first instance of the Expression e in the IR tree t.
static java.util.List<Expression>	findExpressions(Traversable t, Expression e) Finds the list of instances of the Expression e in the IR tree t.
static <T extends Traversable> T	getAncestorOfType(Traversable t, java.lang.Class<T> type) Returns the nearest ancestor object of the given traversable object that has the specified type.
static <T extends Traversable> java.util.List<T>	getDescendentsOfType(Traversable t, java.lang.Class<T> type) Returns a list of descendents of the traversable object t with the specified type type.
static <T extends Expression> java.util.List<T>	getExpressionsOfType(Traversable t, java.lang.Class<T> type) Returns a list of expressions having the specified type in the given traversable object.
static Statement	getFirstNonDeclarationStatement(Traversable t) Returns the first non-DeclarationStatement of the given traverable object.
static java.util.List<FunctionCall>	getFunctionCalls(Traversable t) Returns a list of FunctionCall expressions within the traversable object.
static Declaration	getLastDeclaration(Traversable t) Returns the last declaration that belongs to the given traverable object.
static DeclarationStatement	getLastDeclarationStatement(Traversable t) Returns the last declaration statement that belongs to the given traverable object.
static java.util.List<Statement>	getLastStatements(Procedure proc) Returns a list of the last Statements to be evaluated in the Procedure.
static Procedure	getParentProcedure(Traversable t) Returns the Procedure to which the input traversable object belongs.
static TranslationUnit	getParentTranslationUnit(Traversable t) Returns the TranslationUnit to which the input traversable object belongs.
static java.util.List<Procedure>	getProcedureList(Program program) Return a list of Procedures in a program.
static <T extends Statement> java.util.List<T>	getStatementsOfType(Traversable t, java.lang.Class<T> type) Returns a list of statements having the specified type in the given traversable object.
static java.util.List<UnaryExpression>	getUnaryExpression(Traversable t, UnaryOperator op) Returns a list of unary expressions with the given unary operator.
static boolean	isAncestorOf(Traversable anc, Traversable des) Checks if the specified traversable object anc is an ancestor of the other traversable object des in the IR tree.
static boolean	isDescendantOf(Traversable des, Traversable anc) Checks if the specified traversable object des is a descendant of the other traversable object anc in the IR tree.
static void	removeAnnotations(Traversable t, java.lang.Class<? extends Annotation> type) Removes all annotations with the specified type from the given traversable object.
static void	replaceAll(Traversable t, Expression x, Expression y) Replaces all instances of expression x on the IR tree beneath t by clones of expression y.
static Expression	replaceSymbol(Expression e, Symbol var, Expression expr) Replaces all occurrences of the specified variable var with the given expression expr in the input expression e.
static void	replaceSymbolIn(Traversable t, Symbol var, Expression e) Replaces all occurrences of the specified variable var with the given expression e in the traversable object t in place.

Methods inherited from class java.lang.Object

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

Method Detail

containsExpression

public static boolean containsExpression(Traversable t,
                         Expression e)

Searches the IR tree beginning at t for the Expression e.

Parameters:

t - the traversable object to be searched.

e - the expression to be searched for.

Returns:

true if t contains e and false otherwise.

containsExpressions

public static boolean containsExpressions(Traversable t,
                          java.util.Collection<? extends Expression> es)

Searches the IR tree beginning at t for any expressions in the given collection of expressions.

Parameters:

t - the traversable object to be searched.

es - the collection of expressions to be searched for.

Returns:

true if t contains an expression in the collection es.

countExpressions

public static int countExpressions(Traversable t,
                   Expression e)

Counts the number of times that the Expression e appears in the IR tree t.

Parameters:

t - the traversable object to be searched.

e - the expression to be counted.

Returns:

the number of times e appears in t.

findExpression

public static Expression findExpression(Traversable t,
                        Expression e)

Finds the first instance of the Expression e in the IR tree t.

Parameters:

t - the traversable object to be searched.

e - the expression to be searched for.

Returns:

an expression from t that is equal to e.

findExpressions

public static java.util.List<Expression> findExpressions(Traversable t,
                                         Expression e)

Finds the list of instances of the Expression e in the IR tree t.

Parameters:

t - the traversable object to be searched.

e - the expression to be searched for.

Returns:

the list of matching expressions.

checkConsistency

public static boolean checkConsistency(Traversable t)

Checks the consistency of the IR subtree rooted at t. It checks if every children of a parent node has a correct back link to the parent node.

Parameters:

t - the traversable object to be checked.

Returns:

true if it is consistent, false otherwise.

replaceAll

public static void replaceAll(Traversable t,
              Expression x,
              Expression y)

Replaces all instances of expression x on the IR tree beneath t by clones of expression y. Skips the immediate right hand side of member access expressions.

Parameters:

t - The location at which to start the search.

x - The expression to be replaced.

y - The expression to substitute.

getParentProcedure

public static Procedure getParentProcedure(Traversable t)

Returns the Procedure to which the input traversable object belongs.

Parameters:

t - the traversable object to be searched from.

Returns:

the procedure that contains t.

getParentTranslationUnit

public static TranslationUnit getParentTranslationUnit(Traversable t)

Returns the TranslationUnit to which the input traversable object belongs.

Parameters:

t - the traversable object to be searched from.

Returns:

the translation unit that contains t.

getLastDeclaration

public static Declaration getLastDeclaration(Traversable t)

Returns the last declaration that belongs to the given traverable object.

Parameters:

t - the traversable object to be searched.

Returns:

the last declaration or null if not found.

getLastDeclarationStatement

public static DeclarationStatement getLastDeclarationStatement(Traversable t)

Returns the last declaration statement that belongs to the given traverable object.

Parameters:

t - the traversable object to be searched.

Returns:

the last declaration statement or null if not found.

getFirstNonDeclarationStatement

public static Statement getFirstNonDeclarationStatement(Traversable t)

Returns the first non-DeclarationStatement of the given traverable object.

Parameters:

t - the traversable object to be searched.

Returns:

the first non-declaration statement or null if not found.

replaceSymbol

public static Expression replaceSymbol(Expression e,
                       Symbol var,
                       Expression expr)

Replaces all occurrences of the specified variable var with the given expression expr in the input expression e. If the traversable object is the specified variable it returns a copy of the expression expr.

Parameters:

e - the input expression.

var - the variable to be replaced.

expr - the expression to be substituted.

Returns:

the cloned and modified expression.

replaceSymbolIn

public static void replaceSymbolIn(Traversable t,
                   Symbol var,
                   Expression e)

Replaces all occurrences of the specified variable var with the given expression e in the traversable object t in place.

Parameters:

t - the traversable object to be modified.

var - the variable to be replaced.

e - the expression to be substituted.

containsSymbol

public static boolean containsSymbol(Traversable t,
                     Symbol var)

Checks if the specified traversable object contains any identifier derived from the given symbol var. This method only searches for the derived identifier not the symbol itself.

Parameters:

t - the traversable object to be searched.

var - the symbol to be searched for.

Returns:

true if there is any identifier derived from var, false otherwise.

containsSymbols

public static boolean containsSymbols(Traversable t,
                      java.util.Set<Symbol> vars)

Checks if the specified traversable object contains any identifier derived from the given set of symbols vars. This method only searches for the derived identifier not the symbol itself.

Parameters:

t - the traversable object to be searched.

vars - the set of symbols to be searched for.

Returns:

true if there is any identifier derived from any symbol in vars, false otherwise.

containsSymbols

public static boolean containsSymbols(java.util.Set<Symbol> vars,
                      java.util.Set<Symbol> symbols)

Simple check method for existence of intersection between the two given sets of symbols.

Parameters:

vars - the first set of symbols.

symbols - the second set of symbols.

Returns:

true if the intersection is not empty, false otherwise.

containsClass

public static boolean containsClass(Traversable t,
                    java.lang.Class<? extends Traversable> type)

Checks if the traversable object contains the specified type of object.

Parameters:

t - the traversable object to be searched.

type - the class to be searched for.

Returns:

true if t contains the type type.

containsClasses

public static boolean containsClasses(Traversable t,
                      java.util.Set<java.lang.Class<? extends Traversable>> types)

Checks if the traversable object contains the specified types of object.

Parameters:

t - the traversable object to be searched.

types - the classes to be searched for.

Returns:

true if t contains any of the set types.

containsBinary

public static boolean containsBinary(Traversable t,
                     BinaryOperator op)

Checks if the traversable object contains the specified type of binary operations.

Parameters:

t - The traversable object being searched

op - The binary operator being searched for

Returns:

True if there is such an operation, False otherwise

containsUnary

public static boolean containsUnary(Traversable t,
                    UnaryOperator op)

Checks if the traversable object contains the specified type of unary operations.

Parameters:

t - The traversable object being searched

op - The unary operator being searched for

Returns:

True if there is such an operation, False otherwise

getUnaryExpression

public static java.util.List<UnaryExpression> getUnaryExpression(Traversable t,
                                                 UnaryOperator op)

Returns a list of unary expressions with the given unary operator.

Parameters:

t - the traversable object being searched.

op - the unary operator being searched for.

Returns:

the list of unary expressions.

containsSideEffect

public static boolean containsSideEffect(Traversable t)

Returns true if the traversable contains any side effects that change the program state.

Parameters:

t - The traversable object being searched

Returns:

true if there is such a case, false otherwise.

getAncestorOfType

public static <T extends Traversable> T getAncestorOfType(Traversable t,
                                          java.lang.Class<T> type)

Returns the nearest ancestor object of the given traversable object that has the specified type.

Parameters:

t - the traversable object to be searched from.

type - the IR type being searched for.

Returns:

the youngest ancestor of t having the type type.

getDescendentsOfType

public static <T extends Traversable> java.util.List<T> getDescendentsOfType(Traversable t,
                                                             java.lang.Class<T> type)

Returns a list of descendents of the traversable object t with the specified type type.

Parameters:

t - the traversable object to be searched.

type - the IR type to be searched for.

Returns:

the list of descendents having the type type.

isAncestorOf

public static boolean isAncestorOf(Traversable anc,
                   Traversable des)

Checks if the specified traversable object anc is an ancestor of the other traversable object des in the IR tree.

Parameters:

anc - a possible ancestor of des.

des - a possible descendant of anc.

Returns:

true if anc is an ancestor of des, false if not.

isDescendantOf

public static boolean isDescendantOf(Traversable des,
                     Traversable anc)

Checks if the specified traversable object des is a descendant of the other traversable object anc in the IR tree.

Parameters:

des - a possible descendant of anc.

anc - a possible ancestor of des.

Returns:

true if des is a descendant of anc, false if not.

containsFunctionCall

public static boolean containsFunctionCall(Traversable t)

Returns true if there is a FunctionCall within the traversable.

Parameters:

t - traversable object to be searched.

Returns:

true if t contains a function call.

getFunctionCalls

public static java.util.List<FunctionCall> getFunctionCalls(Traversable t)

Returns a list of FunctionCall expressions within the traversable object.

Parameters:

t - the traversable object to be searched.

Returns:

the list of function calls that appear in t.

collectPragmas

public static <T extends PragmaAnnotation> java.util.List<T> collectPragmas(Traversable t,
                                                            java.lang.Class<T> pragma_cls,
                                                            java.lang.String key)

Returns a list of pragma annotations that contain the specified string keys and are attached to annotatable objects within the traversable object t. For example, it can collect list of OpenMP pragmas having a work-sharing directive for within a specific procedure.

Parameters:

t - the traversable object to be searched.

pragma_cls - the type of pragmas to be searched for.

key - the keyword to be searched for.

Returns:

the list of matching pragma annotations.

getLastStatements

public static java.util.List<Statement> getLastStatements(Procedure proc)

Returns a list of the last Statements to be evaluated in the Procedure. This method actually searches for return statements or the last statement in traversal order if there is no return statement.

getStatementsOfType

public static <T extends Statement> java.util.List<T> getStatementsOfType(Traversable t,
                                                          java.lang.Class<T> type)

Returns a list of statements having the specified type in the given traversable object.

Parameters:

t - the traversable object to be examined.

type - the type of statements to be collected.

Returns:

the list of statements that are instances of type.

getExpressionsOfType

public static <T extends Expression> java.util.List<T> getExpressionsOfType(Traversable t,
                                                            java.lang.Class<T> type)

Returns a list of expressions having the specified type in the given traversable object.

Parameters:

t - the traversable object to be examined.

type - the type of expressions to be collected.

Returns:

the list of expressions that are instances of type.

getProcedureList

public static java.util.List<Procedure> getProcedureList(Program program)

Return a list of Procedures in a program.

removeAnnotations

public static void removeAnnotations(Traversable t,
                     java.lang.Class<? extends Annotation> type)

Removes all annotations with the specified type from the given traversable object.

Parameters:

t - the traversable object to be searched.

type - the annotation types to be removed.