TranslationUnit

java.lang.Object
- cetus.hir.TranslationUnit

All Implemented Interfaces:

Printable, SymbolTable, Traversable
```
public final class TranslationUnit
extends java.lang.Object
implements SymbolTable, Traversable
```
Represents a single source file of the program. A TranslationUnit is a collection of Declarations. The compilation of a Program may involve several TranslationUnits.

Constructor Summary

Constructors
Constructor and Description

TranslationUnit(java.lang.String input_filename)
Create an empty translation unit associated with a file.

Constructors
Constructor and Description
`TranslationUnit(java.lang.String input_filename)` Create an empty translation unit associated with a file.

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.
`void`	`addDeclarationFirst(Declaration decl)` Adds a new declaration decl at the head of the child list.
`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(TranslationUnit tu, java.io.PrintWriter o)`
`static void`	`defaultPrint2(TranslationUnit t, java.io.PrintWriter o)` Prints a translation unit to a stream without skipping the included headers.
`Declaration`	`findSymbol(IDExpression name)` Retrieves the declaration for a symbol, possibly searching through parent symbol tables.
`java.util.List<Traversable>`	`getChildren()` Provides access to the children of this object as a list.
`java.util.Set<Declaration>`	`getDeclarations()` Returns the set of declarations declared within the symbol table object.
`Declaration`	`getFirstDeclaration()` Returns the first declaration that comes right after header files.
`java.lang.String`	`getInputFilename()` Returns the original filename for the translation unit.
`java.lang.String`	`getOutputFilename()` Returns the new filename for the translation unit to be written to.
`Traversable`	`getParent()` Provides access to the parent of this 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`	`print(java.io.File outDir)` Prints this translation unit to the output file with which it is associated.
`void`	`print(java.io.PrintWriter o)` Prints this translation unit to the given print writer.
`void`	`removeChild(Traversable child)` Removes the specified child.
`void`	`setChild(int index, Traversable t)` Sets the `index`th child of this object to `t`.
`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`	`setOutputFilename(java.lang.String output_filename)` Sets the output filename for the translation unit.
`void`	`setParent(Traversable t)` Sets the parent program for this translation unit.
`void`	`setPrintMethod(java.lang.reflect.Method m)` Overrides the print method for this object only.
`java.lang.String`	`toString()` Returns a string representation of this translation unit.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TranslationUnit
```
public TranslationUnit(java.lang.String input_filename)
```
    Create an empty translation unit associated with a file.
    
    Parameters:
    input_filename - The file name for this TranslationUnit
- Method Detail
  - 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.
  - addDeclarationFirst
```
public void addDeclarationFirst(Declaration decl)
```
    Adds a new declaration decl at the head of the child list.
    
    Parameters:
    decl - the new declaration to be added.
    
    Throws:
    
    NotAnOrphanException - if decl has a parent object.
  - 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.
  - getFirstDeclaration
```
public Declaration getFirstDeclaration()
```
    Returns the first declaration that comes right after header files.
    
    Returns:
    First declaration that comes after header files.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this translation unit.
    
    Overrides:
    
    toString in class java.lang.Object
  - 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.
  - getChildren
```
public java.util.List<Traversable> getChildren()
```
    Description copied from interface: Traversable
    
    Provides access to the children of this object as a list. This object is free to internally implement its list as a LinkedList or an ArrayList. It is generally not good practice to call this method yourself; the ordering of children is not guaranteed so instead you should use the methods of the particular class whose children you wish to access.
    
    Specified by:
    
    getChildren in interface Traversable
    
    Returns:
    the children as a list.
  - getInputFilename
```
public java.lang.String getInputFilename()
```
    Returns the original filename for the translation unit.
    
    Returns:
    the original filename for the translation unit.
  - getOutputFilename
```
public java.lang.String getOutputFilename()
```
    Returns the new filename for the translation unit to be written to.
    
    Returns:
    the new filename.
  - getParent
```
public Traversable getParent()
```
    Description copied from interface: Traversable
    
    Provides access to the parent of this object. Every IR object has at most one parent. (The parent relationship is the same as the parent relationship in the parse tree, and is not to be confused with the base class of a derived class declaration.)
    
    Specified by:
    
    getParent in interface Traversable
    
    Returns:
    the parent of this object.
  - 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.
  - defaultPrint2
```
public static void defaultPrint2(TranslationUnit t,
                 java.io.PrintWriter o)
```
    Prints a translation unit to a stream without skipping the included headers.
    
    Parameters:
    t - The translation unit to print.
    o - The writer on which to print the translation unit.
  - defaultPrint
```
public static void defaultPrint(TranslationUnit tu,
                java.io.PrintWriter o)
```
  - print
```
public void print(java.io.File outDir)
           throws java.io.FileNotFoundException
```
    Prints this translation unit to the output file with which it is associated.
    
    Parameters:
    outDir - the target directory.
    
    Throws:
    
    java.io.FileNotFoundException - if an output file could not be opened.
  - print
```
public void print(java.io.PrintWriter o)
```
    Prints this translation unit to the given print writer.
    
    Specified by:
    
    print in interface Printable
    
    Parameters:
    o - the output print writer.
  - removeChild
```
public void removeChild(Traversable child)
```
    Description copied from interface: Traversable
    
    Removes the specified child.
    
    Specified by:
    
    removeChild in interface Traversable
    
    Parameters:
    child - a reference to a child object that must match with ==.
  - setChild
```
public void setChild(int index,
            Traversable t)
```
    Description copied from interface: Traversable
    
    Sets the indexth child of this object to t. By calling this method, the old child located at the position i will have a null parent. It is generally not good practice to call this method yourself; the ordering of children is not guaranteed so instead you should use the methods of the particular class whose children you wish to access. There are checks to prevent such actions as making a statement a child of an expression, but you still may be able to do some damage with this method if you are not careful.
    
    Specified by:
    
    setChild in interface Traversable
  - 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.
  - setOutputFilename
```
public void setOutputFilename(java.lang.String output_filename)
```
    Sets the output filename for the translation unit.
    
    Parameters:
    output_filename - The output filename for the translation unit.
  - setParent
```
public void setParent(Traversable t)
```
    Sets the parent program for this translation unit.
    
    Specified by:
    
    setParent in interface Traversable
    
    Parameters:
    t - The parent program.
  - setPrintMethod
```
public void setPrintMethod(java.lang.reflect.Method m)
```
    Overrides the print method for this object only.
    
    Parameters:
    m - The new print method.
  - 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.

Class TranslationUnit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TranslationUnit

Method Detail

addDeclaration

addDeclarationFirst

addDeclarationBefore

addDeclarationAfter

getFirstDeclaration

toString

findSymbol

getChildren

getInputFilename

getOutputFilename

getParent

getParentTables

defaultPrint2

defaultPrint

print

print

removeChild

setChild

setClassPrintMethod

setOutputFilename

setParent

setPrintMethod

getSymbols

getDeclarations

containsSymbol

containsDeclaration