cetus.hir

Class CompoundStatement

java.lang.Object

cetus.hir.Statement

cetus.hir.CompoundStatement

All Implemented Interfaces:

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

Direct Known Subclasses:

ExceptionHandler

public class CompoundStatement
extends Statement
implements SymbolTable

CompoundStatement represents a group of statements that are treated as a single statement.

Constructor Summary

Constructors

Constructor and Description
CompoundStatement() Creates an empty compound statement.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeclaration(Declaration decl) Adds a declaration after the last declaration; this models the C language's requirement that all declarations appear at the beginning of a block.
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.
void	addStatement(Statement stmt) Adds a statement to the end of this compound statement.
void	addStatementAfter(Statement ref_stmt, Statement new_stmt) Add a new statement after the reference statement.
void	addStatementBefore(Statement ref_stmt, Statement new_stmt) Add a new statement before the reference statement.
CompoundStatement	clone() Returns a clone of this compound statement.
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.
int	countStatements() Returns the total number of statements contained within this CompoundStatement.
static void	defaultPrint(CompoundStatement s, java.io.PrintWriter o) Prints a statement to the given print writer.
Declaration	findSymbol(IDExpression name) Retrieves the declaration for a symbol, possibly searching through parent symbol tables.
java.util.Set<Declaration>	getDeclarations() Returns the set of declarations declared within the symbol table object.
java.util.List<SymbolTable>	getParentTables() Returns a list of symbol tables that are parents of this table in the distributed symbol table graph.
java.util.Set<Symbol>	getSymbols() Returns the set of declared symbols in the symbol table object.
void	removeChild(Traversable child) Removes the specified child object if it exists.
void	removeStatement(Statement stmt) Remove the given statement if it exists.

Methods inherited from class cetus.hir.Statement

annotate, annotateAfter, annotateBefore, containsAnnotation, detach, equals, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getChildren, getParent, getProcedure, hashCode, print, removeAnnotations, removeAnnotations, 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, setChild, setParent

Methods inherited from interface cetus.hir.Printable

print

Constructor Detail

CompoundStatement

public CompoundStatement()

Creates an empty compound statement.

Method Detail

addDeclaration

public void addDeclaration(Declaration decl)

Adds a declaration after the last declaration; this models the C language's requirement that all declarations appear at the beginning of a block.

Specified by:

addDeclaration in interface SymbolTable

Parameters:

decl - The declaration to add.

Throws:

NotAnOrphanException - if decl has a parent.

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.

Throws:

java.lang.IllegalArgumentException - if ref is not found.

NotAnOrphanException - if decl has a parent.

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.

Throws:

java.lang.IllegalArgumentException - if ref is not found.

NotAnOrphanException - if decl has a parent.

addStatement

public void addStatement(Statement stmt)

Adds a statement to the end of this compound statement. For consistent management of symbol table interface, the input statement stmt must not be a declaration statement; the declaration should be added using the method addDeclaration(cetus.hir.Declaration).

Parameters:

stmt - The statement to add.

Throws:

java.lang.IllegalArgumentException - If stmt is null.

NotAnOrphanException - if stmt has a parent.

java.lang.UnsupportedOperationException - if stmt is a declaration statement.

addStatementBefore

public void addStatementBefore(Statement ref_stmt,
                      Statement new_stmt)

Add a new statement before the reference statement.

Parameters:

new_stmt - the statement to be added.

ref_stmt - the reference statement.

Throws:

java.lang.IllegalArgumentException - If ref_stmt is not found or new_stmt is null.

NotAnOrphanException - if new_stmt has a parent.

java.lang.UnsupportedOperationException - If new_stmt is a declaration statement.

addStatementAfter

public void addStatementAfter(Statement ref_stmt,
                     Statement new_stmt)

Add a new statement after the reference statement.

Parameters:

new_stmt - the statement to be added.

ref_stmt - the reference statement.

Throws:

java.lang.IllegalArgumentException - If ref_stmt is not found or new_stmt is null.

NotAnOrphanException - if new_stmt has a parent.

java.lang.UnsupportedOperationException - If stmt is a declaration statement.

removeStatement

public void removeStatement(Statement stmt)

Remove the given statement if it exists.

Parameters:

stmt - the statement to be removed.

clone

public CompoundStatement clone()

Returns a clone of this compound statement.

Overrides:

clone in class Statement

Returns:

the cloned compound statement.

countStatements

public int countStatements()

Returns the total number of statements contained within this CompoundStatement.

Returns:

the number of statements within this compound statement

defaultPrint

public static void defaultPrint(CompoundStatement s,
                java.io.PrintWriter o)

Prints a statement to the given print writer.

Parameters:

s - The statement to print.

o - The writer on which to print the statement.

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.

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.

removeChild

public void removeChild(Traversable child)

Removes the specified child object if it exists.

Specified by:

removeChild in interface Traversable

Overrides:

removeChild in class Statement

Parameters:

child - the child object to be removed.

Throws:

java.lang.IllegalArgumentException - if child is not found.

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.