cetus.hir

Class Procedure

java.lang.Object

cetus.hir.Declaration

cetus.hir.Procedure

All Implemented Interfaces:

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

public final class Procedure
extends Declaration
implements SymbolTable, Symbol

Represents a function, subroutine, or method. A procedure object consists of specifiers, a procedure declarator, initializers, and a body, the body being the only traversable child.

Constructor Summary

Constructors

Constructor and Description
Procedure(Declarator declarator, CompoundStatement body) Creates a constructor definition (declaration plus body).
Procedure(java.util.List leading_specs, Declarator declarator, CompoundStatement body) Creates a procedure definition (declaration plus body).
Procedure(java.util.List leading_specs, Declarator declarator, CompoundStatement body, boolean is_old_style_function) Constructor that can preserve the old style of the declaration
Procedure(Specifier spec, Declarator declarator, CompoundStatement body) Creates a procedure definition (declaration plus body).

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeclaration(Declaration decl) Adds a parameter declaration to the procedure.
void	addDeclarationAfter(Declaration ref, Declaration decl) Adds a new parameter declaration after the reference declaration.
void	addDeclarationBefore(Declaration ref, Declaration decl) Adds a new parameter declaration before the reference declaration.
Procedure	clone() Returns a clone of the procedure.
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(Procedure p, java.io.PrintWriter o) Prints a procedure to a stream.
Declaration	findSymbol(IDExpression name) Retrieves the declaration for a symbol, possibly searching through parent symbol tables.
java.util.List	getArraySpecifiers() Not used in a procedure; it just returns null
CompoundStatement	getBody() Returns the body compound statement of this procedure.
Declaration	getDeclaration() Returns the parent declaration containing the symbol object.
java.util.Set<Declaration>	getDeclarations() Returns the set of declarations declared within the symbol table object.
Declarator	getDeclarator() Returns the procedure declarator of the procedure.
java.util.List<IDExpression>	getDeclaredIDs() Returns the list of declared name IDs in the procedure.
IDExpression	getName() Returns the name ID of the procedure.
int	getNumParameters() Returns the number of parameters of the procedure.
Declaration	getParameter(int index) returns the parameter at specified index
java.util.List	getParameters() Returs the list of procedure parameters.
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.List	getReturnType() Returns the list of type specifiers of the procedure.
java.lang.String	getSymbolName() Returns the name of the symbol.
java.util.Set<Symbol>	getSymbols() Returns the set of declared symbols in the symbol table object.
java.util.List	getTypeSpecifiers() Returns a list of type specifiers.
void	setBody(CompoundStatement body) Assigns a new procedure body for the procedure.
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	setConstructorInitializers(java.util.List list) Sets the list of initializers - not used in a C program.
void	setName(IDExpression name) Modifies the name of the procedure.
void	setName(java.lang.String name) Modify the name of the symbol.

Methods inherited from class cetus.hir.Declaration

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

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

Procedure

public Procedure(Declarator declarator,
         CompoundStatement body)

Creates a constructor definition (declaration plus body).

Parameters:

declarator - The name and parameter list of the procedure. Must not be null.

body - The body of the procedure.

Throws:

NotAnOrphanException - If body has a parent object.

Procedure

public Procedure(java.util.List leading_specs,
         Declarator declarator,
         CompoundStatement body)

Creates a procedure definition (declaration plus body).

Parameters:

leading_specs - A list of specifiers describing the return type of the procedure. May be null.

declarator - The name and parameter list of the procedure. Must not be null.

body - The body of the procedure.

Throws:

NotAnOrphanException - If body has a parent object.

Procedure

public Procedure(java.util.List leading_specs,
         Declarator declarator,
         CompoundStatement body,
         boolean is_old_style_function)

Constructor that can preserve the old style of the declaration

Procedure

public Procedure(Specifier spec,
         Declarator declarator,
         CompoundStatement body)

Creates a procedure definition (declaration plus body).

Parameters:

spec - A specifier describing the return type of the procedure.

declarator - The name and parameter list of the procedure. Must not be null.

body - The body of the procedure.

Throws:

NotAnOrphanException - If body has a parent object.

Method Detail

addDeclaration

public void addDeclaration(Declaration decl)

Adds a parameter declaration to the procedure.

Specified by:

addDeclaration in interface SymbolTable

Parameters:

decl - the new parameter declaration to be added.

addDeclarationBefore

public void addDeclarationBefore(Declaration ref,
                        Declaration decl)

Adds a new parameter declaration before the reference declaration.

Specified by:

addDeclarationBefore in interface SymbolTable

Parameters:

ref - the reference parameter declaration.

decl - the new parameter declaration to be added.

addDeclarationAfter

public void addDeclarationAfter(Declaration ref,
                       Declaration decl)

Adds a new parameter declaration after the reference declaration.

Specified by:

addDeclarationAfter in interface SymbolTable

Parameters:

ref - the reference parameter declaration.

decl - the new parameter declaration to be added.

getDeclarator

public Declarator getDeclarator()

Returns the procedure declarator of the procedure.

Returns:

the procedure declarator.

defaultPrint

public static void defaultPrint(Procedure p,
                java.io.PrintWriter o)

Prints a procedure to a stream.

Parameters:

p - The procedure to print.

o - The writer on which to print the procedure.

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 CompoundStatement getBody()

Returns the body compound statement of this procedure.

Returns:

the body of this procedure.

getDeclaredIDs

public java.util.List<IDExpression> getDeclaredIDs()

Returns the list of declared name IDs in the procedure.

Specified by:

getDeclaredIDs in class Declaration

Returns:

the list of declared IDs.

getName

public IDExpression getName()

Returns the name ID of the procedure.

Returns:

the name ID of the procedure.

getNumParameters

public int getNumParameters()

Returns the number of parameters of the procedure.

getParameters

public java.util.List getParameters()

Returs the list of procedure parameters.

getParameter

public Declaration getParameter(int index)

returns the parameter at specified index

Parameters:

index - - zero-based index of the required parameter

Returns:

- parameter at specified index or null

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.

getReturnType

public java.util.List getReturnType()

Returns the list of type specifiers of the procedure.

setBody

public void setBody(CompoundStatement body)

Assigns a new procedure body for the procedure.

Parameters:

body - the new procedure body to be added.

Throws:

NotAnOrphanException - if body has a parent object.

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.

setConstructorInitializers

public void setConstructorInitializers(java.util.List list)

Sets the list of initializers - not used in a C program.

setName

public void setName(IDExpression name)

Modifies the name of the procedure.

setName

public void setName(java.lang.String name)

Description copied from interface: Symbol

Modify the name of the symbol. This method effectively renames all the identifiers constructed from the symbol object. Pass writers should be cautious when renaming global names since the effective scope of this operation is within a translation unit; extern variables and procedure names are not automatically handled.

Specified by:

setName in interface Symbol

Parameters:

name - the new name of the symbol.

getSymbolName

public java.lang.String getSymbolName()

Description copied from interface: Symbol

Returns the name of the symbol.

Specified by:

getSymbolName in interface Symbol

Returns:

the name of the symbol.

getTypeSpecifiers

public java.util.List getTypeSpecifiers()

Description copied from interface: Symbol

Returns a list of type specifiers.

Specified by:

getTypeSpecifiers in interface Symbol

Returns:

the list of type specifiers.

getArraySpecifiers

public java.util.List getArraySpecifiers()

Not used in a procedure; it just returns null

Specified by:

getArraySpecifiers in interface Symbol

Returns:

the list of array specifiers.

clone

public Procedure clone()

Returns a clone of the procedure.

Overrides:

clone in class Declaration

Returns:

a deep copy of this declaration.

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.

getDeclaration

public Declaration getDeclaration()

Description copied from interface: Symbol

Returns the parent declaration containing the symbol object. The return value is searched from the internal look-up table. Depending on the type of the symbol, this method may return the symbol object itself, or null if the symbol object does not exist in the IR.

Specified by:

getDeclaration in interface Symbol

Returns:

the parent declaration.

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.