Environment

java.lang.Object
- fmrisc.ProgramExplorer.Semantics.Environment

public final class Environment
extends java.lang.Object

An environment giving meaning to identifiers.

Constructor Summary

Constructors
Constructor and Description

Environment(PackageSymbol top, ErrorStream error)
Create a new environment at top-level.

Constructors
Constructor and Description
`Environment(PackageSymbol top, ErrorStream error)` Create a new environment at top-level.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enterBody()` Enter from constructor/method level the body level.
`boolean`	`enterClass(ClassSymbol csymbol)` Enter from package level the class level.
`boolean`	`enterClassVariable(ClassVariableSymbol csymbol)` Enter in class level another class variable.
`boolean`	`enterClassVariables()` Enter from class level the initialization of class variables.
`void`	`enterMethod(ParamSymbol msymbol)` Enter from class level the constructor/method level.
`void`	`enterObject()` Enter object ("non-static") context.
`boolean`	`enterObjectVariable(ObjectVariableSymbol osymbol)` Enter in class level another object variable.
`boolean`	`enterObjectVariables()` Enter from class level the initialization of object variables.
`void`	`enterPackage(PackageSymbol psymbol)` Enter from top-level the package level.
`void`	`enterScope()` Enter a new local scope from (at least) body level.
`void`	`exitBody()` Return from body level to constructor/method level.
`void`	`exitClass()` Return from class level to package level.
`boolean`	`exitClassVariables()` Return from entering class variables.
`void`	`exitMethod()` Return from method level to class level.
`void`	`exitObject()` Leave object ("non-static") context.
`boolean`	`exitObjectVariables()` Return from entering object variables.
`void`	`exitPackage()` Return from package level to top-level.
`void`	`exitScope()` Return from local scope to previous level.
`ClassSymbol`	`getClass(Name name)` Return symbol for class denoted by name in current environment.
`SymbolTable<ClassVariableSymbol>`	`getClassVariables()` Get currently visible class variables.
`ConstructorSymbol`	`getConstructor(CallStatement stat, TypeExpression[] atypes)` Return symbol for constructor denoted by name and argument types in current environment.
`ParamSymbol`	`getCurrentMethod()` Get symbol of current method.
`MethodSymbol`	`getMethod(CallStatement call, TypeExpression[] atypes)` Return symbol for a method called with arguments of denoted types in current environment and annotate call with symbol.
`SymbolTable<ObjectVariableSymbol>`	`getObjectVariables()` Get currently visible object variables.
`VariableSymbol`	`getVariable(Identifier ident)` Return symbol for variable denoted by identifier in current environment.
`VariableSymbol`	`getVariable(Name name)` Return symbol for variable denoted by name in current environment.
`VariableSymbol`	`getVariable(Name name, boolean verbose)` Return symbol for variable denoted by name in current environment.
`boolean`	`put(BodySymbol symbol)` Enter new body symbol into environment.
`boolean`	`put(ClassMethodDeclaration decl)` Enter new class method into environment.
`boolean`	`put(ClassSymbol symbol)` Enter new class symbol into environment.
`boolean`	`put(ClassVariableDeclaration decl)` Enter new class variable symbol into environment.
`boolean`	`put(ConstructorDeclaration decl)` Enter new constructor symbol into environment.
`boolean`	`put(ObjectMethodDeclaration decl)` Enter new object method symbol into environment.
`boolean`	`put(ObjectVariableDeclaration decl)` Enter new object variable symbol into environment.
`boolean`	`put(PackageSymbol symbol)` Enter new package symbol into environment.
`boolean`	`put(ParameterSymbol symbol)` Enter new parameter symbol into environment.
`boolean`	`put(VariableDeclaration decl)` Enter new local variable declaration into environment.

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

- Constructor Detail
  - Environment
```
public Environment(PackageSymbol top,
                   ErrorStream error)
```
    Create a new environment at top-level.
    
    Parameters:
    
    top - the package for holding "top-level" declarations.
    
    error - the stream for printing error messages.
- Method Detail
  - enterPackage
```
public void enterPackage(PackageSymbol psymbol)
```
    Enter from top-level the package level.
    
    Parameters:
    
    psymbol - the symbol of the package that is entered.
  - exitPackage
```
public void exitPackage()
```
    Return from package level to top-level.
  - enterClass
```
public boolean enterClass(ClassSymbol csymbol)
```
    Enter from package level the class level.
    
    Parameters:
    
    csymbol - the symbol of the class that is entered.
    
    Returns:
    
    true iff everything went well (message is printed otherwise).
  - enterObjectVariables
```
public boolean enterObjectVariables()
```
    Enter from class level the initialization of object variables.
    
    Returns:
    
    true iff everything went well (message is printed otherwise).
  - exitObjectVariables
```
public boolean exitObjectVariables()
```
    Return from entering object variables.
    
    Returns:
    
    always true.
  - enterObjectVariable
```
public boolean enterObjectVariable(ObjectVariableSymbol osymbol)
```
    Enter in class level another object variable.
    
    Parameters:
    
    osymbol - the symbol of the object variable that is entered.
    
    Returns:
    
    true iff everything went well (message is printed otherwise).
  - getObjectVariables
```
public SymbolTable<ObjectVariableSymbol> getObjectVariables()
```
    Get currently visible object variables.
    
    Returns:
    
    the set of object values (null if none).
  - enterClassVariables
```
public boolean enterClassVariables()
```
    Enter from class level the initialization of class variables.
    
    Returns:
    
    true iff everything went well (message is printed otherwise).
  - exitClassVariables
```
public boolean exitClassVariables()
```
    Return from entering class variables.
    
    Returns:
    
    always true.
  - enterClassVariable
```
public boolean enterClassVariable(ClassVariableSymbol csymbol)
```
    Enter in class level another class variable.
    
    Parameters:
    
    csymbol - the symbol of the class variable that is entered.
    
    Returns:
    
    true iff everything went well (message is printed otherwise).
  - getClassVariables
```
public SymbolTable<ClassVariableSymbol> getClassVariables()
```
    Get currently visible class variables.
    
    Returns:
    
    the set of class values (null if none).
  - exitClass
```
public void exitClass()
```
    Return from class level to package level.
  - enterObject
```
public void enterObject()
```
    Enter object ("non-static") context.
  - exitObject
```
public void exitObject()
```
    Leave object ("non-static") context.
  - enterMethod
```
public void enterMethod(ParamSymbol msymbol)
```
    Enter from class level the constructor/method level.
    
    Parameters:
    
    msymbol - the symbol of the method that is entered.
  - exitMethod
```
public void exitMethod()
```
    Return from method level to class level.
  - getCurrentMethod
```
public ParamSymbol getCurrentMethod()
```
    Get symbol of current method.
    
    Returns:
    
    symbol of current method (null, if we are not inside a method).
  - enterBody
```
public void enterBody()
```
    Enter from constructor/method level the body level.
  - exitBody
```
public void exitBody()
```
    Return from body level to constructor/method level.
  - enterScope
```
public void enterScope()
```
    Enter a new local scope from (at least) body level.
  - exitScope
```
public void exitScope()
```
    Return from local scope to previous level.
  - put
```
public boolean put(PackageSymbol symbol)
```
    Enter new package symbol into environment.
    
    Parameters:
    
    symbol - the package symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(ClassSymbol symbol)
```
    Enter new class symbol into environment.
    
    Parameters:
    
    symbol - the class symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(ConstructorDeclaration decl)
```
    Enter new constructor symbol into environment.
    
    Parameters:
    
    decl - the constructor declaration giving rise to the symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(ClassMethodDeclaration decl)
```
    Enter new class method into environment.
    
    Parameters:
    
    decl - the declaration of the class method.
    
    Returns:
    
    true iff symbol of the declaration could be successfully added.
  - put
```
public boolean put(ObjectMethodDeclaration decl)
```
    Enter new object method symbol into environment.
    
    Parameters:
    
    decl - the declaration givning rise to the symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(ClassVariableDeclaration decl)
```
    Enter new class variable symbol into environment.
    
    Parameters:
    
    decl - the declaration giving rise to the symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(ObjectVariableDeclaration decl)
```
    Enter new object variable symbol into environment.
    
    Parameters:
    
    decl - the declaration giving rise to the symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(ParameterSymbol symbol)
```
    Enter new parameter symbol into environment.
    
    Parameters:
    
    symbol - the parameter symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(VariableDeclaration decl)
```
    Enter new local variable declaration into environment.
    
    Parameters:
    
    decl - the declaration.
    
    Returns:
    
    true iff symbol could be successfully added.
  - put
```
public boolean put(BodySymbol symbol)
```
    Enter new body symbol into environment.
    
    Parameters:
    
    symbol - the symbol.
    
    Returns:
    
    true iff symbol could be successfully added.
  - getClass
```
public ClassSymbol getClass(Name name)
```
    Return symbol for class denoted by name in current environment.
    
    Parameters:
    
    name - a name which should denote a class.
    
    Returns:
    
    the symbol or null if the name could not be looked up. in the first case, the symbol is fully populated with declarations.
  - getConstructor
```
public ConstructorSymbol getConstructor(CallStatement stat,
                                        TypeExpression[] atypes)
```
    Return symbol for constructor denoted by name and argument types in current environment.
    
    Parameters:
    
    stat - the constructor call.
    
    atypes - the argument types of the constructor.
    
    Returns:
    
    the symbol or null if the name could not be looked up
  - getMethod
```
public MethodSymbol getMethod(CallStatement call,
                              TypeExpression[] atypes)
```
    Return symbol for a method called with arguments of denoted types in current environment and annotate call with symbol.
    
    Parameters:
    
    call - the method call.
    
    atypes - the argument types of the method.
    
    Returns:
    
    the symbol or null if the name could not be looked up
  - getVariable
```
public VariableSymbol getVariable(Identifier ident)
```
    Return symbol for variable denoted by identifier in current environment.
    
    Parameters:
    
    ident - a name which should denote a variable.
    
    Returns:
    
    the symbol or null if the name could not be looked up (no message is generated in this case).
  - getVariable
```
public VariableSymbol getVariable(Name name)
```
    Return symbol for variable denoted by name in current environment.
    
    Parameters:
    
    name - a name which should denote a variable.
    
    Returns:
    
    the symbol or null if the name could not be looked up (in this case, an error message is printed)
  - getVariable
```
public VariableSymbol getVariable(Name name,
                                  boolean verbose)
```
    Return symbol for variable denoted by name in current environment.
    
    Parameters:
    
    name - a name which should denote a variable.
    
    verbose - true iff error messages shall be printed if the lookup fails.
    
    Returns:
    
    the symbol or null if the name could not be looked up.

Class Environment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Environment

Method Detail

enterPackage

exitPackage

enterClass

enterObjectVariables

exitObjectVariables

enterObjectVariable

getObjectVariables

enterClassVariables

exitClassVariables

enterClassVariable

getClassVariables

exitClass

enterObject

exitObject

enterMethod

exitMethod

getCurrentMethod

enterBody

exitBody

enterScope

exitScope

put

put

put

put

put

put

put

put

put

put

getClass

getConstructor

getMethod

getVariable

getVariable

getVariable