edu.illinois.cs.cogcomp.lbjava.IR

Class SymbolTable

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.IR.SymbolTable

public class SymbolTable
extends Object

A symbol table is simply a HashMap associating names with their types. This class also assumes responsibility for determining type information for externally defined names.

The global symbol table also keeps track of package and import declarations so that when a name cannot be found otherwise, it is searched for in the imported packages.

Author:

Nick Rizzolo

Constructor Summary

Constructors

Constructor and Description
SymbolTable() Initializes the member variables.
SymbolTable(SymbolTable p) Initializes the member variables.

Method Summary

Modifier and Type	Method and Description
void	addChild(SymbolTable s) Adds a child to this table.
void	addImported(String name) Adds a name to the list of imported names in the top level table.
Class<?>	classForName(ClassifierName name) Attempts to locate the named class in the current package and any imported packages.
Class<?>	classForName(Name name) Attempts to locate the named class in the current package and any imported packages.
Class<?>	classForName(String name) Attempts to locate the named class in the current package and any imported packages.
boolean	containsKey(ClassifierName key) Determines whether the specified name has been used as a key in this table or any of its parents.
boolean	containsKey(Name key) Determines whether the specified name has been used as a key in this table or any of its parents.
boolean	containsKey(String key) Determines whether the specified name has been used as a key in this table or any of its parents.
protected static File	findFile(String name, String extension, String path) Given the name of a class, which may or may not be fully qualified, this method returns the absolute path to the file with the same name and the given extension.
void	generateHeader(PrintStream out) Generates package and import statements from the names in the member variable imported.
Type	get(ClassifierName name) Retrieves the type associated with the given name.
Type	get(Name name) Retrieves the type associated with the given name.
Type	get(String name) Retrieves the type associated with the given name.
String	getPackage() Gets the package name.
SymbolTable	getParent() Retrieves the parent of this table.
String[]	getSymbols() Returns the names of the symbols in this (local) table.
int	importedSize() Returns the size of the list of imported items.
boolean	localContainsKey(ClassifierName key) Determines whether the specified name has been used as a key in this table.
boolean	localContainsKey(Name key) Determines whether the specified name has been used as a key in this table.
boolean	localContainsKey(String key) Determines whether the specified name has been used as a key in this table.
void	print() Prints this table and all its children recursively to STDOUT.
void	print(String indent) Prints this table and all its children recursively to STDOUT.
Type	put(Argument a) Adds a new entry to the table.
Type	put(ClassifierName name, Type type) Adds a new entry to the table.
Type	put(Name name, Type type) Adds a new entry to the table.
Type	put(String name, Type type) Adds a new entry to the table.
void	setPackage(String name) Sets the package name in the top level table.

Methods inherited from class java.lang.Object

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

Constructor Detail

SymbolTable

public SymbolTable()

Initializes the member variables.

SymbolTable

public SymbolTable(SymbolTable p)

Initializes the member variables.

Parameters:

p - The parent of this table.

Method Detail

findFile

protected static File findFile(String name,
                               String extension,
                               String path)

Given the name of a class, which may or may not be fully qualified, this method returns the absolute path to the file with the same name and the given extension. This method was written for use by the LBJava compiler and its generated code. The user should not need to call it.

Parameters:

name - The name of the class.

extension - The extension of the file to search for.

path - Paths in which to search for name.extension.

Returns:

An object representing the file or null if it can't be located.

getParent

public SymbolTable getParent()

Retrieves the parent of this table.

addChild

public void addChild(SymbolTable s)

Adds a child to this table.

Parameters:

s - The child to add.

put

public Type put(Argument a)

Adds a new entry to the table.

Parameters:

a - An argument containing the name its associated type.

Returns:

The type previously associated with the given name or null if no type was previously associated with it.

put

public Type put(ClassifierName name,
                Type type)

Adds a new entry to the table.

Parameters:

name - The name to add to the table.

type - The type to associate with the given name.

Returns:

The type previously associated with the given name or null if no type was previously associated with it.

put

public Type put(Name name,
                Type type)

Adds a new entry to the table.

Parameters:

name - The name to add to the table.

type - The type to associate with the given name.

Returns:

The type previously associated with the given name or null if no type was previously associated with it.

put

public Type put(String name,
                Type type)

Adds a new entry to the table.

Parameters:

name - The name to add to the table.

type - The type to associate with the given name.

Returns:

The type previously associated with the given name or null if no type was previously associated with it.

get

public Type get(ClassifierName name)

Retrieves the type associated with the given name. If this table does not contain the name, imported packages are searched.

Parameters:

name - The name to retrieve type information for.

Returns:

The type associated with the given name or null if no type information could be found.

get

public Type get(Name name)

Retrieves the type associated with the given name. If this table does not contain the name, imported packages are searched.

Parameters:

name - The name to retrieve type information for.

Returns:

The type associated with the given name or null if no type information could be found.

get

public Type get(String name)

Retrieves the type associated with the given name. If this table does not contain the name, imported packages are searched.

Parameters:

name - The name to retrieve type information for.

Returns:

The type associated with the given name or null if no type information could be found.

classForName

public Class<?> classForName(ClassifierName name)

Attempts to locate the named class in the current package and any imported packages. If the corresponding Java source file is found and either the class file does not exist or its time of last modification is earlier than the java file's, it is recompiled. If no class with the specified name is found, null is returned.

Parameters:

name - The name of the class to search for.

Returns:

The Class object representing that class.

classForName

public Class<?> classForName(String name)

Attempts to locate the named class in the current package and any imported packages. If the corresponding Java source file is found and either the class file does not exist or its time of last modification is earlier than the java file's, it is recompiled. If no class with the specified name is found, null is returned.

Parameters:

name - The name of the class to search for.

Returns:

The Class object representing that class.

classForName

public Class<?> classForName(Name name)

Attempts to locate the named class in the current package and any imported packages. If the corresponding Java source file is found and either the class file does not exist or its time of last modification is earlier than the java file's, it is recompiled. If no class with the specified name is found, null is returned.

Parameters:

name - The name of the class to search for.

Returns:

The Class object representing that class.

containsKey

public boolean containsKey(ClassifierName key)

Determines whether the specified name has been used as a key in this table or any of its parents.

Parameters:

key - The name.

Returns:

true iff key is already a key in this table or any of its parents.

containsKey

public boolean containsKey(Name key)

Determines whether the specified name has been used as a key in this table or any of its parents.

Parameters:

key - The name.

Returns:

true iff key is already a key in this table or any of its parents.

containsKey

public boolean containsKey(String key)

Determines whether the specified name has been used as a key in this table or any of its parents.

Parameters:

key - The name.

Returns:

true iff key is already a key in this table or any of its parents.

localContainsKey

public boolean localContainsKey(ClassifierName key)

Determines whether the specified name has been used as a key in this table.

Parameters:

key - The name.

Returns:

true iff key is already a key in this table.

localContainsKey

public boolean localContainsKey(Name key)

Determines whether the specified name has been used as a key in this table.

Parameters:

key - The name.

Returns:

true iff key is already a key in this table.

localContainsKey

public boolean localContainsKey(String key)

Determines whether the specified name has been used as a key in this table.

Parameters:

key - The name.

Returns:

true iff key is already a key in this table.

addImported

public void addImported(String name)

Adds a name to the list of imported names in the top level table.

Parameters:

name - The name of a new imported package.

importedSize

public int importedSize()

Returns the size of the list of imported items.

Returns:

The size of the list of imported items.

setPackage

public void setPackage(String name)

Sets the package name in the top level table.

Parameters:

name - The package name.

getPackage

public String getPackage()

Gets the package name.

Returns:

The package name.

generateHeader

public void generateHeader(PrintStream out)

Generates package and import statements from the names in the member variable imported.

Parameters:

out - The stream to write to.

getSymbols

public String[] getSymbols()

Returns the names of the symbols in this (local) table.

print

public void print()

Prints this table and all its children recursively to STDOUT.

print

public void print(String indent)

Prints this table and all its children recursively to STDOUT.

Parameters:

indent - The level of indentation.