Package gw.internal.gosu.parser

Class DynamicFunctionSymbol

java.lang.Object

gw.internal.gosu.parser.Symbol

gw.internal.gosu.parser.AbstractDynamicSymbol

gw.internal.gosu.parser.DynamicFunctionSymbol

All Implemented Interfaces:

IDynamicFunctionSymbol, IDynamicSymbol, IFunctionSymbol, IHasType, IReducedSymbol, ISymbol

Direct Known Subclasses:

DelegateFunctionSymbol, EnhancementDynamicFunctionSymbol, EnumAllValuesFunctionSymbol, EnumCodeFunctionSymbol, EnumDisplayNameFunctionSymbol, EnumNameFunctionSymbol, EnumOrdinalFunctionSymbol, EnumValueFunctionSymbol, EnumValueOfFunctionSymbol, EnumValuesFunctionSymbol, GosuObjectFunctionSymbol, InitConstructorFunctionSymbol, IntrinsicTypeFunctionSymbol, OuterFunctionSymbol, ParameterizedDynamicFunctionSymbol, ProgramClassFunctionSymbol, ProgramExecuteFunctionSymbol, SuperConstructorFunctionSymbol, TemplateRenderFunctionSymbol, ThisConstructorFunctionSymbol, VarPropertyGetFunctionSymbol, VarPropertySetFunctionSymbol

public class DynamicFunctionSymbol
extends AbstractDynamicSymbol
implements IDynamicFunctionSymbol

Represents a parsed function as specified in the Gosu spec.

Field Summary

Fields

Modifier and Type	Field	Description
private IExpression	_annotationDefault
private List<ISymbol>	_args
private boolean	_bLoopImplicitReturn
private FunctionStatement	_functionStmt
private MethodCallStatement	_initializer
private Object	_mi
private String	_strDisplayName
private DynamicFunctionSymbol	_superDfs
private static final Object	DEFINITION_CLEARED
private static final Object	NULL_MI

Fields inherited from class gw.internal.gosu.parser.AbstractDynamicSymbol

_scriptPartId, _symTable

Fields inherited from class gw.internal.gosu.parser.Symbol

_bGlobal, _iIndex, _stackProvider, _symbolTable, _value, MEMBER_STACK_PROVIDER

Fields inherited from interface gw.lang.parser.ISymbol

SUPER, THIS

Constructor Summary

Constructors

Modifier	Constructor	Description
	DynamicFunctionSymbol(DynamicFunctionSymbol dfs)
	DynamicFunctionSymbol(ISymbolTable symTable, CharSequence strName, IFunctionType type, List<ISymbol> args, IExpression value)	Constructs a DynamicFunctionSymbol for use with an IGosuParser's ISymbolTable.
	DynamicFunctionSymbol(ISymbolTable symTable, CharSequence strName, IFunctionType type, List<ISymbol> args, IStatement value)	Constructs a DynamicFunctionSymbol for use with an IGosuParser's ISymbolTable.
protected	DynamicFunctionSymbol(ISymbolTable symTable, CharSequence name, IFunctionType type, List<ISymbol> args, Object value)

Method Summary

Modifier and Type	Method	Description
void	clearDebugInfo()
void	clearDefn()	Used to remove definition compiled info from this class.
IReducedDynamicFunctionSymbol	createReducedSymbol()
private void	ensureDeclaringClassIsCompiled()
boolean	equals(Object o)
private IGosuClass	findGosuClassOrProgram(IParsedElement pe)
IExpression	getAnnotationDefault()
List<ISymbol>	getArgs()
IType[]	getArgTypes()
IDynamicFunctionSymbol	getBackingDfs()
protected String	getCannonicalName()
ITypeInfo	getDeclaringTypeInfo()
FunctionStatement	getDeclFunctionStmt()
String	getDisplayName()	Returns the Symbol's optional display name.
String	getFullDescription()
protected DynamicFunctionSymbol	getFunctionSymbol()
MethodCallStatement	getInitializer()
ISymbol	getLightWeightReference()	Creates a copy of this symbol without the value so that the empty symbol can be stored.
IAttributedFeatureInfo	getMethodOrConstructorInfo()
IAttributedFeatureInfo	getMethodOrConstructorInfo(boolean acceptNone)
String	getMethodSignature()
String	getParameterDisplay(boolean bRelative)
DynamicFunctionSymbol	getParameterizedVersion(IGosuClass gsClass)
IType	getReturnType()
String	getSignatureDescription()	Returns a description of arguments of the form ( < argName1 >, < argName2 >, etc.
protected String	getSignatureName(CharSequence strName)
static String	getSignatureName(CharSequence strName, List<ISymbol> args)
DynamicFunctionSymbol	getSuperDfs()
private static String	getUniqueNameForParameters(List<ISymbol> args)
int	hashCode()
boolean	hasOptionalParameters()
boolean	hasTypeVariables()
Object	invoke(Object[] args)	Invokes the dynamic function.
private Object	invokeFromBytecode(Object[] args)
boolean	isAbstract()
boolean	isClassMember()
boolean	isConstructor()
boolean	isFinal()
boolean	isLoopImplicitReturn()
boolean	isReified()
void	renameAsErrantDuplicate(int iIndex)
void	setAbstract(boolean bAbstract)
void	setAnnotationDefault(IExpression annotationDefault)
void	setArgs(List<ISymbol> args)
void	setDeclFunctionStmt(FunctionStatement declFunctionStmt)
protected void	setDisplayName(String strDisplayName)
void	setFinal(boolean bFinal)
void	setInitializer(MethodCallStatement initializer)
void	setLoopImplicitReturn(boolean bLoopImplicitReturn)
void	setSuperDfs(DynamicFunctionSymbol superDfs)
void	setValue(Object value)	Assigns a value to this Symbol.

Methods inherited from class gw.internal.gosu.parser.AbstractDynamicSymbol

assignIndex, getCompiledStatementDirectly, getGosuClass, getScriptPart, getSymbolTable, hasDynamicSymbolTable, isFromJava, isLocal, setDynamicSymbolTable, setScriptPart

Methods inherited from class gw.internal.gosu.parser.Symbol

assignIndexInStack, canBeCaptured, getAnnotations, getDefaultValueExpression, getDynamicSymbolTable, getIndex, getModifierInfo, getModifiers, getName, getSymbolClass, getType, getValue, getValueDirectly, isHide, isImplicitlyInitialized, isInternal, isOverride, isPrivate, isProtected, isPublic, isStackSymbol, isStatic, isValueBoxed, isWritable, makeCapturedSymbol, replaceModifierInfo, setClassMember, setDefaultValueExpression, setHide, setIndex, setInternal, setModifierInfo, setModifiers, setName, setOverride, setPrivate, setProtected, setPublic, setReified, setStatic, setType, setValueDirectly, setValueIsBoxed, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.lang.parser.IDynamicFunctionSymbol

getValueDirectly, isOverride, isStatic

Methods inherited from interface gw.lang.parser.IDynamicSymbol

getGosuClass, getScriptPart

Methods inherited from interface gw.lang.parser.IFunctionSymbol

getModifiers, isFromJava, isStackSymbol

Methods inherited from interface gw.lang.parser.IReducedSymbol

getAnnotations, getSymbolClass, getType, isInternal, isPrivate, isProtected, isPublic

Methods inherited from interface gw.lang.parser.ISymbol

canBeCaptured, getDefaultValueExpression, getDynamicSymbolTable, getIndex, getModifierInfo, getName, getType, getValue, hasDynamicSymbolTable, isLocal, isValueBoxed, isWritable, makeCapturedSymbol, setDefaultValueExpression, setDynamicSymbolTable, setType, setValueIsBoxed

Field Details

DEFINITION_CLEARED

private static final Object DEFINITION_CLEARED

NULL_MI

private static final Object NULL_MI

_strDisplayName

private String _strDisplayName

_args

private List<ISymbol> _args

_initializer

private MethodCallStatement _initializer

_functionStmt

private FunctionStatement _functionStmt

_superDfs

private DynamicFunctionSymbol _superDfs

_bLoopImplicitReturn

private boolean _bLoopImplicitReturn

_annotationDefault

private IExpression _annotationDefault

_mi

private volatile Object _mi

Constructor Details

DynamicFunctionSymbol

public DynamicFunctionSymbol(ISymbolTable symTable,
 CharSequence strName,
 IFunctionType type,
 List<ISymbol> args,
 IStatement value)

Constructs a DynamicFunctionSymbol for use with an IGosuParser's ISymbolTable.

Parameters:

symTable - The symbol table.

strName - The symbol name.

type - The IGosuParser specific type.

args - The symbols for the function's arguments (or null).

value - A statement for the body of the function (or null).

DynamicFunctionSymbol

public DynamicFunctionSymbol(ISymbolTable symTable,
 CharSequence strName,
 IFunctionType type,
 List<ISymbol> args,
 IExpression value)

Constructs a DynamicFunctionSymbol for use with an IGosuParser's ISymbolTable.

Parameters:

symTable - The symbol table.

strName - The symbol name.

type - The IGosuParser specific type.

args - The symbols for the function's arguments (or null).

value - An expression for the body of the function (or null).

DynamicFunctionSymbol

protected DynamicFunctionSymbol(ISymbolTable symTable,
 CharSequence name,
 IFunctionType type,
 List<ISymbol> args,
 Object value)

DynamicFunctionSymbol

public DynamicFunctionSymbol(DynamicFunctionSymbol dfs)

Method Details

renameAsErrantDuplicate

public void renameAsErrantDuplicate(int iIndex)

Overrides:

renameAsErrantDuplicate in class Symbol

getDisplayName

public String getDisplayName()

Description copied from class: Symbol

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

Overrides:

getDisplayName in class Symbol

setDisplayName

protected void setDisplayName(String strDisplayName)

getArgs

public List<ISymbol> getArgs()

Specified by:

getArgs in interface IDynamicFunctionSymbol

Returns:

The Symbols for the arguments to this function.

getArgTypes

public IType[] getArgTypes()

Specified by:

getArgTypes in interface IDynamicFunctionSymbol

getReturnType

public IType getReturnType()

Specified by:

getReturnType in interface IDynamicFunctionSymbol

invoke

public Object invoke(Object[] args)

Invokes the dynamic function.

Specified by:

invoke in interface IFunctionSymbol

Overrides:

invoke in class Symbol

Parameters:

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

invokeFromBytecode

private Object invokeFromBytecode(Object[] args)

ensureDeclaringClassIsCompiled

private void ensureDeclaringClassIsCompiled()

findGosuClassOrProgram

private IGosuClass findGosuClassOrProgram(IParsedElement pe)

getCannonicalName

protected String getCannonicalName()

Returns:

the canonical, generic name of this function

isClassMember

public boolean isClassMember()

Overrides:

isClassMember in class Symbol

clearDebugInfo

public void clearDebugInfo()

Overrides:

clearDebugInfo in class AbstractDynamicSymbol

isReified

public boolean isReified()

Specified by:

isReified in interface IReducedSymbol

Overrides:

isReified in class Symbol

isConstructor

public boolean isConstructor()

Specified by:

isConstructor in interface IDynamicFunctionSymbol

getSignatureDescription

public 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

Overrides:

getSignatureDescription in class Symbol

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

Specified by:

getLightWeightReference in class AbstractDynamicSymbol

getMethodSignature

public String getMethodSignature()

Specified by:

getMethodSignature in interface IDynamicFunctionSymbol

getSignatureName

public static String getSignatureName(CharSequence strName,
 List<ISymbol> args)

getSignatureName

protected String getSignatureName(CharSequence strName)

getParameterDisplay

public String getParameterDisplay(boolean bRelative)

Specified by:

getParameterDisplay in interface IDynamicFunctionSymbol

getUniqueNameForParameters

private static String getUniqueNameForParameters(List<ISymbol> args)

getFunctionSymbol

protected DynamicFunctionSymbol getFunctionSymbol()

setInitializer

public void setInitializer(MethodCallStatement initializer)

getInitializer

public MethodCallStatement getInitializer()

Specified by:

getInitializer in interface IDynamicFunctionSymbol

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface IReducedSymbol

Overrides:

isAbstract in class Symbol

setAbstract

public void setAbstract(boolean bAbstract)

Overrides:

setAbstract in class Symbol

isFinal

public boolean isFinal()

Specified by:

isFinal in interface IReducedSymbol

Overrides:

isFinal in class Symbol

setFinal

public void setFinal(boolean bFinal)

Overrides:

setFinal in class Symbol

getBackingDfs

public IDynamicFunctionSymbol getBackingDfs()

Specified by:

getBackingDfs in interface IDynamicFunctionSymbol

getMethodOrConstructorInfo

public IAttributedFeatureInfo getMethodOrConstructorInfo(boolean acceptNone)

Specified by:

getMethodOrConstructorInfo in interface IDynamicFunctionSymbol

getMethodOrConstructorInfo

public IAttributedFeatureInfo getMethodOrConstructorInfo()

Specified by:

getMethodOrConstructorInfo in interface IDynamicFunctionSymbol

getDeclaringTypeInfo

public ITypeInfo getDeclaringTypeInfo()

Specified by:

getDeclaringTypeInfo in interface IDynamicFunctionSymbol

getFullDescription

public String getFullDescription()

Specified by:

getFullDescription in interface IReducedSymbol

Overrides:

getFullDescription in class Symbol

setValue

public void setValue(Object value)

Description copied from class: Symbol

Assigns a value to this Symbol.

Specified by:

setValue in interface ISymbol

Overrides:

setValue in class Symbol

getDeclFunctionStmt

public FunctionStatement getDeclFunctionStmt()

Specified by:

getDeclFunctionStmt in interface IDynamicFunctionSymbol

setDeclFunctionStmt

public void setDeclFunctionStmt(FunctionStatement declFunctionStmt)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Symbol

getParameterizedVersion

public DynamicFunctionSymbol getParameterizedVersion(IGosuClass gsClass)

Specified by:

getParameterizedVersion in class AbstractDynamicSymbol

clearDefn

public void clearDefn()

Used to remove definition compiled info from this class.

setArgs

public void setArgs(List<ISymbol> args)

setSuperDfs

public void setSuperDfs(DynamicFunctionSymbol superDfs)

getSuperDfs

public DynamicFunctionSymbol getSuperDfs()

Specified by:

getSuperDfs in interface IDynamicFunctionSymbol

hasTypeVariables

public boolean hasTypeVariables()

Specified by:

hasTypeVariables in interface IReducedSymbol

Overrides:

hasTypeVariables in class AbstractDynamicSymbol

hasOptionalParameters

public boolean hasOptionalParameters()

createReducedSymbol

public IReducedDynamicFunctionSymbol createReducedSymbol()

Specified by:

createReducedSymbol in interface IDynamicFunctionSymbol

Specified by:

createReducedSymbol in interface ISymbol

Overrides:

createReducedSymbol in class Symbol

setLoopImplicitReturn

public void setLoopImplicitReturn(boolean bLoopImplicitReturn)

isLoopImplicitReturn

public boolean isLoopImplicitReturn()

getAnnotationDefault

public IExpression getAnnotationDefault()

setAnnotationDefault

public void setAnnotationDefault(IExpression annotationDefault)