Skip navigation links
A B C D E F G H I J L M N O P R S T U V 

A

add(String) - Method in class org.antlr.symtab.StringTable
 
argumentTypes - Variable in class org.antlr.symtab.FunctionType
 
ArrayType - Class in org.antlr.symtab
An element within a type type such is used in C or Java where we need to indicate the type is an array of some element type like float[] or User[].
ArrayType(Type) - Constructor for class org.antlr.symtab.ArrayType
 
ArrayType(Type, int) - Constructor for class org.antlr.symtab.ArrayType
 

B

BaseScope - Class in org.antlr.symtab
An abstract base class that houses common functionality for scopes.
BaseScope() - Constructor for class org.antlr.symtab.BaseScope
 
BaseScope(Scope) - Constructor for class org.antlr.symtab.BaseScope
 
BaseSymbol - Class in org.antlr.symtab
An abstract base class used to house common functionality.
BaseSymbol(String) - Constructor for class org.antlr.symtab.BaseSymbol
 

C

ClassSymbol - Class in org.antlr.symtab
A symbol representing the class.
ClassSymbol(String) - Constructor for class org.antlr.symtab.ClassSymbol
 

D

DataAggregateSymbol - Class in org.antlr.symtab
A symbol representing a collection of data like a struct or class.
DataAggregateSymbol(String) - Constructor for class org.antlr.symtab.DataAggregateSymbol
 
define(Symbol) - Method in class org.antlr.symtab.BaseScope
 
define(Symbol) - Method in class org.antlr.symtab.DataAggregateSymbol
 
define(Symbol) - Method in interface org.antlr.symtab.Scope
Define a symbol in this scope, throw IllegalArgumentException if sym already defined in this scope.
defineGlobalSymbol(Symbol) - Method in class org.antlr.symtab.SymbolTable
 
definePredefinedSymbol(Symbol) - Method in class org.antlr.symtab.SymbolTable
 
defNode - Variable in class org.antlr.symtab.BaseSymbol
 
defNode - Variable in class org.antlr.symtab.DataAggregateSymbol
 
defNode - Variable in class org.antlr.symtab.FunctionSymbol
 

E

elemType - Variable in class org.antlr.symtab.ArrayType
 
enclosingScope - Variable in class org.antlr.symtab.BaseScope
 
equals(Object) - Method in class org.antlr.symtab.BaseSymbol
 
equals(Object) - Method in interface org.antlr.symtab.Symbol
 
equals(Object) - Method in class org.antlr.symtab.SymbolWithScope
 

F

FieldSymbol - Class in org.antlr.symtab
A field symbol is just a variable that lives inside an aggregate like a class or struct.
FieldSymbol(String) - Constructor for class org.antlr.symtab.FieldSymbol
 
filter(List<T>, Predicate<T>) - Static method in class org.antlr.symtab.Utils
 
filter(Collection<T>, Predicate<T>) - Static method in class org.antlr.symtab.Utils
 
findFirst(List<T>, Predicate<T>) - Static method in class org.antlr.symtab.Utils
 
FunctionSymbol - Class in org.antlr.symtab
This symbol represents a function ala C, not a method ala Java.
FunctionSymbol(String) - Constructor for class org.antlr.symtab.FunctionSymbol
 
FunctionType - Class in org.antlr.symtab
For C types like "void (*)(int)", we need that to be a pointer to a function taking a single integer argument returning void.
FunctionType(Type, List<Type>) - Constructor for class org.antlr.symtab.FunctionType
 

G

getAllAnnotatedFields(Class<?>) - Static method in class org.antlr.symtab.Utils
 
getAllFields(Class<?>) - Static method in class org.antlr.symtab.Utils
 
getAllNestedScopedSymbols() - Method in class org.antlr.symtab.BaseScope
 
getAllNestedScopedSymbols(Scope, List<Scope>) - Static method in class org.antlr.symtab.Utils
Order of scopes not guaranteed but is currently breadth-first according to nesting depth.
getAllNestedScopes(Scope, List<Scope>) - Static method in class org.antlr.symtab.Utils
Order of scopes not guaranteed but is currently breadth-first according to nesting depth.
getAllSymbols() - Method in class org.antlr.symtab.BaseScope
 
getAllSymbols() - Method in interface org.antlr.symtab.Scope
Return all symbols found in all nested scopes.
getAncestor(Parser, ParserRuleContext, String) - Static method in class org.antlr.symtab.Utils
Return first ancestor node up the chain towards the root that has ruleName.
getAncestor(ParserRuleContext, int) - Static method in class org.antlr.symtab.Utils
Return first ancestor node up the chain towards the root that has the rule index.
getArgumentTypes() - Method in class org.antlr.symtab.FunctionType
 
getDefinedFields() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getDefinedMethods() - Method in class org.antlr.symtab.ClassSymbol
Return the set of all methods defined within this class
getDefNode() - Method in class org.antlr.symtab.BaseSymbol
 
getDefNode() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getDefNode() - Method in class org.antlr.symtab.FunctionSymbol
 
getEnclosingPathToRoot() - Method in class org.antlr.symtab.BaseScope
 
getEnclosingPathToRoot() - Method in interface org.antlr.symtab.Scope
Return (inclusive) list of all scopes on path to root scope.
getEnclosingScope() - Method in class org.antlr.symtab.BaseScope
 
getEnclosingScope() - Method in interface org.antlr.symtab.Scope
Scope in which this scope defined.
getEnclosingScope() - Method in class org.antlr.symtab.SymbolWithScope
 
getEnclosingScopeOfType(Class<?>) - Method in class org.antlr.symtab.BaseScope
Walk up enclosingScope until we find an object of a specific type.
getFields() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getFirstAncestorOfType(ParserRuleContext, Class<?>) - Static method in class org.antlr.symtab.Utils
Return first ancestor node up the chain towards the root that is clazz.
getFullyQualifiedName(String) - Method in class org.antlr.symtab.BaseSymbol
 
getFullyQualifiedName(String) - Method in class org.antlr.symtab.SymbolWithScope
Return the fully qualified name includes all scopes from the root down to this particular symbol.
getInsertionOrderNumber() - Method in class org.antlr.symtab.BaseSymbol
 
getInsertionOrderNumber() - Method in interface org.antlr.symtab.Symbol
 
getInsertionOrderNumber() - Method in class org.antlr.symtab.SymbolWithScope
 
getMembers() - Method in class org.antlr.symtab.BaseScope
 
getMembers() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getMethods() - Method in class org.antlr.symtab.ClassSymbol
Return the set of all methods either inherited or not
getName() - Method in class org.antlr.symtab.ArrayType
 
getName() - Method in class org.antlr.symtab.BaseSymbol
 
getName() - Method in class org.antlr.symtab.FunctionType
 
getName() - Method in class org.antlr.symtab.GlobalScope
 
getName() - Method in class org.antlr.symtab.InvalidType
 
getName() - Method in class org.antlr.symtab.LocalScope
 
getName() - Method in class org.antlr.symtab.PointerType
 
getName() - Method in class org.antlr.symtab.PredefinedScope
 
getName() - Method in class org.antlr.symtab.PrimitiveType
 
getName() - Method in interface org.antlr.symtab.Scope
Often scopes have names like function or class names.
getName() - Method in interface org.antlr.symtab.Symbol
 
getName() - Method in class org.antlr.symtab.SymbolWithScope
 
getName() - Method in interface org.antlr.symtab.Type
 
getNestedScopedSymbols() - Method in class org.antlr.symtab.BaseScope
 
getNestedScopedSymbols() - Method in interface org.antlr.symtab.Scope
Return all immediately enclosed scoped symbols in insertion order.
getNestedScopes() - Method in class org.antlr.symtab.BaseScope
 
getNestedScopes() - Method in interface org.antlr.symtab.Scope
Return a list of scopes nested within this scope.
getNumberOfDefinedFields() - Method in class org.antlr.symtab.DataAggregateSymbol
get the number of fields defined specifically in this class
getNumberOfDefinedMethods() - Method in class org.antlr.symtab.ClassSymbol
get the number of methods defined specifically in this class
getNumberOfFields() - Method in class org.antlr.symtab.DataAggregateSymbol
get the total number of fields visible to this class
getNumberOfMethods() - Method in class org.antlr.symtab.ClassSymbol
get the total number of methods visible to this class
getNumberOfParameters() - Method in class org.antlr.symtab.FunctionSymbol
 
getNumberOfStrings() - Method in class org.antlr.symtab.StringTable
 
getNumberOfSymbols() - Method in class org.antlr.symtab.BaseScope
 
getNumberOfSymbols() - Method in interface org.antlr.symtab.Scope
Number of symbols in this specific scope
getNumberOfSymbols() - Method in class org.antlr.symtab.SymbolWithScope
 
getNumberOfVariables() - Method in class org.antlr.symtab.FunctionSymbol
Return the number of VariableSymbols specifically defined in the scope.
getOuterMostEnclosingScope() - Method in class org.antlr.symtab.BaseScope
Walk up enclosingScope until we find topmost.
getParentScope() - Method in class org.antlr.symtab.BaseScope
 
getParentScope() - Method in class org.antlr.symtab.ClassSymbol
 
getParentScope() - Method in interface org.antlr.symtab.Scope
Where to look next for symbols if just one parent; superclass or enclosing scope.
getParentScope() - Method in class org.antlr.symtab.SymbolWithScope
 
getParentScopes() - Method in class org.antlr.symtab.BaseScope
 
getParentScopes() - Method in interface org.antlr.symtab.Scope
Multiple superclass or interface implementations and the like...
getQualifiedName() - Method in class org.antlr.symtab.SymbolWithScope
Return the name prefixed with the name of its enclosing scope using '.' (dot) as the scope separator.
getQualifiedName(String) - Method in class org.antlr.symtab.SymbolWithScope
Return the name prefixed with the name of its enclosing scope.
getScope() - Method in class org.antlr.symtab.BaseSymbol
 
getScope() - Method in interface org.antlr.symtab.Symbol
 
getScope() - Method in class org.antlr.symtab.SymbolWithScope
 
getSlotNumber() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getSlotNumber() - Method in class org.antlr.symtab.FieldSymbol
 
getSlotNumber() - Method in interface org.antlr.symtab.MemberSymbol
 
getSlotNumber() - Method in class org.antlr.symtab.MethodSymbol
 
getSuperClassName() - Method in class org.antlr.symtab.ClassSymbol
 
getSymbol(String) - Method in class org.antlr.symtab.BaseScope
 
getSymbol(String) - Method in interface org.antlr.symtab.Scope
Get symbol if name defined within this specific scope
getSymbolNames() - Method in class org.antlr.symtab.BaseScope
 
getSymbolNames() - Method in interface org.antlr.symtab.Scope
Return the set of names associated with all symbols in the scope.
getSymbols() - Method in class org.antlr.symtab.BaseScope
 
getSymbols() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getSymbols() - Method in interface org.antlr.symtab.Scope
Return the symbols defined within this scope.
getTargetType() - Method in class org.antlr.symtab.TypeAlias
 
getType() - Method in class org.antlr.symtab.BaseSymbol
 
getType() - Method in class org.antlr.symtab.FunctionSymbol
 
getType() - Method in interface org.antlr.symtab.TypedSymbol
 
getTypeIndex() - Method in class org.antlr.symtab.ArrayType
 
getTypeIndex() - Method in class org.antlr.symtab.DataAggregateSymbol
 
getTypeIndex() - Method in class org.antlr.symtab.FunctionType
 
getTypeIndex() - Method in class org.antlr.symtab.InvalidType
 
getTypeIndex() - Method in class org.antlr.symtab.PointerType
 
getTypeIndex() - Method in class org.antlr.symtab.PrimitiveType
 
getTypeIndex() - Method in interface org.antlr.symtab.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.
getTypeIndex() - Method in class org.antlr.symtab.TypeAlias
 
GLOBALS - Variable in class org.antlr.symtab.SymbolTable
 
GlobalScope - Class in org.antlr.symtab
A scope associated with globals.
GlobalScope(Scope) - Constructor for class org.antlr.symtab.GlobalScope
 

H

hashCode() - Method in class org.antlr.symtab.BaseSymbol
 
hashCode() - Method in interface org.antlr.symtab.Symbol
 
hashCode() - Method in class org.antlr.symtab.SymbolWithScope
 

I

index - Variable in class org.antlr.symtab.StringTable
 
index - Variable in class org.antlr.symtab.SymbolWithScope
 
initTypeSystem() - Method in class org.antlr.symtab.SymbolTable
 
INVALID_TYPE - Static variable in class org.antlr.symtab.SymbolTable
 
InvalidType - Class in org.antlr.symtab
 
InvalidType() - Constructor for class org.antlr.symtab.InvalidType
 

J

join(Collection<T>, String) - Static method in class org.antlr.symtab.Utils
 
join(Collection<T>, String, String, String) - Static method in class org.antlr.symtab.Utils
 
join(Iterator<T>, String, String, String) - Static method in class org.antlr.symtab.Utils
 
join(T[], String) - Static method in class org.antlr.symtab.Utils
 
joinScopeNames(List<Scope>, String) - Static method in class org.antlr.symtab.Utils
 

L

lexicalOrder - Variable in class org.antlr.symtab.BaseSymbol
 
LocalScope - Class in org.antlr.symtab
A scope object typically associated with {...} code blocks
LocalScope(Scope) - Constructor for class org.antlr.symtab.LocalScope
 

M

map(Collection<T>, Function<T, R>) - Static method in class org.antlr.symtab.Utils
 
map(T[], Function<T, R>) - Static method in class org.antlr.symtab.Utils
 
MemberSymbol - Interface in org.antlr.symtab
A symbol within an aggregate like a class or struct.
MethodSymbol - Class in org.antlr.symtab
A method symbol is a function that lives within an aggregate/class and has a slot number.
MethodSymbol(String) - Constructor for class org.antlr.symtab.MethodSymbol
 

N

name - Variable in class org.antlr.symtab.BaseSymbol
 
name - Variable in class org.antlr.symtab.SymbolWithScope
 
nest(Scope) - Method in class org.antlr.symtab.BaseScope
Add a nested scope to this scope; could also be a FunctionSymbol if your language allows nested functions.
nest(Scope) - Method in interface org.antlr.symtab.Scope
Add a nested local scope to this scope; it's like define() but for non SymbolWithScope objects.
nestedScopesNotSymbols - Variable in class org.antlr.symtab.BaseScope
All directly contained scopes, typically LocalScopes within a LocalScope or a LocalScope within a FunctionSymbol.
nextFreeFieldSlot - Variable in class org.antlr.symtab.DataAggregateSymbol
 
nextFreeMethodSlot - Variable in class org.antlr.symtab.ClassSymbol
 
numElems - Variable in class org.antlr.symtab.ArrayType
 

O

org.antlr.symtab - package org.antlr.symtab
 

P

ParameterSymbol - Class in org.antlr.symtab
A parameter is just kind of variable used as an argument to a function or method.
ParameterSymbol(String) - Constructor for class org.antlr.symtab.ParameterSymbol
 
PointerType - Class in org.antlr.symtab
An element in a type tree that represents a pointer to some type, such as we need for C.
PointerType(Type) - Constructor for class org.antlr.symtab.PointerType
 
PREDEFINED - Variable in class org.antlr.symtab.SymbolTable
 
PredefinedScope - Class in org.antlr.symtab
A scope to hold predefined symbols of your language.
PredefinedScope() - Constructor for class org.antlr.symtab.PredefinedScope
 
PrimitiveType - Class in org.antlr.symtab
 
PrimitiveType(String) - Constructor for class org.antlr.symtab.PrimitiveType
 

R

resolve(String) - Method in class org.antlr.symtab.BaseScope
 
resolve(String) - Method in interface org.antlr.symtab.Scope
Look up name in this scope or recursively in parent scope if not here
resolveMethod(String) - Method in class org.antlr.symtab.ClassSymbol
 
retType - Variable in class org.antlr.symtab.FunctionSymbol
 
returnType - Variable in class org.antlr.symtab.FunctionType
 

S

scope - Variable in class org.antlr.symtab.BaseSymbol
 
Scope - Interface in org.antlr.symtab
A scope is a dictionary of symbols that are grouped together by some lexical construct in the input language.
setDefNode(ParserRuleContext) - Method in class org.antlr.symtab.BaseSymbol
 
setDefNode(ParserRuleContext) - Method in class org.antlr.symtab.DataAggregateSymbol
 
setDefNode(ParserRuleContext) - Method in class org.antlr.symtab.FunctionSymbol
 
setEnclosingScope(Scope) - Method in class org.antlr.symtab.BaseScope
 
setEnclosingScope(Scope) - Method in interface org.antlr.symtab.Scope
What scope encloses this scope.
setInsertionOrderNumber(int) - Method in class org.antlr.symtab.BaseSymbol
 
setInsertionOrderNumber(int) - Method in interface org.antlr.symtab.Symbol
 
setInsertionOrderNumber(int) - Method in class org.antlr.symtab.SymbolWithScope
 
setScope(Scope) - Method in class org.antlr.symtab.BaseSymbol
 
setScope(Scope) - Method in interface org.antlr.symtab.Symbol
 
setScope(Scope) - Method in class org.antlr.symtab.SymbolWithScope
 
setSlotNumber(Symbol) - Method in class org.antlr.symtab.ClassSymbol
 
setSlotNumber(Symbol) - Method in class org.antlr.symtab.DataAggregateSymbol
 
setSuperClass(String) - Method in class org.antlr.symtab.ClassSymbol
 
setType(Type) - Method in class org.antlr.symtab.BaseSymbol
 
setType(Type) - Method in class org.antlr.symtab.FunctionSymbol
 
setType(Type) - Method in interface org.antlr.symtab.TypedSymbol
 
setType(Type) - Method in class org.antlr.symtab.VariableSymbol
 
setTypeIndex(int) - Method in class org.antlr.symtab.DataAggregateSymbol
 
setTypeIndex(int) - Method in class org.antlr.symtab.PrimitiveType
 
slot - Variable in class org.antlr.symtab.FieldSymbol
 
slot - Variable in class org.antlr.symtab.MethodSymbol
 
StringTable - Class in org.antlr.symtab
A unique set of strings mapped to a monotonically increasing index.
StringTable() - Constructor for class org.antlr.symtab.StringTable
 
superClassName - Variable in class org.antlr.symtab.ClassSymbol
 
Symbol - Interface in org.antlr.symtab
A generic programming language symbol.
symbols - Variable in class org.antlr.symtab.BaseScope
All symbols defined in this scope; can include classes, functions, variables, or anything else that is a Symbol impl.
SymbolTable - Class in org.antlr.symtab
A marginally useful object to track predefined and global scopes.
SymbolTable() - Constructor for class org.antlr.symtab.SymbolTable
 
SymbolWithScope - Class in org.antlr.symtab
An abstract base class that houses common functionality for symbols like classes and functions that are both symbols and scopes.
SymbolWithScope(String) - Constructor for class org.antlr.symtab.SymbolWithScope
 

T

tab(int) - Static method in class org.antlr.symtab.Utils
 
table - Variable in class org.antlr.symtab.StringTable
 
targetType - Variable in class org.antlr.symtab.PointerType
 
targetType - Variable in class org.antlr.symtab.TypeAlias
 
toArray() - Method in class org.antlr.symtab.StringTable
Return an array, possibly of length zero, with all strings sitting at their appropriate index within the array.
toList() - Method in class org.antlr.symtab.StringTable
Return a List, possibly of length zero, with all strings sitting at their appropriate index within the array.
toQualifierString(String) - Method in class org.antlr.symtab.BaseScope
 
toQualifierString(String) - Method in interface org.antlr.symtab.Scope
Return scopes from to current with separator in between
toQualifierString(Scope, String) - Static method in class org.antlr.symtab.Utils
Return a string of scope names with the "stack" growing to the right.
toScopeStackString(String) - Method in class org.antlr.symtab.BaseScope
 
toScopeStackString(Scope, String) - Static method in class org.antlr.symtab.Utils
Return a string of scope names with the "stack" growing to the left E.g., myblock:mymethod:myclass.
toString() - Method in class org.antlr.symtab.ArrayType
 
toString() - Method in class org.antlr.symtab.BaseScope
 
toString() - Method in class org.antlr.symtab.BaseSymbol
 
toString() - Method in class org.antlr.symtab.ClassSymbol
 
toString() - Method in class org.antlr.symtab.FunctionSymbol
 
toString() - Method in class org.antlr.symtab.FunctionType
 
toString() - Method in class org.antlr.symtab.PointerType
 
toString() - Method in class org.antlr.symtab.StringTable
 
toString(Scope, int) - Static method in class org.antlr.symtab.Utils
 
toString(Scope) - Static method in class org.antlr.symtab.Utils
 
toTestString() - Method in class org.antlr.symtab.BaseScope
 
toTestString(String, String) - Method in class org.antlr.symtab.BaseScope
 
type - Variable in class org.antlr.symtab.BaseSymbol
 
Type - Interface in org.antlr.symtab
This interface is a tag that indicates the implementing object is a kind of type.
TypeAlias - Class in org.antlr.symtab
A "typedef int I;" in C results in a TypeAlias("I", ptrToIntegerType)
TypeAlias(String, Type) - Constructor for class org.antlr.symtab.TypeAlias
 
TypedSymbol - Interface in org.antlr.symtab
This interface tags user-defined symbols that have static type information, like variables and functions.
typeIndex - Variable in class org.antlr.symtab.DataAggregateSymbol
 
typeIndex - Variable in class org.antlr.symtab.PrimitiveType
 

U

Utils - Class in org.antlr.symtab
 
Utils() - Constructor for class org.antlr.symtab.Utils
 

V

VariableSymbol - Class in org.antlr.symtab
 
VariableSymbol(String) - Constructor for class org.antlr.symtab.VariableSymbol
 
A B C D E F G H I J L M N O P R S T U V 
Skip navigation links

Copyright © 2016 ANTLR. All Rights Reserved.