Class AggregateWithTraitsSymbol

java.lang.Object

org.ek9lang.compiler.symbols.Symbol

org.ek9lang.compiler.symbols.ScopedSymbol

org.ek9lang.compiler.symbols.CaptureScopedSymbol

org.ek9lang.compiler.symbols.PossibleGenericSymbol

org.ek9lang.compiler.symbols.AggregateSymbol

org.ek9lang.compiler.symbols.AggregateWithTraitsSymbol

All Implemented Interfaces:

Serializable, IAggregateSymbol, ICanBeGeneric, ICanCaptureVariables, IScope, IScopedSymbol, ISymbol, ISymbolNature, ITokenReference

public class AggregateWithTraitsSymbol
extends AggregateSymbol

An aggregate, but one that can have zero or more traits (like interfaces).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface IScope

IScope.ScopeType

Constructor Summary

Constructors

Constructor	Description
AggregateWithTraitsSymbol(String name, Optional<ISymbol> type, IScope enclosingScope)
AggregateWithTraitsSymbol(String name, IScope enclosingScope)

Method Summary

Modifier and Type	Method	Description
void	addAllowedExtender(IAggregateSymbol extenderSymbol)	For use with constraining types to be limited to a declared set.
void	addTrait(AggregateWithTraitsSymbol traitSymbol)	mark this aggregate as having additional 'trait'.
AggregateWithTraitsSymbol	clone(IScope withParentAsAppropriate)	Clone the symbol and re-parent if this symbol like a method should have a parent.
protected AggregateWithTraitsSymbol	cloneIntoAggregateWithTraitsSymbol(AggregateWithTraitsSymbol 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.
List<MethodSymbol>	getAllAbstractMethods()	Gets all abstract methods in this aggregate and any super classes.
List<MethodSymbol>	getAllEffectiveMethods()	Gets all methods that are effective, by this I mean if supers (classes or traits) have the same method name but, it has been overridden then we would only retain the 'overridden' one as that has taken effect.
List<AggregateWithTraitsSymbol>	getAllExtensionConstrainedTraits()	Gets all sealed ancestors (traits AND super classes) that have extension constraints.
List<MethodSymbol>	getAllMethods()	Get all methods on this and any supers or traits.
List<MethodSymbol>	getAllNonAbstractMethods()	Get all methods not marked as abstract in this or any supers.
List<IAggregateSymbol>	getAllowedExtenders()
List<ISymbol>	getAllSymbolsMatchingName(String symbolName)	Return a list of all the symbols that match the name.
List<AggregateWithTraitsSymbol>	getAllTraits()	Get all the traits this aggregate implements - this means all the traits any of these traits extends.
double	getAssignableCostTo(ISymbol s)
List<IAggregateSymbol>	getTraits()	Get the traits that this aggregates implements.
double	getUnCoercedAssignableCostTo(ISymbol s)
int	hashCode()	Mixes in exactly the fields Symbol.equals(Object) compares, and nothing else.
boolean	hasImmediateTrait(IAggregateSymbol trait)	Does this aggregate have the trait passed in as an immediate trait.
boolean	isAllowingExtensionBy(IAggregateSymbol extenderSymbol)	Is the extender allowed to implement this aggregate (normally a trait).
boolean	isExtensionConstrained()
boolean	isImplementingInSomeWay(IAggregateSymbol traitSymbol)	Only really used by aggregates that can have one or more traits.
MethodSymbolSearchResult	resolveMatchingMethods(MethodSymbolSearch search, MethodSymbolSearchResult result)	Looks in scope and parent scopes.
Optional<ISymbol>	resolveMember(SymbolSearch search)	Just try and resolve a member in this or super scopes.
Optional<ISymbol>	resolveWithParentScope(SymbolSearch search)	Resolve using super aggregate and or any traits we have.

Methods inherited from class AggregateSymbol

addBlockCallEntry, addInjectionField, addRegistration, addTraitsIfNotPresent, cloneIntoAggregateSymbol, define, getAggregateDescription, getAllAbstractMethodsInThisScopeOnly, getAllMethodInThisScopeOnly, getAllNonAbstractMethodsInThisScopeOnly, getAllOperators, getAnySuperTypeOrFunction, getApplication, getBlockCallEntries, getConstraint, getConstructors, getFriendlyName, getInjectionFields, getPipeSinkType, getPipeSourceType, getProperties, getRegistrations, getSuperAggregate, getType, hasImmediateSuper, isExtensionOfInjectable, isInAggregateHierarchy, isInjectable, isMarkedAsDispatcher, methodNotPresent, methodsMatch, setAggregateDescription, setApplication, setConstraint, setInjectable, setMarkedAsDispatcher, setPipeSinkType, setPipeSourceType, setSuperAggregate, setSuperAggregate, setType

Methods inherited from class PossibleGenericSymbol

addGenericSymbolReference, addTypeParameterOrArgument, cloneIntoPossibleGenericSymbol, getAnyConceptualTypeParameters, getAnyGenericParamsAsFriendlyNames, getDefinitionContext, getGenericSymbolReferences, getGenericType, getTypeParameterOrArguments, isConceptualTypeParameter, isGenericInNature, isOpenForExtension, isParameterisedType, resolve, resolveFromParameterTypes, resolveInThisScopeOnly, setConceptualTypeParameter, setDefinitionContext, setGenericType, setGenericType, setOpenForExtension

Methods inherited from class CaptureScopedSymbol

cloneIntoCaptureScopedSymbol, getCapturedVariables, getModuleScope, getPrivateVariablesForDisplay, isMarkedAbstract, resolveExcludingCapturedVariables, setCapturedVariables, setCapturedVariables, setCapturedVariablesVisibility, setMarkedAbstract, setModuleScope

Methods inherited from class ScopedSymbol

cloneIntoScopeSymbol, copyScopedSymbolProperties, findNearestDynamicBlockScopeInEnclosingScopes, findNearestNonBlockScopeInEnclosingScopes, getActualScope, getEnclosingScope, getEncounteredExceptionToken, getFriendlyScopeName, getOuterMostTypeOrFunction, getScopeName, getScopeType, getSymbolsForThisScope, isMarkedPure, isMutable, isNotMarkedPure, isScopeAMatchForEnclosingScope, isTerminatedNormally, resolveMatchingMethodsInThisScopeOnly, setEncounteredExceptionToken, setMarkedPure, setOuterMostTypeOrFunction, setScopeType

Methods inherited from class Symbol

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

Methods inherited from class Object

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

Methods inherited from interface IAggregateSymbol

getName, getScopeType

Methods inherited from interface ICanBeGeneric

addGenericSymbolReference, addTypeParameterOrArgument, getAnyConceptualTypeParameters, getGenericSymbolReferences, getGenericType, getTypeParameterOrArguments, isOpenForExtension

Methods inherited from interface IScope

findNearestDynamicBlockScopeInEnclosingScopes, findNearestNonBlockScopeInEnclosingScopes, getEnclosingScope, getEncounteredExceptionToken, getFriendlyScopeName, getScopeName, getSymbolsForThisScope, isMarkedPure, isScopeAMatchForEnclosingScope, isTerminatedNormally, resolve, resolveInThisScopeOnly, resolveMatchingMethodsInThisScopeOnly, setEncounteredExceptionToken

Methods inherited from interface ISymbol

clearInitialisedBy, getAssignableCostTo, getFullyQualifiedName, getInitialisedBy, getParsedModule, getSourceToken, getSquirrelledData, isAssignableTo, isAssignableTo, isDeclaredAsConstant, isDevSource, isExactSameType, isFromLiteral, isIncomingParameter, isInitialised, isInjectionExpected, isLibSource, isLoopVariable, isMarkedAbstract, isMarkedPure, isMutable, isNullAllowed, isPrivate, isPromotionSupported, isPropertyField, isProtected, isPublic, isReferenced, isReturningParameter, putSquirrelledData, setInitialisedBy, setInjectionExpected, setName, setNotMutable, setNullAllowed, setParsedModule, setReferenced, setType

Methods inherited from interface ISymbolNature

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

Methods inherited from interface ITokenReference

setSourceToken

Constructor Details

AggregateWithTraitsSymbol

public AggregateWithTraitsSymbol(String name,
 IScope enclosingScope)

AggregateWithTraitsSymbol

public AggregateWithTraitsSymbol(String name,
 Optional<ISymbol> type,
 IScope enclosingScope)

Method Details

cloneIntoAggregateWithTraitsSymbol

protected AggregateWithTraitsSymbol cloneIntoAggregateWithTraitsSymbol(AggregateWithTraitsSymbol newCopy)

addTrait

public void addTrait(AggregateWithTraitsSymbol traitSymbol)

mark this aggregate as having additional 'trait'.

hasImmediateTrait

public boolean hasImmediateTrait(IAggregateSymbol trait)

Does this aggregate have the trait passed in as an immediate trait. i.e. one it implements itself. Note this is different from being compatible with the trait via hierarchy!

Parameters:

trait - The trait to check.

Returns:

true if it does false otherwise.

addAllowedExtender

public void addAllowedExtender(IAggregateSymbol extenderSymbol)

For use with constraining types to be limited to a declared set.

getAllowedExtenders

public List<IAggregateSymbol> getAllowedExtenders()

isAllowingExtensionBy

public boolean isAllowingExtensionBy(IAggregateSymbol extenderSymbol)

Is the extender allowed to implement this aggregate (normally a trait).

Parameters:

extenderSymbol - The class (normally the one we are testing)

Returns:

true if extending is allowed.

getAllSymbolsMatchingName

public List<ISymbol> getAllSymbolsMatchingName(String symbolName)

Description copied from interface: IScope

Return a list of all the symbols that match the name. So for class and traits this must include supers and traits.

Specified by:

getAllSymbolsMatchingName in interface IScope

Overrides:

getAllSymbolsMatchingName in class AggregateSymbol

clone

public AggregateWithTraitsSymbol 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 IAggregateSymbol

Specified by:

clone in interface IScope

Specified by:

clone in interface IScopedSymbol

Specified by:

clone in interface ISymbol

Overrides:

clone in class AggregateSymbol

getUnCoercedAssignableCostTo

public double getUnCoercedAssignableCostTo(ISymbol s)

Specified by:

getUnCoercedAssignableCostTo in interface ISymbol

Overrides:

getUnCoercedAssignableCostTo in class AggregateSymbol

getAssignableCostTo

public double getAssignableCostTo(ISymbol s)

Specified by:

getAssignableCostTo in interface ISymbol

Overrides:

getAssignableCostTo in class Symbol

isImplementingInSomeWay

public boolean isImplementingInSomeWay(IAggregateSymbol traitSymbol)

Description copied from interface: IAggregateSymbol

Only really used by aggregates that can have one or more traits. But also super classes or super traits. So can either be implementing directly, super, super - super or traits and supe traits.

Specified by:

isImplementingInSomeWay in interface IAggregateSymbol

Overrides:

isImplementingInSomeWay in class AggregateSymbol

getTraits

public List<IAggregateSymbol> getTraits()

Get the traits that this aggregates implements.

Returns:

The list of traits.

getAllExtensionConstrainedTraits

public List<AggregateWithTraitsSymbol> getAllExtensionConstrainedTraits()

Gets all sealed ancestors (traits AND super classes) that have extension constraints. Walks the full trait hierarchy AND the super class chain to find all ancestors where 'allow only' is declared. The caller checks whether this aggregate is permitted.

getAllTraits

public List<AggregateWithTraitsSymbol> getAllTraits()

Get all the traits this aggregate implements - this means all the traits any of these traits extends. But also going up the class supers and getting those traits and any of the traits they extend.

Specified by:

getAllTraits in interface IAggregateSymbol

Overrides:

getAllTraits in class AggregateSymbol

getAllEffectiveMethods

public List<MethodSymbol> getAllEffectiveMethods()

Description copied from interface: IAggregateSymbol

Gets all methods that are effective, by this I mean if supers (classes or traits) have the same method name but, it has been overridden then we would only retain the 'overridden' one as that has taken effect. In the case of a trait that has multiple traits where the same method has been overridden in the trait only one method is now in effect. However, if there are multiple traits (or a super has the same method name) we would end up with 'duplicate' methods of the same name in this list 'CheckConflictingMethods' will need to detect this.

Specified by:

getAllEffectiveMethods in interface IAggregateSymbol

Overrides:

getAllEffectiveMethods in class AggregateSymbol

Returns:

A List of methods that are in effect.

getAllMethods

public List<MethodSymbol> getAllMethods()

Description copied from interface: IAggregateSymbol

Get all methods on this and any supers or traits.

Specified by:

getAllMethods in interface IAggregateSymbol

Overrides:

getAllMethods in class AggregateSymbol

Returns:

the list

getAllAbstractMethods

public List<MethodSymbol> getAllAbstractMethods()

Gets all abstract methods in this aggregate and any super classes.

Specified by:

getAllAbstractMethods in interface IAggregateSymbol

Overrides:

getAllAbstractMethods in class AggregateSymbol

Returns:

A list of all the methods marked as abstract.

isExtensionConstrained

public boolean isExtensionConstrained()

getAllNonAbstractMethods

public List<MethodSymbol> getAllNonAbstractMethods()

Description copied from interface: IAggregateSymbol

Get all methods not marked as abstract in this or any supers.

Specified by:

getAllNonAbstractMethods in interface IAggregateSymbol

Overrides:

getAllNonAbstractMethods in class AggregateSymbol

Returns:

The list.

resolveMatchingMethods

public MethodSymbolSearchResult resolveMatchingMethods(MethodSymbolSearch search,
 MethodSymbolSearchResult result)

Description copied from interface: IScope

Looks in scope and parent scopes.

Specified by:

resolveMatchingMethods in interface IAggregateSymbol

Specified by:

resolveMatchingMethods in interface IScope

Overrides:

resolveMatchingMethods in class AggregateSymbol

resolveMember

public Optional<ISymbol> resolveMember(SymbolSearch search)

Description copied from class: AggregateSymbol

Just try and resolve a member in this or super scopes.

Specified by:

resolveMember in interface IAggregateSymbol

Specified by:

resolveMember in interface IScope

Overrides:

resolveMember in class AggregateSymbol

resolveWithParentScope

public Optional<ISymbol> resolveWithParentScope(SymbolSearch search)

Resolve using super aggregate and or any traits we have. Look in our traits first then go to the normal AggregateSymbol resolution.

Overrides:

resolveWithParentScope in class ScopedSymbol

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 AggregateSymbol

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 AggregateSymbol