Module suggest

Package de.grogra.suggest.scope

Class FunctionSymbol

java.lang.Object

de.grogra.suggest.scope.BaseScope

de.grogra.suggest.scope.SymbolWithScope

de.grogra.suggest.scope.FunctionSymbol

All Implemented Interfaces:

Member, Scope, Symbol, SymbolWithModifiers, 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	Description
protected org.antlr.v4.runtime.ParserRuleContext	defNode
protected boolean	isArray
protected Type	retType
String	typeAsText
boolean	typeResolved

Fields inherited from class de.grogra.suggest.scope.SymbolWithScope

index, modifiers, name

Fields inherited from class de.grogra.suggest.scope.BaseScope

enclosingScope, nestedScopesNotSymbols, symbols

Fields inherited from interface de.grogra.suggest.scope.Member

ABSTRACT, ALL_VISIBILITY, CLASS, COMPLETE_NAME, CONSTRUCTOR, DECLARED, FIELD, FINAL, INTERFACE, JAVA_TYPE, METHOD, NATIVE, NEW, NODE, PACKAGE, PRIVATE, PROTECTED, PUBLIC, SCOPE, STATIC, STATIC_ONLY, STRICT, SUPER, SYNCHRONIZED, TRANSIENT, VOLATILE, XL

Constructor Summary

Constructors

Constructor	Description
FunctionSymbol(String name)

Method Summary

Modifier and Type	Method	Description
org.antlr.v4.runtime.ParserRuleContext	getDefNode()
int	getNumberOfParameters()
int	getNumberOfVariables()	Return the number of VariableSymbols specifically defined in the scope.
Type	getType()
boolean	isArray()
Type	resolveType(Scope scope)	Symbol can be set a type that will be define latter in the file.
void	setDefNode(org.antlr.v4.runtime.ParserRuleContext defNode)
void	setType(Type type)
void	setTypeResolved(boolean b)
String	toString()

Methods inherited from class de.grogra.suggest.scope.SymbolWithScope

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

Methods inherited from class de.grogra.suggest.scope.BaseScope

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.grogra.suggest.scope.Scope

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

Methods inherited from interface de.grogra.suggest.scope.Symbol

accept

Field Details

defNode

protected org.antlr.v4.runtime.ParserRuleContext defNode

retType

protected Type retType

isArray

protected boolean isArray

typeResolved

public boolean typeResolved

typeAsText

public String typeAsText

Constructor Details

FunctionSymbol

public FunctionSymbol(String name)

Method Details

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

isArray

public boolean isArray()

Specified by:

isArray 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()

resolveType

public Type resolveType(Scope scope)

Description copied from interface: TypedSymbol

Symbol can be set a type that will be define latter in the file. They can save the text as type and mark themselves as type unresovled. Then when the type is fetched for the first type it is looked in the type table.

Specified by:

resolveType in interface TypedSymbol

setTypeResolved

public void setTypeResolved(boolean b)

Specified by:

setTypeResolved in interface TypedSymbol

toString

public String toString()

Overrides:

toString in class SymbolWithScope