org.antlr.symtab

Class FunctionSymbol

java.lang.Object

org.antlr.symtab.BaseScope

org.antlr.symtab.SymbolWithScope

org.antlr.symtab.FunctionSymbol

All Implemented Interfaces:

Scope, Symbol, TypedSymbol

Direct Known Subclasses:

MethodSymbol

public class FunctionSymbol
extends SymbolWithScope
implements TypedSymbol

This symbol represents a function ala C, not a method ala Java. You can associate a node in the parse tree that is responsible for defining this symbol.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.antlr.v4.runtime.ParserRuleContext	defNode
protected Type	retType

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
FunctionSymbol(String name)

Method Summary

Modifier and Type	Method and Description
org.antlr.v4.runtime.ParserRuleContext	getDefNode()
int	getNumberOfParameters()
int	getNumberOfVariables() Return the number of VariableSymbols specifically defined in the scope.
Type	getType()
void	setDefNode(org.antlr.v4.runtime.ParserRuleContext defNode)
void	setType(Type type)
String	toString()

Methods inherited from class org.antlr.symtab.SymbolWithScope

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

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, 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

defNode

protected org.antlr.v4.runtime.ParserRuleContext defNode

retType

protected Type retType

Constructor Detail

FunctionSymbol

public FunctionSymbol(String name)

Method Detail

setDefNode

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

getDefNode

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

getType

public Type getType()

Specified by:

getType in interface TypedSymbol

setType

public void setType(Type type)

Specified by:

setType in interface TypedSymbol

getNumberOfVariables

public int getNumberOfVariables()

Return the number of VariableSymbols specifically defined in the scope. This is useful as either the number of parameters or the number of parameters and locals depending on how you build the scope tree.

getNumberOfParameters

public int getNumberOfParameters()

toString

public String toString()

Overrides:

toString in class BaseScope