org.antlr.symtab

Class DataAggregateSymbol

java.lang.Object

org.antlr.symtab.BaseScope

org.antlr.symtab.SymbolWithScope

org.antlr.symtab.DataAggregateSymbol

All Implemented Interfaces:

MemberSymbol, Scope, Symbol, Type

Direct Known Subclasses:

ClassSymbol, StructSymbol

public abstract class DataAggregateSymbol
extends SymbolWithScope
implements MemberSymbol, Type

A symbol representing a collection of data like a struct or class. Each member has a slot number indexed from 0 and we track data fields and methods with different slot sequences. A DataAggregateSymbol can also be a member of an aggregate itself (nested structs, ...).

Field Summary

Fields

Modifier and Type	Field and Description
protected org.antlr.v4.runtime.ParserRuleContext	defNode
protected int	nextFreeFieldSlot
protected int	typeIndex

Fields inherited from class org.antlr.symtab.SymbolWithScope

index, name

Fields inherited from class org.antlr.symtab.BaseScope

enclosingScope, nestedScopesNotSymbols, symbols

Constructor Summary

Constructors

Constructor and Description
DataAggregateSymbol(String name)

Method Summary

Modifier and Type	Method and Description
void	define(Symbol sym) Define a symbol in this scope, throw IllegalArgumentException if sym already defined in this scope.
List<? extends FieldSymbol>	getDefinedFields() Return the list of fields in this specific aggregate
org.antlr.v4.runtime.ParserRuleContext	getDefNode()
List<? extends FieldSymbol>	getFields()
Map<String,? extends MemberSymbol>	getMembers()
int	getNumberOfDefinedFields() get the number of fields defined specifically in this class
int	getNumberOfFields() Get the total number of fields visible to this class
int	getSlotNumber()
List<MemberSymbol>	getSymbols() Return the symbols defined within this scope.
int	getTypeIndex() It is useful during type computation and code gen to assign an int index to the primitive types and possibly user-defined types like structs and classes.
Symbol	resolveField(String name) Look for a field with this name in this scope only.
Symbol	resolveMember(String name) Look up name within this scope only.
void	setDefNode(org.antlr.v4.runtime.ParserRuleContext defNode)
void	setSlotNumber(Symbol sym)
void	setTypeIndex(int typeIndex)

Methods inherited from class org.antlr.symtab.SymbolWithScope

equals, getEnclosingScope, getFullyQualifiedName, getInsertionOrderNumber, getName, getNumberOfSymbols, getQualifiedName, getQualifiedName, getScope, hashCode, setInsertionOrderNumber, setScope

Methods inherited from class org.antlr.symtab.BaseScope

getAllNestedScopedSymbols, getAllSymbols, getEnclosingPathToRoot, getEnclosingScopeOfType, getNestedScopedSymbols, getNestedScopes, getOuterMostEnclosingScope, getSymbol, getSymbolNames, 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.Symbol

equals, getInsertionOrderNumber, getName, getScope, hashCode, setInsertionOrderNumber, setScope

Methods inherited from interface org.antlr.symtab.Type

getName

Methods inherited from interface org.antlr.symtab.Scope

getAllSymbols, getEnclosingPathToRoot, getNestedScopedSymbols, getNestedScopes, getSymbol, getSymbolNames, nest, resolve, setEnclosingScope, toQualifierString

Field Detail

defNode

protected org.antlr.v4.runtime.ParserRuleContext defNode

nextFreeFieldSlot

protected int nextFreeFieldSlot

typeIndex

protected int typeIndex

Constructor Detail

DataAggregateSymbol

public DataAggregateSymbol(String name)

Method Detail

setDefNode

public void setDefNode(org.antlr.v4.runtime.ParserRuleContext defNode)

getDefNode

public org.antlr.v4.runtime.ParserRuleContext getDefNode()

define

public void define(Symbol sym)
            throws IllegalArgumentException

Description copied from interface: Scope

Define a symbol in this scope, throw IllegalArgumentException if sym already defined in this scope. This alters sym: 1. Set insertion order number of sym 2. Set sym's scope to be the scope. The order in which symbols are defined must be preserved so that Scope.getSymbols() returns the list in definition order.

Specified by:

define in interface Scope

Overrides:

define in class BaseScope

Throws:

IllegalArgumentException

getSymbols

public List<MemberSymbol> getSymbols()

Description copied from interface: Scope

Return the symbols defined within this scope. The order of insertion into the scope is the order returned in this list.

Specified by:

getSymbols in interface Scope

Overrides:

getSymbols in class BaseScope

getMembers

public Map<String,? extends MemberSymbol> getMembers()

Overrides:

getMembers in class BaseScope

resolveMember

public Symbol resolveMember(String name)

Look up name within this scope only. Return any kind of MemberSymbol found or null if nothing with this name found as MemberSymbol.

resolveField

public Symbol resolveField(String name)

Look for a field with this name in this scope only. Return null if no field found.

getNumberOfDefinedFields

public int getNumberOfDefinedFields()

get the number of fields defined specifically in this class

getNumberOfFields

public int getNumberOfFields()

Get the total number of fields visible to this class

getDefinedFields

public List<? extends FieldSymbol> getDefinedFields()

Return the list of fields in this specific aggregate

getFields

public List<? extends FieldSymbol> getFields()

setSlotNumber

public void setSlotNumber(Symbol sym)

getSlotNumber

public int getSlotNumber()

Specified by:

getSlotNumber in interface MemberSymbol

getTypeIndex

public int getTypeIndex()

Description copied from interface: Type

It is useful during type computation and code gen to assign an int index to the primitive types and possibly user-defined types like structs and classes.

Specified by:

getTypeIndex in interface Type

Returns:

Return 0-indexed type index else -1 if no index.

setTypeIndex

public void setTypeIndex(int typeIndex)