Class ParamExpressionSymbol

java.lang.Object

org.ek9lang.compiler.symbols.Symbol

org.ek9lang.compiler.symbols.ParamExpressionSymbol

All Implemented Interfaces:

Serializable, ISymbol, ISymbolNature, ITokenReference

public class ParamExpressionSymbol
extends Symbol

While we don't add these in the scoped structures when compiling. We do use these to augment the parse tree for the appropriate context. We do this so that we can work out what type of result will be returned from an expression. For this call we need the order list of parameters specifically the types of those parameters.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParamExpressionSymbol(String name)

Method Summary

Modifier and Type	Method	Description
void	addParameter(ISymbol symbol)
ParamExpressionSymbol	clone(IScope withParentAsAppropriate)	Clone the symbol and re-parent if this symbol like a method should have a parent.
protected ParamExpressionSymbol	cloneIntoStreamPipeLineSymbol(ParamExpressionSymbol newCopy)
boolean	equals(Object o)	Two symbols are the same symbol when they agree on name, category, genus, mutability AND the declaration site they came from.
String	getFriendlyName()	Provide the name an end user would need to see on the screen.
List<ISymbol>	getParameters()
int	hashCode()	Mixes in exactly the fields Symbol.equals(Object) compares, and nothing else.

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, isMarkedPure, isMutable, isNullAllowed, isPromotionSupported, isReferenced, putSquirrelledData, setCategory, setEk9Core, setGenus, setInitialisedBy, setInjectionExpected, setMarkedPure, setName, setNotMutable, setNullAllowed, setParsedModule, setProduceFullyQualifiedName, setReferenced, setSourceToken, setType, toString

Methods inherited from class Object

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

Methods inherited from interface ISymbol

isDeclaredAsConstant, isExtensionOfInjectable, isFromLiteral, isIncomingParameter, isInitialised, isInjectable, isLoopVariable, isMarkedAbstract, isPrivate, isPropertyField, isProtected, isPublic, isReturningParameter, setType

Methods inherited from interface ISymbolNature

isApplication, isConceptualTypeParameter, isConstant, isControl, isFunction, isGenericInNature, isMethod, isParameterisedType, isPrimitiveType, isTemplateFunction, isTemplateType, isType, isVariable

Constructor Details

ParamExpressionSymbol

public ParamExpressionSymbol(String name)

Method Details

addParameter

public void addParameter(ISymbol symbol)

clone

public ParamExpressionSymbol 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 ISymbol

Overrides:

clone in class Symbol

cloneIntoStreamPipeLineSymbol

protected ParamExpressionSymbol cloneIntoStreamPipeLineSymbol(ParamExpressionSymbol newCopy)

getParameters

public List<ISymbol> getParameters()

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 Symbol

Returns:

a user presentable of the symbol name.

equals

public boolean equals(Object o)

Description copied from class: Symbol

Two symbols are the same symbol when they agree on name, category, genus, mutability AND the declaration site they came from.

The source token is part of identity deliberately. Name alone is not enough: symbol names are unqualified here, so two unrelated variables both called count, or two types called Foo in different modules, would otherwise compare equal. The compiler relies on telling those apart - CodeFlowMap keys initialisation state on Map<IScope, Map<ISymbol, SymbolAccess>>, and conflating two same-named declarations there makes flow analysis attribute one variable's initialisation to another.

That distinction used to be present ONLY in Symbol.hashCode(), which is why this looked like it worked: two same-named symbols compared equal yet hashed apart, so hash collections usually - but not reliably - kept them separate, while any direct equals call saw them as one. Encoding it here makes the two agree. See SymbolEqualsHashCodeContractTest.

Overrides:

equals in class Symbol

hashCode

public int hashCode()

Description copied from class: Symbol

Mixes in exactly the fields Symbol.equals(Object) compares, and nothing else.

A hashCode may legitimately use FEWER fields than equals (that only causes collisions, which are correct), but never MORE: any extra field makes two symbols that compare equal land in different buckets, so a HashSet silently holds visible duplicates and a HashMap lookup misses an entry that is present. This method used to mix in purity, which no equals at THIS level consults - purity belongs in FunctionSymbol, the level whose equals compares it. The source token stays, and is now matched by Symbol.equals(Object). See SymbolEqualsHashCodeContractTest.

Overrides:

hashCode in class Symbol