Class CallSymbol

java.lang.Object

org.ek9lang.compiler.symbols.Symbol

org.ek9lang.compiler.symbols.ScopedSymbol

org.ek9lang.compiler.symbols.MethodSymbol

org.ek9lang.compiler.symbols.CallSymbol

All Implemented Interfaces:

Serializable, IMayReturnSymbol, IScope, IScopedSymbol, ISymbol, ISymbolNature, ITokenReference

public class CallSymbol
extends MethodSymbol

Just re-uses the bulk of method symbol for when we want to make a symbol that is a call to an actual method. This will be used to build up the sort of call we want to make based on the source . We then have to resolve this CallSymbol against a real method symbol.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface IScope

IScope.ScopeType

Constructor Summary

Constructors

Constructor	Description
CallSymbol(String name, IScope enclosingScope)

Method Summary

Modifier and Type	Method	Description
CallSymbol	clone(IScope withParentAsAppropriate)	Clone the symbol and re-parent if this symbol like a method should have a parent.
protected CallSymbol	cloneIntoCallSymbol(CallSymbol newCopy)
boolean	equals(Object o)
String	getFriendlyName()	Provide the name an end user would need to see on the screen.
String	getFriendlyScopeName()	Useful for printing out errors and information.
ScopedSymbol	getResolvedSymbolToCall()
VariableSymbol	getReturningSymbol()	Provide a symbol that is returned from this method.
int	hashCode()
boolean	isFormOfDeclarationCall()
boolean	isReturningSymbolPresent()	Some methods have a named return symbol 'like rtn as String' for example.
void	setFormOfDeclarationCall(boolean formOfDeclarationCall)
void	setResolvedSymbolToCall(ScopedSymbol symbol)	Set the actual method/function that should be called.

Methods inherited from class MethodSymbol

clone, cloneIntoMethodSymbol, copyMethodProperties, doGetFriendlyName, getAccessModifier, getCallParameters, getParentScope, getUsedAsProxyForDelegate, isConstant, isConstructor, isEk9ReturnsThis, isExactSignatureMatchTo, isMarkedAbstract, isMarkedAsDispatcher, isMarkedNoClone, isNotConstructor, isNotMarkedAbstract, isNotOperator, isOperator, isOverride, isParameterSignatureMatchTo, isPrivate, isProtected, isPublic, isSignatureMatchTo, isSynthetic, isUsedAsProxyForDelegate, justSetReturningSymbol, resolve, resolveInThisScopeOnly, setAccessModifier, setCallParameters, setConstructor, setEk9ReturnsThis, setMarkedAbstract, setMarkedAsDispatcher, setMarkedNoClone, setOperator, setOverride, setReturningSymbol, setSynthetic, setUsedAsProxyForDelegate, toString

Methods inherited from class ScopedSymbol

cloneIntoScopeSymbol, copyScopedSymbolProperties, define, findNearestDynamicBlockScopeInEnclosingScopes, findNearestNonBlockScopeInEnclosingScopes, getActualScope, getAllSymbolsMatchingName, getAnySuperTypeOrFunction, getEnclosingScope, getEncounteredExceptionToken, getOuterMostTypeOrFunction, getScopeName, getScopeType, getSymbolsForThisScope, isMarkedPure, isMutable, isNotMarkedPure, isScopeAMatchForEnclosingScope, isTerminatedNormally, resolveMatchingMethods, resolveMatchingMethodsInThisScopeOnly, resolveMember, resolveWithParentScope, setEncounteredExceptionToken, setMarkedPure, setOuterMostTypeOrFunction, setScopeType

Methods inherited from class Symbol

clearInitialisedBy, cloneIntoSymbol, copySymbolProperties, getAssignableCostTo, getAssignableCostTo, getCategory, getFullyQualifiedName, getGenus, getInitialisedBy, getName, getParsedModule, getProduceFullyQualifiedName, getSourceToken, getSquirrelledData, getSymbolTypeAsString, getType, getUnCoercedAssignableCostTo, isAssignableTo, isAssignableTo, isDevSource, isEk9Core, isExactSameType, isInjectionExpected, isLibSource, isNullAllowed, isPromotionSupported, isReferenced, putSquirrelledData, setCategory, setEk9Core, setGenus, setInitialisedBy, setInjectionExpected, setName, setNotMutable, setNullAllowed, setParsedModule, setProduceFullyQualifiedName, setReferenced, setSourceToken, setType

Methods inherited from class Object

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

Methods inherited from interface ISymbol

clearInitialisedBy, getAssignableCostTo, getAssignableCostTo, getFullyQualifiedName, getInitialisedBy, getName, getParsedModule, getSourceToken, getSquirrelledData, getType, getUnCoercedAssignableCostTo, isAssignableTo, isAssignableTo, isDeclaredAsConstant, isDevSource, isExactSameType, isExtensionOfInjectable, isFromLiteral, isIncomingParameter, isInitialised, isInjectable, isInjectionExpected, isLibSource, isLoopVariable, isNullAllowed, isPromotionSupported, isPropertyField, isReferenced, isReturningParameter, putSquirrelledData, setInitialisedBy, setInjectionExpected, setName, setNotMutable, setNullAllowed, setParsedModule, setReferenced, setType, setType

Methods inherited from interface ISymbolNature

getCategory, getGenus, isApplication, isConceptualTypeParameter, isControl, isEk9Core, isFunction, isGenericInNature, isMethod, isParameterisedType, isPrimitiveType, isTemplateFunction, isTemplateType, isType, isVariable, setGenus

Methods inherited from interface ITokenReference

setSourceToken

Constructor Details

CallSymbol

public CallSymbol(String name,
 IScope enclosingScope)

Method Details

isFormOfDeclarationCall

public boolean isFormOfDeclarationCall()

setFormOfDeclarationCall

public void setFormOfDeclarationCall(boolean formOfDeclarationCall)

clone

public CallSymbol clone(IScope withParentAsAppropriate)

Description copied from interface: ISymbol

Clone the symbol and re-parent if this symbol like a method should have a parent. Other symbols like VariableSymbols are un-parented

Specified by:

clone in interface IScope

Specified by:

clone in interface IScopedSymbol

Specified by:

clone in interface ISymbol

Overrides:

clone in class MethodSymbol

cloneIntoCallSymbol

protected CallSymbol cloneIntoCallSymbol(CallSymbol newCopy)

getResolvedSymbolToCall

public ScopedSymbol getResolvedSymbolToCall()

setResolvedSymbolToCall

public void setResolvedSymbolToCall(ScopedSymbol symbol)

Set the actual method/function that should be called.

isReturningSymbolPresent

public boolean isReturningSymbolPresent()

Description copied from class: MethodSymbol

Some methods have a named return symbol 'like rtn as String' for example. In other cases a method will not return anything (We use 'Void') in the case as the 'type'. So when a Returning Symbol is set we use the type of the returning variable as the type return on the method.

Specified by:

isReturningSymbolPresent in interface IMayReturnSymbol

Overrides:

isReturningSymbolPresent in class MethodSymbol

getReturningSymbol

public VariableSymbol getReturningSymbol()

Description copied from class: MethodSymbol

Provide a symbol that is returned from this method. Note in EK9 this is not just a type but actually a variable symbol (that has a type).

Specified by:

getReturningSymbol in interface IMayReturnSymbol

Overrides:

getReturningSymbol in class MethodSymbol

getFriendlyScopeName

public String getFriendlyScopeName()

Description copied from interface: IScope

Useful for printing out errors and information. The scope name might be a complex generated name used internally a bit like symbol names are. So some items are both scopes and symbols - so ideally we'd want to use a friendly name where possible.

Specified by:

getFriendlyScopeName in interface IScope

Overrides:

getFriendlyScopeName in class ScopedSymbol

Returns:

The friendly name to be used for the developer.

getFriendlyName

public String getFriendlyName()

Description copied from interface: ISymbol

Provide the name an end user would need to see on the screen. Normally this is just 'getName' but in the case of Templates We use a very nasty internal naming for List of SomeClass - which will probably be something like _List_hashed_version_of_ComeClass and the end user needs to see 'List of SomeClass' for it to be meaningful.

Specified by:

getFriendlyName in interface ISymbol

Overrides:

getFriendlyName in class MethodSymbol

Returns:

a user presentable of the symbol name.

equals

public boolean equals(Object o)

Overrides:

equals in class MethodSymbol

hashCode

public int hashCode()

Overrides:

hashCode in class MethodSymbol