Package gw.internal.gosu.parser

Class Symbol

java.lang.Object

gw.internal.gosu.parser.Symbol

All Implemented Interfaces:

IFunctionSymbol, IHasType, IReducedSymbol, ISymbol

Direct Known Subclasses:

AbstractDynamicSymbol, AmbiguousSymbol, CapturedSymbol, CommonSymbolsScope.LockedDownSymbol, CompileTimeExpressionParser.CompileTimeFieldSymbol, QueryPathRootSymbol, ReadOnlySymbol, ReducedSymbol.SyntheticSymbol, TemplateGenerator.LockedDownSymbol, ThisSymbol, TypedSymbol

public class Symbol
extends java.lang.Object
implements IFunctionSymbol

Base class for all symbols in the symbol table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Symbol.MemberStackProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_bGlobal
private IExpression	_defaultValue
protected int	_iIndex
private ModifierInfo	_modifiers
private java.lang.String	_name
protected IStackProvider	_stackProvider
protected ISymbolTable	_symbolTable
private IType	_type
protected java.lang.Object	_value
private MutableBoolean	_valueIsBoxed
static IStackProvider	MEMBER_STACK_PROVIDER

Fields inherited from interface gw.lang.parser.ISymbol

SUPER, THIS

Constructor Summary

Constructors

Constructor	Description
Symbol(Symbol copy)
Symbol(java.lang.String strName, IType type, IStackProvider stackProvider)
Symbol(java.lang.String strName, IType type, IStackProvider stackProvider, java.lang.Object value)
Symbol(java.lang.String strName, IType type, IStackProvider stackProvider, java.lang.Object value, IScope scope)
Symbol(java.lang.String strName, IType type, java.lang.Object value)

Method Summary

Modifier and Type	Method	Description
protected int	assignIndex(IScope scope)
protected int	assignIndexInStack(IScope scope)
boolean	canBeCaptured()
IReducedSymbol	createReducedSymbol()
boolean	equals(java.lang.Object o)
java.util.List<IGosuAnnotation>	getAnnotations()
IExpression	getDefaultValueExpression()	The symbol's default value e.g., a default parameter value for a function.
java.lang.String	getDisplayName()	Returns the Symbol's optional display name.
ISymbolTable	getDynamicSymbolTable()
java.lang.String	getFullDescription()
IGosuClass	getGosuClass()
int	getIndex()
ISymbol	getLightWeightReference()	Creates a copy of this symbol without the value so that the empty symbol can be stored.
ModifierInfo	getModifierInfo()
int	getModifiers()	Returns the modifiers for this function symbol
java.lang.String	getName()	Returns the Symbol's name.
IScriptPartId	getScriptPart()
java.lang.String	getSignatureDescription()	Returns a description of arguments of the form ( < argName1 >, < argName2 >, etc.
java.lang.Class	getSymbolClass()
IType	getType()	Returns the Symbol's type.
java.lang.Object	getValue()	Returns the value assigned to this Symbol.
java.lang.Object	getValueDirectly()
private java.lang.Object	getValueFromSymbolTable()
boolean	hasDynamicSymbolTable()
boolean	hasTypeVariables()
java.lang.Object	invoke(java.lang.Object[] args)	Invokes function.
boolean	isAbstract()
boolean	isClassMember()
boolean	isFinal()
boolean	isFromJava()
boolean	isHide()
boolean	isImplicitlyInitialized()
boolean	isInternal()
boolean	isLocal()
boolean	isOverride()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isReified()
boolean	isStackSymbol()	Returns true if the value of this function symbol is stored on the stack as a variable
boolean	isStatic()
boolean	isValueBoxed()
boolean	isWritable()	Returns true if this symbol is writable.
ICapturedSymbol	makeCapturedSymbol(java.lang.String strName, ISymbolTable symbolTable, IScope scope)
void	renameAsErrantDuplicate(int iIndex)
void	replaceModifierInfo(IModifierInfo mi)
void	setAbstract(boolean bAbstract)
void	setClassMember(boolean bClassMember)
void	setDefaultValueExpression(IExpression defaultValue)
void	setDynamicSymbolTable(ISymbolTable symTable)	Assigns an optional symbol table so that the symbol can get/set its value dynamically e.g., via ThreadLocalSymbolTable.
void	setFinal(boolean bFinal)
void	setHide(boolean bHide)
void	setIndex(int i)
void	setInternal(boolean bInternal)
void	setModifierInfo(IModifierInfo modifiers)
void	setModifiers(int modifiers)
protected void	setName(java.lang.String name)
void	setOverride(boolean bOverride)
void	setPrivate(boolean bPrivate)
void	setProtected(boolean bProtected)
void	setPublic(boolean bPublic)
void	setReified(boolean bReified)
void	setStatic(boolean bStatic)
void	setType(IType type)	Sets the Symbol's type.
void	setValue(java.lang.Object value)	Assigns a value to this Symbol.
void	setValueDirectly(java.lang.Object value)
private void	setValueFromSymbolTable(java.lang.Object value)
void	setValueIsBoxed(boolean b)	Indicates that this symbol should use a reference rather than storing its value directly.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MEMBER_STACK_PROVIDER

public static final IStackProvider MEMBER_STACK_PROVIDER

_name

private java.lang.String _name

_type

private IType _type

_value

protected java.lang.Object _value

_defaultValue

private IExpression _defaultValue

_iIndex

protected int _iIndex

_bGlobal

protected boolean _bGlobal

_stackProvider

protected IStackProvider _stackProvider

_symbolTable

protected ISymbolTable _symbolTable

_valueIsBoxed

private MutableBoolean _valueIsBoxed

_modifiers

private ModifierInfo _modifiers

Constructor Detail

Symbol

public Symbol(java.lang.String strName,
              IType type,
              IStackProvider stackProvider)

Symbol

public Symbol(java.lang.String strName,
              IType type,
              IStackProvider stackProvider,
              java.lang.Object value)

Symbol

public Symbol(java.lang.String strName,
              IType type,
              IStackProvider stackProvider,
              java.lang.Object value,
              IScope scope)

Symbol

public Symbol(Symbol copy)

Symbol

public Symbol(java.lang.String strName,
              IType type,
              java.lang.Object value)

Method Detail

setDynamicSymbolTable

public void setDynamicSymbolTable(ISymbolTable symTable)

Description copied from interface: ISymbol

Assigns an optional symbol table so that the symbol can get/set its value dynamically e.g., via ThreadLocalSymbolTable.

Specified by:

setDynamicSymbolTable in interface ISymbol

hasDynamicSymbolTable

public boolean hasDynamicSymbolTable()

Specified by:

hasDynamicSymbolTable in interface ISymbol

getDynamicSymbolTable

public ISymbolTable getDynamicSymbolTable()

Specified by:

getDynamicSymbolTable in interface ISymbol

assignIndex

protected int assignIndex(IScope scope)

assignIndexInStack

protected int assignIndexInStack(IScope scope)

getName

public java.lang.String getName()

Returns the Symbol's name.

Specified by:

getName in interface IReducedSymbol

Specified by:

getName in interface ISymbol

getDisplayName

public java.lang.String getDisplayName()

Returns the Symbol's optional display name. If a display name is not assigned, returns the symbol's name.

Specified by:

getDisplayName in interface IReducedSymbol

Specified by:

getDisplayName in interface ISymbol

getFullDescription

public java.lang.String getFullDescription()

Specified by:

getFullDescription in interface IReducedSymbol

renameAsErrantDuplicate

public void renameAsErrantDuplicate(int iIndex)

getType

public IType getType()

Returns the Symbol's type.

Specified by:

getType in interface IHasType

Specified by:

getType in interface IReducedSymbol

Specified by:

getType in interface ISymbol

setType

public void setType(IType type)

Sets the Symbol's type.

Specified by:

setType in interface ISymbol

getValue

public java.lang.Object getValue()

Returns the value assigned to this Symbol.

Specified by:

getValue in interface ISymbol

getValueFromSymbolTable

private java.lang.Object getValueFromSymbolTable()

setValue

public void setValue(java.lang.Object value)

Assigns a value to this Symbol.

Specified by:

setValue in interface ISymbol

getDefaultValueExpression

public IExpression getDefaultValueExpression()

Description copied from interface: ISymbol

The symbol's default value e.g., a default parameter value for a function.

Specified by:

getDefaultValueExpression in interface IReducedSymbol

Specified by:

getDefaultValueExpression in interface ISymbol

setDefaultValueExpression

public void setDefaultValueExpression(IExpression defaultValue)

Specified by:

setDefaultValueExpression in interface ISymbol

isStackSymbol

public boolean isStackSymbol()

Description copied from interface: IFunctionSymbol

Returns true if the value of this function symbol is stored on the stack as a variable

Specified by:

isStackSymbol in interface IFunctionSymbol

setValueFromSymbolTable

private void setValueFromSymbolTable(java.lang.Object value)

getValueDirectly

public java.lang.Object getValueDirectly()

setValueDirectly

public void setValueDirectly(java.lang.Object value)

invoke

public java.lang.Object invoke(java.lang.Object[] args)

Invokes function.

Specified by:

invoke in interface IFunctionSymbol

Parameters:

args - An array of arguments to forward to the function.

getLightWeightReference

public ISymbol getLightWeightReference()

Description copied from interface: ISymbol

Creates a copy of this symbol without the value so that the empty symbol can be stored.

Specified by:

getLightWeightReference in interface ISymbol

isImplicitlyInitialized

public boolean isImplicitlyInitialized()

isWritable

public boolean isWritable()

Description copied from interface: ISymbol

Returns true if this symbol is writable.

An example of a symbol that is not writable is a readonly Property referenced as a symbol in a Gosu class.

Specified by:

isWritable in interface ISymbol

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getSignatureDescription

public java.lang.String getSignatureDescription()

Description copied from interface: IFunctionSymbol

Returns a description of arguments of the form ( < argName1 >, < argName2 >, etc. ) appropriate for display in a source editor ui.

Specified by:

getSignatureDescription in interface IFunctionSymbol

getIndex

public int getIndex()

Specified by:

getIndex in interface IReducedSymbol

Specified by:

getIndex in interface ISymbol

isClassMember

public boolean isClassMember()

setClassMember

public void setClassMember(boolean bClassMember)

isStatic

public boolean isStatic()

Specified by:

isStatic in interface IReducedSymbol

setStatic

public void setStatic(boolean bStatic)

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface IReducedSymbol

setPrivate

public void setPrivate(boolean bPrivate)

isInternal

public boolean isInternal()

Specified by:

isInternal in interface IReducedSymbol

setInternal

public void setInternal(boolean bInternal)

isProtected

public boolean isProtected()

Specified by:

isProtected in interface IReducedSymbol

setProtected

public void setProtected(boolean bProtected)

isPublic

public boolean isPublic()

Specified by:

isPublic in interface IReducedSymbol

setPublic

public void setPublic(boolean bPublic)

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface IReducedSymbol

setAbstract

public void setAbstract(boolean bAbstract)

isFinal

public boolean isFinal()

Specified by:

isFinal in interface IReducedSymbol

setFinal

public void setFinal(boolean bFinal)

isReified

public boolean isReified()

Specified by:

isReified in interface IReducedSymbol

setReified

public void setReified(boolean bReified)

isOverride

public boolean isOverride()

setOverride

public void setOverride(boolean bOverride)

isHide

public boolean isHide()

setHide

public void setHide(boolean bHide)

getModifierInfo

public ModifierInfo getModifierInfo()

Specified by:

getModifierInfo in interface ISymbol

setModifierInfo

public void setModifierInfo(IModifierInfo modifiers)

replaceModifierInfo

public void replaceModifierInfo(IModifierInfo mi)

getModifiers

public int getModifiers()

Description copied from interface: IFunctionSymbol

Returns the modifiers for this function symbol

Specified by:

getModifiers in interface IFunctionSymbol

Specified by:

getModifiers in interface IReducedSymbol

getAnnotations

public java.util.List<IGosuAnnotation> getAnnotations()

Specified by:

getAnnotations in interface IReducedSymbol

getScriptPart

public IScriptPartId getScriptPart()

Specified by:

getScriptPart in interface IReducedSymbol

getGosuClass

public IGosuClass getGosuClass()

Specified by:

getGosuClass in interface IReducedSymbol

hasTypeVariables

public boolean hasTypeVariables()

Specified by:

hasTypeVariables in interface IReducedSymbol

setModifiers

public void setModifiers(int modifiers)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

canBeCaptured

public boolean canBeCaptured()

Specified by:

canBeCaptured in interface ISymbol

makeCapturedSymbol

public ICapturedSymbol makeCapturedSymbol(java.lang.String strName,
                                          ISymbolTable symbolTable,
                                          IScope scope)

Specified by:

makeCapturedSymbol in interface ISymbol

setIndex

public void setIndex(int i)

setValueIsBoxed

public void setValueIsBoxed(boolean b)

Description copied from interface: ISymbol

Indicates that this symbol should use a reference rather than storing its value directly.

Specified by:

setValueIsBoxed in interface ISymbol

isValueBoxed

public boolean isValueBoxed()

Specified by:

isValueBoxed in interface IReducedSymbol

Specified by:

isValueBoxed in interface ISymbol

setName

protected void setName(java.lang.String name)

isLocal

public boolean isLocal()

Specified by:

isLocal in interface ISymbol

isFromJava

public boolean isFromJava()

Specified by:

isFromJava in interface IFunctionSymbol

Returns:

true if this function symbol came from a java superclass

getSymbolClass

public java.lang.Class getSymbolClass()

Specified by:

getSymbolClass in interface IReducedSymbol

createReducedSymbol

public IReducedSymbol createReducedSymbol()

Specified by:

createReducedSymbol in interface ISymbol