org.antlr.symtab

Class SymbolWithScope

java.lang.Object

org.antlr.symtab.BaseScope

org.antlr.symtab.SymbolWithScope

All Implemented Interfaces:

Scope, Symbol

Direct Known Subclasses:

DataAggregateSymbol, FunctionSymbol

public abstract class SymbolWithScope
extends BaseScope
implements Symbol, Scope

An abstract base class that houses common functionality for symbols like classes and functions that are both symbols and scopes. There is some common cut and paste functionality with BaseSymbol because of a lack of multiple inheritance in Java but it is minimal.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	index
protected String	name

Fields inherited from class org.antlr.symtab.BaseScope

enclosingScope, nestedScopesNotSymbols, symbols

Constructor Summary

Constructors

Constructor and Description
SymbolWithScope(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Scope	getEnclosingScope() Scope in which this scope defined.
String	getFullyQualifiedName(String scopePathSeparator) Return the fully qualified name includes all scopes from the root down to this particular symbol.
int	getInsertionOrderNumber()
String	getName() Often scopes have names like function or class names.
int	getNumberOfSymbols() Number of symbols in this specific scope
Scope	getParentScope() Where to look next for symbols if just one parent; superclass or enclosing scope.
String	getQualifiedName() Return the name prefixed with the name of its enclosing scope using '.' (dot) as the scope separator.
String	getQualifiedName(String scopePathSeparator) Return the name prefixed with the name of its enclosing scope.
Scope	getScope()
int	hashCode()
void	setInsertionOrderNumber(int i)
void	setScope(Scope scope)

Methods inherited from class org.antlr.symtab.BaseScope

define, getAllNestedScopedSymbols, getAllSymbols, getEnclosingPathToRoot, getEnclosingScopeOfType, getMembers, getNestedScopedSymbols, getNestedScopes, getOuterMostEnclosingScope, getParentScopes, getSymbol, getSymbolNames, getSymbols, nest, resolve, setEnclosingScope, toQualifierString, toScopeStackString, toString, toTestString, toTestString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.antlr.symtab.Scope

define, getAllSymbols, getEnclosingPathToRoot, getNestedScopedSymbols, getNestedScopes, getParentScopes, getSymbol, getSymbolNames, getSymbols, nest, resolve, setEnclosingScope, toQualifierString

Field Detail

name

protected final String name

index

protected int index

Constructor Detail

SymbolWithScope

public SymbolWithScope(String name)

Method Detail

getName

public String getName()

Description copied from interface: Scope

Often scopes have names like function or class names. For unnamed scopes like code blocks, you can just return "local" or something.

Specified by:

getName in interface Scope

Specified by:

getName in interface Symbol

getScope

public Scope getScope()

Specified by:

getScope in interface Symbol

setScope

public void setScope(Scope scope)

Specified by:

setScope in interface Symbol

getParentScope

public Scope getParentScope()

Description copied from interface: Scope

Where to look next for symbols if just one parent; superclass or enclosing scope.

Specified by:

getParentScope in interface Scope

Overrides:

getParentScope in class BaseScope

getEnclosingScope

public Scope getEnclosingScope()

Description copied from interface: Scope

Scope in which this scope defined. null if no enclosing scope

Specified by:

getEnclosingScope in interface Scope

Overrides:

getEnclosingScope in class BaseScope

getQualifiedName

public String getQualifiedName()

Return the name prefixed with the name of its enclosing scope using '.' (dot) as the scope separator.

getQualifiedName

public String getQualifiedName(String scopePathSeparator)

Return the name prefixed with the name of its enclosing scope.

getFullyQualifiedName

public String getFullyQualifiedName(String scopePathSeparator)

Return the fully qualified name includes all scopes from the root down to this particular symbol.

getInsertionOrderNumber

public int getInsertionOrderNumber()

Specified by:

getInsertionOrderNumber in interface Symbol

setInsertionOrderNumber

public void setInsertionOrderNumber(int i)

Specified by:

setInsertionOrderNumber in interface Symbol

getNumberOfSymbols

public int getNumberOfSymbols()

Description copied from interface: Scope

Number of symbols in this specific scope

Specified by:

getNumberOfSymbols in interface Scope

Overrides:

getNumberOfSymbols in class BaseScope

equals

public boolean equals(Object obj)

Specified by:

equals in interface Symbol

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Symbol

Overrides:

hashCode in class Object