cetus.hir

Interface SymbolTable

All Superinterfaces:

Printable, Traversable

All Known Implementing Classes:

ClassDeclaration, CompoundStatement, DoLoop, ExceptionHandler, ForLoop, LinkageSpecification, Namespace, Procedure, TranslationUnit, WhileLoop

public interface SymbolTable
extends Traversable

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.
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.
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.

Methods inherited from interface cetus.hir.Traversable

getChildren, getParent, removeChild, setChild, setParent

Methods inherited from interface cetus.hir.Printable

print

Method Detail

addDeclaration

void addDeclaration(Declaration decl)

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

Parameters:

decl - The declaration to add.

addDeclarationBefore

void addDeclarationBefore(Declaration ref,
                        Declaration decl)

Add a declaration before the reference declaration.

Parameters:

ref - The reference point.

decl - The declaration to add.

addDeclarationAfter

void addDeclarationAfter(Declaration ref,
                       Declaration decl)

Add a declaration after the reference declaration.

Parameters:

ref - The reference point.

decl - The declaration to add.

findSymbol

Declaration findSymbol(IDExpression name)

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

Parameters:

name - The name of the symbol.

getParentTables

java.util.List<SymbolTable> getParentTables()

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.

Returns:

a List of SymbolTables.

containsDeclaration

boolean containsDeclaration(Declaration decl)

Checks if the symbol table contains the specified declaration.

Returns:

true if the symbol table contains decl.

containsSymbol

boolean containsSymbol(Symbol symbol)

Checks if the symbol table contains the specified symbol.

Returns:

true if the symbol table contains symbol.

getSymbols

java.util.Set<Symbol> getSymbols()

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

Returns:

the set of declared symbols.

getDeclarations

java.util.Set<Declaration> getDeclarations()

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

Returns:

the set of declarations within the symbol table object.