cetus.hir

Class ClassDeclaration

java.lang.Object

cetus.hir.Declaration

cetus.hir.ClassDeclaration

All Implemented Interfaces:

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

public class ClassDeclaration
extends Declaration
implements SymbolTable

Represents a class, struct, or union. These are actually specifiers in C and C++, since variables can be declared immediately following the class declaration, but that's mostly syntactic sugar. We assume it can be split into a class declaration followed by a variable declaration. We have a single class representing all three (class, struct, union) because they are fundamentally the same except for default access levels and storage layout, which do not make a significant difference to source-to-source compilers. Anonymous structs should be given a unique name (most compilers do this internally anyway).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassDeclaration.Key Class for representing the four different types of class declarations, class, struct, union, and interface.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassDeclaration.Key	CLASS Keyword for class type declaration.
static ClassDeclaration.Key	INTERFACE Keyword for interface type declaration.
static ClassDeclaration.Key	STRUCT Keyword for struct type declaration.
static ClassDeclaration.Key	UNION Keyword for union type declaration.

Constructor Summary

Constructors

Constructor and Description
ClassDeclaration(ClassDeclaration.Key type, IDExpression name) Constructs an empty class declaration with the given type and name ID.
ClassDeclaration(ClassDeclaration.Key type, IDExpression name, boolean no_body) Constructs a class declaration with the given type, name ID, and the flag for forward declaration.
ClassDeclaration(java.util.List class_specs, ClassDeclaration.Key type, IDExpression name) Constructs a class declaration from the given list of specifiers, type keyword, and name ID.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBaseClass(IDExpression name) Adds the name of the base class - not used in C
void	addBaseClass(Specifier access, IDExpression name) Adds the name of the base class with the specifier - not used in C
void	addBaseInterface(IDExpression name) Adds the name of the interface - not used in C
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.
ClassDeclaration	clone() Returns a clone of this class 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.
static void	defaultPrint(ClassDeclaration d, java.io.PrintWriter o) Prints a class to a stream.
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<IDExpression>	getDeclaredIDs() Returns the IDs declared by this class declaration; the returned list contains one ID which gives the type and the name.
ClassDeclaration.Key	getKey() Returns the type keyword for the class declaration
IDExpression	getName() Returns the name ID of the class declaration
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.
boolean	matches(java.lang.Object otherObj)
static void	printCpp(ClassDeclaration d, java.io.PrintWriter o) Prints a C++ class to a stream.
static void	printJava(ClassDeclaration d, java.io.PrintWriter o) Prints a Java class to a stream.
void	removeChild(Traversable child) This operation is not allowed.
static void	setClassPrintMethod(java.lang.reflect.Method m) Overrides the class print method, so that all subsequently created objects will use the supplied method.

Methods inherited from class cetus.hir.Declaration

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

Methods inherited from interface cetus.hir.Printable

print

Field Detail

CLASS

public static final ClassDeclaration.Key CLASS

Keyword for class type declaration.

STRUCT

public static final ClassDeclaration.Key STRUCT

Keyword for struct type declaration.

UNION

public static final ClassDeclaration.Key UNION

Keyword for union type declaration.

INTERFACE

public static final ClassDeclaration.Key INTERFACE

Keyword for interface type declaration.

Constructor Detail

ClassDeclaration

public ClassDeclaration(java.util.List class_specs,
                ClassDeclaration.Key type,
                IDExpression name)

Constructs a class declaration from the given list of specifiers, type keyword, and name ID. This method is intended for JAVA classes.

ClassDeclaration

public ClassDeclaration(ClassDeclaration.Key type,
                IDExpression name)

Constructs an empty class declaration with the given type and name ID.

Parameters:

type - Must be one of CLASS, STRUCT, UNION, or INTERFACE.

name - The name ID for the class.

ClassDeclaration

public ClassDeclaration(ClassDeclaration.Key type,
                IDExpression name,
                boolean no_body)

Constructs a class declaration with the given type, name ID, and the flag for forward declaration.

Parameters:

type - Must be one of CLASS, STRUCT, UNION, or INTERFACE.

name - The name for the class.

no_body - True if this a forward declaration.

Method Detail

addBaseClass

public void addBaseClass(IDExpression name)

Adds the name of the base class - not used in C

addBaseClass

public void addBaseClass(Specifier access,
                IDExpression name)

Adds the name of the base class with the specifier - not used in C

addBaseInterface

public void addBaseInterface(IDExpression name)

Adds the name of the interface - not used in C

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(ClassDeclaration d,
                java.io.PrintWriter o)

Prints a class to a stream.

Parameters:

d - The class to print.

o - The writer on which to print the class.

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.

getDeclaredIDs

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

Returns the IDs declared by this class declaration; the returned list contains one ID which gives the type and the name. e.g., "struct foo".

Specified by:

getDeclaredIDs in class Declaration

Returns:

the list of the declared IDs.

getKey

public ClassDeclaration.Key getKey()

Returns the type keyword for the class declaration

getName

public IDExpression getName()

Returns the name ID of the class declaration

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.

printCpp

public static void printCpp(ClassDeclaration d,
            java.io.PrintWriter o)

Prints a C++ class to a stream.

Parameters:

d - The class to print.

o - The writer on which to print the class.

printJava

public static void printJava(ClassDeclaration d,
             java.io.PrintWriter o)

Prints a Java class to a stream.

Parameters:

d - The class to print.

o - The writer on which to print the class.

removeChild

public void removeChild(Traversable child)

Description copied from class: Declaration

This operation is not allowed.

Specified by:

removeChild in interface Traversable

Overrides:

removeChild in class Declaration

Parameters:

child - a reference to a child object that must match with ==.

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.

clone

public ClassDeclaration clone()

Returns a clone of this class declaration. The features for C++ are not supported (access specifications, ...).

Overrides:

clone in class Declaration

Returns:

the cloned class declaration.

matches

public boolean matches(java.lang.Object otherObj)

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.