cetus.hir

Class ForLoop

java.lang.Object

cetus.hir.Statement

cetus.hir.ForLoop

All Implemented Interfaces:

Annotatable, Loop, Printable, SymbolTable, Traversable, java.lang.Cloneable

public class ForLoop
extends Statement
implements Loop, SymbolTable

ForLoop represents a C-style for loop, typically having an initial statement, a condition expression, and a step expression.

Constructor Summary

Constructors

Constructor and Description
ForLoop(Statement init, Expression condition, Expression step, Statement body) Constructs a new for loop with the given initial expression init, the condition expression condition, the step expression step, and the body statement body.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeclaration(Declaration decl) Add a declaration to the end of the set of declarations and place the declared symbols in the symbol table.
void	addDeclarationAfter(Declaration ref, Declaration decl) Add a declaration after the reference declaration.
void	addDeclarationBefore(Declaration ref, Declaration decl) Add a declaration before the reference declaration.
ForLoop	clone() Returns a clone of this for loop.
boolean	containsDeclaration(Declaration decl) Checks if the symbol table contains the specified declaration.
boolean	containsSymbol(Symbol symbol) Checks if the symbol table contains the specified symbol.
static void	defaultPrint(ForLoop l, java.io.PrintWriter o) Prints the for loop to the given print writer.
Declaration	findSymbol(IDExpression name) Retrieves the declaration for a symbol, possibly searching through parent symbol tables.
Statement	getBody() Returns the statement that is the body of the loop.
Expression	getCondition() Returns the expression that determines the duration of the loop.
java.util.Set<Declaration>	getDeclarations() Returns the set of declarations declared within the symbol table object.
Statement	getInitialStatement() Returns the initial statement of the for loop allowing null.
java.util.List<SymbolTable>	getParentTables() Returns a list of symbol tables that are parents of this table in the distributed symbol table graph.
Expression	getStep() Returns the step expression of the for loop allowing null.
java.util.Set<Symbol>	getSymbols() Returns the set of declared symbols in the symbol table object.
void	setBody(Statement body) Sets the body statement of the loop with the given statement body.
static void	setClassPrintMethod(java.lang.reflect.Method m) Overrides the class print method, so that all subsequently created objects will use the supplied method.
void	setCondition(Expression cond) Sets the condition expression with the given expression cond.
void	setInitialStatement(Statement stmt) Sets the initial statement with the given statement stmt.
void	setStep(Expression step) Sets the step expression with the given expression step.

Methods inherited from class cetus.hir.Statement

annotate, annotateAfter, annotateBefore, containsAnnotation, detach, equals, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getChildren, getParent, getProcedure, hashCode, print, removeAnnotations, removeAnnotations, removeChild, setChild, setLineNumber, setParent, setPrintMethod, swapWith, toString, verify, where

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cetus.hir.Traversable

getChildren, getParent, removeChild, setChild, setParent

Methods inherited from interface cetus.hir.Printable

print

Constructor Detail

ForLoop

public ForLoop(Statement init,
       Expression condition,
       Expression step,
       Statement body)

Constructs a new for loop with the given initial expression init, the condition expression condition, the step expression step, and the body statement body. Any non-compound body statement is internally normalized to a compound statement.

Parameters:

init - the initial statement.

condition - the condition expression.

step - the step expression.

body - the body statement.

Throws:

NotAnOrphanException - if init, condition, step, or body has a parent.

Method Detail

addDeclaration

public void addDeclaration(Declaration decl)

Description copied from interface: SymbolTable

Add a declaration to the end of the set of declarations and place the declared symbols in the symbol table.

Specified by:

addDeclaration in interface SymbolTable

Parameters:

decl - The declaration to add.

addDeclarationBefore

public void addDeclarationBefore(Declaration ref,
                        Declaration decl)

Description copied from interface: SymbolTable

Add a declaration before the reference declaration.

Specified by:

addDeclarationBefore in interface SymbolTable

Parameters:

ref - The reference point.

decl - The declaration to add.

addDeclarationAfter

public void addDeclarationAfter(Declaration ref,
                       Declaration decl)

Description copied from interface: SymbolTable

Add a declaration after the reference declaration.

Specified by:

addDeclarationAfter in interface SymbolTable

Parameters:

ref - The reference point.

decl - The declaration to add.

defaultPrint

public static void defaultPrint(ForLoop l,
                java.io.PrintWriter o)

Prints the for loop to the given print writer.

Parameters:

l - The loop to print.

o - The writer on which to print the loop.

findSymbol

public Declaration findSymbol(IDExpression name)

Description copied from interface: SymbolTable

Retrieves the declaration for a symbol, possibly searching through parent symbol tables.

Specified by:

findSymbol in interface SymbolTable

Parameters:

name - The name of the symbol.

getBody

public Statement getBody()

Description copied from interface: Loop

Returns the statement that is the body of the loop.

Specified by:

getBody in interface Loop

Returns:

the body of the loop.

getCondition

public Expression getCondition()

Description copied from interface: Loop

Returns the expression that determines the duration of the loop.

Specified by:

getCondition in interface Loop

Returns:

the condition that is tested each iteration.

getInitialStatement

public Statement getInitialStatement()

Returns the initial statement of the for loop allowing null.

Returns:

the initial statement.

getParentTables

public java.util.List<SymbolTable> getParentTables()

Description copied from interface: SymbolTable

Returns a list of symbol tables that are parents of this table in the distributed symbol table graph. A list is necessary because representing multiple inheritence in C++ requires it. Note that the parent tables are not necessarily tables of the immediate parent. The list is all symbol tables enclosing this object which appear at the same level such that no other symbol tables appear between this object and those tables.

Specified by:

getParentTables in interface SymbolTable

Returns:

a List of SymbolTables.

getStep

public Expression getStep()

Returns the step expression of the for loop allowing null.

Returns:

the step expression.

setBody

public void setBody(Statement body)

Sets the body statement of the loop with the given statement body. Any non-compound body statement is normalized to a compound statement.

Parameters:

body - the new body statement.

Throws:

NotAnOrphanException - if body has a parent.

setClassPrintMethod

public static void setClassPrintMethod(java.lang.reflect.Method m)

Overrides the class print method, so that all subsequently created objects will use the supplied method.

Parameters:

m - The new print method.

setCondition

public void setCondition(Expression cond)

Sets the condition expression with the given expression cond.

Parameters:

cond - the new condition expression (null is allowed).

Throws:

NotAnOrphanException - if cond has a parent object.

setInitialStatement

public void setInitialStatement(Statement stmt)

Sets the initial statement with the given statement stmt.

Parameters:

stmt - the new initial statement (null is allowed).

Throws:

NotAnOrphanException - if stmt has a parent object.

setStep

public void setStep(Expression step)

Sets the step expression with the given expression step.

Parameters:

step - the new step expression (null is allowed).

Throws:

NotAnOrphanException - if step has a parent object.

clone

public ForLoop clone()

Returns a clone of this for loop.

Overrides:

clone in class Statement

Returns:

the cloned for loop.

getSymbols

public java.util.Set<Symbol> getSymbols()

Description copied from interface: SymbolTable

Returns the set of declared symbols in the symbol table object.

Specified by:

getSymbols in interface SymbolTable

Returns:

the set of declared symbols.

getDeclarations

public java.util.Set<Declaration> getDeclarations()

Description copied from interface: SymbolTable

Returns the set of declarations declared within the symbol table object.

Specified by:

getDeclarations in interface SymbolTable

Returns:

the set of declarations within the symbol table object.

containsSymbol

public boolean containsSymbol(Symbol symbol)

Description copied from interface: SymbolTable

Checks if the symbol table contains the specified symbol.

Specified by:

containsSymbol in interface SymbolTable

Returns:

true if the symbol table contains symbol.

containsDeclaration

public boolean containsDeclaration(Declaration decl)

Description copied from interface: SymbolTable

Checks if the symbol table contains the specified declaration.

Specified by:

containsDeclaration in interface SymbolTable

Returns:

true if the symbol table contains decl.