Uses of Interface
org.ek9lang.compiler.symbols.ISymbol
Packages that use ISymbol
Package
Description
B - For the EK9 compiler itself.
Common parts of processing that can be reused across various phases.
The directives are really aimed at helping the creation of the EK9 language, but they
maybe very useful in the early stages of adoption of EK9 (should there be any).
IR Instruction Classes - The instruction set for EK9 intermediate representation.
IR Support Utilities - Helper classes for IR generation and processing.
E - Initial Symbol definition by traversing the 'ANTLR' - 'AST'.
F - Resolution of Explicitly Defined Type Symbols - at this point phase3 processing should have defined
most of the explicitly defined symbols, so they should be resolvable.
G - Full Symbol Resolution can now take place.
H - Generic/Parameterised types can have their methods checked when used in specific contexts.
I - PRE Intermediate Representation generation checks.
Call graph infrastructure for EK9 compiler static analysis.
Data model for slice-2 deadlock detection analysis results.
K - Intermediate Representation Generation.
Synthetic operator and method generation for EK9.
Support classes for synthetic operator IR generation.
M - Intermediate Representation Analysis and Optimization.
Used primarily to hold structures that are related to searching for symbols.
Contains critical general components used in the
Ek9Compiler listeners.THE reading of EK9 literals - one class per question, each held as an instance by the class that asks.
THE reading of a statement that stores the object in one of its OWN properties -
me: this,
next := this, this.owner :=? this - a property of the object's own type that refers back to it
(StoredProperty).THE classification of stream stages by what they need from the stream - use these classes, never a list of stage
tokens of your own.
This is the main source of EK9 Symbols used within the compiler.
-
Uses of ISymbol in org.ek9lang.compiler
Classes in org.ek9lang.compiler that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classFind the ISymbol at a given token position by traversing the parse tree.Methods in org.ek9lang.compiler that return ISymbolModifier and TypeMethodDescriptionParsedModule.getRecordedSymbol(org.antlr.v4.runtime.tree.ParseTree node) Locate and return a recorded symbol against part of the parse tree, this may return null if nothing has been recorded.ParsedModuleTransientData.getRecordedSymbol(org.antlr.v4.runtime.tree.ParseTree node) Locate and return a recorded symbol against part of the parse tree, this may return null if nothing has been recorded.Methods in org.ek9lang.compiler that return types with arguments of type ISymbolModifier and TypeMethodDescriptionParseTreeSymbolLocator.apply(CompilableSource source, IToken targetToken) ParsedModule.locateSymbolAtToken(CompilableSource source, IToken targetToken) Locate a symbol at a specific token position in the source.CompilableProgram.resolveByFullyQualifiedSearch(SymbolSearch search) Resolve some symbol via a fully qualified search.CompilableProgram.resolveFromImplicitScopes(SymbolSearch search) Search in the implicit ek9 module namespaces of: org.ek9.lang etc.CompilableProgram.resolveFromModule(String moduleName, SymbolSearch search) A package name (moduleName) can actually have multiple parsedModules (i.e.CompilableProgram.resolveReferenceFromModule(String moduleName, SymbolSearch search) Check the existing set of references in the moduleName.Methods in org.ek9lang.compiler with parameters of type ISymbolModifier and TypeMethodDescriptionvoidParsedModule.recordSymbol(org.antlr.v4.runtime.tree.ParseTree node, ISymbol symbol) Record a particular node context with a particular symbol.voidParsedModuleTransientData.recordSymbol(org.antlr.v4.runtime.tree.ParseTree node, ISymbol symbol, Module module) Record a particular node context with a particular symbol. -
Uses of ISymbol in org.ek9lang.compiler.common
Classes in org.ek9lang.compiler.common that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classTest if a symbol is a BARE-defaulted operator, i.e.final classChecks if a symbol should be tracked as a closeable resource.final classThe exit code a test DECLARED with"EXIT:<n>", or null when it declared none (IsTestProgramhas the encoding contract).final classTHE test that an operator was written asdefault operator X(or added by the baredefault operator): theDEFAULTEDsquirrel, so the compiler wrote its body.final classThe exit code a test program must end with for the test to pass: the one it declared with"EXIT:<n>"(DeclaredTestExitCodeOf), else 0.final classTest if a symbol is externally implemented.final classTest if a (generic base function) symbol is forward-target dispatched: the closed set of extern abstract function types a built-in invokes through the erased base_call(Any...)path with the argument held RAW —MutexKey(viaMutexLock.enter) andComparator(viaPriorityQueue.withComparator/Ek9Sort).final classTHE test that a symbol has no type because the expression it was declared from is already reported (E-7): its readers stay silent rather than adding a 'type not resolved' for every later use.final classTHE test for "is this type EXTERNALLY LINKED?" - whatCallDetails.isExternTargetstates (Steve, 2026-10-28: "extern should be externally linked in some way; defaulted/synthetic methods are not external").final classTHE answer to "is this a@Testprogram?" (and, with its siblings, what execution group it is in) — use this, do not read the squirrelled key directly.final classWhether this symbol is a test program or a method declared inside one (IsTestProgramhas the encoding contract).final classAccess the Symbol for the lhs of the preflow statement.final classChecks for a type is resolved and is suitable genus and category.final classFunction that extracts signature-qualified-name from a symbol.final classJust gets the type from a symbol, or throws a compiler exception if missing.final classThe sequential execution group a test belongs to (IsTestProgramhas the encoding contract).final classExtracts the fully qualified type name from the symbol.final classTHE reading of "was this variable, property or returning variable declared with NO value" - theUNINITIALISED_AT_DECLARATIONsquirrel that phase 1 sets onname as Type?(and phase 3 on a synthesised returning variable).final classTHE test that a symbol is a PROPERTY declared with no value, so every access to it is questionable until a constructor (or a guard) has set it: aVariableSymbolthat is a property field andUninitialisedAtDeclaration.final classChecks if a variable should be processed as a possible uninitialised variable.Methods in org.ek9lang.compiler.common that return ISymbolModifier and TypeMethodDescriptionLhsFromPreFlowOrError.apply(EK9Parser.PreFlowStatementContext ctx) TypedSymbolAccess.getRecordedAndTypedSymbol(org.antlr.v4.runtime.tree.ParseTree node) Gets any symbol associated with this node.SymbolsAndScopes.getRecordedSymbol(org.antlr.v4.runtime.tree.ParseTree node) TypeNameOrException.typeSymbolOf(ISymbol symbol) THE type SYMBOL whose fully qualified nameTypeNameOrException.apply(ISymbol)emits - deliberately the same returning-symbol rule, yielding the symbol rather than its name.Methods in org.ek9lang.compiler.common that return types with arguments of type ISymbolModifier and TypeMethodDescriptionSuitableGenusOrError.apply(org.antlr.v4.runtime.ParserRuleContext ctx) HasRealOperator.declaredAt(IAggregateSymbol level) The operator this one LEVEL declares (not its supers or traits), if any.CodeFlowAnalyzer.getSymbolsNotMeetingAcceptableCriteria(IScope inScope) CodeFlowMap.getSymbolsNotMeetingAcceptableCriteria(IScope inScope) Just provide a list of variables that have not been marked as meeting acceptable criteria in the scope.SymbolsAndScopes.getSymbolsWithSafeAccess()The variables with at least one safe-access proof (ok(),error(),get(),next()) in the current scope, each once.SymbolsAndScopes.getUninitialisedVariables(IScope inScope) SymbolsAndScopes.resolveOrDefine(PossibleGenericSymbol parameterisedSymbol, SemanticErrorReporter errorListener) Resolve or define a parameterised type here.UnSafeGenericAccessAnalyzer.symbolsMeetingAcceptableCriteria(IScope inScope) The variables proven safe to access ininScope.CodeFlowMap.symbolsRecordedFrom(IScope inScope) The variables recorded in this scope or any scope enclosing it, nearest first and each once (by identity).TypeDefResolver.typeDefToSymbol(String typeDefinition) Use an ek9 parser to accept a String of a typeDef and convert to a symbol (if it can be found).Methods in org.ek9lang.compiler.common with parameters of type ISymbolModifier and TypeMethodDescriptionThe declared exit code.The group of the test.intExpectedTestExitCodeOf.applyAsInt(ISymbol symbol) The expected exit code.ClassModifierChangePredicate.canChange(ISymbol symbol, ClassModifierChangePredicate.Mode mode) VisibilityChangePredicate.canChangeTo(ISymbol member, String targetAccessModifier) booleanCodeFlowAnalyzer.doesSymbolMeetAcceptableCriteria(ISymbol identifierSymbol, IScope inScope) booleanCodeFlowMap.doesSymbolMeetAcceptableCriteria(ISymbol identifierSymbol, IScope inScope) Check if a variable meets the criteria of being acceptable.protected voidTypedSymbolAccess.emitTypeNotResolvedError(ISymbol symbol) voidSymbolsAndScopes.enterNewConstant(ISymbol symbol, org.antlr.v4.runtime.tree.ParseTree node, SymbolChecker symbolChecker) Create a new constant as declared in the constants section and records the symbol.voidSymbolsAndScopes.enterNewLiteral(ISymbol symbol, org.antlr.v4.runtime.tree.ParseTree node) For literals, we only record in the parsedModule.voidSymbolsAndScopes.enterNewSymbol(ISymbol symbol, org.antlr.v4.runtime.tree.ParseTree node) A new symbol has been encountered and is defined within the current scope in the scope stack and recorded in the parsedModule against the appropriate node.protected SymbolAccessCodeFlowMap.getSymbolAccessForVariable(ISymbol identifierSymbol, IScope fromScope) The access record of a variable in exactly this scope, made (from the enclosing scopes) when it is not there yet - so a change to it affects this scope and every scope later made inside it, never the enclosing ones.protected booleanTypedSymbolAccess.isAlreadyInError(ISymbol symbol) THE test that a symbol has no type because the expression it was declared from is already reported (E-7): its readers stay silent rather than adding a 'type not resolved' for every later use (IsAlreadyInError).booleanSymbolsAndScopes.isErrorResultAccessSafe(ISymbol identifierSymbol) booleanSymbolsAndScopes.isGetOptionalAccessSafe(ISymbol identifierSymbol) booleanSymbolsAndScopes.isInitialiserReplaced(ISymbol returningVariable, IScope inScope) True when every path to the end of the scope has given the returning variable a new value - the definite assignment E08050 asks of a returning variable with no initialiser, asked of one that has an initialiser - so the value it was declared with cannot be the one returned.booleanCloseableResourceToBeChecked.isManagedCloseableType(ISymbol type) THE 'is this a type whose values the compiler must see closed' predicate: an aggregate with acloseoperator that is not one of the global standard streams and not a bare type parameter (BareTypeParameter- a generic type that HAS type parameters is closeable when it has a close).booleanSymbolsAndScopes.isNextIteratorAccessSafe(ISymbol identifierSymbol) booleanSymbolsAndScopes.isOkResultAccessSafe(ISymbol identifierSymbol) protected booleanTypedSymbolAccess.isPureReassignmentDisallowed(ISymbol leftHandSideSymbol) THE purity half of E08100 (NO_PURE_REASSIGNMENT): true when a plain reassignment (:=) ofleftHandSideSymbolwould be refused here because the processing scope ispure.booleanSymbolsAndScopes.isSymbolAccessSafe(ISymbol identifierSymbol) true if identifier is safe to access.booleanSymbolsAndScopes.isSymbolAccessSafe(ISymbol identifierSymbol, IScope inScope) true if identifier is safe to access within the specified scope (rather than the current top scope).booleanSymbolsAndScopes.isVariableInitialised(ISymbol identifierSymbol) booleanSymbolsAndScopes.isVariableInitialised(ISymbol identifierSymbol, IScope inScope) voidSymbolsAndScopes.markErrorResultAccessSafe(ISymbol identifierSymbol, IScope inScope) voidSymbolsAndScopes.markGetOptionalAccessSafe(ISymbol identifierSymbol, IScope inScope) voidSymbolsAndScopes.markNextIteratorAccessSafe(ISymbol identifierSymbol, IScope inScope) voidSymbolsAndScopes.markOkResultAccessSafe(ISymbol identifierSymbol, IScope inScope) voidSymbolsAndScopes.markSymbolAccessSafe(ISymbol identifierSymbol, IScope inScope) Record an identifier as being safe to access.voidSymbolsAndScopes.markSymbolAsInitialised(ISymbol identifierSymbol, IScope inScope) Record an identifier was initialised.voidCodeFlowAnalyzer.markSymbolAsMeetingAcceptableCriteria(ISymbol identifierSymbol, IScope inScope) voidCodeFlowMap.markSymbolAsMeetingAcceptableCriteria(ISymbol identifierSymbol, IScope inScope) Ensures that an identifier symbol is now marked as meeting the criteria of being acceptable.voidTypedSymbolAccess.recordATypedSymbol(ISymbol symbol, org.antlr.v4.runtime.tree.ParseTree node) Records a symbol against a node and also emits an error if its type has not been set.voidSymbolsAndScopes.recordDeclarationOfVariableUsingIterator(ISymbol identifierSymbol) voidSymbolsAndScopes.recordDeclarationOfVariableUsingOptional(ISymbol identifierSymbol) voidSymbolsAndScopes.recordDeclarationOfVariableUsingResult(ISymbol identifierSymbol) voidSymbolsAndScopes.recordInitialisedReturningVariable(ISymbol returningVariable) Follow a returning variable that was declared WITH a value: from here onSymbolsAndScopes.isInitialiserReplaced(ISymbol, IScope)says whether every path has since given it a new one.voidSymbolsAndScopes.recordInitialiserReplaced(ISymbol returningVariable) Record a plain assignment to a followed returning variable: on this path its declared value is replaced.voidCodeFlowAnalyzer.recordSymbol(ISymbol identifierSymbol, IScope inScope) voidCodeFlowMap.recordSymbol(ISymbol identifierSymbol, IScope inScope) Records a symbol against the specific scope if it is a variable to be analysed.voidSymbolsAndScopes.recordSymbol(ISymbol symbol, org.antlr.v4.runtime.tree.ParseTree node) Record a symbol against a specific node (so it can be looked up later).voidSymbolsAndScopes.recordSymbolAssignment(ISymbol identifierSymbol) Record an identifier was assigned and therefore initialised.voidSymbolsAndScopes.recordSymbolDeclaration(ISymbol identifierSymbol) Records a variable against the appropriate scope.voidSymbolsAndScopes.recordSymbolDeclaration(ISymbol identifierSymbol, IScope inScope) Record variable declaration against a specific scope.booleanbooleanbooleanbooleanbooleanbooleanbooleanIs the type externally linked.booleanWhether this symbol is itself a@Testprogram.booleanIs the symbol, or its enclosing aggregate, a test program.booleanTrue when the symbol was declared with no value: a property, local or returning variable thatname as Type?left unset.booleanbooleanTypeNameOrException.typeSymbolOf(ISymbol symbol) THE type SYMBOL whose fully qualified nameTypeNameOrException.apply(ISymbol)emits - deliberately the same returning-symbol rule, yielding the symbol rather than its name.booleanSuitableGenusOrError.validOrError(org.antlr.v4.runtime.ParserRuleContext ctx, ISymbol symbol) Checks a symbol that is already in hand (for example the type a call constructs), reporting at ctx.(package private) voidThe proof that the variable is safe to access no longer holds ininScope(nor in any scope made inside it from now on); the enclosing scopes are left as they are.voidSymbolsAndScopes.withdrawSafeAccess(ISymbol identifierSymbol, IScope inScope) Withdraw every safe-access proof (ok(),error(),get(),next()) the variable has ininScope, there and in every scope later made inside it: something that may change the container ran.Constructors in org.ek9lang.compiler.common with parameters of type ISymbolModifierConstructorDescriptionHasRealComparator(ISymbol ek9Any) HasRealOperator(ISymbol ek9Any, String operatorGlyph, boolean binary) Constructor parameters in org.ek9lang.compiler.common with type arguments of type ISymbolModifierConstructorDescriptionprotectedCodeFlowMap(Predicate<ISymbol> isVariableToBeChecked, Predicate<SymbolAccess> meetsCriteria, Consumer<SymbolAccess> markAsMeetingCriteria) SymbolTypeOrException(UnaryOperator<ISymbol> typeResolver) Create with a type resolver for Scenario 3 type parameter substitution.TypeNameOrException(Function<ISymbol, String> typeResolver) Create with a type resolver for Scenario 3 type parameter substitution. -
Uses of ISymbol in org.ek9lang.compiler.directives
Methods in org.ek9lang.compiler.directives with parameters of type ISymbolModifier and TypeMethodDescription(package private) FileDirectiveClassBytes.mainClassFile(CompilationEvent compilationEvent, ISymbol symbol) The main (non-dev) class file location for a symbol — used for the "not found" diagnostic.(package private) Optional<byte[]> DirectiveClassBytes.read(CompilationEvent compilationEvent, ISymbol symbol) The bytes for a symbol's generated class, using the dev-then-main lookup — but asking the sink rather than the filesystem.protected voidByteCodeDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidComplexityDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidCounterexampleDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidDebugDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective directive, ISymbol symbol) protected voidGenusDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidImplementsDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidInputVarietyDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidIRDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidNotResolvedDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective directive, ISymbol symbol) protected voidObligationsDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected abstract voidResolutionDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective directive, ISymbol symbol) protected voidResolvedDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective directive, ISymbol symbol) protected voidSquirrelledDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) protected voidVerifiedDirectiveListener.symbolMatch(CompilationEvent compilationEvent, ResolutionDirective resolutionDirective, ISymbol symbol) -
Uses of ISymbol in org.ek9lang.compiler.ir.instructions
Methods in org.ek9lang.compiler.ir.instructions that return ISymbolModifier and TypeMethodDescriptionField.getSymbol()Get the symbol representing this field.IRConstruct.getSymbol()OperationInstr.getSymbol()Methods in org.ek9lang.compiler.ir.instructions that return types with arguments of type ISymbolModifier and TypeMethodDescriptionIRConstruct.getImplementedTraits()IRConstruct.getSuperType()The single nominal super type this construct extends, resolved from the symbol's declared super (function super-chain, Scenario-2 wrapper base, or aggregate super).Methods in org.ek9lang.compiler.ir.instructions with parameters of type ISymbolModifier and TypeMethodDescriptionvoidIRConstruct.addImplementedTrait(ISymbol traitSymbol) booleanIRConstruct.isForSymbol(ISymbol toCheck) static FieldField.staticField(ISymbol symbol, String name, String typeName, DebugInfo debugInfo) Factory method for creating a static field (e.g., enum constants).Constructors in org.ek9lang.compiler.ir.instructions with parameters of type ISymbol -
Uses of ISymbol in org.ek9lang.compiler.ir.support
Classes in org.ek9lang.compiler.ir.support that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionclassExtracts call metadata from symbols for use in IR generation.Methods in org.ek9lang.compiler.ir.support with parameters of type ISymbolModifier and TypeMethodDescription -
Uses of ISymbol in org.ek9lang.compiler.phase1
Classes in org.ek9lang.compiler.phase1 that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classTypically used with programs.(package private) classIf any of its OWN methods is marked as 'dispatcher' then mark this class as a 'dispatcher'.(package private) final class(package private) classChecks that if the aggregate is a generic class that the appropriate public constructors are in place.Methods in org.ek9lang.compiler.phase1 that return ISymbolModifier and TypeMethodDescriptionConflictingTokens.symbol()Returns the value of thesymbolrecord component.Methods in org.ek9lang.compiler.phase1 with parameters of type ISymbolModifier and TypeMethodDescriptionvoidImplementationPresentOrError.accept(ISymbol aggregate, EK9Parser.MethodDeclarationContext ctx) voidvoidvoidConstructors in org.ek9lang.compiler.phase1 with parameters of type ISymbolModifierConstructorDescription(package private)ConflictingTokens(IToken tokenInError, IToken firstUse, ISymbol symbol) Creates an instance of aConflictingTokensrecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase2
Classes in org.ek9lang.compiler.phase2 that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classA generic type's inferring constructor must take exactly its type parameters, in the same order - that is what lets 'Box(21)' infer 'Box of Integer'.(package private) final classChecks HTTP Access for service operations because some require HTTP_SOURCE, but others do not support it.(package private) final classChecks that the variable supplied (if not null and has a type), does not have a type that is a genericTypeParameter.(package private) classFor Constrained Types, focus on checking it is possible to constrain the type and if so then clones the appropriate methods/operators over and alters the types as appropriate.(package private) final classValidates that the 'sanitized' keyword is used correctly: 1.(package private) final classChecks for a type is resolved and is suitable to be extended from (in basic terms).(package private) final classOnly types of a specific genus can be used as constraints on the generic type 'T'.(package private) final classChecks the PATH value (if this is a path parameter) and ensures that the name appears in the path itself on the operation.Methods in org.ek9lang.compiler.phase2 that return types with arguments of type ISymbolModifier and TypeMethodDescriptionSuitableToExtendOrError.apply(org.antlr.v4.runtime.ParserRuleContext ctx) Methods in org.ek9lang.compiler.phase2 with parameters of type ISymbolModifier and TypeMethodDescriptionvoidvoidvoidvoidPopulateConstrainedTypeOrError.accept(AggregateSymbol newType, ISymbol constrainedType) (package private) voidPopulateConstrainedTypeOrError.accept(AggregateSymbol newType, ISymbol constrainedType, boolean hasConstraint) voidbooleanbooleanValidPathParameterOrError.test(ServiceOperationSymbol operation, ISymbol param) -
Uses of ISymbol in org.ek9lang.compiler.phase3
Classes in org.ek9lang.compiler.phase3 that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classChecks the assignments for operator : := = and :=? that's all.(package private) final classE07187 (D24 Q4 REVISED, Steve 2026-10-20): the comparison coalescing operators<?and>?select one operand by<=>.(package private) classGiven a symbol, this check that the type that the symbol has can support the '<=>' operator.(package private) final classInside a constructor body, 'this' must not be passed as an argument to any NON-PURE call.(package private) classGiven a symbol, this check that the type that the symbol has can support the '--' operator.(package private) final classTHE text of a denied bare-name reference (CaptureEvaluationScope.deniesAccessTo(ParseTree, ISymbol)), the same at every site: what was named and where it is declared -reference to 'name' on line: N:.(package private) final classChecks that the symbol passed has a type and that the type is compatible with an EK9 Exception.(package private) final classAttempts to locate an Trait by name.(package private) final classGiven a 'type' (the IAggregateSymbol passed in), see it would be possible to iterator over it with some other type.(package private) classGiven a symbol, this check that the type that the symbol has can support the '#?' operator.(package private) final classUsed for pure identifier resolution and recording.(package private) final classEnsures that 'identifierReference' is now resolved and hangs together and is 'typed' or emit "not resolved" error.(package private) classGiven a symbol, this check that the type that the symbol has can support the '++' operator.(package private) final classTHE rule for what a condition may be: can a value of this type (first argument) be a condition, given the Boolean type (second argument) - a Boolean, or a type that promotes to Boolean with '#^'.(package private) final classTHE rule for what a condition may be: can a value of this type (first argument) be a condition, given the Boolean type (second argument) - a Boolean, or a type that promotes to Boolean with '#^'.(package private) classChecks if a type has the $ 'toString' method or a 'promotion' #^ to a String method.(package private) final classGiven a symbol, this check that the type that the symbol has can support the '?' operation.(package private) final classChecks if a symbol can be mutated, this is nothing to do with a pure context.(package private) final classAs it is possible to have a variable that is a delegate 'function', it means that to call that function, the ek9 developer would use variable-name(parameters).(package private) final classTHE 'cannot call an abstract function or type' check (CANNOT_CALL_ABSTRACT_TYPE), with the located message.(package private) classProvides a common set of operations for checking operators.(package private) final classUsed for resolving and recoding of fields on specific types.(package private) final classJust check that with in the current 'context' - if pure that the processing call is pure.(package private) final classTo be used with operators on aggregates (except for the is-set ? operator, that has to deal with functions).(package private) final classTHE rule for when a write to a local resets its 'referenced' flag (E08090): a write is not a use.(package private) final classLooks at the returning param (if not null) and sets the symbol type as appropriate.(package private) final classReturns the appropriate symbol from the symbol and scope management component.(package private) final classChecks if a symbol has been referenced or not (can be null - no error).(package private) final classJust extracts the ISymbols from the expression contexts and issues not resolved errors if any are not present.(package private) final classProvides the PossibleGenericSymbol type of the symbol if it has been typed, or empty.(package private) final classA text made with a plain String literal naming a language that has nodefines text forblock is an error (E07157, Steve 2026-11-02).(package private) classChecks that a trait access like T1.xyz() - is allowed i.e.(package private) final classIf the Ek9 developer has used named parameters, then they must be validated.(package private) final classChecks if a symbol's type is Void and emits E10010 if so.Methods in org.ek9lang.compiler.phase3 that return ISymbolModifier and TypeMethodDescriptionIdentifierOrError.apply(EK9Parser.IdentifierContext ctx) PropertyFieldOrError.apply(EK9Parser.IdentifierContext ctx, IScope scopeToResolveIn) SymbolFromContextOrError.apply(org.antlr.v4.runtime.ParserRuleContext ctx) NoteOrderingThroughCall.OrderingCall.called()Returns the value of thecalledrecord component.StreamFunctionCheckData.currentStreamType()Returns the value of thecurrentStreamTyperecord component.DelegateFunctionData.delegateSymbol()Returns the value of thedelegateSymbolrecord component.CaptureEvaluationScope.OuterField.field()Returns the value of thefieldrecord component.CovarianceData.fromVar()Returns the value of thefromVarrecord component.(package private) ISymbolRangeOrError.inRangeOf(EK9Parser.ExpressionContext ctx) The range ofx in a ... b: the start israngeFromand the end isrightof the comparison alternative (the range form shares that level, so its end binds like any comparison operand - PRECEDENCE (4), Steve 2026-10-07).ExprLeftAndRightData.left()Returns the value of theleftrecord component.TypeCompatibilityData.lhs()Returns the value of thelhsrecord component.TypeCompatibilityData.rhs()Returns the value of therhsrecord component.ExprLeftAndRightData.right()Returns the value of therightrecord component.CheckOperatorData.symbol()Returns the value of thesymbolrecord component.SymbolAccessData.symbol()Returns the value of thesymbolrecord component.StreamAggregateCheckData.symbolType()Returns the value of thesymbolTyperecord component.CovarianceData.toVar()Returns the value of thetoVarrecord component.Methods in org.ek9lang.compiler.phase3 that return types with arguments of type ISymbolModifier and TypeMethodDescriptionGetIteratorType.apply(IAggregateSymbol aggregate) IdentifierReferenceOrError.apply(EK9Parser.IdentifierReferenceContext ctx) RequiredOperatorPresentOrError.apply(CheckOperatorData checkOperatorData) RequiredOperatorPresentOrError.apply(CheckOperatorData checkOperatorData, CallSymbol callSymbol) Overloaded version that accepts a CallSymbol and sets the resolved method on it.SymbolsFromParamExpression.apply(EK9Parser.ParamExpressionContext ctx) NoteOrderingThroughCall.OrderingCall.arguments()Returns the value of theargumentsrecord component.MethodOnAggregateData.callArguments()Returns the value of thecallArgumentsrecord component.DelegateFunctionData.callArgumentTypes()Returns the value of thecallArgumentTypesrecord component.FunctionData.callArgumentTypes()Returns the value of thecallArgumentTypesrecord component.LiteralTargetType.dictKeyValueTypes(EK9Parser.DictContext ctx) The declared key and value types of the Dict literal at this context, if it has a Dict target.ParametersData.from()Returns the value of thefromrecord component.OperatorTest.getSymbolType(ISymbol symbol) LiteralTargetType.listElementType(EK9Parser.ListContext ctx) The declared type parameters of the List literal at this context, if it has a List target.SanitizedCheckData.superParameters()Returns the value of thesuperParametersrecord component.SanitizedCheckData.thisParameters()Returns the value of thethisParametersrecord component.ParametersData.to()Returns the value of thetorecord component.Methods in org.ek9lang.compiler.phase3 with parameters of type ISymbolModifier and TypeMethodDescriptionvoid(package private) voidCheck if assignment from a sanitized parameter is allowed.(package private) voidCheck a call that has been resolved.voidJudge the common type of a comparison coalescing operator's operands.voidConstructorThisEscapeOrError.accept(EK9Parser.ParamExpressionContext paramExpression, ISymbol resolvedTarget) voidvoidvoidvoidvoidvoidvoidSetTypeFromReturningParam.accept(ISymbol symbol, EK9Parser.ReturningParamContext ctx) void(package private) voidAsSymbolReferencedOrError.accept(ISymbol), with what else the developer needs to know to fix it (placed after the name, before the standard text).voidTextLanguageDefinedOrError.accept(ISymbol resolved, EK9Parser.ParamExpressionContext paramExpression) Check a call that has been resolved.voidIsSetPresentOrError.decidedForType(ISymbol symbolType) The types '?' is decided for without a search - shared byIsSetPresentOrError.test(IToken, ISymbol)andOperatorTest.testType(IToken, ISymbol)(B-2, so the coalescing operators judging a common type get them too).OperatorTest.decidedForType(ISymbol symbolType) THE stepOperatorTest.test(IToken, ISymbol)andOperatorTest.testType(IToken, ISymbol)both take before searching for the operator: a type for which this operator is decided without a search (for '?': a function, Any, text, an enumeration).(package private) booleanCaptureEvaluationScope.deniesAccessTo(org.antlr.v4.runtime.tree.ParseTree node, ISymbol symbol) THE "may this code reach that property?" check for a BARE name, shared by every site that resolves one against the scope stack: a read (IdentifierReferenceOrError), an assignment, an object-access start, a pre-flow or a for-range (IdentifierOrError), and a stream pipeline part (ResolveFunctionOrDelegateByNameOrError: a sink,head,map with,tee in).(package private) voidLiteralTargetType.elementFitsOrError(org.antlr.v4.runtime.ParserRuleContext elementCtx, ISymbol element, ISymbol declaredType, SemanticErrorReporter errorListener) An element of a targeted literal must be assignable to the declared element (or key/value) type - exactly the test a single assignment applies.(package private) static CheckOperatorDataCheckOperatorData.forType(ISymbol type, IToken operatorUseToken, MethodSymbolSearch search) An operator required of a TYPE, by a caller that has no value of it.protected MethodSymbolSearchComparatorPresentOrError.getMethodSymbolSearch(ISymbol symbolType) protected MethodSymbolSearchDecrementPresentOrError.getMethodSymbolSearch(ISymbol symbolType) protected MethodSymbolSearchHashCodePresentOrError.getMethodSymbolSearch(ISymbol symbolType) protected MethodSymbolSearchIncrementPresentOrError.getMethodSymbolSearch(ISymbol symbolType) protected MethodSymbolSearchIsSetPresentOrError.getMethodSymbolSearch(ISymbol symbolType) protected abstract MethodSymbolSearchOperatorTest.getMethodSymbolSearch(ISymbol symbolType) OperatorTest.getSymbolType(ISymbol symbol) (package private) ConceptualAccess.OrderingStepOrderingBodyHere.Body.handsOn(IScopedSymbol into, ISymbol intoParameter) The body hands the values on tointo, where they are values ofintoParameter.booleanOperatorTest.notAnEnumerationTypeOrError(IToken operatorUse, ISymbol operand) Is this operand a value rather than the enumeration TYPE itself? E07630 when it is the type.(package private) booleanRequiredOperatorPresentOrError.notAnEnumerationTypeOrError(IToken operatorUse, ISymbol operand) THE check that an operand is a VALUE, not the enumeration TYPE itself (CardSuit > CardSuit.Hearts), which is E07630.(package private) String'own' and 'other' <location of other>:.(package private) String'other' <location of other>- the paired declaration as the pair prefix names it.(package private) voidConstructorThisEscapeOrError.recordDynamicClass(ISymbol target, EK9Parser.AssignmentExpressionContext assignment) Inside a constructor, mark a local that is given a dynamic class capturing 'this'.booleanbooleanbooleanboolean(package private) booleanbooleanTest if the symbol has a Void type.booleanAsOperatorTest.test(IToken, ISymbol), for a TYPE rather than a value of it - e.g.Method parameters in org.ek9lang.compiler.phase3 with type arguments of type ISymbolModifier and TypeMethodDescriptionvoidValidNamedArgumentsOrError.accept(EK9Parser.ParamExpressionContext ctx, List<ISymbol> parameters) Constructors in org.ek9lang.compiler.phase3 with parameters of type ISymbolModifierConstructorDescription(package private)CheckOperatorData(ISymbol symbol, IToken operatorUseToken, MethodSymbolSearch search) An operator used on a VALUE (the usual case).(package private)CheckOperatorData(ISymbol symbol, IToken operatorUseToken, MethodSymbolSearch search, boolean onType) Creates an instance of aCheckOperatorDatarecord class.(package private)Creates an instance of aCovarianceDatarecord class.(package private)DelegateFunctionData(IToken token, ISymbol delegateSymbol, List<ISymbol> callArgumentTypes) Creates an instance of aDelegateFunctionDatarecord class.(package private)ExprLeftAndRightData(ISymbol left, ISymbol right) Creates an instance of aExprLeftAndRightDatarecord class.(package private)OrderingCall(ISymbol called, boolean delegate, List<ISymbol> arguments) Creates an instance of aOrderingCallrecord class.(package private)OuterField(ISymbol field, boolean fromDynamicClass, boolean denied) Creates an instance of aOuterFieldrecord class.(package private)StreamAggregateCheckData(org.antlr.v4.runtime.Token errorLocation, IAggregateSymbol aggregateSymbol, ISymbol symbolType) Creates an instance of aStreamAggregateCheckDatarecord class.(package private)StreamFunctionCheckData(org.antlr.v4.runtime.Token errorLocation, FunctionSymbol functionSymbol, ISymbol currentStreamType) Creates an instance of aStreamFunctionCheckDatarecord class.(package private)Creates an instance of aSymbolAccessDatarecord class.(package private)TypeCompatibilityData(IToken location, ISymbol lhs, ISymbol rhs) Creates an instance of aTypeCompatibilityDatarecord class.Constructor parameters in org.ek9lang.compiler.phase3 with type arguments of type ISymbolModifierConstructorDescription(package private)DelegateFunctionData(IToken token, ISymbol delegateSymbol, List<ISymbol> callArgumentTypes) Creates an instance of aDelegateFunctionDatarecord class.(package private)FunctionData(IToken token, FunctionSymbol function, List<ISymbol> callArgumentTypes) Creates an instance of aFunctionDatarecord class.(package private)MethodOnAggregateData(IToken token, IScope scopeToSearch, String methodName, List<ISymbol> callArguments) Creates an instance of aMethodOnAggregateDatarecord class.(package private)OrderingCall(ISymbol called, boolean delegate, List<ISymbol> arguments) Creates an instance of aOrderingCallrecord class.(package private)Creates an instance of aParametersDatarecord class.(package private)SanitizedCheckData(Supplier<String> errorMessage, List<ISymbol> superParameters, List<ISymbol> thisParameters) Creates an instance of aSanitizedCheckDatarecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase4
Constructor parameters in org.ek9lang.compiler.phase4 with type arguments of type ISymbolModifierConstructorDescription(package private)ParameterisedTypeOrError(Ek9Types ek9Types, ErrorListener errorListener, Map<IAggregateSymbol, List<MethodSymbol>> accessedMethodsByT, Function<PossibleGenericSymbol, Optional<ISymbol>> definedParameterisation) Create the check. -
Uses of ISymbol in org.ek9lang.compiler.phase5
Classes in org.ek9lang.compiler.phase5 that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classTHE entry state of a dynamic class's capture constructor: its captures are stored before its first statement (before_i_init, and before athis(...)call), so each one is set from the start of its body.(package private) final classWhere a dynamic function's or class's captured copy came from, as the RETAINS derivation walks a callable: each capture argument a capture list names ((p, items) is Adder as function) is noted with the variable or property it copies, andCaptureOrigins.apply(ISymbol)answers the ORIGIN of a copy - transitively, so a capture of a capture is the outermost variable.(package private) final classThe NAMED half of the closeable ownership rule (Steve, 2026-10-05): "A closeable value you never NAME is owned by the statement that created it and closed when that statement finishes; a closeable value you NAME must be declared as a try-with-resources resource." (E81056).(package private) final classTHE human-readable label of the construct a symbol represents ("service operation", "operator", "method", "function", "callable"), for the size diagnostics that judge it against itsStatementBudgetOf(AcceptableStatementCountOrError,AcceptableCombinedComplexitySizeOrError).(package private) final classExtracts the EXISTING variable a pre-flow assigns: the target of a blind assignment (v := e()) or an assign-if-unset (v :=? e()).(package private) final class(package private) final classThe position of a symbol in a list by IDENTITY, or -1: symbols of the same name in different scopes must not match (a parameter list read for occurrences,CallableParameterOccurrences, and for closeable slot stores,CloseableSlotStoreOrError).(package private) final classThe position of a symbol in a list by IDENTITY, or -1: symbols of the same name in different scopes must not match (a parameter list read for occurrences,CallableParameterOccurrences, and for closeable slot stores,CloseableSlotStoreOrError).(package private) classCalculates the Depth of Inheritance Tree (DIT) for aggregate symbols.(package private) final classTHE "is this symbol a capture of the callable whose returning variable is being read" of the return-source readings (ReturnSourceClassifier,ReturnSourceOrigins): by IDENTITY (IsCapturedVariable), one the callable (a dynamic function) or the type it belongs to (a dynamic class) captured.(package private) final classTHE test of E08270's domain (GuardVariableReadWhereUnsetOrError), for a rule that must not report the same use a second time (E08096,OperatorKeepsValueUnsetOrError): isatinside a later block of anifchain (anelse ifor theelse) whose earlier block's<-guard declarestarget, provably unset there (ProvablyUnsetGuardOf).(package private) final classIs this recorded symbol a property field (a property, or a capture held in one) - false for no symbol.(package private) final classTHE first step of everyAcceptable*OrErrorquality-metric check (withRecordMetricandMetricLimitCheck): the symbol the metric is recorded against - one null policy, an assertion, because a metric scope is pushed on entry for a construct that has a symbol (the node, not the symbol, is never null).(package private) final classAn aggregate's own property fields, in declaration order, as an unmodifiable list.(package private) final classThe variable anifblock's pre-flow declares, when that block is skipped ONLY because the variable is unset (E08270): a<-guard that is the whole condition, and not a Boolean truth guard (BooleanTruthGuard, which also skips a setfalse).(package private) final classTHE injections that can run when the given callables run - transitively, through the phase-5 call graph: an injection (name as T!) in a body the roots reach, or a property injection of a type they construct (a property's injection belongs to its type and runs wherever the type is constructed).(package private) final classTHE encoding of a measured quality metric (withMetricSymbolOfandMetricLimitCheck, the steps of everyAcceptable*OrErrorcheck): squirrel the integer on the symbol, under the one key this instance is made for, as decimal text throughSmallIntStrings.(package private) final classMarks specific types of variable of specific types (generic Result/Option) in a manner that enables the compiler to check if access to certain methods is safe.(package private) final classTests specific types of variable of specific types (generic Result/Option) in a manner that enables the compiler to check if access to certain methods is safe.(package private) final classIt may be that before calling this you have determined that 'isSet' has been called or you 'know' that the value of the variable is present and set.(package private) final classTHE per-construct statement budget - the maximum number of statements permitted for the construct the symbol represents, keyed off the symbol kind (the limits live inQualityMetricLimits).(package private) final classThe variables of one source that a signal handler captures, by IDENTITY (design §13.11 S2c, option A): the outer symbol each argument of aSignalHandlerimplementation's capture list names.Methods in org.ek9lang.compiler.phase5 that return ISymbolModifier and TypeMethodDescriptionThe outermost variable or propertysymbolis a captured copy of; null when it is no recorded copy.MetricSymbolOf.apply(org.antlr.v4.runtime.tree.ParseTree node) ConstrainedConstructionResolver.Site.argSymbol()Returns the value of theargSymbolrecord component.OrderingTotality.Finding.callee()Returns the value of thecalleerecord component.(package private) ISymbolThe construct whose captures a concurrent entry point reaches: itself, or a method's owner (a dynamic class).ConstrainedConstructionResolver.Site.constructorParamType()Returns the value of theconstructorParamTyperecord component.CloseableArgumentKeeping.Holder.symbol()Returns the value of thesymbolrecord component.SafeAccessConjuncts.Proof.symbol()Returns the value of thesymbolrecord component.StoreSite.target()Returns the value of thetargetrecord component.MutatedOnlyVariables.Deferred.variable()Returns the value of thevariablerecord component.MutatedOnlyVariables.Source.Variable.variable()Returns the value of thevariablerecord component.Methods in org.ek9lang.compiler.phase5 that return types with arguments of type ISymbolModifier and TypeMethodDescriptionGetGuardVariable.apply(EK9Parser.PreFlowStatementContext ctx) PropertyFieldsOf.apply(IAggregateSymbol aggregate) ProvablyUnsetGuardOf.apply(EK9Parser.IfControlBlockContext block) Every injection that can run from the roots, in source order, each with where it lives (for a message).ValuesCapturedBySignalHandlers.apply(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree source) ScopeVariableCollector.collectLocalVariables(org.antlr.v4.runtime.tree.ParseTree node, Predicate<ISymbol> filter) Collect the local variable symbols declared inside the callable's instruction blocks (including those nested in if/while/for/try/switch), admitting only those for which the filter holds.FieldClassifier.FieldCounts.dataFields()Returns the value of thedataFieldsrecord component.ScopeVariableCollector.getAccessibleFields(IScope scope) The property fields of the nearest enclosing aggregate, or an empty list if there is none.PossibleExpressionConstruct.getPreFlowAssignedVariables(EK9Parser.PreFlowAndControlContext ctx) PossibleExpressionConstruct.getPreFlowAssignedVariables(EK9Parser.PreFlowStatementContext ctx) The EXISTING variables the pre-flow assigns, which are initialised after the construct whether or not its body runs - seeGetGuardVariable.MutatedOnlyVariables.ReturningCallable.localSources()Returns the value of thelocalSourcesrecord component.ScopeVariableCollector.namedCaptures(org.antlr.v4.runtime.tree.ParseTree node) THE variables a NAMED capture '(name: value)' introduces on a dynamic function or class - read by every name-quality check (E11030, E11031, E11032; C-1: only E11031 once collected them, FE57).InjectionCycles.notExplained(String ownerFqn, Set<ISymbol> injections) The injections ofownerFqnthe ordering checks still judge: those no cycle explains.FieldClassifier.FieldCounts.serviceFields()Returns the value of theserviceFieldsrecord component.StoreSite.valueType(SymbolsAndScopes symbolsAndScopes) The resolved type of the value stored - not the slot's declared type.Methods in org.ek9lang.compiler.phase5 with parameters of type ISymbolModifier and TypeMethodDescriptionvoidCalled once the constructor's own scope has been entered.voidvoid(package private) voidReport E08040 atopiftargetis proven safe to unwrap in the current scope.voidvoid(package private) voidCloseableSlotStoreOrError.acceptCallableDeclaration(ISymbol recorded) A callable declaration (a constructor, method, operator, function or dynamic function): what it does with each of its parameters is then known, so an unnamed closeable given to it is a loan unless it keeps the argument (the verdict of a constructor isCloseableArgumentKeeping.fateOf(MethodSymbol, int); of any other callable, its derived RETAINS).(package private) voidSharedTypeClosure.addCapturesOf(ISymbol symbol, Collection<ISymbol> into) What the construct captured - never the construct's own type: concurrent code calling a method of a type it made itself does not make that type shared (only what it captures, or reaches through what it captures, does).(package private) voidCloseableArgumentKeeping.aliases(CloseableArgumentKeeping.Holder from, ISymbol to) The localtonow refers to the same object asfrom.(package private) booleanContainerChangedBetween.anywhereIn(org.antlr.v4.runtime.tree.ParseTree region, ISymbol container) May anything inregionchangecontainer's object.The outermost variable or propertysymbolis a captured copy of; null when it is no recorded copy.intIdentityIndexOf.applyAsInt(List<ISymbol> symbols, ISymbol wanted) intInheritanceDepthCalculator.applyAsInt(ISymbol symbol) Calculate the inheritance depth for a symbol.intStatementBudgetOf.applyAsInt(ISymbol symbol) protected voidAbstractSafeSymbolMarker.assessIsSetCall(ISymbol toBeAssessed, IScope scopeMadeSafe) (package private) booleanContainerChangedBetween.between(org.antlr.v4.runtime.tree.ParseTree region, ISymbol container, int afterToken, int beforeToken) May anything inregionthat starts strictly after tokenafterTokenand strictly before tokenbeforeTokenchangecontainer's object.(package private) booleanProvenContainerChange.byOccurrence(ISymbol occurrenceSymbol, List<ObjectSharing.Use> uses, ISymbol container, boolean sharingCounts) May this occurrence ofoccurrenceSymbol- with the effectsuses(ObjectSharing) - change the objectcontainerrefers to? A mutating operator, a call that may change it or a holder nothing names keeping it does, through any name that may be the same object.(package private) booleanProvenContainerChange.bySite(ProgramCodeSites.Site site, ISymbol container) May the program code run atsite(ProgramCodeSites) change the objectcontainerrefers to - through a name an in-place write or an iteration changes in place, or beyond the names it is given (a call's are judged as their own occurrences)?(package private) ISymbolThe construct whose captures a concurrent entry point reaches: itself, or a method's owner (a dynamic class).(package private) voidOperatorKeepsValueUnsetOrError.constructedUnset(ISymbol symbol, ISymbol type) symbolwas given the value aCONSTRUCTS_UNSETconstructor oftypemakes.(package private) voidA callable declaration was reached: its parameters are the variables whose occurrences are followed.(package private) voidOperatorKeepsValueUnsetOrError.declaredWithoutValue(ISymbol symbol) symbolwas declaredas T?, with no value.(package private) voidMutatedOnlyVariables.Collector.enterCallable(ISymbol symbol) A method, operator, function or dynamic function is entered; only one with a returning variable is followed.(package private) voidMutatedOnlyVariables.Collector.enterCallable(ISymbol symbol, boolean inheritsBody) AsMutatedOnlyVariables.Collector.enterCallable(ISymbol); a dynamic function with no body of its own (inheritsBody) is also queued for the inherited-rules step of both derivations (MutatedOnlyVariables.inheritingBodies).(package private) voidCohesionTracker.enterMethod(ISymbol member) Enter a member (method, operator or service operation) for tracking field accesses and calls.(package private) voidMetricLimitCheck.errorIfExceeds(ISymbol symbol, int value, int max, Supplier<String> message) Raise this check's code on the symbol's source token when the value is strictly above the maximum.(package private) booleanTrue when the injection ofinjectedintoownerFqnis explained by a cycle, not by the order.(package private) Optional<CloseableArgumentKeeping.Holder> The callable whose own variable this is, when it is one that is followed (a parameter, or a local made to refer to one); empty otherwise.The node for what a property declared with this type can hold, or empty when it can hold nothing that has properties of its own (a function, a built-in leaf, an unresolved type).(package private) booleanSafeGenericContainers.isAccessSafe(ISymbol symbol) Is the (OK for a Result) unwrapping access of this symbol safe in the scope it is used in.protected booleanSafeSymbolAccess.isAccessUnSafe(ISymbol calledFromSymbol, String methodName, org.antlr.v4.runtime.tree.ParseTree accessSite) True when the access needs a check that neither the enclosing scope nor an earlierandconjunct of the expression ataccessSiteprovides (SafeAccessConjuncts.isProvenEarlier(ParseTree, ISymbol, CommonValues)).(package private) booleanSafeGenericContainers.isContainer(ISymbol symbol) Is the symbol a Result, Optional or Iterator.(package private) booleanSafeAccessConjuncts.isProvenEarlier(org.antlr.v4.runtime.tree.ParseTree accessSite, ISymbol symbol, CommonValues access) True whenaccessonsymbolataccessSiteis protected by an EARLIER conjunct of an enclosingandevaluated as part of the same expression, and nothing evaluated between that conjunct and the access may change the container (name? and forget(name) and name.get() > 0is not protected -ContainerChangedBetween).protected booleanPossibleExpressionConstruct.isVariableInitialisedInScopes(CodeFlowAnalyzer analyzer, ISymbol variable, List<IScope> scopes) (package private) booleanOperatorKeepsValueUnsetOrError.keepsIncrementedUnset(EK9Parser.IdentifierContext ctx, ISymbol target) An identifier written in place byx++orx--: true when it is UNSET and the operator keeps it unset - reported, and it stays UNSET.(package private) booleanOperatorKeepsValueUnsetOrError.keepsTargetUnset(EK9Parser.AssignmentStatementContext ctx, ISymbol target) An assignment statementx += y(any in-place operator but a store): true when its target is UNSET and the operator keeps it unset - the target then stays UNSET and the finding is made once the right-hand side has been walked (OperatorKeepsValueUnsetOrError.assignmentCompleted(EK9Parser.AssignmentStatementContext)).(package private) voidSafeGenericContainers.markAccessSafe(ISymbol symbol, IScope scopeMadeSafe) Mark the (OK for a Result) unwrapping access of this symbol safe in the scope; nothing for other symbols.(package private) booleanSlotAssignedOnce.mayAlreadyHold(ISymbol slot, org.antlr.v4.runtime.tree.ParseTree assignment) True when the slot may already hold a value at this assignment, judged from the assignments recorded so far; the assignment is then recorded, so call this once for every assignment to the slot, in source order.(package private) voidsymbolwas narrowed by a set-check (if not x?): known unset now because of the check.(package private) voidA capture list madecopyoforigin.(package private) voidSafeAccessWithdrawal.occurrence(ISymbol occurrenceSymbol, List<ObjectSharing.Use> uses, boolean assignmentTarget) One occurrence of a variable, with what it does to the object (ProvenContainerChange.usesOf(EK9Parser.IdentifierContext, ISymbol)): withdraw every proof that may break.(package private) static CloseableArgumentKeeping.HolderCloseableArgumentKeeping.Holder.of(ScopedSymbol callable, ISymbol symbol) (package private) Optional<SafeGenericContainers.Container> (package private) Optional<ProgramCodeSites.Site> ProgramCodeSites.ofInPlaceWrite(EK9Parser.IdentifierContext occurrence, ISymbol symbol, ObjectSharing.Use use) The in-place write one use of an identifier's occurrence makes, when that use is an in-place write by an operator of the program's own (counter += 1withCounter's own+=).(package private) voidOperatorKeepsValueUnsetOrError.otherwiseGiven(ISymbol symbol) symbolwas given some other value, by a store or a narrowing.protected voidPossibleExpressionConstruct.processPossibleGuardInitialisation(CodeFlowAnalyzer analyzer, ISymbol guardVariable, org.antlr.v4.runtime.ParserRuleContext ctx) Now when there is a preflow control, it may mean that a variable is initialised.(package private) booleanSafeAccessConjuncts.provesEveryAccess(EK9Parser.ExpressionContext condition, ISymbol symbol) Doesconditionprove EVERY accesssymbol's container guards (get()of an Optional,next()of an Iterator; a Result'sok()anderror()are never both proven), with nothing after the proving conjunct that may change it? The trailing condition of ado/whilethat does is checked before every later pass of its body, so the body's own changes do not reach those passes.(package private) voidThe squirrel core — package-private so it is unit-testable with a hand-built callable, no parse tree or scope resolution required.(package private) voidOrderingTotality.record(ISymbol callable, List<OrderingTotality.Finding> found) Record the partial sources of one callable's Integer result; nothing is recorded for a total one.(package private) voidSafeGenericContainers.recordDeclaration(ISymbol symbol) Record the declaration of a variable of a container type, so that its unwrapping call needs a check.(package private) voidCouplingTracker.recordDependency(ISymbol type) Record a type dependency.(package private) voidModuleCouplingTracker.recordDependency(String sourceModuleName, ISymbol referencedType) Record a type dependency for a specific module.(package private) voidCohesionTracker.recordFieldAccess(ISymbol field) Record a field access (read or write) by the current member, made on the object itself.(package private) voidModuleCohesionTracker.recordReference(String moduleName, String fromConstructFqn, ISymbol referencedType) Record a type reference from one construct to another.protected booleanSafeSymbolAccess.requiresSafeAccess(ISymbol calledFromSymbol, String methodName) WhethermethodNameoncalledFromSymbolis a container-unwrap that needs a preceding safety check (Optional.get,Result.ok/error,Iterator.nexton a symbol the marker has flagged) — i.e.(package private) List<MutatedOnlyVariables.Source> What the local is made to refer to; none for a variable this body never re-points.booleanbooleanIsCaptureOf.test(ISymbol symbol, ScopedSymbol callable) booleanbooleanboolean(package private) List<ObjectSharing.Use> ProvenContainerChange.usesOf(EK9Parser.IdentifierContext occurrence, ISymbol symbol) What one occurrence ofsymboldoes to the object it names (ObjectSharing); for a container itself, without what is done to its views -show(name.get())hands on the ITEM, which cannot empty the Optional (ObjectSharing.ofTheObjectItself(EK9Parser.IdentifierContext, Function)).(package private) List<ObjectSharing.Use> ProvenContainerChange.usesOf(EK9Parser.IdentifierContext occurrence, ISymbol symbol, List<ObjectSharing.Use> allUses) AsProvenContainerChange.usesOf(EK9Parser.IdentifierContext, ISymbol), when every use of the occurrence (allUses,ObjectSharing.apply(EK9Parser.IdentifierContext, Function)) is already known: those, or for a container only the uses of the object itself.(package private) voidMutatedOnlyVariables.Collector.variableDeclared(EK9Parser.VariableDeclarationContext ctx, ISymbol symbol) Method parameters in org.ek9lang.compiler.phase5 with type arguments of type ISymbolModifier and TypeMethodDescription(package private) voidSharedTypeClosure.addCapturesOf(ISymbol symbol, Collection<ISymbol> into) What the construct captured - never the construct's own type: concurrent code calling a method of a type it made itself does not make that type shared (only what it captures, or reaches through what it captures, does).SharedTypeClosure.apply(Collection<? extends ISymbol> roots) The fully qualified names of every type reachable from the roots (the roots included), or null for any type.intIdentityIndexOf.applyAsInt(List<ISymbol> symbols, ISymbol wanted) (package private) voidSharedStateMutationOutsideLockOrError.capturedBySignalHandlers(Set<ISymbol> captured) The variables of this source that a signal handler captures (identity), for the beside-a-signal-handler rule.(package private) voidUnsatisfiedInjectionReporter.checkInjectionsAvailable(String aggName, Set<ISymbol> injections, Set<String> availableTypes, Set<String> allRegisteredTypes, IToken triggerToken, ErrorListener errorListener) Report the injections (of a type, or in a callable's body) that are not available at the trigger: never registered (E08210) or not yet registered (E08200).ScopeVariableCollector.collectLocalVariables(org.antlr.v4.runtime.tree.ParseTree node, Predicate<ISymbol> filter) Collect the local variable symbols declared inside the callable's instruction blocks (including those nested in if/while/for/try/switch), admitting only those for which the filter holds.(package private) voidSafeAccessWithdrawal.enterLoop(org.antlr.v4.runtime.tree.ParseTree loop, Predicate<ISymbol> reprovedOnEveryLaterPass) A loop is about to be entered: what its body (or its condition) may change is withdrawn now, before any of it is walked - a change late in the body comes before an access early in it on the next pass.InjectionCycles.notExplained(String ownerFqn, Set<ISymbol> injections) The injections ofownerFqnthe ordering checks still judge: those no cycle explains.(package private) voidDataClumpTracker.recordSignature(String moduleName, String callableName, List<ISymbol> params, IToken token) Record a callable's parameter signature for a specific module.Constructors in org.ek9lang.compiler.phase5 with parameters of type ISymbolModifierConstructorDescription(package private)(package private)Deferred(ParsedModule parsedModule, ISymbol variable, EK9Parser.ExpressionContext initialiser) Creates an instance of aDeferredrecord class.(package private)DynamicClassComparatorRetraction(ParsedModule parsedModule, ISymbol ek9Any) (package private)Creates an instance of aFindingrecord class.(package private)HasTypeOfGeneric(ISymbol matchType) Constructor to check if symbol has a type that matches the use of the match generic type.(package private)Holder(ScopedSymbol callable, ISymbol symbol) Creates an instance of aHolderrecord class.(package private)Proof(ISymbol symbol, CommonValues access) Creates an instance of aProofrecord class.PropertyTypeGraph(ConcreteSubtypeFinder subtypeFinder, ISymbol anyType) The graph over the program, its subtypes and aggregates from the phase's ONE shared subtype index (was the staticover).PropertyTypeGraph(PropertyTypeGraph.TypeUniverse universe, ISymbol anyType) (package private)Site(AggregateSymbol constrainedType, ConstraintExpr constraint, ISymbol argSymbol, ISymbol constructorParamType) Creates an instance of aSiterecord class.(package private)StoreSite(ISymbol target, EK9Parser.AssignmentExpressionContext value, IToken location) Creates an instance of aStoreSiterecord class.Creates an instance of aVariablerecord class.Constructor parameters in org.ek9lang.compiler.phase5 with type arguments of type ISymbolModifierConstructorDescription(package private)CallableReturnsInitialisedOrError(SymbolsAndScopes symbolsAndScopes, ErrorListener errorListener, Function<C, EK9Parser.OperationDetailsContext> operationDetailsOf, Class<? extends ISymbol> expectedSymbolKind) (package private)ConfinedTypeMarker(CallGraph callGraph, ConcreteSubtypeFinder subtypeFinder, List<ISymbol> directEntryPoints, IsMutexLockType isMutexLockType) (package private)FieldCounts(int serviceFieldCount, int dataFieldCount, int byDelegatedFieldCount, List<ISymbol> serviceFields, List<ISymbol> dataFields, Set<String> byDelegatedFields) Creates an instance of aFieldCountsrecord class.(package private)ReturningCallable(ParsedModule parsedModule, ScopedSymbol callable, List<EK9Parser.ExpressionContext> sources, List<EK9Parser.ExpressionContext> capturedSources, Map<ISymbol, List<MutatedOnlyVariables.Source>> localSources) Creates an instance of aReturningCallablerecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase5.callgraph
Methods in org.ek9lang.compiler.phase5.callgraph that return ISymbolModifier and TypeMethodDescriptionCallableInfo.symbol()Returns the value of thesymbolrecord component.Methods in org.ek9lang.compiler.phase5.callgraph that return types with arguments of type ISymbolModifier and TypeMethodDescriptionCallGraph.getInjectionSites(String callable) The injection sites declared directly in a callable's body (not transitively).Methods in org.ek9lang.compiler.phase5.callgraph with parameters of type ISymbolModifier and TypeMethodDescriptionvoidCallGraph.addInjectionSite(String callable, ISymbol injectedVariable) Record an injection site (name as T!) in the body of a callable.Constructors in org.ek9lang.compiler.phase5.callgraph with parameters of type ISymbolModifierConstructorDescriptionCallableInfo(String fullyQualifiedName, ISymbol symbol, IToken sourceToken, String moduleName, boolean isPure, boolean isProgram, boolean isTestEntry, boolean isServiceEntry, boolean containsAssertion, boolean containsInjection) Create CallableInfo with validation. -
Uses of ISymbol in org.ek9lang.compiler.phase5.construction
Classes in org.ek9lang.compiler.phase5.construction that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classFE77's "is this type concrete?": a type that names no conceptual type parameter anywhere in it - not a bareT, not a parameterisation with aTamong its arguments (at any depth), and not a generic type itself.Methods in org.ek9lang.compiler.phase5.construction that return ISymbolModifier and TypeMethodDescriptionConstructionEdges.CallTarget.callee()Returns the value of thecalleerecord component.ConstructionEdges.TypeParameterConstruction.typeParameter()Returns the value of thetypeParameterrecord component.Methods in org.ek9lang.compiler.phase5.construction that return types with arguments of type ISymbolModifier and TypeMethodDescriptionConstructionEdges.constructionNodes()Every construction node, by call-graph identity.Methods in org.ek9lang.compiler.phase5.construction with parameters of type ISymbolModifier and TypeMethodDescriptionvoidConstructionEdges.addConstructionNode(String key, ISymbol symbol) Record a construction node - a constructor, or a type's_i_init- which every cycle reported must contain.booleanMethod parameters in org.ek9lang.compiler.phase5.construction with type arguments of type ISymbolModifier and TypeMethodDescription(package private) Optional<PossibleGenericSymbol> Parameterisations.lookup(PossibleGenericSymbol generic, List<ISymbol> arguments) The existing parameterisation of a generic with exactly these (concrete) arguments, if there is one.Constructors in org.ek9lang.compiler.phase5.construction with parameters of type ISymbolModifierConstructorDescriptionCallTarget(ISymbol callee) Creates an instance of aCallTargetrecord class.TypeParameterConstruction(ISymbol typeParameter, int arity) Creates an instance of aTypeParameterConstructionrecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase5.flow
Methods in org.ek9lang.compiler.phase5.flow that return ISymbolModifier and TypeMethodDescriptionLockIdentityInference.resolveParamSymbol(String paramFqn) Resolve the original parameterISymbolfor a placeholder FQN, if one has been registered viaLockIdentityInference.tokenForSymbol(ISymbol).LockIdentityInference.unwrapCapture(ISymbol symbol, IScopedSymbol enclosingFunction) LikeLockIdentityInference.tokenForSymbol(ISymbol)but unwraps one level of dynamic-function capture: if the symbol is one ofenclosingFunction's captured variables, resolve the same-named variable in theCaptureScope's enclosing scope and use that outer symbol's identity instead.Methods in org.ek9lang.compiler.phase5.flow that return types with arguments of type ISymbolModifier and TypeMethodDescriptionConstraintState.trackedSymbols()Every symbol this state holds anything about (a value or the values it may hold), as a copy.Methods in org.ek9lang.compiler.phase5.flow with parameters of type ISymbolModifier and TypeMethodDescriptionvoidRecord that nothing is provable aboutsymbolhere.ValueTrackingAnalyzer.evaluateIsEmpty(ISymbol symbol) Evaluate the empty state of a variable based on its tracked value.ValueTrackingAnalyzer.evaluateIsSet(ISymbol symbol) Evaluate the isSet state of a variable based on its tracked value.Get the abstract value for a symbol.The constant values that reach this point on SOME path; empty when nothing is provable.ValueTrackingAnalyzer.getMayValues(ISymbol symbol) The constant values that reach this point on SOME path — the MAY side of the analysis.booleanConstraintState.isFreshInLoop(ISymbol symbol) True ifsymbolwas written, on every path here, since the innermost loop body was entered.booleanValueTrackingAnalyzer.isFreshInLoop(ISymbol symbol) True ifsymbolwas written, on every path to here, since the innermost loop body was entered: inside the loop its value is then what that write gave it on every pass, so a decision about it holds (D48) even though the body is walked only once.TrackedValues.knownValueOf(ISymbol symbol) The symbol's tracked value but only if that is known, else TOP - the symbol half ofTrackedValues.knownValueOf(EK9Parser.ExpressionContext), for a name that is not an expression (abystep identifier).voidConstraintState.markFreshInLoop(ISymbol symbol) Note thatsymbolwas written since the innermost loop body was entered (seeConstraintState.freshInLoop).booleanValueTrackingAnalyzer.mayBeChangedByCall(ISymbol symbol, boolean reachesOutside, Collection<ISymbol> reachedNames) THE reading ofValueTrackingAnalyzer.recordCallThatMayChange(boolean, Collection)as a question about ONE object: may a call that may run the program's own code, given what it reaches, change the objectsymbolrefers to? Yes when that object itself has escaped, or when the call reaches an object from outside andsymbol's may be one.booleanValueTrackingAnalyzer.mayBeChangedThrough(ISymbol changed, ISymbol symbol) THE reading ofValueTrackingAnalyzer.recordInPlaceChange(ISymbol)as a question about ONE object: may an in-place change made throughchanged(a mutating operator, a call given it) change the objectsymbolrefers to? Yes when the two names may refer to the same object, or whensymbol's object has escaped - the object changed may be the holder it is kept in.voidValueTrackingAnalyzer.narrowedWithGuardSkipPath(ISymbol guardTarget, Runnable narrowing) Runnarrowing- the false narrowing of an if block's condition, at the start of its next alternative - when the block's guard (v <- f(),v :=? f()) can leaveguardTargetunset: then the condition afterthenwas never evaluated, and the alternative is reached by that skip path as well as by the condition being false (D46).voidValueTrackingAnalyzer.narrowForCondition(ISymbol symbol, String operator, long operandValue, boolean isTrueBranch) 🔑 Narrowing must reduce the MAY side too, or it goes stale. These paths write the MUST side DIRECTLY rather than throughValueTrackingAnalyzer.recordAssignment(ISymbol, AbstractValue), so without this the may-set keeps a value the narrowing has just ruled out — and a value that provably does NOT arrive would be reported as if it did.voidValueTrackingAnalyzer.narrowForIsSet(ISymbol symbol, boolean isTrueBranch) Narrow a variable's value based on an isSet check.voidValueTrackingAnalyzer.recordAssignment(ISymbol symbol, AbstractValue abstractValue) Record a variable assignment with a known constant value.voidValueTrackingAnalyzer.recordEscape(ISymbol symbol) Record that the objectsymbolrefers to is now kept somewhere the analysis cannot name (D61): it may be changed through that holder at any later point, so it is changed now (ValueTrackingAnalyzer.recordInPlaceChange(ISymbol)) and nothing learned about it later - a condition narrowing it included - survives a call that may run the program's own code (ValueTrackingAnalyzer.recordCallThatMayChange(boolean, Collection)) or an in-place change to anything.voidValueTrackingAnalyzer.recordEscapeOfWhatItHolds(ISymbol symbol) AsValueTrackingAnalyzer.recordEscape(ISymbol), for an escape of only whatsymbol's object holds -show(name.get())for an Optional: everything known about it is forgotten as for any escape, but the object itself is not kept anywhere new, so the questions about it (ValueTrackingAnalyzer.mayBeChangedByCall(ISymbol, boolean, Collection),ValueTrackingAnalyzer.mayBeChangedThrough(ISymbol, ISymbol)) are not widened.voidValueTrackingAnalyzer.recordInPlaceChange(ISymbol symbol) Record that the objectsymbolrefers to was changed IN PLACE (x++,cat items > x, a call given it) - so nothing is known any more about it, nor about any name that may refer to the same object.voidValueTrackingAnalyzer.recordInPlaceChangeThroughOthers(ISymbol symbol) voidValueTrackingAnalyzer.recordKeptUnset(ISymbol symbol) The variablesymbolis UNSET and an operation that keeps an unset value unset (KEEPS_UNSET, e.g.voidValueTrackingAnalyzer.recordLiteralAssignment(ISymbol symbol, AbstractValue abstractValue) AsValueTrackingAnalyzer.recordAssignment(ISymbol, AbstractValue), for a value that is exact on EVERY pass of an open loop - a literal, which no earlier pass can have changed (D48).voidValueTrackingAnalyzer.recordMayAliasOutside(ISymbol symbol) Record that the objectsymbolrefers to may be one that exists outside this callable (x <- view(),x <- this): a later call that reaches such an object may change it.voidValueTrackingAnalyzer.recordMayValues(ISymbol symbol, Set<Object> values) Record thatsymbol's value is not known exactly, but is one ofvalues.voidValueTrackingAnalyzer.recordSharing(ISymbol first, ISymbol second) Record thatfirstandsecondmay refer to the same object from here on -alias <- base, or the copy a capture list makes.voidValueTrackingAnalyzer.recordUnknownAssignment(ISymbol symbol) voidValueTrackingAnalyzer.registerModuleConstant(ISymbol symbol, AbstractValue abstractValue) Register a module-level constant (from defines constant blocks).voidValueTrackingAnalyzer.reportWhenSure(ISymbol symbol, Runnable report) Runreport- a finding thatsymbolis UNSET at this point on every pass - once it is SURE.voidConstraintState.set(ISymbol symbol, AbstractValue abstractValue) Set the abstract value for a symbol (mutates this state).voidRecord thatsymboldefinitely holdsvaluehere, REPLACING anything it may have held before — a later write kills an earlier value on this path.voidRecord the full set of values that may reachsymbolhere, REPLACING what came before.LockIdentityInference.tokenForSymbol(ISymbol symbol) Return an identity token for a field, parameter, or capture receiver.voidConstraintState.unmarkFreshInLoop(ISymbol symbol) symbolwas written with something other than a literal: what it holds may be what an earlier pass left in another variable, so it is no longer fresh (seeConstraintState.freshInLoop).LockIdentityInference.unwrapCapture(ISymbol symbol, IScopedSymbol enclosingFunction) LikeLockIdentityInference.tokenForSymbol(ISymbol)but unwraps one level of dynamic-function capture: if the symbol is one ofenclosingFunction's captured variables, resolve the same-named variable in theCaptureScope's enclosing scope and use that outer symbol's identity instead.Method parameters in org.ek9lang.compiler.phase5.flow with type arguments of type ISymbolModifier and TypeMethodDescriptionbooleanValueTrackingAnalyzer.mayBeChangedByCall(ISymbol symbol, boolean reachesOutside, Collection<ISymbol> reachedNames) THE reading ofValueTrackingAnalyzer.recordCallThatMayChange(boolean, Collection)as a question about ONE object: may a call that may run the program's own code, given what it reaches, change the objectsymbolrefers to? Yes when that object itself has escaped, or when the call reaches an object from outside andsymbol's may be one.voidValueTrackingAnalyzer.recordCallThatMayChange(boolean reachesOutside, Collection<ISymbol> reachedNames) A call that may run the program's own code (not pure, not a concrete built-in) - it may change every object it can reach (D66, Steve 2026-10-21): the receiver, every argument, everything reachable from them and everything that may be the same object. -
Uses of ISymbol in org.ek9lang.compiler.phase5.lockanalysis
Methods in org.ek9lang.compiler.phase5.lockanalysis that return ISymbolModifier and TypeMethodDescriptionCrossThreadEdge.caller()Returns the value of thecallerrecord component.ChainStep.contextFunction()Returns the value of thecontextFunctionrecord component.EnterCallSite.enclosingFunction()Returns the value of theenclosingFunctionrecord component.MutexKeyBody.enclosingFunction()Returns the value of theenclosingFunctionrecord component.FunctionLockSummary.function()Returns the value of thefunctionrecord component.CrossThreadEdge.handler()Returns the value of thehandlerrecord component.MutexKeyBody.keyFunction()Returns the value of thekeyFunctionrecord component.LockIdentityDescriptor.originSymbol()Returns the value of theoriginSymbolrecord component.ChainStep.stepTarget()Returns the value of thestepTargetrecord component.Methods in org.ek9lang.compiler.phase5.lockanalysis that return types with arguments of type ISymbolModifier and TypeMethodDescriptionLockAnalysis.lookupPureGetterReturnFields(String methodFqn) Look up the set of fields a pure-getter method may return.Methods in org.ek9lang.compiler.phase5.lockanalysis with parameters of type ISymbolModifier and TypeMethodDescriptionstatic FunctionLockSummaryConvenience factory producing an empty summary backed by mutable collections.voidLockAnalysis.recordPureGetterReturnField(String methodFqn, ISymbol returnedField) Record that a pure-getter method (by FQN) returns the given field symbol.Constructors in org.ek9lang.compiler.phase5.lockanalysis with parameters of type ISymbolModifierConstructorDescriptionChainStep(StepKind kind, IToken stepLocation, ISymbol contextFunction, ISymbol stepTarget, String contextDescription) Creates an instance of aChainSteprecord class.CrossThreadEdge(ISymbol caller, ISymbol handler, IToken callLocation) Creates an instance of aCrossThreadEdgerecord class.EnterCallSite(String stableId, ISymbol enclosingFunction, IToken callLocation, Set<String> lockIdentityIds, String receiverDisplayForm, EnterKind kind) Creates an instance of aEnterCallSiterecord class.FunctionLockSummary(ISymbol function, List<EnterCallSite> directEnters, List<MutexKeyBody> directKeyBodies, Set<TransitiveEnterRecord> mayEnter) Creates an instance of aFunctionLockSummaryrecord class.LockIdentityDescriptor(String stableId, IdentityOrigin origin, ISymbol originSymbol, IToken originLocation, String displayName) Creates an instance of aLockIdentityDescriptorrecord class.MutexKeyBody(String stableId, ISymbol keyFunction, IToken declarationLocation, ISymbol enclosingFunction, String outerLockIdentityId) Creates an instance of aMutexKeyBodyrecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase7
Fields in org.ek9lang.compiler.phase7 declared as ISymbolModifier and TypeFieldDescription(package private) final ISymbolScenario2WrapperHelper.delegateTypeMethods in org.ek9lang.compiler.phase7 that return ISymbolModifier and TypeMethodDescription(package private) ISymbolConstrainedTypeInstrs.booleanType()(package private) ISymbolConstrainedTypeInstrs.definingTypeOf(String methodName, List<ISymbol> argumentTypes) The type that DECLARES the base method a call forwards to, via THE sharedDefiningType- so the descriptor owner here is derived exactly as at every other phase-7 call site (Base.balanceOf, neverDerived.balanceOf).Methods in org.ek9lang.compiler.phase7 with parameters of type ISymbolModifier and TypeMethodDescription(package private) booleanScenario2WrapperHelper.containedTypeHasOperator(ISymbol type, String operatorGlyph) Whether the contained (element) type has a REAL binaryoperatorGlyph(==,<>) - its own, a super's or a trait's, never only the degenerateAnyone.protected voidAbstractDfnGenerator.createInitOperation(IRConstruct construct, IScope aggregateSymbol, ISymbol superType) Create _c_init operation for class/static initialization.(package private) StringScenario2WrapperHelper.emitVirtualCall(List<IRInstr> instructions, String targetVar, String targetType, ISymbol targetTypeSymbol, String methodName, List<String> paramTypes, String returnType, List<String> argNames, DebugInfo debugInfo) A virtual method call whose result (+1) the caller states the owner of itself - it casts it (Scenario2WrapperHelper.ownedCast(List, String, String, String, DebugInfo)) or moves it.(package private) StringScenario2WrapperHelper.generateConstructorCall(List<IRInstr> instructions, ISymbol type, boolean externallyLinked, String typeName, List<String> paramTypes, List<String> argNames, DebugInfo debugInfo) A constructor call whose new value (+1) the caller states the owner of itself (it moves it).(package private) StringScenario2WrapperHelper.generateConstructorCallInstructions(List<IRInstr> instructions, ISymbol type, String typeName, List<String> paramTypes, List<String> argNames, String scopeId, DebugInfo debugInfo) Generate a constructor call on a type: the new value (+1) is owned by the scope, dropped at its exit.(package private) StringScenario2WrapperHelper.generateProducerVirtualCall(List<IRInstr> instructions, String targetVar, String targetType, ISymbol targetTypeSymbol, String methodName, List<String> paramTypes, String returnType, List<String> argNames, String scopeId, DebugInfo debugInfo) Generate a virtual method call whose result is a +1 PRODUCER — a value-method or operator that hands back a freshly-owned object (e.g.(package private) booleanScenario2WrapperHelper.hasPublicNoArgConstructor(ISymbol type) Whethertype()can be called here to make an unset value of it: a concrete aggregate with a public no-argument constructor.(package private) booleanIs this the built-in Any (by symbol identity, never by name)?(package private) booleanScenario2WrapperHelper.isBareConceptualOnTemplate(ISymbol templateDeclaredType) True when the generic template declared this position as a bare conceptual type parameter (T), as opposed to a parameterisation such as Iterator of T or Comparator of T.(package private) booleanScenario2WrapperHelper.isDelegatingParameterisedType(ISymbol type) THE shared check for "is this a parameterised BUILT-IN generic that carries a rawdelegate" — one whose value must be UNWRAPPED via.delegateon store and RE-WRAPPED on return / at a callback edge.(package private) booleanScenario2WrapperHelper.isFunctionParameterisation(ISymbol type) THE shared check for "is this type a parameterisation of a generic FUNCTION" (e.g.(package private) booleanScenario2WrapperHelper.isThisWrapper(ISymbol type) Is this exactly THIS wrapper's type (parameterised wrappers are closed: a different parameterisation of the same generic is a different type)?(package private) booleanIs this the built-in Void (by symbol identity)? An absent type is a void return.(package private) voidScenario2WrapperHelper.returnVirtualCall(List<IRInstr> instructions, String targetVar, String targetType, ISymbol targetTypeSymbol, String methodName, List<String> paramTypes, String returnType, List<String> argNames, String scopeId, DebugInfo debugInfo) A virtual method call whose result (+1) is moved straight into the return variable: the method hands its caller exactly the count the callee handed it.(package private) StringTHE IR name of a type in a Scenario-2 wrapper: its fully qualified name.Method parameters in org.ek9lang.compiler.phase7 with type arguments of type ISymbolModifier and TypeMethodDescription(package private) CallMetaDataDetailsConstrainedTypeInstrs.baseConstructorMetaData(List<ISymbol> argumentTypes) Metadata for a constructor of the BASE type - every constrained-type lowering that materialises a base value (unset delegate, conversion, copy) calls one of these.(package private) CallMetaDataDetailsConstrainedTypeInstrs.baseMetaData(String methodName, List<ISymbol> argumentTypes) Metadata for the BASE type'smethodNametakingargumentTypes.(package private) ISymbolConstrainedTypeInstrs.definingTypeOf(String methodName, List<ISymbol> argumentTypes) The type that DECLARES the base method a call forwards to, via THE sharedDefiningType- so the descriptor owner here is derived exactly as at every other phase-7 call site (Base.balanceOf, neverDerived.balanceOf).(package private) voidConstrainedConstruction.processParameterizedConstructor(OperationInstr operation, List<ISymbol> params) Generate constructor that takes a base-type argument and stores it in the delegate field. -
Uses of ISymbol in org.ek9lang.compiler.phase7.calls
Classes in org.ek9lang.compiler.phase7.calls that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classTHE type that DECLARES a resolved method (its enclosing scope) - i.e.final classTHE type that DECLARES a resolved method (its enclosing scope) - i.e.final classTHE type that DECLARES a resolved method (its enclosing scope) - i.e.(package private) final classTHE test, for a chained call (ChainedCallDispatch), of whetherdefiningTypeis a strict ancestor ofreceiverTypethrough the CLASS super-chain (IAggregateSymbol.getSuperAggregate()- class inheritance only; traits are NOT on this chain).(package private) final classTHE test, for a chained call (ChainedCallDispatch), of whetherdefiningTypeis a strict ancestor ofreceiverTypethrough the CLASS super-chain (IAggregateSymbol.getSuperAggregate()- class inheritance only; traits are NOT on this chain).final classTHE test of whether a type is open for extension (can have subclasses) - the openness half of a call's dispatch decision (CallTargetResolution).final classTHE virtual-dispatch decision of a resolved call (CallTargetResolution):falsefor constructors, private methods (cannot be overridden), and targets not open for extension (effectively final).final classTHE virtual-dispatch decision of a resolved call (CallTargetResolution):falsefor constructors, private methods (cannot be overridden), and targets not open for extension (effectively final).final classTHE dispatch flag for a call the compiler SYNTHESISED, where the callee type may not have been threaded through (CallTargetResolution).final classTHE return type of the operator a unary or binary expression resolved to (IR tidy W3.9, OPS-11 - it wasAbstractGenerator.extractReturnType): read off theCallSymbolphase 3 recorded on the expression, the returning type of the method or function it calls, else the fallback (the operand).final classTHE return type of the operator a unary or binary expression resolved to (IR tidy W3.9, OPS-11 - it wasAbstractGenerator.extractReturnType): read off theCallSymbolphase 3 recorded on the expression, the returning type of the method or function it calls, else the fallback (the operand).final classTHE return type of the operator a unary or binary expression resolved to (IR tidy W3.9, OPS-11 - it wasAbstractGenerator.extractReturnType): read off theCallSymbolphase 3 recorded on the expression, the returning type of the method or function it calls, else the fallback (the operand).Methods in org.ek9lang.compiler.phase7.calls that return ISymbolModifier and TypeMethodDescriptionThe declaring type ofresolvedMethod, elsestaticType.The return type of the operation the expression symbol resolved to.CallContext.returnType()Returns the value of thereturnTyperecord component.CallContext.targetType()Returns the value of thetargetTyperecord component.Methods in org.ek9lang.compiler.phase7.calls that return types with arguments of type ISymbolModifier and TypeMethodDescriptionCallContext.argumentTypes()Returns the value of theargumentTypesrecord component.OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes) THE declared parameter types of the operator/method that actually serves a call - read off the RESOLVED member, never copied from the arguments.OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.declaredParameterTypes(ISymbol, String, List)inside a monomorphisation: the parameter types the member that SERVES the call declares (OperatorTargetMethodResolver.servingMember(ISymbol, String, List, UnaryOperator)), so a call a generic body makes on its bareTnames the type argument's operator, never the template'sT._cmp(T)(D53).Methods in org.ek9lang.compiler.phase7.calls with parameters of type ISymbolModifier and TypeMethodDescriptionThe declaring type ofresolvedMethod, elsestaticType.Create CallDetails for _isSet() call on the specified operand.OperatorTargetMethodResolver.apply(ISymbol targetType, String methodName, List<ISymbol> argumentTypes) Resolve a method/operator on the target type, returning the resolved symbol itself (not just type names), so callers can read its defining type, return type and metadata rather than re-deriving them.The return type of the operation the expression symbol resolved to.Metadata for a zero-argument call (operand._isSet(),resource._close()).ResolvemethodName(argumentTypes)ontargetTypeand read the metadata off the resolved callee.OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes) THE declared parameter types of the operator/method that actually serves a call - read off the RESOLVED member, never copied from the arguments.OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.declaredParameterTypes(ISymbol, String, List)inside a monomorphisation: the parameter types the member that SERVES the call declares (OperatorTargetMethodResolver.servingMember(ISymbol, String, List, UnaryOperator)), so a call a generic body makes on its bareTnames the type argument's operator, never the template'sT._cmp(T)(D53).static CallContextCallContext.forBinaryOperation(ISymbol leftType, ISymbol rightType, ISymbol returnType, String methodName, String leftVariable, String rightVariable, String scopeId) Create context for binary operation: left.method(right)static CallContextCallContext.forBinaryOperationWithContext(ISymbol leftType, ISymbol rightType, ISymbol returnType, String methodName, String leftVariable, String rightVariable, String scopeId, org.antlr.v4.runtime.ParserRuleContext parseContext) Create context for binary operation with parseContext: left.method(right) Used when Phase 3 has already resolved the method (e.g., switch case comparisons)SynthesisedCallMetaData.forConstructor(ISymbol targetType, List<ISymbol> argumentTypes) Metadata for a CONSTRUCTOR call on the given type - the default constructor whenargumentTypesis empty, otherwise the matching overload (e.g.static CallContextCallContext.forFunctionCall(ISymbol targetType, List<ISymbol> argumentTypes, String methodName, String targetVariable, List<String> argumentVariables, String scopeId, EK9Parser.CallContext parseContext) Create context for function call: function(args...)static CallContextCallContext.forPrimaryReferenceOperation(ISymbol leftType, ISymbol rightType, ISymbol returnType, String methodName, String leftVariable, String rightVariable, String scopeId, boolean isSuperReceiver) Create context for a method-based operator applied to an explicitthisorsuperprimary reference -super :=: source,super :~: source, and friends.SynthesisedCallMetaData.forSynthesisedCallee(ISymbol target, String methodName, List<ISymbol> argumentTypes) Metadata for a callee the COMPILER itself synthesised, where a symbol may legitimately not exist - returns null, meaning no metadata clause, when there is nothing measured to report.SynthesisedCallMetaData.forSynthesisedConstructor(ISymbol targetType, List<ISymbol> argumentTypes) A compiler-synthesised CONSTRUCTOR - seeSynthesisedCallMetaData.forSynthesisedCallee(ISymbol, String, List).static CallContextCallContext.forUnaryOperation(ISymbol targetType, String methodName, String targetVariable, ISymbol returnType, String scopeId) Create context for unary operation: target.method()static CallContextCallContext.forUnaryOperation(ISymbol targetType, String methodName, String targetVariable, ISymbol returnType, String scopeId, boolean isSuperReceiver) Context for a unary operator applied to an explicitsuperprimary reference -$super,#?super,$$super.static ChainedCallDispatchChainedCallDispatch.of(MethodSymbol toBeCalled, String receiverTemp, ISymbol receiverType, boolean isExplicitTraitTypeRef, boolean isSuperCall, IRGenerationContext stackContext) Decide how a chained call totoBeCalledonreceiverTypeis dispatched.(package private) static DispatchFactsDispatchFacts.ofClose(String ownerTypeName, boolean isTraitCall, boolean isVirtualCall, ISymbol ownerType) The facts of a generatedclose- seeCloseCallTarget, which decides them.static DispatchFactsDispatchFacts.ofForwardToBase(String definingTypeName, ISymbol definingType, ISymbol baseType) The facts of a call a constrained type FORWARDS to its base (a delegated member, a constraint comparison): the call names the type that DECLARES the base member and the trait flag is read off that same type, dispatch is the BASE type's openness, and extern is the declaring type's (IsExternallyLinked).static DispatchFactsDispatchFacts.ofOperatorFallback(Optional<ScopedSymbol> servingMember, ISymbol staticType, boolean explicitSuperReceiver, TypeNameOrException typeNames, UnaryOperator<ISymbol> concreteType) The facts of an operator call with no parse node (path B ofCallDetailsBuilder: a compound assignment, a unary operator, a phase-7 protocol call): the call names the type that declares the serving member when one resolves, else the static type; a trait call is virtual by definition, otherwise dispatch is the static type's openness; extern is the STATIC type's (MONO-5 - see the class note).static DispatchFactsDispatchFacts.ofResolvedCall(ISymbol resolvedMethod, ISymbol servingMethod, ISymbol staticType, boolean explicitSuperReceiver, TypeNameOrException typeNames, UnaryOperator<ISymbol> concreteType) The facts of a call to a member phase 3 RESOLVED (path A ofCallDetailsBuilder): the call names the type that DECLARES the serving member, the trait flag is read off that same type (they move together -CallTargetResolution), dispatch is a trait call orIsVirtualCallof the RECORDED member and the static type, and extern is the declaring type's.static DispatchFactsDispatchFacts.ofSynthesisedCallee(String targetTypeName, boolean isTraitCall, ISymbol calleeType, UnaryOperator<ISymbol> concreteType) The facts of a call the compiler SYNTHESISED on a value's type (?,close): the named type and its trait flag as given, dispatch from the callee type's openness (IsVirtualForSynthesisedCallee), extern the callee type's (IsExternallyLinked).static DispatchFactsDispatchFacts.ofTargetType(String targetTypeName, ISymbol targetType, boolean shapePermitsDispatch) The facts of a call on a type held as a SYMBOL but with no resolved member (CallDetailsFactory.call's symbol overload): the call names that type, the trait flag and openness are read off it, the call SHAPE may veto dispatch, and extern is the named type's (IsExternallyLinked).CloseCallTarget.ofType(ISymbol staticType, String staticTypeName, Function<ISymbol, String> resolveTypeName) The dispatch facts for closing a value whose static TYPE is known.OperatorTargetMethodResolver.servingMember(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.apply(ISymbol, String, List)followed byOperatorTargetMethodResolver.onTypeArgument(ScopedSymbol, UnaryOperator): the member that serves the call, read off the type argument when the call is resolved on a generic's bareTinside a monomorphisation.booleanTrue iffdefiningTypeis a strict class ancestor ofreceiverType.booleanbooleanWhether a call toresolvedMethodontargetTypeneeds virtual (vtable) dispatch.booleanMethod parameters in org.ek9lang.compiler.phase7.calls with type arguments of type ISymbolModifier and TypeMethodDescriptionOperatorTargetMethodResolver.apply(ISymbol targetType, String methodName, List<ISymbol> argumentTypes) Resolve a method/operator on the target type, returning the resolved symbol itself (not just type names), so callers can read its defining type, return type and metadata rather than re-deriving them.ResolvemethodName(argumentTypes)ontargetTypeand read the metadata off the resolved callee.OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes) THE declared parameter types of the operator/method that actually serves a call - read off the RESOLVED member, never copied from the arguments.OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.declaredParameterTypes(ISymbol, String, List)inside a monomorphisation: the parameter types the member that SERVES the call declares (OperatorTargetMethodResolver.servingMember(ISymbol, String, List, UnaryOperator)), so a call a generic body makes on its bareTnames the type argument's operator, never the template'sT._cmp(T)(D53).OperatorTargetMethodResolver.declaredParameterTypes(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.declaredParameterTypes(ISymbol, String, List)inside a monomorphisation: the parameter types the member that SERVES the call declares (OperatorTargetMethodResolver.servingMember(ISymbol, String, List, UnaryOperator)), so a call a generic body makes on its bareTnames the type argument's operator, never the template'sT._cmp(T)(D53).SynthesisedCallMetaData.forConstructor(ISymbol targetType, List<ISymbol> argumentTypes) Metadata for a CONSTRUCTOR call on the given type - the default constructor whenargumentTypesis empty, otherwise the matching overload (e.g.static CallContextCallContext.forFunctionCall(ISymbol targetType, List<ISymbol> argumentTypes, String methodName, String targetVariable, List<String> argumentVariables, String scopeId, EK9Parser.CallContext parseContext) Create context for function call: function(args...)SynthesisedCallMetaData.forSynthesisedCallee(ISymbol target, String methodName, List<ISymbol> argumentTypes) Metadata for a callee the COMPILER itself synthesised, where a symbol may legitimately not exist - returns null, meaning no metadata clause, when there is nothing measured to report.SynthesisedCallMetaData.forSynthesisedConstructor(ISymbol targetType, List<ISymbol> argumentTypes) A compiler-synthesised CONSTRUCTOR - seeSynthesisedCallMetaData.forSynthesisedCallee(ISymbol, String, List).static DispatchFactsDispatchFacts.ofOperatorFallback(Optional<ScopedSymbol> servingMember, ISymbol staticType, boolean explicitSuperReceiver, TypeNameOrException typeNames, UnaryOperator<ISymbol> concreteType) The facts of an operator call with no parse node (path B ofCallDetailsBuilder: a compound assignment, a unary operator, a phase-7 protocol call): the call names the type that declares the serving member when one resolves, else the static type; a trait call is virtual by definition, otherwise dispatch is the static type's openness; extern is the STATIC type's (MONO-5 - see the class note).static DispatchFactsDispatchFacts.ofResolvedCall(ISymbol resolvedMethod, ISymbol servingMethod, ISymbol staticType, boolean explicitSuperReceiver, TypeNameOrException typeNames, UnaryOperator<ISymbol> concreteType) The facts of a call to a member phase 3 RESOLVED (path A ofCallDetailsBuilder): the call names the type that DECLARES the serving member, the trait flag is read off that same type (they move together -CallTargetResolution), dispatch is a trait call orIsVirtualCallof the RECORDED member and the static type, and extern is the declaring type's.static DispatchFactsDispatchFacts.ofSynthesisedCallee(String targetTypeName, boolean isTraitCall, ISymbol calleeType, UnaryOperator<ISymbol> concreteType) The facts of a call the compiler SYNTHESISED on a value's type (?,close): the named type and its trait flag as given, dispatch from the callee type's openness (IsVirtualForSynthesisedCallee), extern the callee type's (IsExternallyLinked).CloseCallTarget.ofType(ISymbol staticType, String staticTypeName, Function<ISymbol, String> resolveTypeName) The dispatch facts for closing a value whose static TYPE is known.OperatorTargetMethodResolver.onTypeArgument(ScopedSymbol templateMember, UnaryOperator<ISymbol> typeArgumentOf) THE member that serves, inside a monomorphisation, a call phase 3 resolved on a generic's bareT.OperatorTargetMethodResolver.servingMember(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.apply(ISymbol, String, List)followed byOperatorTargetMethodResolver.onTypeArgument(ScopedSymbol, UnaryOperator): the member that serves the call, read off the type argument when the call is resolved on a generic's bareTinside a monomorphisation.OperatorTargetMethodResolver.servingMember(ISymbol targetType, String methodName, List<ISymbol> argumentTypes, UnaryOperator<ISymbol> typeArgumentOf) OperatorTargetMethodResolver.apply(ISymbol, String, List)followed byOperatorTargetMethodResolver.onTypeArgument(ScopedSymbol, UnaryOperator): the member that serves the call, read off the type argument when the call is resolved on a generic's bareTinside a monomorphisation.Constructors in org.ek9lang.compiler.phase7.calls with parameters of type ISymbolModifierConstructorDescriptionCallContext(ISymbol targetType, String targetVariable, String methodName, List<ISymbol> argumentTypes, List<String> argumentVariables, String scopeId, ISymbol returnType, org.antlr.v4.runtime.ParserRuleContext parseContext) Every call site that is not an explicitsuperreceiver - which is all of them but one.CallContext(ISymbol targetType, String targetVariable, String methodName, List<ISymbol> argumentTypes, List<String> argumentVariables, String scopeId, ISymbol returnType, org.antlr.v4.runtime.ParserRuleContext parseContext, boolean explicitSuperReceiver) Creates an instance of aCallContextrecord class.Constructor parameters in org.ek9lang.compiler.phase7.calls with type arguments of type ISymbolModifierConstructorDescriptionCallContext(ISymbol targetType, String targetVariable, String methodName, List<ISymbol> argumentTypes, List<String> argumentVariables, String scopeId, ISymbol returnType, org.antlr.v4.runtime.ParserRuleContext parseContext) Every call site that is not an explicitsuperreceiver - which is all of them but one.CallContext(ISymbol targetType, String targetVariable, String methodName, List<ISymbol> argumentTypes, List<String> argumentVariables, String scopeId, ISymbol returnType, org.antlr.v4.runtime.ParserRuleContext parseContext, boolean explicitSuperReceiver) Creates an instance of aCallContextrecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase7.generation
Methods in org.ek9lang.compiler.phase7.generation that return ISymbolModifier and TypeMethodDescriptionIRGenerationContext.resolveType(ISymbol typeSymbol) The SYMBOL form ofIRGenerationContext.resolveTypeName(ISymbol)- the concrete type a (possibly conceptual) type resolves to under the current generic substitution.Monomorphisation.resolveType(ISymbol typeSymbol) The concrete type a (possibly conceptual) type resolves to under the monomorphisation in progress; outside one the symbol is returned unchanged.Methods in org.ek9lang.compiler.phase7.generation that return types with arguments of type ISymbolModifier and TypeMethodDescriptionMonomorphisation.dynamicConstructCopyOf(ISymbol template) The copy already made of a dynamic construct for the monomorphisation in progress, if any.IRGenerationContext.resolveTypeByIrName(String fullyQualifiedName) THE recovery of a type symbol from the IR type NAME a phase-7 site already emitted - only for where the name is all that survived (aCallInstrcarries its return type as a name).Methods in org.ek9lang.compiler.phase7.generation with parameters of type ISymbolModifier and TypeMethodDescriptionCreate an input-class probe for a public construct's entry (the dynamic numerator, §5).voidIRInstructionBuilder.callInstanceInit(ISymbol constructType, DebugInfo debugInfo) voidIRInstructionBuilder.callSuperClassInit(ISymbol superType) THE call of a super type's_c_init(class initialisation) from a construct's own, into the fixedIRConstants.TEMP_C_INIT, with the current frame's debug info.voidIRInstructionBuilder.callSuperConstructor(ISymbol superType) AddIRInstructionBuilder.superConstructorCall(ISymbol, DebugInfo)with the current frame's debug info.Monomorphisation.dynamicConstructCopyOf(ISymbol template) The copy already made of a dynamic construct for the monomorphisation in progress, if any.voidIRInstructionBuilder.initializeEnumConstant(ISymbol enumType, String constantName, int ordinal) Initialize an enum constant static field.IRInstructionBuilder.instanceInitCall(ISymbol constructType, DebugInfo debugInfo) THE call of a construct's own_i_init- its field initialisers - from a constructor, synthetic or written (IR tidy W3.4, OPS-2/MONO-14); use this, never a hand-builtCallDetails.voidMonomorphisation.recordDynamicConstructCopy(ISymbol template, ISymbol monomorph) Record the copy made of a dynamic construct for the monomorphisation in progress; from now on every reference to the construct (its own body, its constructor call, a nested construct) resolves to the copy.IRGenerationContext.resolveType(ISymbol typeSymbol) The SYMBOL form ofIRGenerationContext.resolveTypeName(ISymbol)- the concrete type a (possibly conceptual) type resolves to under the current generic substitution.Monomorphisation.resolveType(ISymbol typeSymbol) The concrete type a (possibly conceptual) type resolves to under the monomorphisation in progress; outside one the symbol is returned unchanged.IRGenerationContext.resolveTypeName(ISymbol typeSymbol) THE "what concrete type name does this (possibly conceptual) type have inside the current Scenario-3 monomorphisation?" step - use this, and never re-derive a variant.Monomorphisation.resolveTypeName(ISymbol typeSymbol) The name form ofMonomorphisation.resolveType(ISymbol).IRInstructionBuilder.superConstructorCall(ISymbol superType, DebugInfo debugInfo) THE implicit super-constructor call (super.<init>()) of a constructor, synthetic or written (IR tidy W3.4, OPS-2/MONO-14) - use this, never a hand-builtCallDetails. -
Uses of ISymbol in org.ek9lang.compiler.phase7.generator
Classes in org.ek9lang.compiler.phase7.generator that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classTHE assignment of an assignmentExpression to a symbol (the expression is generated bygenerators.assignmentExprGenerator), in one of twoAssignExpressionToSymbol.Modes - TWO per construct on the set,generators.assignToNewSymbolandgenerators.assignToExistingSymbol(IR tidy W3.9, EXPR-15), never one per assignment.final classTHE resolver of phase-5 quality metrics for one operation, for every IR generator that registers a function entry withCoverageProbePlacer.final classResolves the user-facing display name for a function/method symbol used in coverage and quality reports.final classTHE join key for a construct - the display name (CoverageDisplayName) minus its one cosmetic exception.(package private) final classTHE coverage name of a function/method symbol, before the display-only transform - the one resolution bothCoverageDisplayName(bareConstructortrue) andCoverageIdentity(bareConstructorfalse) give; the class javadoc ofCoverageDisplayNamehas the four cases.(package private) final classThe source-level names a coverage name is made from (seeCoverageDisplayName): a callable's own name, and an aggregate's name.final classTHE fully-qualified name to use as a coverage/profiling IDENTITY for a callable - stable across every parameterisation of a generic.final classTHE test of whether a member the compiler synthesised is instrumented (given coverage and profiling probes byFunctionProbes): only what an author would recognise.Methods in org.ek9lang.compiler.phase7.generator with type parameters of type ISymbolModifier and TypeMethodDescription<T extends ICanCaptureVariables & ISymbol>
List<IRInstr> DynamicConstructEmitter.emit(T dynamicSymbol, Function<IRGenerationContext, IRConstruct> generate, EK9Parser.DynamicVariableCaptureContext captureCtx, DebugInfo debugInfo, String resultVariable, Function<List<ISymbol>, CallMetaDataDetails> metaData) Emit the dynamic construct and the instructions that construct it.Methods in org.ek9lang.compiler.phase7.generator that return ISymbolModifier and TypeMethodDescriptionRangeIterationHelper.InitializationData.byType()Returns the value of thebyTyperecord component.protected ISymbolThe CONCRETE form of a type read straight off a stream symbol (aStreamCallSymbol's produces or consumes type) - under the current Scenario-3 substitution, so inside a monomorphized generic body a templateTorList of Tbecomes the parameterisation's own type.RangeIterationHelper.InitializationData.constrainedBase()Returns the value of theconstrainedBaserecord component.TerminalSetup.consumesType()Returns the value of theconsumesTyperecord component.(package private) ISymbolRangeIterationHelper.InitializationData.counterType()The type the counter, the end copy and the direction probe are held in: the base of a constrained range type, else the range type itself.(package private) ISymbolStreamPipelineMachinery.edgeConsumes(EK9Parser.StreamPartContext stage) The phase-3-resolved IN-edge (consumes) type of a stream stage, ornullif unresolved.(package private) ISymbolStreamPipelineMachinery.edgeProduces(EK9Parser.StreamPartContext stage) The phase-3-resolved OUT-edge (produces) type of a stream stage, ornullif the stage has no recordedStreamCallSymbolor no produced type set.(package private) ISymbolStreamPipelineMachinery.effectivePostSortElementType(SortSetup sortSetup, List<EK9Parser.StreamPartContext> allStages, ISymbol sourceType) The element type the POST-sort pipeline (and terminal) observe.StreamSource.elementType()Returns the value of theelementTyperecord component.(package private) ISymbolPipelineVarPlan.finalType()protected ISymbolAbstractGenerator.getRecordedSymbolOrException(org.antlr.v4.runtime.tree.ParseTree node) Safely retrieve the recorded symbol for a parse tree node with automatic validation.ReturningParamProcessor.getReturnSymbol(EK9Parser.ReturningParamContext ctx) Extract the return variable symbol from a returningParam context.(package private) ISymbolPipelineVarPlan.inType(int stageIndex) (package private) ISymbolGuardedConditionEvaluator.preFlowTargetSymbol(EK9Parser.PreFlowStatementContext preFlowStmt) THE recorded symbol of the variable a pre-flow declares or assigns (FLOW-1).LoopGuardHelper.preFlowTargetSymbol(EK9Parser.PreFlowStatementContext preFlowStmt) THE recorded symbol of the variable a pre-flow declares or assigns (FLOW-1), for the constructs that read it themselves (a switch's discriminant).ConstructorCallProcessor.processChainStart(CallSymbol callSymbol, EK9Parser.CallContext callContext, String resultVariable, List<IRInstr> instructions) THE constructor call that STARTS an object-access chain -String(move).upperCase(),Holder(3).amount(),SomeText("en").message().RangeIterationHelper.InitializationData.rangeType()Returns the value of therangeTyperecord component.protected ISymbolAbstractStreamStageGenerator.returnTypeOf(FunctionSymbol function) THE return type of a stage's function operand (a uniq/group key, a tee mapper) - read throughAbstractStreamStageGenerator.symbolTypeOrException, so under the current Scenario-3 substitution; nevergetReturningSymbol().getType()raw.ResourceCloser.Closing.staticType()Returns the value of thestaticTyperecord component.ObjectAccessInstrGenerator.ChainStepResult.typeSymbol()Returns the value of thetypeSymbolrecord component.SwitchStatementGenerator.EvalVariable.typeSymbol()Returns the value of thetypeSymbolrecord component.Methods in org.ek9lang.compiler.phase7.generator that return types with arguments of type ISymbolModifier and TypeMethodDescriptionWrittenParameters.symbols(EK9Parser.ArgumentParamContext argumentParam, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recordedSymbol) The symbols of the written parameters - thoseWrittenParameters.declarations(EK9Parser.ArgumentParamContext, GeneratorSet)declares.PipelineVarPlan.typeAt()Returns the value of thetypeAtrecord component.Methods in org.ek9lang.compiler.phase7.generator with parameters of type ISymbolModifier and TypeMethodDescriptionAssignExpressionToSymbol.apply(ISymbol lhsSymbol, EK9Parser.AssignmentExpressionContext ctx) Resolve every phase-5 metric for one operation.Resolve the display name for a function/method symbol.The join key of a function/method symbol.The name ofoperationSymbol.The callable's own source-level name: its declared name, except that a constructor of a parameterised type is named for the generic it parameterises.The coverage/profiling identity of a callable.(package private) voidStreamEmissionEngine.applyAsyncBufferSortEmit(String asyncExecutorVar, ISymbol asyncProducesType, List<EK9Parser.StreamPartContext> preSortStages, EK9Parser.StreamPartContext sortStage, List<EK9Parser.StreamPartContext> postSortStages, TerminalSetup terminalSetup, org.antlr.v4.runtime.tree.ParseTree probeSite, DebugInfo debugInfo, List<IRInstr> instructions) Async-specific entry toStreamEmissionEngine.bufferSortEmit(HelperSource, ISymbol, List, EK9Parser.StreamPartContext, List, TerminalSetup, ParseTree, DebugInfo, List): drains the async executor (hasNext/next); its pipeline's finally region closes it.(package private) voidStreamEmissionEngine.applyGroupingStage(StreamSource source, ISymbol consumedElementType, BucketTracker tracker, StageGroup preStageGroup, StageGroup postStageGroup, BoundaryConditionBuilder boundaryBuilder, TerminalSetup terminalSetup, org.antlr.v4.runtime.tree.ParseTree probeSite, List<IRInstr> instructions, DebugInfo debugInfo) Shared drain+emit engine for the consecutive-grouping stream stages (GROUP, SPLIT).(package private) SortSetupStreamEmissionEngine.applySortToCollection(List<EK9Parser.StreamPartContext> stages, IteratorSetup iteratorSetup, ISymbol elementType, IAggregateSymbol collectionType, org.antlr.v4.runtime.tree.ParseTree probeSite, DebugInfo debugInfo, List<IRInstr> instructions) (package private) voidStreamEmissionEngine.applyWindowedAsyncToCollection(List<EK9Parser.StreamPartContext> stages, int asyncIndex, List<EK9Parser.StreamPartContext> preAsyncStages, List<StageState> preAsyncStageStates, IteratorSetup iteratorSetup, ISymbol elementType, ISymbol asyncProducesType, String asyncExecutorVar, TerminalSetup terminalSetup, org.antlr.v4.runtime.tree.ParseTree probeSite, DebugInfo debugInfo, List<IRInstr> instructions, List<StageState> postAsyncStates) Step C — the interleaved WINDOWED async driver for an unbounded source (the telemetry casecat udp | async | filter | head N | collect).(package private) voidStreamEmissionEngine.bufferSortEmit(HelperSource source, ISymbol bucketType, List<EK9Parser.StreamPartContext> preSortStages, EK9Parser.StreamPartContext sortStage, List<EK9Parser.StreamPartContext> postSortStages, TerminalSetup terminalSetup, org.antlr.v4.runtime.tree.ParseTree probeSite, DebugInfo debugInfo, List<IRInstr> instructions) (package private) StageWrapResultStreamEmissionEngine.buildAsyncSubmitAction(String submitItemVar, ISymbol elementType, String asyncExecutorVar, String inFlightVar, String oneVar, ISymbol integerType, List<EK9Parser.StreamPartContext> preAsyncStages, List<StageState> preAsyncStageStates, org.ek9lang.compiler.phase7.generator.StreamEmissionEngine.AsyncCap cap, DebugInfo debugInfo) The per-item SUBMIT action shared by the windowed prime loop and the drain refill:executor.submit(item); inFlight++, wrapped in the pre-ASYNC stages (filter/map/etc.).(package private) ConditionAndPostLoopStreamPipelineMachinery.buildStreamLoop(IteratorSetup iteratorSetup, List<StageState.Counter> demandBounds, String itemVar, ISymbol itemType, boolean rawIterator, org.antlr.v4.runtime.tree.ParseTree probeSite, StreamLoopSink sink, DebugInfo debugInfo) The unified iterator-driven stream while-loop skeleton: condition scope (hasNext(), with the demand bounds - the segment's heads, or the async window - folded in ahead of it byStreamDemand) + body scope (binditerator.next()then theStreamLoopSinkbody-tail) + theConditionAndPostLoopthe caller emits withStreamPipelineMachinery.emitStreamLoop(ConditionAndPostLoop, String, DebugInfo, List).(package private) ConditionAndPostLoopStreamPipelineMachinery.buildUnprobedStreamLoop(IteratorSetup iteratorSetup, List<StageState.Counter> demandBounds, String itemVar, ISymbol itemType, boolean rawIterator, StreamLoopSink sink, DebugInfo debugInfo) StreamPipelineMachinery.buildStreamLoop(IteratorSetup, List, String, ISymbol, boolean, ParseTree, StreamLoopSink, DebugInfo)with NO loop-body coverage probe - the emission of a sorted bucket buffer (StreamEmissionEngine.bufferSortEmit), which has never carried one.StreamEmissionEngine.buildWindowRefill(IteratorSetup iteratorSetup, boolean isRawIterator, String submitItemVar, ISymbol elementType, String asyncExecutorVar, String inFlightVar, String oneVar, ISymbol integerType, List<EK9Parser.StreamPartContext> preAsyncStages, List<StageState> preAsyncStageStates, List<StageState.Counter> postHeads, org.ek9lang.compiler.phase7.generator.StreamEmissionEngine.AsyncCap cap, DebugInfo debugInfo) The windowed drain's REFILL step:if ([c1 < l1 AND ...] source.hasNext()) { bind submitItem = next(); [pre-async stages]; submit(submitItem); inFlight++ }.protected ISymbolThe CONCRETE form of a type read straight off a stream symbol (aStreamCallSymbol's produces or consumes type) - under the current Scenario-3 substitution, so inside a monomorphized generic body a templateTorList of Tbecomes the parameterisation's own type.(package private) voidStreamEmissionEngine.continueOverIterator(List<EK9Parser.StreamPartContext> stages, IteratorSetup sourceIter, ISymbol sourceElementType, Function<List<IRInstr>, TerminalSetup> terminalResolver, boolean sourceUnbounded, org.antlr.v4.runtime.tree.ParseTree probeSite, DebugInfo debugInfo, List<IRInstr> instructions) THE pipeline driver over a source iterator: emit a stream given assourceIterthroughstagesto the terminal, with NO composition limit.(package private) voidStreamEmissionEngine.continueOverIterator(List<EK9Parser.StreamPartContext> stages, IteratorSetup sourceIter, ISymbol sourceElementType, TerminalSetup terminalSetup, org.antlr.v4.runtime.tree.ParseTree probeSite, DebugInfo debugInfo, List<IRInstr> instructions, boolean sourceUnbounded) THE pipeline driver over a terminal that is already resolved - the buffers' own re-entry: see the overload below.(package private) StringStreamPipelineMachinery.declareInitialisedSlot(List<IRInstr> target, ISymbol type, String literal, DebugInfo debugInfo) THE declaration of a compiler-made, initialised SLOT - a counter or flag rebound as the pipeline runs (a head or skip counter, the async in-flight and submitted counts, the windowed-asyncmoreflag):REFERENCE,STOREof the initial value,RETAIN, then the slot registered in the current scope, which releases its LAST value on exit and on unwind (A10; EK9_IR_OWNERSHIP_MODEL.md §6).(package private) IteratorSetupStreamPipelineMachinery.drainSourceToIterator(HelperSource source, ISymbol bucketType, boolean keepsUnset, DebugInfo debugInfo, List<IRInstr> instructions) As above;keepsUnsetappends with+=so an UNSET element survives the buffer - a stage never drops one (KeepsUnsetElements).(package private) IteratorSetupStreamPipelineMachinery.drainSourceToIterator(HelperSource source, ISymbol bucketType, DebugInfo debugInfo, List<IRInstr> instructions) MATERIALISE a buffering value source (a GROUP/SPLIT tracker's hasNextGroup/nextGroup, or an async executor's hasNext/next) into a fresh raw EK9_LIST buffer and return an IteratorSetup over it.(package private) ISymbolStreamPipelineMachinery.effectivePostSortElementType(SortSetup sortSetup, List<EK9Parser.StreamPartContext> allStages, ISymbol sourceType) The element type the POST-sort pipeline (and terminal) observe.protected StringAbstractStreamStageGenerator.emitStageFunctionOperand(List<IRInstr> target, EK9Parser.PipelinePartContext pipelinePartCtx, ISymbol operandSymbol, FunctionSymbol functionType, DebugInfo debugInfo) THE shared emission of a stream stage's function operand - use this, do not re-derive it.FunctionProbes.enter(CoverageProbePlacer placer, ISymbol operation, DebugInfo debugInfo) THE registration of a callable with the probe placer, and its three probes.GuardedConditionEvaluator.evaluateGuardOnlyForVariable(ISymbol guardSymbol, String variableName, VariableDetails conditionResult, String scopeId, DebugInfo debugInfo) Evaluates guard only for a pre-resolved variable (used by WHILE/DO-WHILE for entry check).ControlFlowChainGenerator.generateAssignIfUnset(ISymbol lhsSymbol, List<IRInstr> assignmentEvaluation, String assignmentResult, DebugInfo debugInfo) Generate SWITCH_CHAIN_BLOCK for assign-if-unset (:=?).ControlFlowChainGenerator.generateAssignIfUnsetTestForTemp(String variableName, ISymbol variableSymbol, String resultVariable, DebugInfo debugInfo) The question operator on a temp that holds the current value of a:=?target: a null there is the never-written slot:=?exists to write, so it is NOT a strict-absent observation (StrictAbsent).(package private) ConditionAndPostLoopStreamEmissionEngine.generateConditionAndBody(org.antlr.v4.runtime.tree.ParseTree probeSite, List<EK9Parser.StreamPartContext> stages, IteratorSetup iteratorSetup, String pipelineItemVar, ISymbol elementType, TerminalSetup terminalSetup, DebugInfo debugInfo, List<StageState> stageStates, boolean rawIterator, String pipelineScopeId, List<IRInstr> preLoopInstructions) Generate condition (hasNext) and body (next + stages + terminal pipe).AbstractStreamStageGenerator.generateCounterDelta(String counterVar, String oneVar, String op, ISymbol integerType, DebugInfo debugInfo) ReassigncounterVar = counterVar <op> oneVar("_add"to increment,"_sub"to decrement) via the RELEASE/STORE/RETAIN reassignment pattern.StreamPipelineMachinery.generateDynamicStageLimit(EK9Parser.StreamPartContext stageCtx, String limitVar, ISymbol integerType, String scopeId, DebugInfo debugInfo) Generate IR to evaluate a dynamic stage operand (function reference or call) and store the Integer result in the given limit variable.StreamPipelineMachinery.generatePipelineItemBinding(String iteratorVar, IAggregateSymbol iteratorType, String pipelineItemVar, ISymbol elementType, DebugInfo debugInfo, boolean rawIterator) Generate: pipelineItem = iterator.next() Follows ForInGenerator.generateLoopVariableBinding() pattern.ControlFlowChainGenerator.generateQuestionOperatorForTemp(String variableName, ISymbol variableSymbol, String resultVariable, DebugInfo debugInfo) Generate SWITCH_CHAIN_BLOCK for Question operator applied to a temp variable.ControlFlowChainGenerator.generateQuestionOperatorForVariable(ISymbol variableSymbol, String resultVariable, DebugInfo debugInfo) Generate SWITCH_CHAIN_BLOCK for Question operator applied to a variable.AbstractStreamStageGenerator.generateTerminalPipe(TerminalSetup terminalSetup, String pipelineItemVar, ISymbol elementType, DebugInfo debugInfo) THE shared "pipe a value into a sink" step:sink._pipe(value)- used by the pipeline terminal and bytee's side terminal.booleanStatementOwnedCloseables.involvesCloseables(List<IRInstr> evaluation, ISymbol resultType) True whenStatementOwnedCloseables.ownedEvaluation(ParserRuleContext, List, String, ISymbol)could do anything to this evaluation: its value is closeable, or it makes a closeable temporary phase 5 marked as owned, or it holds one deferred to it.protected StringAbstractStreamStageGenerator.loadManagedLiteral(List<IRInstr> target, String value, ISymbol type, DebugInfo debugInfo) THE load of a compiler-made literal ("0","1", a fixed head/tail limit,"true") into a fresh managed temp - mints the temp, then the managed literal load.StatementOwnedCloseables.ownedEvaluation(org.antlr.v4.runtime.ParserRuleContext ctx, List<IRInstr> evaluation, String resultVariable, ISymbol resultType) An evaluation nested inside another instruction (a condition, a control, an operand) that hands ONE value on: the evaluation wrapped, like a statement, in THE owned region that closes the closeable temporaries it made - and the variable that now holds its value after the region.(package private) PipelineVarPlanStreamPipelineMachinery.planPipelineVars(List<EK9Parser.StreamPartContext> stages, String sourceVar, ISymbol sourceType, String scopeId, DebugInfo debugInfo, List<IRInstr> declarationsOut) Compute the per-boundary item-variable plan for an in-loop stage list, allocating a fresh variable (declared at the produced type) only where a stage changes the element type.(package private) static PipelineVarPlan(package private) StageWrapResultStreamEmissionEngine.terminalBodyTail(List<EK9Parser.StreamPartContext> stages, String itemVar, ISymbol itemType, TerminalSetup terminalSetup, String scopeId, List<IRInstr> preLoopInstructions, List<StageState> stageStates, String asyncExecutorVar, DebugInfo debugInfo) StreamEmissionEngine.terminalBodyTail(List, String, ISymbol, TerminalSetup, String, List, List, DebugInfo)over an async executor's results:asyncExecutorVaris handed to a HEAD among the stages so a satisfied head cancels the executor's outstanding work (null: no executor).(package private) StageWrapResultStreamEmissionEngine.terminalBodyTail(List<EK9Parser.StreamPartContext> stages, String itemVar, ISymbol itemType, TerminalSetup terminalSetup, String scopeId, List<IRInstr> preLoopInstructions, List<StageState> stageStates, DebugInfo debugInfo) The shared stream body-tail, used identically by the cat path (theStreamPipelineMachinery.buildStreamLoop(IteratorSetup, List, String, ISymbol, boolean, ParseTree, StreamLoopSink, DebugInfo)sink) and the for-range streaming body: plan the per-boundary item vars (declared pre-loop inpreLoopInstructionsso a post-loop consumer like JOIN's emit references a dominating var), pipe the final-typed item to the terminal, and wrap the result in the intermediate stages.booleanTrue when the synthesised member gets probes.static ResourceCloser.ClosingThe super class's close, called NON-virtually on this object (super._close()): the last step of a generated close chain.FilterRejectStageWrapper.wrap(StageWrapParams params, String pipelineItemVar, ISymbol elementType) StreamElementStageWrapper.wrap(StageWrapParams params, String pipelineItemVar, ISymbol elementType) WrapinnerBodyin this stage's gate or side effect.TeeStageWrapper.wrap(StageWrapParams params, String pipelineItemVar, ISymbol elementType, StageState teeState) WrapinnerBody: pipe the item (or its mapped value) to the side target, then run the inner body.UniqStageWrapper.wrap(StageWrapParams params, String pipelineItemVar, ISymbol elementType, StageState stageState) (package private) StageWrapResultStreamStageDispatcher.wrapWithStages(List<EK9Parser.StreamPartContext> stages, Supplier<List<IRInstr>> innerBody, String pipelineItemVar, ISymbol elementType, DebugInfo debugInfo, List<StageState> stageStates) Wrap an innermost body with intermediate pipeline stages in reverse order.(package private) StageWrapResultStreamStageDispatcher.wrapWithStages(List<EK9Parser.StreamPartContext> stages, Supplier<List<IRInstr>> innerBody, String pipelineItemVar, ISymbol elementType, DebugInfo debugInfo, List<StageState> stageStates, String asyncExecutorVar) Wrap inner body instructions with intermediate pipeline stages in reverse order.(package private) StageWrapResultStreamStageDispatcher.wrapWithStages(List<EK9Parser.StreamPartContext> stages, Supplier<List<IRInstr>> innerBody, String pipelineItemVar, ISymbol elementType, DebugInfo debugInfo, List<StageState> stageStates, String asyncExecutorVar, PipelineVarPlan plan) Core stage-wrapping with an explicit per-boundaryPipelineVarPlan.Method parameters in org.ek9lang.compiler.phase7.generator with type arguments of type ISymbolModifier and TypeMethodDescriptionprotected CallDetailsAbstractStreamStageGenerator.streamFunctionCall(FunctionSymbol fn, String funcInstanceVar, List<ISymbol> flowingTypes, List<String> argVars, String returnTypeName, DebugInfo debugInfo, List<IRInstr> setupInstructions) THE shared builder for a stream stage-function_callinvocation - used by every stage that invokes a resolved function on the flowing element(s): filter/reject and split predicates, map and tee mappers, uniq and group key-functions, and the join fold.WrittenParameters.symbols(EK9Parser.ArgumentParamContext argumentParam, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recordedSymbol) The symbols of the written parameters - thoseWrittenParameters.declarations(EK9Parser.ArgumentParamContext, GeneratorSet)declares.Constructors in org.ek9lang.compiler.phase7.generator with parameters of type ISymbolModifierConstructorDescription(package private)ChainStepResult(String tempName, ISymbol typeSymbol, boolean isVoid, boolean isExplicitTraitTypeRef) Creates an instance of aChainStepResultrecord class.A value already held in a variable.Closing(List<IRInstr> load, String variable, ISymbol staticType, String staticTypeName, DebugInfo debugInfo) A value brought into a variable byload(a property's LOAD_FIELD).Closing(List<IRInstr> load, String variable, ISymbol staticType, String staticTypeName, DebugInfo debugInfo, boolean viaSuper) Creates an instance of aClosingrecord class.EvalVariable(String name, String type, ISymbol typeSymbol) Creates an instance of aEvalVariablerecord class.(package private)InitializationData(List<IRInstr> instructions, String endTemp, String byTemp, String directionTemp, String currentTemp, ISymbol rangeType, ISymbol byType, ISymbol constrainedBase, String startTemp, boolean progressChecked) Creates an instance of aInitializationDatarecord class.(package private)StreamSource(IteratorSetup iteratorSetup, ISymbol elementType, boolean sourceUnbounded) Creates an instance of aStreamSourcerecord class.(package private)TerminalSetup(String variable, IAggregateSymbol type, MethodSymbol resolvedPipeMethod, ISymbol consumesType) Creates an instance of aTerminalSetuprecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase7.support
Classes in org.ek9lang.compiler.phase7.support that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionclassCreates the appropriate Field object for the symbol and adds it to the construct.final classTHE reading of how a function call finds the function instance it invokes - hold one and ask it, never read theDELEGATE_CALLmark by hand.final classGet the name of the variable suitable for use in the IR.Methods in org.ek9lang.compiler.phase7.support that return ISymbolModifier and TypeMethodDescriptionComparisonParams.booleanType()Returns the value of thebooleanTyperecord component.DirectionCheckParams.booleanType()Returns the value of thebooleanTyperecord component.IncrementParams.counterType()Returns the value of thecounterTyperecord component.PromotionCallGenerator.getPromotedType(ISymbol sourceType) Get the type that results from promoting the given type using #^.DirectionCheckParams.integerType()Returns the value of theintegerTyperecord component.BinaryOperatorParams.leftType()Returns the value of theleftTyperecord component.ComparisonParams.leftType()Returns the value of theleftTyperecord component.AssignIfUnsetDetails.lhsSymbol()Returns the value of thelhsSymbolrecord component.LiteralProcessingDetails.literalSymbol()Returns the value of theliteralSymbolrecord component.LiteralParams.literalType()Returns the value of theliteralTyperecord component.UnaryOperatorParams.operandType()Returns the value of theoperandTyperecord component.BinaryOperatorParams.resultType()Returns the value of theresultTyperecord component.UnaryOperatorParams.resultType()Returns the value of theresultTyperecord component.BinaryOperatorParams.rightType()Returns the value of therightTyperecord component.ComparisonParams.rightType()Returns the value of therightTyperecord component.PromotionParams.sourceType()Returns the value of thesourceTyperecord component.Methods in org.ek9lang.compiler.phase7.support that return types with arguments of type ISymbolModifier and TypeMethodDescriptionArgumentDetails.argumentSymbols()Returns the value of theargumentSymbolsrecord component.CaptureConstructorParameters.typeSymbols()Returns the value of thetypeSymbolsrecord component.Methods in org.ek9lang.compiler.phase7.support with parameters of type ISymbolModifier and TypeMethodDescriptionvoidConstantCopyOnAccessLoader.apply(ISymbol constantSymbol, String resultVariable, DebugInfo debugInfo) Read the constant into resultVariable as a fresh copy.IsSetEvaluationCreator.apply(String operandVariable, ISymbol operandSymbol, VariableDetails resultDetails) Creates _isSet() method call instructions.ConstantCopyOnAccessLoader.applyToNewTemp(ISymbol constantSymbol, DebugInfo debugInfo) Read the constant into a freshly generated temp, returning both the instructions and that temp.CallDetailsFactory.call(String targetObject, ISymbol targetType, String methodName, List<String> parameterTypes, String returnTypeName, List<String> arguments, CallMetaDataDetails metaData) The same call, but taking the target type as a SYMBOL so BOTH the emitted type name and the virtual-dispatch flag derive from it - they then cannot disagree.PromotionCallGenerator.getPromotedType(ISymbol sourceType) Get the type that results from promoting the given type using #^.booleanConstantCopyOnAccessLoader.isCopyOnAccessConstant(ISymbol symbol) Does this symbol need the copy-on-access constant read?FunctionMemberSymbols.isSet(FunctionSymbol function, ISymbol booleanType) The function's?operator: pure, returningBoolean rtn- a function is always set.CollectionElementPromoter.promoteIfRequired(ISymbol elementType, ISymbol targetType, String elementTemp, DebugInfo debugInfo, List<IRInstr> setupInstructions) Insert a#^promotion for a collection element when its static type is not directly assignable to the collection's resolved element type but is coercible to it (single promotion, per EK9 rules).CollectionElementPromoter.promoteIfRequired(ISymbol elementType, ISymbol targetType, String elementTemp, DebugInfo debugInfo, List<IRInstr> setupInstructions, boolean escaping) AsCollectionElementPromoter.promoteIfRequired(ISymbol, ISymbol, String, DebugInfo, List), butescapingselects the ARC of any inserted promote:falsefor a scope-local value (collection element, range bound, comparison operand) — RETAIN + SCOPE_REGISTER;truefor a value that ESCAPES the current scope (a coalescing/ternary body-result that becomes the expression value) — RETAIN only, the consumer takes ownership.CollectionElementPromoter.promotionNeed(ISymbol from, ISymbol to) THE "promote if required" decision, for every site that widens a value into a slot (parameters, assignments, collection elements, range bounds, operands): never re-derive thegetUnCoercedAssignableCostTo/TypeCoercionspair.booleanTraitCall.requiredFor(ISymbol targetType) booleanTraitCall.requiredForValue(ISymbol targetValue) AsTraitCall.requiredFor(ISymbol)but for a value symbol (field/variable/expression) whose declared type is the call target.booleanTraitCall.requiredForValue(ISymbol targetValue, UnaryOperator<ISymbol> typeArgumentOf) AsTraitCall.requiredForValue(ISymbol)inside a monomorphisation: the value's declared type is substituted first, so a value typed by a bareTis judged by the type argument (D54).booleanTrue when the recorded call symbol is a delegate call: the function instance is loaded from a variable (or is the result of an inner call) instead of being the named function's singleton.Method parameters in org.ek9lang.compiler.phase7.support with type arguments of type ISymbolModifier and TypeMethodDescriptionFunctionMemberSymbols.constructor(FunctionSymbol function, boolean pure, List<ISymbol> parameters) The function's constructor, returning the function's own type.(package private) Optional<OperationDetailsLocator.Located> OperationDetailsLocator.find(ParsedModule parsedModule, EK9Parser.AggregatePartsContext ctx, Predicate<ISymbol> matches) Find the declaration whose recorded symbol satisfiesmatches.The stores of each captured variable's property from the capture constructor's parameter at the same position.The stores of a construct whose capture constructor's parameters are its captured variables themselves (a dynamic function's, or a dynamic class's synthetic one).SanitizedParameterPrologue.of(IRGenerationContext stackContext, List<ISymbol> parameters) Create the prologue that cleans everySANITIZED_REQUIREDparameter in place, each instruction attributed to the parameter's own declaration.SanitizedParameterPrologue.of(IRGenerationContext stackContext, List<ISymbol> parameters, DebugInfo debugInfo) Create the prologue with every instruction attributed todebugInfo.booleanTraitCall.requiredForValue(ISymbol targetValue, UnaryOperator<ISymbol> typeArgumentOf) AsTraitCall.requiredForValue(ISymbol)inside a monomorphisation: the value's declared type is substituted first, so a value typed by a bareTis judged by the type argument (D54).Constructors in org.ek9lang.compiler.phase7.support with parameters of type ISymbolModifierConstructorDescriptionAssignIfUnsetDetails(ISymbol lhsSymbol, EK9Parser.AssignmentExpressionContext assignmentExpression, org.antlr.v4.runtime.Token operatorToken) Creates an instance of aAssignIfUnsetDetailsrecord class.BinaryOperatorParams(String leftOperand, String rightOperand, String operator, ISymbol leftType, ISymbol rightType, ISymbol resultType, String resultTemp, String scopeId, DebugInfo debugInfo) Creates an instance of aBinaryOperatorParamsrecord class.ComparisonParams(String leftOperand, String rightOperand, String operator, ISymbol leftType, ISymbol rightType, ISymbol booleanType, String booleanObjectTemp, String primitiveBooleanTemp, String scopeId, DebugInfo debugInfo) Creates an instance of aComparisonParamsrecord class.DirectionCheckParams(String directionTemp, String comparisonOperator, String zeroTemp, String booleanObjectTemp, String primitiveBooleanTemp, ISymbol integerType, ISymbol booleanType, String scopeId, DebugInfo debugInfo) Creates an instance of aDirectionCheckParamsrecord class.IncrementParams(String counterVar, String operator, ISymbol counterType, String scopeId, DebugInfo debugInfo) Creates an instance of aIncrementParamsrecord class.LiteralParams(String tempName, String literalValue, ISymbol literalType, DebugInfo debugInfo) Creates an instance of aLiteralParamsrecord class.LiteralProcessingDetails(ISymbol literalSymbol, String literalResult) Creates an instance of aLiteralProcessingDetailsrecord class.PromotionParams(ISymbol sourceType, String sourceVariable, DebugInfo debugInfo) Non-escaping (scope-local) promotion — the common case (list/dict element, range bound, comparison operand).PromotionParams(ISymbol sourceType, String sourceVariable, DebugInfo debugInfo, boolean escaping) Creates an instance of aPromotionParamsrecord class.UnaryOperatorParams(String operand, String operator, ISymbol operandType, ISymbol resultType, String resultTemp, String scopeId, DebugInfo debugInfo) Creates an instance of aUnaryOperatorParamsrecord class. -
Uses of ISymbol in org.ek9lang.compiler.phase7.synthesis
Classes in org.ek9lang.compiler.phase7.synthesis that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classCreates the synthetic_fieldSetStatusmethod symbol used as an IR carrier.Methods in org.ek9lang.compiler.phase7.synthesis that return ISymbolModifier and TypeMethodDescriptionprotected ISymbolAbstractSyntheticGenerator.getAnyType()The Any type SYMBOL - the root of every EK9 type, a Java interface at the backend.protected ISymbolAbstractSyntheticGenerator.getBitsType()The Bits type SYMBOL - seeAbstractSyntheticGenerator.getBooleanType().protected ISymbolAbstractSyntheticGenerator.getBooleanType()The Boolean type SYMBOL - for reading call metadata off it, rather than only naming it.protected ISymbolAbstractSyntheticGenerator.getIntegerType()The Integer type SYMBOL - seeAbstractSyntheticGenerator.getBooleanType().protected ISymbolAbstractSyntheticGenerator.getStringType()The String type SYMBOL - seeAbstractSyntheticGenerator.getBooleanType().protected ISymbolThe same type, as a SYMBOL rather than a name - so a call ON this value can derive its dispatch flag instead of inheriting the builder's shape-only default.EnumPrimitiveOperatorGenerator.Call.receiverType()Returns the value of thereceiverTyperecord component.Methods in org.ek9lang.compiler.phase7.synthesis that return types with arguments of type ISymbolModifier and TypeMethodDescriptionAbstractSyntheticGenerator.getSyntheticFields(AggregateSymbol aggregateSymbol) Get all fields from an aggregate that should be included in synthetic operations.Methods in org.ek9lang.compiler.phase7.synthesis with parameters of type ISymbolModifier and TypeMethodDescriptionFieldSetStatusSymbolGenerator.apply(AggregateSymbol aggregateSymbol, ISymbol bitsType) Create the detached_fieldSetStatuscarrier for this aggregate, if it should have one.protected DebugInfoAbstractSyntheticGenerator.createDebugInfo(ISymbol symbol) Create debug info from a symbol's source token.protected SynthesisScopeAbstractSyntheticGenerator.createSynthesisScope(ISymbol symbol, String scopeLabel) Create an SynthesisScope for the given operator symbol.AbstractSyntheticGenerator.fieldIsSetCall(ISymbol field, String fieldVar, String resultVar, DebugInfo debugInfo, String scopeId) THEfield._isSet()step of the field-wise synthetic generators - a trait-typed field is dispatched through its interface.AbstractSyntheticGenerator.fieldOperatorCall(ISymbol field, String fieldVar, String glyph, String jvmMethodName, String otherVar, String returnTypeName, String resultVar, DebugInfo debugInfo, String scopeId) THE per-field "call the field type's own operator, or fall back to Any's" step of every field-wise synthetic generator (==,<=>,#?,$,$$) - use this, never a hand-writtenfieldCapable ? getType(field) : getAnyType()(SYN-3).protected booleanAbstractSyntheticGenerator.fieldTypeHasRealOperator(ISymbol field, String glyph, boolean binary) Does the field's TYPE have a REALoperatorGlyphof its own (declared or inherited from a real super), as opposed to only the degenerateAnydefault that every type inherits?AbstractSyntheticGenerator.generateBinaryOperatorGuards(String aggregateTypeName, ISymbol aggregateType, String paramName, String unsetLabel, SynthesisScope ctx) Generate isSet guards for binary operators (this and param).AbstractSyntheticGenerator.generateIsSetGuard(String variableName, String typeName, ISymbol type, String unsetLabel, SynthesisScope ctx) Generate isSet guard check for a variable using SynthesisScope.AbstractSyntheticGenerator.generateIsSetGuard(String variableName, String typeName, ISymbol type, DebugInfo debugInfo, String unsetLabel, String scopeId) Generate isSet guard check for a variable with branch to unset return.AbstractSyntheticGenerator.generateThisIsSetGuard(String aggregateTypeName, ISymbol aggregateType, String unsetLabel, SynthesisScope ctx) Generate isSet guard for 'this' using SynthesisScope.AbstractSyntheticGenerator.generateThisIsSetGuard(String aggregateTypeName, ISymbol aggregateType, DebugInfo debugInfo, String unsetLabel, String scopeId) Generate isSet guard check for 'this' with branch to unset return.protected ISymbolThe same type, as a SYMBOL rather than a name - so a call ON this value can derive its dispatch flag instead of inheriting the builder's shape-only default.protected StringAbstractSyntheticGenerator.getTypeName(ISymbol symbol) Get the fully qualified name for a type.Constructors in org.ek9lang.compiler.phase7.synthesis with parameters of type ISymbol -
Uses of ISymbol in org.ek9lang.compiler.phase7.synthesis.support
Methods in org.ek9lang.compiler.phase7.synthesis.support with parameters of type ISymbolModifier and TypeMethodDescriptionReturnBlockHelper.generateUnsetReturn(String labelName, String returnTypeName, ISymbol returnType, String returnVarName, DebugInfo debugInfo, String scopeId) Generate a return block that returns an unset value of the given type.ReturnBlockHelper.generateUnsetStore(String labelName, String returnTypeName, ISymbol returnType, String returnVarName, DebugInfo debugInfo, String scopeId, String continueLabel) Generate a block that sets the return variable to an unset value of the given type and then goes on tocontinueLabelinstead of returning (seeReturnBlockHelper.generateBooleanStore(String, boolean, String, DebugInfo, String, String)).The same target, but named by its resolved SYMBOL so the dispatch flag can be derived from it. -
Uses of ISymbol in org.ek9lang.compiler.phase9
Constructor parameters in org.ek9lang.compiler.phase9 with type arguments of type ISymbolModifierConstructorDescription(package private)CalleeOfCall(Function<String, Optional<ISymbol>> typeNamed) -
Uses of ISymbol in org.ek9lang.compiler.search
Methods in org.ek9lang.compiler.search that return ISymbolMethods in org.ek9lang.compiler.search that return types with arguments of type ISymbolModifier and TypeMethodDescriptionSymbolSearch.getAsSymbol()Creates a new Symbol from the name in the search and the module name.SymbolSearch.getOfTypeOrReturn()SymbolSearch.getTypeParameters()Get the parameters being used in this search.Methods in org.ek9lang.compiler.search with parameters of type ISymbolModifier and TypeMethodDescriptionMethodSymbolSearch.addTypeParameter(ISymbol parameter) SymbolSearch.addTypeParameter(ISymbol parameter) Add a parameter to the search parameters.SymbolSearch.setExampleSymbolToMatch(ISymbol exampleSymbolToMatch) MethodSymbolSearch.setOfTypeOrReturn(ISymbol ofTypeOrReturn) SymbolSearch.setOfTypeOrReturn(ISymbol ofTypeOrReturn) Method parameters in org.ek9lang.compiler.search with type arguments of type ISymbolModifier and TypeMethodDescriptionMethodSymbolSearch.addTypeParameter(Optional<ISymbol> parameter) SymbolSearch.addTypeParameter(Optional<ISymbol> parameter) Add a type parameter to the search.MethodSymbolSearch.setOfTypeOrReturn(Optional<ISymbol> ofTypeOrReturn) SymbolSearch.setOfTypeOrReturn(Optional<ISymbol> ofTypeOrReturn) What type of symbol is being searched for or its return type.MethodSymbolSearch.setTypeParameters(List<ISymbol> typeParameters) SymbolSearch.setTypeParameters(List<ISymbol> typeParameters) Set any parameters that might be needed as part of this search.Constructors in org.ek9lang.compiler.search with parameters of type ISymbolModifierConstructorDescriptionMatchResult(int costOfMatch, ISymbol symbol) Create a new match result of a cost to match for a symbol.MethodSymbolSearch(String name, ISymbol ofTypeOrReturn) protectedSymbolSearch(String name, ISymbol ofTypeOrReturn) SymbolSearch(ISymbol exampleSymbolToMatch) Use a symbol to populate the search.Constructor parameters in org.ek9lang.compiler.search with type arguments of type ISymbolModifierConstructorDescriptionMethodSymbolSearch(String name, Optional<ISymbol> ofTypeOrReturn) protectedSymbolSearch(String name, Optional<ISymbol> ofTypeOrReturn) -
Uses of ISymbol in org.ek9lang.compiler.support
Classes in org.ek9lang.compiler.support that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionclassUses the symbol and scope management to traverse back up stack to determine if the outer parent is a generic type or not and also if this symbol passed in is a generic type.final classTHE search for the built-in Any through a scope: the fully qualified name, of category ANY - a category onlyAnyTypeSymbolhas, so nothing a user declares can answer it.final classTHE declared (target) type anassignmentExpressionis given to - use it, do not re-derive the walk.final classTHE test for a generic's bare type parameterTitself, as opposed to a generic that HAS type parameters.final classTHE body method of a program: the compiler-made_mainthat holds what was written in the program, and which IS the program wherever a person reads about it.final classTHE Boolean truth guard rule (Steve, 2026-10-07, decision D9.2) - use this, do not re-derive it.final classTHE Boolean truth guard rule (Steve, 2026-10-07, decision D9.2) - use this, do not re-derive it.final classTHE rule B of the closeable ownership decision (Steve, 2026-10-21): may a value of this RETURN type hold a borrowed VIEW of a closeable that was passed in - i.e.final classThe symbol a recorded symbol BINDS its occurrence to: for a call, the callable it resolved to, never the call itself; anything else (null included) as it is.final classTHE identity of a callable in the phase-5 call graph —module::Aggregate.member(T1,T2)for a method,module::Aggregate.memberfor any other aggregate member, and the plain fully-qualified name for everything else.final classTHE copy a dynamic function or class makes from one argument of its capture list (CaptureAliasesfollows these).final classTHE copy a dynamic function or class makes from one argument of its capture list (CaptureAliasesfollows these).final classRecords what the captures of a dynamic class are to its constructors (phase 3 only, once the capture constructor is decided).final classTHE "is this symbol one of the variables a dynamic function or class captured?" - by IDENTITY, never by name.classTHE common-type deduction - for collections (List/Dict literals, ranges, stream 'cat') and for the operators that SELECT one of their operands (?:, <? >?, the ternary).classGiven a list of symbols (normally variables), this code will get the type from each of those symbols.classGiven a list of symbols (normally variables), this code will get the type from each of those symbols.classYou may think why this mapping.classYou may think why this mapping.classYou may think why this mapping.classYou may think why this mapping.final classRecursively resolve a type reference to the leaf CONCRETE type symbols it actually couples to, skipping conceptualTs.final classRecursively resolve a type reference to the leaf CONCRETE type symbols it actually couples to, skipping conceptualTs.final classTHE recovery of the base type a CONSTRAINED type narrows — call this, do not re-derive it.final classTHE display name of a construct - the name a person reads for it at RUN TIME (F2, Steve 2026-10-08, Contract 21 inEK9_BACKEND_IR_CONTRACTS.md).final classTHE properties a constructor ofaggregateis responsible for: for a dynamic class its captures first (they live in the capture scope, not the class's own symbol table), then itsDeclaredProperties.final classTHE single enumeration of the type references a construct makes through its signature — super (extends), traits (implements), field types (composes), method / function parameter and return types (references), and closed-over captured-variable types (captures).final classTHE properties a type DECLARES itself, the property half of the fields an object of it carries (the other half, for a dynamic class, isCapturedVariables).final classTHE decision of which operator a GENERATED comparison is answered by - hold one and use it, do not re-derive it.final classConstructDisplayNamewith a dynamic construct among the type arguments left as its mangled name, so two parameterisations over two different dynamic classes never share it (both areBox of clsinConstructDisplayName).final classTHE test "this method or constructor takes exactly these parameter types, in this order" - each byisExactSameType, never by assignability, promotion or a cost-based match.final classTHE test "this method or operator takes exactly ONE parameter, and its type is EXACTLY this type" - byisExactSameType, never by assignability.final classTHE test for "is this symbol provided from OUTSIDE this workspace's EK9 source?" — a built-in, or any member of anexternconstruct.final classTHE field-slot rule: the index of a property in an object's flat field layout, as every back end lays it out and as the IR'sLOAD_FIELD/STORE_FIELD/RELEASE_FIELDindex states it (Contract 2: the index is the slot).classUsed to see if it is possible to resolve types, both simple and parametric.final classTHE fields a generated operator (?,$,$$,==,<=>,#?,_fieldSetStatus) walks for one aggregate: itsDeclaredProperties, then the variables a dynamic class captured (CapturedVariables; each becomes a field).final classTHE test of whether a parameterised type made inside a generic's body is a dependent (generic-in-generic) reference of that generic: it is parameterised, still generic in nature, and every bare type parameter it names (at any depth:List of List of T) is one of the generic's OWN type parameters.final classThe generic template a parameterised type was produced from (List,Dict, a userCache), or empty when the symbol is not a parameterised type.final classThe generic template a parameterised type was produced from (List,Dict, a userCache), or empty when the symbol is not a parameterised type.final classTHE defaulting of a service parameter that declares noHttpAccess: it is a PATH parameter bound to the placeholder of its own name.final classTHE reading and marking ofINPUT_VARIETY_RECEIVER: the input-variety FLOOR of this method counts its receiver as dimension p0 (coverage design section 4.5), so the phase-7 numerator probe emits a receiver cell.final classTHE marking ofINPUT_VARIETY_RECEIVER: the input-variety floor of this method counts its receiver as dimension p0.classGiven some sort of generic type a function or a type with a set of 'type parameters', create a unique internal name for that combination.final classTHE capture constructor of a dynamic class: the constructor whose parameter types are EXACTLY the capture types, in capture order (TakesExactlyTheTypesOf) - the one the definition site builds the object through, and the only one the captured values are stored by (Steve, 2026-10-28: "we need an exact match").final classTHE "is this symbol one of the variables a dynamic function or class captured?" - by IDENTITY againstCapturedVariables, never by name: a name join would take an unrelated variable of the same name (an outer local, a property) for the capture; the E08251 check once did.final classTHE reader of the concurrent-entry-point mark (MarkConcurrentEntryPoint): has this symbol been marked as a root of the data-race model? Never read the squirrel raw.final classTHE reader of the confined-outside-locks fact (phase5 ConfinedTypeMarker, beside the confined fact; design §13.11.1 (f)): can no value of this type be reached from anything shared between threads EXCEPT through aMutexLock's payload? Every confined type is; so is a type reached only through a payload - its objects are either under the lock or still being built by the one thread that will hand them over, copy them in or make them inside the body (T4, §13.12), so a write to one outside a lock is a write to that thread's own object.final classTHE reader of the confined-type fact (phase5 ConfinedTypeMarker; design §13.11 T12): can no value of this type be reached from anything shared between threads? A type with no mark - not yet decided, or not a user aggregate - is shared: fail closed.final classTHE "is this an enumeration?" - the symbol's genus isSymbolGenus.CLASS_ENUMERATION.final classPredicate to determine if a symbol is a function delegate.final classTrue when the symbol is a generic TEMPLATE (e.g.final classPredicate that returns true iff the symbol IS theorg.ek9.lang::MutexKeygeneric function itself, or a parameterised form of it (e.g.final classPredicate that returns true iff the symbol IS theorg.ek9.lang::MutexLockgeneric type itself, or a parameterised form of it (e.g.final classTHE test of whether a value declared of this type can be of another run-time type - so possibly a user's own object, or a sub-type holding anything: a bareT,Any, a function, a trait, an abstract type, and an OPEN class, which is as open-ended as an abstract one (asBase(held as Base) <- rtn as Base: heldgiven a sub-type of an openBasehands that sub-type back).final classTHE reader of the statement-ownership mark (MarkStatementOwned): is this recorded symbol a call whose closeable result its statement owns, and so closes? Phase 5's call graph and phase 7's call generation ask here; never read the squirrel raw.final classTrue when the symbol is a concrete PARAMETERISATION of a generic (e.g.final classTHE "is this a PARTIAL BUILT-IN" (PartialOrdering): a core built-in whose runtime class declares a comparison group (org.ek9.lang.ComparisonGroup) - its<=>is defined only within a group of its own values and unset between groups (a currency forMoney, a unit suffix forDimension).final classIs this type aPRE_BUILTparameterisation - a generic type whose parameterised form ships ready-made in the runtime (Iterator of Integeris_Iterator_2648..., a Java class in ek9-lang and a C struct in the native runtime), marked by phase 6'sParameterizedSymbolCreator.markIfPreBuilt.final classTHE reader ofMarkPublishedHandler's mark: is this a function handed to runtime threads for the life of a server or of the program (design §13.11, S2)?final classTHE reader of the registered-type fact (phase5 RegisteredTypeMarker; design §13.11 S2): can a value of this type be reached from what is published for the life of the program - an application's registrations, a handler given to runtime threads? A type with no mark - not yet decided - is registered: fail closed (a store into it publishes, which costs memory, never safety).final classTHE reader of the signal-reached fact (phase5 SignalHandlerNeighbourMarker; design §13.11 S2c, option A): can a signal handler reach a value of this type - through what it captures or injects, never into a MutexLock payload? A field of such a type written by code that runs beside a signal handler is shared state (E08251).final classWas this call completed from its declared target (TargetTypedConstruction,TargetTypedConstructionMarker).final classTHE test that an identifier's recorded symbol is a VARIABLE (a local, a parameter, a returning variable, a property), not a call or a type: the occurrences the flow checks follow an object through.final classTHE "is this member a whole-object operator?" - an operator whose name is one ofWholeObjectOperators.NAMES(?,==,<=>,$,:=:, ...), however it was written: by hand or bydefault operator.final classTHE types a reference to this type couples to, in order: the generic template it was produced from (empty for a plain type: a built-in container, or a user generic's own module,GenericTemplateOf) and then every leaf concrete type argument (ConcreteTypeArguments).final classTHE types a reference to this type couples to, in order: the generic template it was produced from (empty for a plain type: a built-in container, or a user generic's own module,GenericTemplateOf) and then every leaf concrete type argument (ConcreteTypeArguments).final classTHE "must a generated#?on this type leave this field out?" - the reading of phase 5's property-cycle marks (phase5/PropertyCycleMarker) for the hash (Contract 13).classTHE location of a symbol for a message: "on line 6 in 'filename.ek9'".final classTHE mark of a CONCURRENT ENTRY POINT - a function or method whose body may run on another thread (a service operation, a handler given to a thread-spawning call such asTCP.accept, an element function of anasyncstream stage).final classTHE mark of a function handed to runtime threads for the life of a server or of the program - the handler given toTCP.accept,acceptUntilComplete,HTTP.serveUntilCompleteorSignals.register(design §13.11, S2).final classTHE test of whether a value of a type can reach an object the PROGRAM defines (D7', Steve 2026-11-12): the type is open-ended (IsOpenEndedType: a bareT,Any, a function, a trait, an open or abstract type), or is a type the program defines (not core), or is a parameterisation one of whose arguments can, or has a property whose type can, or a super (other thanAny) that can.final classTHE tolerant reader for a symbol's measuredCommonValues.COMPLEXITY, for consumers that treat "not measured" as zero rather than as an error.final classTHE writer of a measuredCommonValues.COMPLEXITYfor a symbol that phase 5 will never visit; its tolerant reader isMeasuredComplexity.final classTHE module a type symbol belongs to, for the module-level quality trackers: the module the symbol was parsed in (phase 1 already resolved and recorded it, so reading it back is immune to the name-shape assumptions a name split makes), else - only for a symbol with no parsed module, such as a built-in reached through a synthesised scope, where there is nothing else to read - the module part of its fully qualified name.final classTHE rule that aPriorityQueueordered by its elements' natural order needs an orderable element type (D63, Steve 2026-10-21, option B).final classTHE rule that aPriorityQueueordered by its elements' natural order needs an orderable element type (D63, Steve 2026-10-21, option B).final classTHE check that a construct being defined in a user module does not take the name of a built-in construct (E01090).classChecks that a name being defined at module scope does not differ ONLY by case from a name already defined in that same module (across every construct kind - class, record, trait, function, component, service, text, program, application and constant).classChecks that a name being defined at module scope does not differ ONLY by case from a name already defined in that same module (across every construct kind - class, record, trait, function, component, service, text, program, application and constant).classDesigned to check if variable name and method names collide with Type/Function names.classTHE single predicate for "does this super type need an EK9-style super-init call emitted by the IR?".final classTHE error listener that owns a symbol: the listener of the source file that DECLARES it.final classTHE "is this a property of the object whose code is running?" - use it, never re-derive it.final classTheHttpAccesskind of this parameter: what was stored (StoredHttpAccess), else PATH - the kind an unqualified service parameter is assumed to be (seeHttpAccessDefaulting), so a check that runs without having asked for the default first still gets the answer the default would have given.final classTHE strict test:targetis a parameterisation of EXACTLY this generic - not a sub type or a super type of it - and so the parameterisation itself (List of Stringfor the genericList), else empty.final classTHE strict test:targetis a parameterisation of EXACTLY this generic - not a sub type or a super type of it - and so the parameterisation itself (List of Stringfor the genericList), else empty.final classCreate a new parameterised symbol from a generic type and a set of type arguments.classThis will just create an Aggregate/Function 'parameterized type' of the 'generic type' with the 'type arguments' But note it will have not - repeat NOT have - traversed the 'generic type' and cloned over the methods and altered all the 'T', 'K', 'V' - 'type parameters' for each of the 'type arguments' There is a separate function (TypeSubstitution) that does that.final classTHE answer to "is this type's<=>PARTIAL?" - unset for some pair of SET values of the type - given as the wording of why, to follow "'X' ...", or empty when it is total (so "is partial" isapply(...).isPresent()).final classTHE answer to "is this type's<=>PARTIAL?" - unset for some pair of SET values of the type - given as the wording of why, to follow "'X' ...", or empty when it is total (so "is partial" isapply(...).isPresent()).classYou may think why this mapping.classYou may think why this mapping.classCheck if this type being supplied to the test can be used as a program argument.final classTHE reading of a program's body - use it, never a private"_main"test.final classThe#^operator itself that this 'from' type promotes through, or empty if it has none - for a caller that must read the operator, not only its type (what its RETAINS say it does with the object it is called on: the closeable ownership decision, where an argument reaching a callee as its promotion is not the argument itself).final classThe#^operator itself that this 'from' type promotes through, or empty if it has none - for a caller that must read the operator, not only its type (what its RETAINS say it does with the object it is called on: the closeable ownership decision, where an argument reaching a callee as its promotion is not the argument itself).final classThe single type this 'from' type promotes to via its#^operator (PromotionOperator's return type), or empty if it has none.final classThe single type this 'from' type promotes to via its#^operator (PromotionOperator's return type), or empty if it has none.final classTHE element type of a queue type, when it is a parameterisation ofPriorityQueue- recognised through the symbol (Ek9Types.ek9PriorityQueue()), never by name (NaturalOrderQueue).final classTHE element type of a queue type, when it is a parameterisation ofPriorityQueue- recognised through the symbol (Ek9Types.ek9PriorityQueue()), never by name (NaturalOrderQueue).final classThe friendly name of a type as the symbol gives it, with a compiler-made name made readable (D65): the form a generated refusal message uses for the types it names -clsfor a dynamic class, never its digest.final classTHE name a GENERATED operator shows for a type in its text (D65, Contract 21 rule 5): a parameterised type by its friendly name (Holder of String), every other type by its simple name, and in either case a compiler-made name by whatFriendlyInternalNamegives it - a dynamic class iscls, never its_Class_<digest>.final classUtility to determine if an ISymbol represents a reference-counted type that should be included in the traceableFields list during initial IR generation.classRather than just check if the actual ISymbols are the same, this code checks if two symbols actually refer to the same source token from the same source file.classRather than just check if the actual ISymbols are the same, this code checks if two symbols actually refer to the same source token from the same source file.classThe bulk of the processing is in the abstract base.classThe bulk of the processing is in the abstract base.classThe bulk of the processing is in the abstract base.classget the appropriate return type from functions, methods and function delegates and constructors.classget the appropriate return type from functions, methods and function delegates and constructors.final classTHE reader of the runs-beside-signal-handlers fact (phase5 SignalHandlerNeighbourMarker; design §13.11 S2c, option A): can this callable run on the program's own thread while a signal handler can run on the dispatcher? Then E08251 holds it to the same rule as concurrent code for what a signal handler can reach.(package private) classChecks to see if the type parameters are the same as the generic arguments.(package private) classChecks to see if the type parameters are the same as the generic arguments.final classTHE reading and marking ofSANITIZED_REQUIRED: theas sanitizedmodifier on a parameter (and, by propagation, on an expression that is one of them).final classTHE marking ofSANITIZED_REQUIRED: the symbol is a parameter declaredas sanitized(or an expression derived from one), so the RECEIVER must clean it.final classTheHttpAccesskind stored on this parameter, or empty if none has been stored yet.final classTHE re-typing of a single symbol, in place, when it has a type: its type becomes the replacement's answer for it.final classTHE re-typing of a single symbol, in place, when it has a type: its type becomes the replacement's answer for it.classGiven a list of arguments (ISymbols), go through and extract the types out.final classTrue whenmethodtakes exactly the types ofvariables(VariableTypes), in order (ExactParameterTypes); false when any of the variables has no type.final classRecords that this call was completed from its declared target (TargetTypedConstruction, phase 3); read only byIsTargetTypedConstruction.classConverts a list of symbol using their friendly names in to a comma separated list.final classTHE leaf walk of a type's arguments: descend through every parameterisation (List of (Dict of (K, V))) and collect the leavesisLeafaccepts, in order.final classTHE leaf walk of a type's arguments: descend through every parameterisation (List of (Dict of (K, V))) and collect the leavesisLeafaccepts, in order.final classTHE leaf walk of a type's arguments: descend through every parameterisation (List of (Dict of (K, V))) and collect the leavesisLeafaccepts, in order.classGiven a Symbol that is some form of type, check that it could receive some piped data.final classCan the 'from' type be coerced to the 'to' type.final classCan the 'from' type be coerced to the 'to' type.classChecks that the symbols in list one and list two are each the same for the corresponding position in the list.oclassChecks that the symbols in list one and list two are each the same for the corresponding position in the list.ofinal classTHE test of whether a holder - a container variable, a stream's target, a call's result - can keep an object of a given type at all (D80 follow-up, 2026-10-21): the walk behindBorrowedViewReturn(rule B), asked about an object of one ofheldTypesinstead of about a closeable.final classTHE test of whether a holder - a container variable, a stream's target, a call's result - can keep an object of a given type at all (D80 follow-up, 2026-10-21): the walk behindBorrowedViewReturn(rule B), asked about an object of one ofheldTypesinstead of about a closeable.final classTHE reading of "a generic's own hand-written<=>compares values of this conceptualTwith<=>" (D89), however it reaches them (D91 step 4): directly, through the generic's own methods, through the generic functions it gives them to (and on through theirs), or by giving them to a function delegate - which is taken to order them, whatever it does (strict, as E06070).final classThe single level of type parameters (for a template) or type arguments (for a parameterisation) exactly as declared - for display/inspection.final classThe single level of type parameters (for a template) or type arguments (for a parameterisation) exactly as declared - for display/inspection.final classThe types of some variables (or parameters), in order; empty when any of them has no type (an earlier error).final classThe types of some variables (or parameters), in order; empty when any of them has no type (an earlier error).Methods in org.ek9lang.compiler.support that return ISymbolModifier and TypeMethodDescriptionConceptualTypeReplacement.apply(PositionalConceptualLookupMapping.Mapping typeMapping, ISymbol forType, IToken triggeredByToken) The concrete counterpart of a type, which may be conceptual, parameterised with conceptual arguments, or already concrete (in which case it is returned unchanged).ConstrainedBase.apply(IAggregateSymbol aggregate) The base typeaggregateconstrains, or null when it has no such constructor (so it is not a constrained type, or the compiler did not synthesise one).ParameterisedTypeData.genericTypeSymbol()Returns the value of thegenericTypeSymbolrecord component.ConceptualAccess.OrderingStep.intoParameter()Returns the value of theintoParameterrecord component.ConceptualTypeReplacement.rebuild(PositionalConceptualLookupMapping.Mapping typeMapping, PossibleGenericSymbol forType, IToken triggeredByToken) Rebuild a parameterised type against concrete type arguments, unconditionally.RecordedSymbols.Reference.symbol()Returns the value of thesymbolrecord component.ReferenceAssignment.target()Returns the value of thetargetrecord component.ConceptualAccess.OrderingUse.type()Returns the value of thetyperecord component.ConstructTypeReferences.TypeReference.type()Returns the value of thetyperecord component.Methods in org.ek9lang.compiler.support that return types with arguments of type ISymbolModifier and TypeMethodDescriptionCaptureAliases.aliasesOf(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree within, ISymbol symbol) symboland every captured copy of it made by a dynamic function or class insidewithin(transitively: a capture of a capture), as an identity set.DispatcherReachableTypes.all(ISymbol baseType, List<MethodSymbol> handlers, int paramIndex, ConcreteSubtypeFinder finder) AsDispatcherReachableTypes.concrete(ISymbol, List, int, ConcreteSubtypeFinder), but keeping abstract types.The Any reachable throughscope, or empty for a scope that cannot reach the built-in module.AssignmentTarget.apply(SymbolsAndScopes symbolsAndScopes, EK9Parser.AssignmentExpressionContext assignmentExpression) The declared type the assignment expression is given to, if it has one.BooleanTruthGuard.apply(EK9Parser.PreFlowStatementContext preFlow, ISymbol ek9Boolean) The target of a Boolean truth guard, if this pre-flow is one.CapturedCopy.apply(Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded, EK9Parser.ExpressionParamContext param) The copy a dynamic function or class makes from one argument of its capture list -(acc)and(total: acc)both make a copy, namedaccandtotal- which shares the object the argument refers to.CapturedVariables.apply(ICanCaptureVariables capturer) The variablescapturercaptured, in capture order; empty when it captures nothing (every aggregate can capture, only a dynamic one does).CommonTypeOrError.apply(CommonTypeDeterminationDetails details) ConstructorProperties.apply(IAggregateSymbol aggregate) DeclaredProperties.apply(IAggregateSymbol aggregateSymbol) The aggregate's own properties - none for an enumeration, whose values are constants, not fields.GeneralTypeResolver.apply(SymbolSearchConfiguration toResolve) GeneratedOperatorFields.apply(AggregateSymbol aggregateSymbol) The aggregate's own properties followed by its captured variables, in declaration order.ParameterisedLocator.apply(ParameterisedTypeData details) ResolveOrDefineExplicitParameterizedType.apply(EK9Parser.ParameterisedTypeContext ctx) ResolveOrDefineIdentifierReference.apply(EK9Parser.IdentifierReferenceContext ctx) ResolveOrDefineTypeDef.apply(EK9Parser.TypeDefContext ctx) CommonTypeDeterminationDetails.argumentSymbols()Returns the value of theargumentSymbolsrecord component.CommonTypeDeterminationDetails.argumentTypes()Returns the value of theargumentTypesrecord component.DispatcherReachableTypes.concrete(ISymbol baseType, List<MethodSymbol> handlers, int paramIndex, ConcreteSubtypeFinder finder) The types a value at this parameter could actually HAVE at runtime.CommonFactory.getDefaultOperatorInitializer(IToken startToken) QueueElementNeedingOrder.of(EK9Parser.CallContext ctx, CallSymbol callSymbol, Ek9Types ek9Types) The element type of the queue this written call constructs, when the construction needs a natural order.AggregateManipulator.resolveBits(IScope scope) Resolve Bits from cached ek9 types or full scope hierarchy resolution.AggregateManipulator.resolveBoolean(IScope scope) Resolve Boolean from cached ek9 types of full scope hierarchy resolution.AggregateManipulator.resolveInteger(IScope scope) Resolve Integer from cached ek9 types of full scope hierarchy resolution.AggregateManipulator.resolveJson(IScope scope) Resolve JSON from cached ek9 types of full scope hierarchy resolution.ResolverOrDefiner.resolveOrDefine(ParameterisedTypeData details) Attempts to resolve the parameterised type first and return that, else returns a new symbol.ResolveOrDefineTypes.resolveSimpleTypeByIdentifierReference(EK9Parser.IdentifierReferenceContext ctx) AggregateManipulator.resolveString(IScope scope) Resolve String from cached ek9 types of full scope hierarchy resolution.ResolveOrDefineTypes.resolveTypeByIdentifierReference(EK9Parser.IdentifierReferenceContext ctx) ResolveOrDefineTypes.resolveTypeByParameterizedType(IToken triggerToken, EK9Parser.ParameterisedTypeContext ctx) ResolveOrDefineTypes.resolveTypeByTypeDef(IToken triggerToken, EK9Parser.TypeDefContext ctx) Resolves the type for a type def, can trigger recursion.AggregateManipulator.resolveVoid(IScope scope) Resolve Void from cached ek9 types of full scope hierarchy resolution.ParameterisedTypeData.typeArguments()Returns the value of thetypeArgumentsrecord component.PositionalConceptualLookupMapping.Mapping.typeArguments()Returns the value of thetypeArgumentsrecord component.PositionalConceptualLookupMapping.Mapping.typeParameters()Returns the value of thetypeParametersrecord component.Methods in org.ek9lang.compiler.support with parameters of type ISymbolModifier and TypeMethodDescriptionvoidvoidRecord that the floor counts the receiver of this method.voidMark the symbol as a concurrent entry point.voidvoidRecord a complexity against a symbol that phase 5 will never visit.voidMark the symbol as one the receiver must clean.voidSymbolRetyping.accept(ISymbol value, UnaryOperator<ISymbol> replacement) Re-type a single symbol, in place, when it has a type.voidAggregateManipulator.addConstructor(AggregateSymbol t, ISymbol s) Add a constructor to the type aggregate with a particular parameter.CaptureAliases.aliasesOf(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree within, ISymbol symbol) symboland every captured copy of it made by a dynamic function or class insidewithin(transitively: a capture of a capture), as an identity set.DispatcherReachableTypes.all(ISymbol baseType, List<MethodSymbol> handlers, int paramIndex, ConcreteSubtypeFinder finder) AsDispatcherReachableTypes.concrete(ISymbol, List, int, ConcreteSubtypeFinder), but keeping abstract types.The body method of a program - empty when the symbol is not a program.BooleanTruthGuard.apply(EK9Parser.PreFlowStatementContext preFlow, ISymbol ek9Boolean) The target of a Boolean truth guard, if this pre-flow is one.The call-graph identity for a callable symbol.ConceptualTypeReplacement.apply(PositionalConceptualLookupMapping.Mapping typeMapping, ISymbol forType, IToken triggeredByToken) The concrete counterpart of a type, which may be conceptual, parameterised with conceptual arguments, or already concrete (in which case it is returned unchanged).Enumerate the signature-level type references of a construct.DefaultedComparisonDelegate.apply(IAggregateSymbol aggregate, ISymbol ek9Any) The name of the module the type belongs to; empty text when it cannot be told.E07620's wording for an element type that cannot be ordered, or empty when it can.OwningErrorListener.apply(ISymbol symbol, ErrorListener fallback) The error listener of the source that declaressymbol, orfallbackif it has none.The parameterisation of exactlygenericthattargetis, else empty.THE wording of why a type's<=>is partial, to follow "'X' ...", or empty when it is total: a partial built-in, or a type whose values may be of different run-time types under a per-type sameness.The program whose body this symbol is - empty for anything else.intFieldSlots.applyAsInt(ISymbol owner, String fieldName) The slot offieldNamein an object ofowner: the nearest declaration of that property in the chain, at its declaring type's inherited slot count plus its position there.intMeasuredComplexity.applyAsInt(ISymbol symbol) The symbol's measured complexity, or 0 when it was never measured (or is unparseable).DispatcherReachableTypes.concrete(ISymbol baseType, List<MethodSymbol> handlers, int paramIndex, ConcreteSubtypeFinder finder) The types a value at this parameter could actually HAVE at runtime.protected voidCommonFactory.configureSymbol(ISymbol symbol, IToken start) protected List<AggregateSymbol> CommonFactory.createAndRegisterParameterisedSymbols(EK9Parser.ParameterisedParamsContext ctx, ISymbol functionOrClass, IScope scope) voidVoidAsTypeOrError.declaredTypeOrError(ISymbol variable) A variable, property, parameter or returning variable declared with typeVoid.booleanTrue if this property is declared in the same aggregate body as the initialiser - or, for a dynamic class, is one of its captures (declared in its capture list, just before its body).booleanNoNameCollisionOrError.errorsIfLocalNamedLikeAMethod(IAggregateSymbol aggregate, ISymbol symbol) A LOCAL variable may not take the name of a method of the type it is declared in (its own - private included - or one it inherits or takes from a trait, unless that one is private and so unreachable here):total <- total()means a value on the left and a call on the right, and with the local in scope a bare 'total()' no longer reaches the method (it surfaced as E50010 'type not resolved', 2026-10-01).booleanSymbolChecker.errorsIfNameDiffersOnlyByCase(List<ISymbol> alreadyDefined, ISymbol symbol) Check whether the symbol being defined differs ONLY by case from one already defined in the same module.booleanSymbolChecker.errorsIfNameIsBuiltIn(IScope moduleScope, ISymbol symbol) Check the symbol about to be defined in a user module does not take the name of a built-in construct (E01090).booleanNoNameCollisionOrError.errorsIfResolved(IScope inScope, ISymbol symbol, SymbolSearch search, ErrorListener.SemanticClassification classificationError) If a symbol is resolved then this will emit an error.booleanSymbolChecker.errorsIfSymbolAlreadyDefined(IScope inScope, ISymbol symbol, boolean limitVarSearchToBlockScope) Check for exising symbol in the scope.TargetTypedConstruction.forCall(SymbolsAndScopes symbolsAndScopes, EK9Parser.CallContext call, ISymbol generic) The parameterisation a bareG()at this call is completed to from its declared target, if it has one.DispatcherWinner.forParam(ISymbol concreteType, int paramIndex, List<MethodSymbol> handlers) The winning handler for a concrete type at one parameter position.DispatcherWinner.forParamPair(ISymbol type0, ISymbol type1, List<MethodSymbol> handlers) The winning handler for a pair of concrete types across the first two parameters.booleanPropertyInitialiser.isDeclaredBefore(ISymbol candidate) True if this property is declared before the property whose initialiser this is - so its own initialiser, if it has one, has already run.booleanRangeProgressCheck.isNeededFor(ISymbol counterType, ISymbol ek9Time, ISymbol ek9Float, ISymbol ek9Dimension) True when a for-range counted incounterType(already resolved to the concrete type, the base of a constrained one) carries a progress check.UnsetKeepingOperator.keepingUnset(ISymbol receiverType, String operator, Optional<ISymbol> argumentType) AsOperatorResolvedOnthenKeepsUnset: the resolved operator, only when it keeps an unset receiver unset.SymbolFactory.newExpressionSymbol(ISymbol fromSymbol) Create a new expression around a symbol.DelegatedMember.onDelegate(ISymbol delegateField, String methodName, MethodSymbol wrapper) The member ofdelegateField's type that the forwarderwrapper(namedmethodName) calls.voidStore this access kind on the parameter, as the one writer of theHTTP_ACCESSsquirrel.booleanbooleanMay a value ofreturnType(null: unknown) hold a borrowed view?booleanExactSingleParameter.test(MethodSymbol method, ISymbol type) True whenmethodtakes exactly one parameter whose type is exactlytype.booleanIs this symbol externally provided, so its source token must NOT be shown as a location?booleanGenericBodyReference.test(PossibleGenericSymbol generic, ISymbol symbol) True when the symbol is a dependent reference of the generic - see the class description.booleanTrue when the method's input-variety floor counts its receiver.booleanbooleanIsCapturedVariable.test(ISymbol candidate, ICanCaptureVariables capturer) True whencandidateis, by identity, one of the variablescapturercaptured.booleanTrue if the symbol has been marked as a concurrent entry point.booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanIsrecordeda call whose result its statement owns (and closes).booleanbooleanTrue when the type is a core built-in whose runtime class declares a comparison group.booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanLeftOutOfHash.test(IAggregateSymbol owner, ISymbol field) Must a generated#?on this type leave this field out?booleanbooleanCheck the symbol about to be defined in the module scope given.booleanCheck the symbol being defined against those already defined in the same module.booleanCheck for exising symbol in the scope.booleanbooleanOwnProperty.test(ISymbol candidate, IAggregateSymbol aggregate) True whencandidateis one ofaggregate's own declared properties - by identity, never by name.booleanbooleanDetermines if the given ISymbol represents a reference-counted type.booleanbooleanbooleanbooleanTrue when the symbol is a parameter declaredas sanitized, or an expression derived from one.booleanbooleanCan the 'from' type be coerced to the 'to' type.booleanMay a value of the holder's type keep an object of one of the held types (or, for none, a closeable)?booleanSymbolUses.usesOf(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree within, ISymbol symbol) The references inwithintosymbol- that INSTANCE, never another symbol with the same name - plus the references to the copies of it that dynamic functions and classes insidewithincaptured (a capture is a copy symbol; a+=on it mutates the same object).SymbolWrites.writesOf(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree region, ISymbol symbol) Every write tosymbol(or to a captured copy of it) inregion, in source order.Method parameters in org.ek9lang.compiler.support with type arguments of type ISymbolModifier and TypeMethodDescriptionvoidCapturedPropertiesRecorder.accept(IAggregateSymbol dynamicClass, List<ISymbol> capturedVariables) voidSymbolRetyping.accept(ISymbol value, UnaryOperator<ISymbol> replacement) Re-type a single symbol, in place, when it has a type.voidAggregateManipulator.addCaptureConstructorIfRequired(IAggregateSymbol aggregateSymbol, List<ISymbol> capturedVariables) THE capture constructor of a dynamic class (IsCaptureConstructor): the constructor whose parameter types are EXACTLY the capture types, in order.AggregateManipulator.addComparatorOperator(IAggregateSymbol aggregateSymbol, String comparatorType, Optional<ISymbol> returnType) Adds a form of a comparison operator.voidAggregateManipulator.addComparatorOperator(IAggregateSymbol aggregateSymbol, IAggregateSymbol arg0, String comparatorType, Optional<ISymbol> returnType) Adds a form of a comparison operator.AggregateManipulator.addConstructor(AggregateSymbol t, Optional<ISymbol> s) Add another constructor to type t, but passing in an s as the value in the construction.AggregateManipulator.addConstructor(IAggregateSymbol aggregateSymbol, List<ISymbol> constructorArguments, boolean synthetic, boolean markedPure) voidAggregateManipulator.addConstructorIfRequired(IAggregateSymbol aggregateSymbol, List<ISymbol> constructorArguments, boolean synthetic) Add a new constructor if not present, marked as synthetic.AggregateManipulator.addPublicMethod(AggregateSymbol aggregate, String methodName, List<ISymbol> methodParameters, Optional<ISymbol> returnType) Just add a method to an aggregate with the name and parameters and return type.AggregateManipulator.addPublicMethod(AggregateSymbol aggregate, String methodName, List<ISymbol> methodParameters, Optional<ISymbol> returnType) Just add a method to an aggregate with the name and parameters and return type.AggregateManipulator.addPurePublicSimpleOperator(IAggregateSymbol aggregateSymbol, String methodName, Optional<ISymbol> returnType) Adds a simple operator, that is 'pure' (no side effects) and accepts no parameters, but just returns a value.voidAggregateManipulator.addSyntheticConstructorIfRequired(IAggregateSymbol aggregateSymbol, List<ISymbol> constructorArguments) Add a synthetic constructor, if a constructor is not present.CapturedCopy.apply(Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded, EK9Parser.ExpressionParamContext param) The copy a dynamic function or class makes from one argument of its capture list -(acc)and(total: acc)both make a copy, namedaccandtotal- which shares the object the argument refers to.InternalNameFor.apply(PossibleGenericSymbol possibleGenericSymbol, List<ISymbol> typeArguments) ParameterizedSymbolCreator.apply(PossibleGenericSymbol possibleGenericSymbol, List<ISymbol> typeArguments) AggregateManipulator.createPureAcceptSameTypeOperatorAndReturnType(IAggregateSymbol aggregateSymbol, String comparatorType, Optional<ISymbol> returnType) Creates a pure method with an argument the same as the main type.AggregateManipulator.createPureArgumentOperatorAndReturnType(IAggregateSymbol aggregateSymbol, IAggregateSymbol arg0, String comparatorType, Optional<ISymbol> returnType) Creates a pure method with an argument of a different type as the main type.AggregateManipulator.createPurePublicSimpleOperator(IAggregateSymbol aggregateSymbol, String methodName, Optional<ISymbol> returnType) Just creates a public operator with the name specified.booleanSymbolChecker.errorsIfNameDiffersOnlyByCase(List<ISymbol> alreadyDefined, ISymbol symbol) Check whether the symbol being defined differs ONLY by case from one already defined in the same module.doubleSymbolMatcher.getCostOfMatch(Optional<ISymbol> fromSymbol, Optional<ISymbol> toSymbol) Calculates the cost of matching two symbols, which may or may not be present.doubleSymbolMatcher.getCostOfParameterMatch(List<ISymbol> fromSymbols, List<ISymbol> toSymbols) Calculates the percentage of matching these two lists of parameters.protected Consumer<MethodSymbol> CommonFactory.getDefaultOperatorSymbolInitializer(Consumer<ISymbol> initialise) booleanSymbolWrites.isWrittenBetween(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree region, Set<ISymbol> symbols, int afterTokenIndex, int beforeTokenIndex) Is any ofsymbolswritten inregionstrictly between two token positions (token indexes in the compiled token stream: passfirst.getStop().getTokenIndex()andsecond.getStart().getTokenIndex()to ask "does anything change these between the two occurrences?").booleanSymbolWrites.isWrittenIn(ParsedModule parsedModule, org.antlr.v4.runtime.tree.ParseTree region, Set<ISymbol> symbols) Is any ofsymbolswritten anywhere inregion.UnsetKeepingOperator.keepingUnset(ISymbol receiverType, String operator, Optional<ISymbol> argumentType) AsOperatorResolvedOnthenKeepsUnset: the resolved operator, only when it keeps an unset receiver unset.SymbolFactory.newExpressionSymbol(IToken token, String name, Optional<ISymbol> ofType) Create a new expression symbol place-holder.SymbolFactory.newParameterisedSymbol(PossibleGenericSymbol genericType, List<ISymbol> typeArguments) voidClonedMemberRetyping.retype(IScopedSymbol newOwner, List<ISymbol> clonedMembers, UnaryOperator<ISymbol> replacement) Re-type the members, in place.voidClonedMemberRetyping.retype(IScopedSymbol newOwner, List<ISymbol> clonedMembers, UnaryOperator<ISymbol> replacement) Re-type the members, in place.booleanExactParameterTypes.test(MethodSymbol method, List<ISymbol> types) True whenmethodtakes exactly as many parameters astypes, each exactly the type at its position.booleanCheck the symbol being defined against those already defined in the same module.booleanbooleanTakesExactlyTheTypesOf.test(MethodSymbol method, List<ISymbol> variables) booleanCan the 'from' type be coerced to the 'to' type; false when either is absent.booleanbooleanMay a value of the holder's type keep an object of one of the held types (or, for none, a closeable)?Constructors in org.ek9lang.compiler.support with parameters of type ISymbolModifierConstructorDescriptionIsMutexKeyType(ISymbol ek9MutexKey) IsMutexLockType(ISymbol ek9MutexLock) IsThreadSpawningCall(ISymbol ek9Tcp, ISymbol ek9Signals, ISymbol ek9Http) OrderingStep(IScopedSymbol body, boolean inOwnComparison, IScopedSymbol into, ISymbol intoParameter) Creates an instance of aOrderingSteprecord class.OrderingUse(ISymbol type, ConceptualAccess.OrderingKind kind, MethodSymbol operator) Creates an instance of aOrderingUserecord class.ParameterisedTypeData(IToken location, ISymbol genericTypeSymbol, List<ISymbol> typeArguments) Creates an instance of aParameterisedTypeDatarecord class.Creates an instance of aReferencerecord class.ReferenceAssignment(ISymbol target, EK9Parser.ExpressionContext source) Creates an instance of aReferenceAssignmentrecord class.ToCommaSeparated(ISymbol fromType, boolean includeParenthesis) TypeReference(String kind, ISymbol type) Creates an instance of aTypeReferencerecord class.Constructor parameters in org.ek9lang.compiler.support with type arguments of type ISymbolModifierConstructorDescriptionBooleanTruthGuard(Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recordedSymbol) The rule, reading recorded symbols the caller's way.CommonTypeDeterminationDetails(IToken lineToken, List<ISymbol> argumentSymbols, List<ISymbol> argumentTypes) Creates an instance of aCommonTypeDeterminationDetailsrecord class.ConceptualTypeReplacement(BiFunction<PossibleGenericSymbol, IToken, ISymbol> onParameterisedType) Construct the replacement with the action to apply to each rebuilt parameterised type.IsFreshValueExpression(Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded, IsFreshValueExpression.Reading reading) The given reading.Creates an instance of aMappingrecord class.ParameterisedTypeData(IToken location, ISymbol genericTypeSymbol, List<ISymbol> typeArguments) Creates an instance of aParameterisedTypeDatarecord class.ParameterizedSymbolCreator(BiFunction<PossibleGenericSymbol, List<ISymbol>, String> internalNameFor) -
Uses of ISymbol in org.ek9lang.compiler.support.closeables
Classes in org.ek9lang.compiler.support.closeables that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classThe fields the type's close closes, in acquisition order: owned captures (OwnedCaptures), then own closeable properties - never an injected one, nor the delegate aby-delegation proxy close forwards to (the exclusions are listed onCloseSteps).final classTrue when values of this TYPE have a close the compiler must see run (CloseableResourceToBeChecked.isManagedCloseableType(ISymbol)) - THE question for a type that is not a field, for example the component an application registers (the application closes it at program end).(package private) final classA field (or capture) whose type is a managed closeable (IsCloseableType).final classTrue when the capture was marked as owned by the dynamic class that made it.final classThe captures a dynamic class owns: each one PRE_IR_CHECKS marked as a fresh closeable (R-E).Methods in org.ek9lang.compiler.support.closeables that return types with arguments of type ISymbolModifier and TypeMethodDescriptionClosedProperties.apply(IAggregateSymbol aggregate) OwnedCaptures.apply(IAggregateSymbol aggregate) CloseSteps.closed()Returns the value of theclosedrecord component.Methods in org.ek9lang.compiler.support.closeables with parameters of type ISymbolModifier and TypeMethodDescriptionbooleanbooleanbooleanConstructor parameters in org.ek9lang.compiler.support.closeables with type arguments of type ISymbolModifierConstructorDescriptionCloseSteps(List<ISymbol> closed, Optional<MethodSymbol> parentClose) Creates an instance of aCloseStepsrecord class. -
Uses of ISymbol in org.ek9lang.compiler.support.conceptual
Classes in org.ek9lang.compiler.support.conceptual that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classTHE "is the type built on conceptual type parameters without being one": a parameterisation with a bareTamong its leaves (DictEntry of (K, Integer),List of (OrderedBox of T)), or a generic template named in its own body (this < otherinsideOrderedBox of type T, which isOrderedBox of T) (TypeParametersUnder).final classTHE note of a natural-orderPriorityQueueof this element type, when it is built on a conceptual parameter without being one (PriorityQueue of (OrderedBox of T)).final classTHE orderings of types built on any of these conceptual parameters that the generic's body uses, each once (a type built on several parameters is recorded on each) - whatNoteOrderingUseandNoteNaturalOrderQueuerecorded, judged inphase4/ParameterisedTypeOrErrorwhere the parameters are replaced.(package private) final classRecords an ordering use on each conceptual parameter the type is built on (TypeParametersUnder) - the shared step ofNoteOrderingUseandNoteNaturalOrderQueue; read back byOrderingUsesOf.final classTHE conceptual parameters a (non-bare) parameterisation is built on, each once; for a generic template (named in its own body) its own type parameters.Methods in org.ek9lang.compiler.support.conceptual with parameters of type ISymbolModifier and TypeMethodDescriptionvoidvoidRecordOrderingUse.accept(ISymbol type, ConceptualAccess.OrderingUse use) booleanMethod parameters in org.ek9lang.compiler.support.conceptual with type arguments of type ISymbolModifier and TypeMethodDescription -
Uses of ISymbol in org.ek9lang.compiler.support.copy
Classes in org.ek9lang.compiler.support.copy that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classTHE inherited:=:(Super)signatures a GENERATED copy owner overrides (Q5b,PolymorphicCopy): every:=:declared up its super CLASS chain (AllOperatorsAbove) whose single parameter is a super type of the owner - one per distinct parameter type, nearest first - unless the owner itself already declares that signature.final classTHE "does the owner get a_copyAccepts?" (PolymorphicCopy).Methods in org.ek9lang.compiler.support.copy with parameters of type ISymbolModifier and TypeMethodDescriptionInheritedCopySignatures.apply(IAggregateSymbol owner, ISymbol ek9Any) booleanNeedsCopyAccepts.test(IAggregateSymbol owner, ISymbol ek9Any) -
Uses of ISymbol in org.ek9lang.compiler.support.inputvariety
Methods in org.ek9lang.compiler.support.inputvariety that return ISymbolModifier and TypeMethodDescriptionLeafPath.leafType()Returns the value of theleafTyperecord component.Methods in org.ek9lang.compiler.support.inputvariety with parameters of type ISymbolModifier and TypeMethodDescriptionInputVarietyDenominatorCalculator.forInstanceMethod(ISymbol receiverType, List<ISymbol> parameterTypes) The figures for an instance method / operator, treating the receiver type as an implicit parameterp0(design §4.5): its leaf dimensions are prepended to the argument leaves, so a no-arg instance method (e.g.booleanEquivalenceClassModel.isEnumeration(ISymbol typeSymbol) True when this type's value-classes ARE its enumeration members — i.e.EquivalenceClassModel.leafPathsOf(ISymbol typeSymbol) The same leaf dimensionsEquivalenceClassModel.leavesOf(ISymbol)counts, but asLeafPaths — each carrying the field steps walked to reach it.The scalar LEAF dimensions a type contributes to a callable's input space (design §4.5 v3.2 / §4.6) — the composition primitive.The variety of a resolved type symbol;EquivalenceClassModel.FLOORfor a null type (a parameter always has a resolved type by phase 5, so null is only a defensive guard).Method parameters in org.ek9lang.compiler.support.inputvariety with type arguments of type ISymbolModifier and TypeMethodDescriptionInputVarietyDenominatorCalculator.forInstanceMethod(ISymbol receiverType, List<ISymbol> parameterTypes) The figures for an instance method / operator, treating the receiver type as an implicit parameterp0(design §4.5): its leaf dimensions are prepended to the argument leaves, so a no-arg instance method (e.g.InputVarietyDenominatorCalculator.forParameterTypes(List<ISymbol> parameterTypes) The denominator for a construct whose parameters have the given resolved type symbols, in declaration order.Constructors in org.ek9lang.compiler.support.inputvariety with parameters of type ISymbol -
Uses of ISymbol in org.ek9lang.compiler.support.literals
Classes in org.ek9lang.compiler.support.literals that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classWhether a symbol is a literal value that may be lifted into a module constant - the symbol-side companion toLiteralTypeNameOf(the parse-context side).Methods in org.ek9lang.compiler.support.literals with parameters of type ISymbol -
Uses of ISymbol in org.ek9lang.compiler.support.operators
Classes in org.ek9lang.compiler.support.operators that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classThe type a callable declares it returns, if it returns one - whatNarrowedReturnTypesandNarrowedFunctionReturnTypescompare.final classTHE covariant return of a function: its super function's return type, when this function narrows it - the function form ofNarrowedReturnTypes(N07, phase 7's covariant bridges).final classTHE return types of the (non-private) parent declarations a method overrides (OverriddenDeclarations) with a NARROWER - covariant - return, one per distinct type (N07, phase 7's covariant bridges).final classTHE place a missing operator belongs when NOTHING above an aggregate declares it (Q4, Steve 2026-10-08): the nearest super class that HAS fields of its own - the root of the data decides whether its fields are exposed (R4) - or, when no super class has fields, the topmost one (the hierarchy's root belowAny).final classTHE type of a method's single parameter, when it has exactly one - e.g.Methods in org.ek9lang.compiler.support.operators that return types with arguments of type ISymbolModifier and TypeMethodDescriptionDeclaredReturnType.apply(IMayReturnSymbol callable) NarrowedFunctionReturnTypes.apply(FunctionSymbol function) NarrowedReturnTypes.apply(IAggregateSymbol aggregate, MethodSymbol method) Empty for a method that overrides nothing or keeps every parent's return type.SingleParameterType.apply(MethodSymbol method) Methods in org.ek9lang.compiler.support.operators with parameters of type ISymbolModifier and TypeMethodDescriptionOperatorDeclarationSite.apply(IAggregateSymbol aggregate, ISymbol ek9Any) AllOperatorsAbove.of(IAggregateSymbol aggregate, String operatorName, ISymbol ek9Any) Every declaration above, nearest level first.NearestOperatorAbove.of(IAggregateSymbol aggregate, String operatorName, ISymbol ek9Any) The nearest operator calledoperatorNamedeclared ABOVE the aggregate, neverAny's:Anydeclares?$$$#?==<=>for every type, which says nothing about a hierarchy's data.NearestSelfComparisonAbove.of(IAggregateSymbol aggregate, String operatorName, ISymbol ek9Any) The nearest self-comparison above, if any.The operatoroperatorresolves to onreceiverTypegiven an argument ofargumentType(empty for++and--), when it resolves to exactly one.Method parameters in org.ek9lang.compiler.support.operators with type arguments of type ISymbol -
Uses of ISymbol in org.ek9lang.compiler.support.retention
Classes in org.ek9lang.compiler.support.retention that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classTHE declared parameters of a method, operator or function a RETAINS rule names; none for anything else.final classTHE method or function a recorded symbol CALLS, when it is a call that hands back a value made elsewhere: a method, operator or function call - never a constructor, whose result is always fresh.final classTHE method, operator or function an expression CALLS when the whole expression is that call -a.get(k),first(),a + b,(a.get(k))- so its value is whatever the call handed back.Methods in org.ek9lang.compiler.support.retention that return types with arguments of type ISymbolMethods in org.ek9lang.compiler.support.retention with parameters of type ISymbolMethod parameters in org.ek9lang.compiler.support.retention with type arguments of type ISymbolModifier and TypeMethodDescriptionCalleeOfExpression.apply(EK9Parser.ExpressionContext expression, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The callee of the expression. -
Uses of ISymbol in org.ek9lang.compiler.support.sameness
Classes in org.ek9lang.compiler.support.sameness that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classThe fields a generated<=>walks for one type: its properties and, for a dynamic class, its captures (GeneratedOperatorFields; D62 - a capture is a field, not a property).(package private) final classThe nearest concrete<=>above the type that compares its level with itself, read from the methods as DECLARED - a retracted one included (getAllNonAbstractMethodsInThisScopeOnlydoes not filter the retraction), soOrderingAvailability.orderingSurvives(MethodSymbol, ISymbol)gives the same answer whichever types phase 5 has already visited.(package private) final classThe concrete<=>this one LEVEL declares comparing itself with itself, read as DECLARED (a retracted one included), preferring the one taking exactly the level.final classTHE "has the aggregate its own REAL<=>that takes itself" - hand-written, or defaulted (and not retracted) over fields that can all really be ordered.final classTHE sameness a type INHERITS - from its super chain (stopping beforeAny) or any of its traits (its own, a super's, a trait's trait) - if any, sealed or not.final classTHE test behind E07187 (D24 Q4 REVISED, Steve 2026-10-20): can two values of this type be of DIFFERENT run-time types whose<=>is UNSET? Then<?and>?have no lesser or greater value to select, and an unset value cannot be built to stand in for one (aT()may be set, absent, private or abstract, and would run developer code).final classTHE sameness a type would inherit through its super CLASS chain (D24 follow-up Q5, Steve 2026-10-20): the nearest concrete<=>comparing its owner with itself (NearestSelfComparisonAbove) - the super is ORDERED - else the nearest such==- the super is EQUATABLE only.final classTHE sameness a type that declares none of its own gets from its super CLASS chain once PRE_IR_CHECKS has run (D55):NearestSamenessAbove, but a<=>that does not survive (OrderingAvailability.orderingSurvives(MethodSymbol, ISymbol)) is passed over for the nearest==- the super is EQUATABLE only.final classTHE inherited sameness signatures a type with its own sameness OVERRIDES (D24 rule 3; N07 - the object decides, never the reference): for each of==and<=>the type declares taking exactly itself, every same-named comparison above it on its super CLASS chain (AllOperatorsAbove) that takes a type the owner is assignable to and that the owner does not declare itself (OwnOperatorTaking).final classTHE retraction step (D55/D58/D62): whenOrderingAvailability.bareOrderingRetracted(IAggregateSymbol, ISymbol)says the type's bare ordering is withdrawn, mark each of its bare ordering operators (<=>,<,<=,>,>=)DEFAULT_OPERATOR_RETRACTED, which the type's method set then filters out, so none is generated.final classTHE SEALED sameness a type inherits (D24 rule 1) - one written by hand on an abstract base or a trait above it (IsHierarchyWideSameness) - if any.final classTHE wording of why a type has no<=>although it asked for one with the baredefault operator(D58): the field whose type cannot be ordered, the type declaring it and - only where that is a super - that a sub-type follows its super.Methods in org.ek9lang.compiler.support.sameness that return ISymbolModifier and TypeMethodDescriptionUnorderedProperty.property()Returns the value of thepropertyrecord component.Methods in org.ek9lang.compiler.support.sameness that return types with arguments of type ISymbolModifier and TypeMethodDescriptionComparedFieldsOf.apply(IAggregateSymbol aggregate) OrderingAvailability.unorderedDictEntryKey(ISymbol type, ISymbol ek9Any) The key type that stops aDictEntry of (K, V)being ordered (Steve, 2026-10-21): a DictEntry orders by its KEY's<=>, then by its VALUE's when the keys are the same (the entries of one Dict have unique keys), so a key type that cannot be ordered (OrderingAvailability.isOrderable(IAggregateSymbol, ISymbol); a function never can) leaves the entry unordered, and a comparator-lesssort,<?, range or natural-order queue over it is E07620 - not the run-time "Sort cannot order" Exception it was.Methods in org.ek9lang.compiler.support.sameness with parameters of type ISymbolModifier and TypeMethodDescriptionbooleanOrderingAvailability.allPropertiesOrderable(IAggregateSymbol aggregate, ISymbol ek9Any) THE "can every property of this type be ordered?" (OrderingAvailability.isOrderable(IAggregateSymbol, ISymbol)for each property's type) - what a baredefault operator's<=>needs of its own fields.DeclaredOrderingAbove.apply(IAggregateSymbol owner, ISymbol ek9Any) DeclaredOrderingAt.apply(IAggregateSymbol level, ISymbol ek9Any) InheritedSameness.apply(IAggregateSymbol aggregate, ISymbol ek9Any) NearestSamenessAbove.apply(IAggregateSymbol owner, ISymbol ek9Any) NearestSurvivingSamenessAbove.apply(IAggregateSymbol owner, ISymbol ek9Any) OverriddenSamenessSignatures.apply(IAggregateSymbol owner, ISymbol ek9Any) RetractWithdrawnBareOrdering.apply(IAggregateSymbol aggregate, ISymbol ek9Any) SealedSameness.apply(IAggregateSymbol aggregate, ISymbol ek9Any) WhyNotOrderable.apply(IAggregateSymbol type, ISymbol ek9Any) booleanOrderingAvailability.bareOrderingRetracted(IAggregateSymbol owner, ISymbol ek9Any) THE retraction decision for a type's BARE ordering family (<=> < <= > >=added by the baredefault operator): its own bare<=>decides for the whole family throughOrderingAvailability.orderingSurvives(MethodSymbol, ISymbol); without one (the ordering family alone, beside a hand-written<=>) the type's own properties decide.(package private) booleanOrderingAvailability.constrainedOverRetractedOrdering(IAggregateSymbol owner, ISymbol ek9Any) Is this a constrained type whose base's bare ordering is withdrawn? Its copied ordering operators are then withdrawn with it: a constrained type offers exactly the operators its base has (M1).booleanOrderingAvailability.isDegenerateDefaultedOrdering(MethodSymbol operator, ISymbol ek9Any) A defaulted ordering operator on a type whose<=>degenerates because a field cannot be ordered - the case a generic instantiation reaches without any retraction marker:Box of List(its template'sdefault operator <=>is over aTthat became a List).booleanOrderingAvailability.isOrderable(IAggregateSymbol type, ISymbol ek9Any) THE "is this type orderable?" behindHasRealComparator: the nearest<=>it declares or inherits (super chain beforeAny, then its traits) that survives (OrderingAvailability.orderingSurvives(MethodSymbol, ISymbol)).booleanOrderingAvailability.isRetractedOrdering(MethodSymbol operator, ISymbol ek9Any) Is this operator a BARE ordering operator that phase 5 retracts (OrderingAvailability.bareOrderingRetracted(IAggregateSymbol, ISymbol)of its owner)? Order-independent, so usable from POST_RESOLUTION_CHECKS on: a generic's body that uses<=>or<onT, parameterised with a type whose ordering is retracted, is E07620 at the parameterisation (D58, Steve 2026-10-21).booleanOrderingAvailability.isUnavailableOrdering(MethodSymbol operator, ISymbol ek9Any) THE verdict on a call of an ordering operator written as an operator (first < second, acase < x): the operator it resolved to is one phase 5 retracts (OrderingAvailability.isRetractedOrdering(MethodSymbol, ISymbol)) or one that degenerates (OrderingAvailability.isDegenerateDefaultedOrdering(MethodSymbol, ISymbol)).OwnOperatorTaking.of(IAggregateSymbol owner, String name, ISymbol parameterType) The owner's own non-abstract operator of this name taking exactly that one type, if any.booleanOrderingAvailability.orderingSurvives(MethodSymbol comparison, ISymbol ek9Any) THE "does this<=>still order values once PRE_IR_CHECKS has run?" (D55, Steve 2026-10-20).booleanOrderingAvailability.orderingWithdrawn(IAggregateSymbol type, ISymbol ek9Any) Does a use that needs the type's<=>without naming it (sort,<?, a range) rely on an ordering that is not there: a withdrawn bare<=>(OrderingAvailability.withdrawnOrdering(IAggregateSymbol, ISymbol)) or aDictEntrywhose key cannot be ordered (OrderingAvailability.unorderedDictEntryKey(ISymbol, ISymbol))? THE test of phase 5'sRetractedComparatorUseOrError;WhyNotOrderablewords it.booleanHasOwnComparator.test(IAggregateSymbol aggregate, ISymbol ek9Any) booleanMayMixRuntimeTypes.test(IAggregateSymbol type, ISymbol ek9Any) OrderingAvailability.unorderedDictEntryKey(ISymbol type, ISymbol ek9Any) The key type that stops aDictEntry of (K, V)being ordered (Steve, 2026-10-21): a DictEntry orders by its KEY's<=>, then by its VALUE's when the keys are the same (the entries of one Dict have unique keys), so a key type that cannot be ordered (OrderingAvailability.isOrderable(IAggregateSymbol, ISymbol); a function never can) leaves the entry unordered, and a comparator-lesssort,<?, range or natural-order queue over it is E07620 - not the run-time "Sort cannot order" Exception it was.OrderingAvailability.unorderedPropertyBehind(MethodSymbol comparison, ISymbol ek9Any) THE reason a bare<=>does not survive: the first property, from the owner ofcomparisonupward through the<=>s each bare one builds on (read as DECLARED, so it answers the same after the retraction), whose type cannot be ordered (OrderingAvailability.isOrderable(IAggregateSymbol, ISymbol)).OrderingAvailability.withdrawnOrdering(IAggregateSymbol type, ISymbol ek9Any) THE "does a use of this type's<=>rely on an ordering that is withdrawn?" (D58, Steve 2026-10-21): the nearest<=>declared on the type or above it - the one phase 3 resolved the use to - is one the baredefault operatoradded, and it does not survive (OrderingAvailability.orderingSurvives(MethodSymbol, ISymbol)).Constructors in org.ek9lang.compiler.support.sameness with parameters of type ISymbolModifierConstructorDescriptionUnorderedProperty(IAggregateSymbol owner, ISymbol property) Creates an instance of aUnorderedPropertyrecord class. -
Uses of ISymbol in org.ek9lang.compiler.support.selfreference
Classes in org.ek9lang.compiler.support.selfreference that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescriptionfinal classThe property of this object that the assignment statement gives a dynamic function or class capturing 'this' itself (child :=? (owner: this) with trait of Child as class ...), if it does - the parent link.final classTrue when the symbol is a property that the constructor this node is in stores 'this' into - so, in that constructor, the property is 'this' under another name.(package private) final classThe property of this object an assignment statement assigns (me: ...orthis.me: ...), if any.final classThe properties a constructor body stores 'this' into - directly (me: this,StoredProperty) or in a dynamic function or class it gives them (child :=? (owner: this) ...,CapturedInto) - not counting code that runs later (a dynamic function's body, a dynamic class's methods), where 'this' is a different object or the construction is over.final classThe property of this object that the assignment statement re-points at 'this', if it does.Methods in org.ek9lang.compiler.support.selfreference that return ISymbolModifier and TypeMethodDescriptionCaptureAssignment.property()Returns the value of thepropertyrecord component.Methods in org.ek9lang.compiler.support.selfreference that return types with arguments of type ISymbolModifier and TypeMethodDescriptionCapturedInto.apply(EK9Parser.AssignmentStatementContext ctx) OwnPropertyTarget.apply(EK9Parser.AssignmentStatementContext ctx) PropertiesStoredIn.apply(EK9Parser.MethodDeclarationContext constructor) StoredProperty.apply(EK9Parser.AssignmentStatementContext ctx) Methods in org.ek9lang.compiler.support.selfreference with parameters of type ISymbolModifier and TypeMethodDescriptionbooleanConstructors in org.ek9lang.compiler.support.selfreference with parameters of type ISymbolModifierConstructorDescriptionCaptureAssignment(EK9Parser.AssignmentStatementContext statement, ISymbol property) Creates an instance of aCaptureAssignmentrecord class. -
Uses of ISymbol in org.ek9lang.compiler.support.sharing
Classes in org.ek9lang.compiler.support.sharing that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classThe call chain that starts at a variable orthis: a link that may return a VIEW of what it was called on makes the result the same object as (part of) the receiver.final classMay a compound assignment (target += item,target :~: item) to a value of this type keep its operand? A container (a parameterised type, a bareT) does; so does a type of the program's own, whose operator is written in EK9 and may store it - as any call of the program's own may keep its argument (KeepsArgument; the verifier, 2026-10-21:registry += item,Registry's+=adding to its list, was read as keeping nothing, so a loaned closeable was closed by its statement and then used).final classMay a compound assignment (target += item,target :~: item) to a value of this type keep its operand? A container (a parameterised type, a bareT) does; so does a type of the program's own, whose operator is written in EK9 and may store it - as any call of the program's own may keep its argument (KeepsArgument; the verifier, 2026-10-21:registry += item,Registry's+=adding to its list, was read as keeping nothing, so a loaned closeable was closed by its statement and then used).(package private) final classDoes an in-place write of an object of this type (a mutating operator:other -= 5,other++,this :=: copy; or a stream target's|) run code of the program's own (D66)? A concrete built-in's operator does not, unless it may call that operator back on an element (MayBeCalledBack: aDictmerge merges the elements that share a key).(package private) final classA variable (never a constant: each read of one is a copy) orthis/super.final classD66 gap (Steve, 2026-10-21): does afor ... inloop over a value of this type run code of the program's own? THE test: the loop callsiterator()and thenhasNext()/next()(or those two on the value itself), so it is a call that is not pure when the type - or the iterator itsiterator()declares to return - has one of those methods that is notpureand is supplied by the program: a method written in EK9, or an abstract one of a built-in trait or abstract type (Iterator,Iterable) a program implements.final classMay the callee keep its argument? Built-ins say so in their RETAINS; anything else may.(package private) final classTHE test of whether an object of this type may be handed to a built-in that calls a member of it back that is notpure(D66).final classMay the value of this expression BE an object that exists already - rather than a fresh one: a variable (not a constant, which is read as a copy),this/super, a call whose RETAINS says its result may be its receiver's interior or an argument (MayAlias), or a coalescing operator's result or a ternary's when EITHER operand may be (the result is one of them: the same routeObjectSharingfollows for the operand itself).final classIs the expression, looking through parentheses, of a SHAPE whose value may be an object that already exists - a variable,this/super, a call, or a coalescing operator or ternary (whose result IS one of its operands) - so onlyMayBeExistingObject, once phase 5 has derived the RETAINS of the program's own callables, can say whether it is.final classMay the value given to a name be, or hold, an object from OUTSIDE the code being analysed (D66) that the name is not recorded as sharing with:this- itself, or held by a list, a Dict, a constructor's or call's arguments or a dynamic function's or class's capture list (box <- Box(this)) - or a result a call, a coalescing operator or a ternary hands back that may be an existing object.(package private) final classMay a value of this type be of a type of the program's own - whatever it declares? A trait, an abstract class, an open class (Anyincluded) or a generic'sT.(package private) final classMay a callee change the objects it is given as arguments? Not when it ispure, nor when it is a concrete built-in method or function that runs no code of the program's.final classMay the call (or stream stage operand)callrun code of the program's own - something that is notpureand not a concrete built-in? Such code may change any object it can reach, an object kept where the caller cannot name it included.final classTHE reading of what one occurrence of a name does to the OBJECT the name refers to - for every analysis that remembers what a variable holds (the phase-5 value tracker behind E08086,CompileTimeKnownTextbehind E08275).final classWhatthisorsuper- the object a method runs on, whose name is no identifier - does to that object, read exactly as the occurrence of a variable is (ObjectSharing): kept where the whole expression is kept (items += this,box <- Box(this),(this) is ...), or the start of a call chain that may return a view of it (this.me()).(package private) final classWhatoccurrence- an identifier the compiler bound to a symbol - does to the object it names; empty when it only reads it, or stores a new object in it.(package private) final classTHE reading of a property named THROUGHthiswhere a store or a call chain reaches it (Q2, lane B2, 2026-11-13): the single stepthis.Fas a store target (this.F := p,this.F += p) andthis.Fas the start of a call chain (this.F.add(p)) - the same property the bareFnames, soRetainedByreads both spellings asObjectSharing.Kind.KEPT_IN_PROPERTY(the two must never be judged differently, asCallableParameterOccurrences.acceptOwnPropertyalready insists for a property read).(package private) final classTHE reading of a property named THROUGHthiswhere a store or a call chain reaches it (Q2, lane B2, 2026-11-13): the single stepthis.Fas a store target (this.F := p,this.F += p) andthis.Fas the start of a call chain (this.F.add(p)) - the same property the bareFnames, soRetainedByreads both spellings asObjectSharing.Kind.KEPT_IN_PROPERTY(the two must never be judged differently, asCallableParameterOccurrences.acceptOwnPropertyalready insists for a property read).final classD66 gap (verifier, 2026-10-21): does aforrange over values of this type run code of the program's own? The range builds its counter and each loop value with the type's copy constructor and moves the counter with++/--(or+=/-=by a step), comparing with<=>: a program type with any of those notpureruns that code, which may change what it can reach (a copy shares its fields).final classTHE reading of what a call that may run the program's own code can change: everything reachable fromReach, which the value tracker turns into what it forgets (ValueTrackingAnalyzer.recordCallThatMayChange).final classTHE reading of an in-place write as a call (D66, Steve 2026-10-21): when the operator that makes it is the program's own code (InPlaceWriteRunsProgramCode), it is a call that is not pure, given the object written and whatever the right-hand side gives it (other -= amount), or - for a stream target - every element of the stream.final classWhat aforloop overiteratedcan reach (D66, the same reading asReachOfCallgives a call): the value iterated - a name,this, or something no name is given to - and what it is made from.(package private) final classWhat a call node resolved to, or null when nothing was recorded; a recorded symbol that is not a call (a delegate, a stage operand) is answered as itself.(package private) final classWhat a call node resolved to, or null when nothing was recorded; a recorded symbol that is not a call (a delegate, a stage operand) is answered as itself.(package private) final classTHE retention walk ofObjectSharing(D61): the object an expression evaluates to (or contains) - what keeps it? The variable it is stored in, a container it is added to or put in a literal of, a call or constructor that may keep its argument, aforloop's variable, a stream's holders, or the returning variable of a construct whose value is assigned -ObjectSharing.Kind.SHAREDwith a nameable holder, elseObjectSharing.Kind.ESCAPES.(package private) final classA stage operand that is a function, or a delegate holding one, that may change what it is given.(package private) final classThe variable a declaration or a plain store gives the value ofassignedto, or null.(package private) final classThe variable a declaration or a plain store gives the value ofassignedto, or null.final classTHE types of the objects a stream pulls from one source expression (cat [item],cat items): the type arguments of a collection, else the source's own type.final classTHE types of the objects a stream pulls from one source expression (cat [item],cat items): the type arguments of a collection, else the source's own type.(package private) final classThe target's own KIND half ofCompoundTargetMayKeep: may a compound assignment to a value of this type keep its operand at all? A container (a parameterised type, a bareT) and a type of the program's own may; a built-in value, a constrained type over one and an enumeration copy.Fields in org.ek9lang.compiler.support.sharing with type parameters of type ISymbolMethods in org.ek9lang.compiler.support.sharing that return ISymbolModifier and TypeMethodDescriptionPropertyOfThis.apply(org.antlr.v4.runtime.tree.ParseTree node, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The propertythis.Fnames whennodeis exactly that single step; null otherwise.ResolvedCallee.apply(org.antlr.v4.runtime.tree.ParseTree call, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) StoreTarget.apply(EK9Parser.AssignmentExpressionContext assigned, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) ObjectSharing.Use.sharedWith()Returns the value of thesharedWithrecord component.(package private) ISymbolPropertyOfThis.startOf(EK9Parser.ObjectAccessExpressionContext chain, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The property a call chain starts on throughthis-this.F.add(p)'sF, whatever follows it; null when the chain starts anywhere else or its first step is a call.InPlaceWrite.type()Returns the value of thetyperecord component.InPlaceWrite.written()Returns the value of thewrittenrecord component.Methods in org.ek9lang.compiler.support.sharing that return types with arguments of type ISymbolModifier and TypeMethodDescriptionStreamSourceElementTypes.apply(EK9Parser.ExpressionContext source, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) Reach.named()Returns the value of thenamedrecord component.Methods in org.ek9lang.compiler.support.sharing with parameters of type ISymbolModifier and TypeMethodDescriptionbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanMethod parameters in org.ek9lang.compiler.support.sharing with type arguments of type ISymbolModifier and TypeMethodDescriptionChainedViewUses.apply(EK9Parser.ObjectAccessStartContext start, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) ObjectSharing.apply(EK9Parser.IdentifierContext occurrence, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) EVERY effect of one occurrence: what the occurrence itself does (OccurrenceUse), plus what it RETAINS (D61) - the object put in a collection literal, a Dict value, given to a call or constructor that keeps its argument, added with a compound assignment, or iterated by afor: whatever holds it afterwards shares the object, so an in-place change through the holder (a loop variable, an element, a field) changes it too.ObjectSharingOfSelf.apply(EK9Parser.PrimaryReferenceContext self, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) OccurrenceUse.apply(EK9Parser.IdentifierContext occurrence, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The effect of one occurrence.PropertyOfThis.apply(org.antlr.v4.runtime.tree.ParseTree node, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The propertythis.Fnames whennodeis exactly that single step; null otherwise.ReachOfCall.apply(org.antlr.v4.runtime.tree.ParseTree call, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) ReachOfInPlaceWrite.apply(InPlaceWrite write, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) ReachOfIteration.apply(EK9Parser.ExpressionContext iterated, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) ResolvedCallee.apply(org.antlr.v4.runtime.tree.ParseTree call, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) RetainedBy.apply(EK9Parser.ExpressionContext expression, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The objectexpressionevaluates to (or contains) - what keeps it?StoreTarget.apply(EK9Parser.AssignmentExpressionContext assigned, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) StreamSourceElementTypes.apply(EK9Parser.ExpressionContext source, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) ObjectSharing.ofTheObjectItself(EK9Parser.IdentifierContext occurrence, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) AsObjectSharing.apply(EK9Parser.IdentifierContext, Function), without what a call chain on the name does to a VIEW of the object (name.get()handed on is the Optional's ITEM, not the Optional): what the occurrence does to exactly the object the name refers to.(package private) ISymbolPropertyOfThis.startOf(EK9Parser.ObjectAccessExpressionContext chain, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) The property a call chain starts on throughthis-this.F.add(p)'sF, whatever follows it; null when the chain starts anywhere else or its first step is a call.booleanIsExistingNamedObject.test(EK9Parser.ExpressionContext expression, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) booleanMayBeExistingObject.test(EK9Parser.ExpressionContext expression, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) booleanMayBeExistingObjectByShape.test(EK9Parser.ExpressionContext expression, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) booleanMayBeObjectFromOutside.test(org.antlr.v4.runtime.tree.ParseTree value, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) booleanMayRunProgramCode.test(org.antlr.v4.runtime.tree.ParseTree call, Function<org.antlr.v4.runtime.tree.ParseTree, ISymbol> recorded) Constructors in org.ek9lang.compiler.support.sharing with parameters of type ISymbolModifierConstructorDescriptionInPlaceWrite(org.antlr.v4.runtime.ParserRuleContext occurrence, ISymbol written, ISymbol type) Creates an instance of aInPlaceWriterecord class.Use(ObjectSharing.Kind kind, ISymbol sharedWith) Creates an instance of aUserecord class.Constructor parameters in org.ek9lang.compiler.support.sharing with type arguments of type ISymbol -
Uses of ISymbol in org.ek9lang.compiler.support.streams
Classes in org.ek9lang.compiler.support.streams that implement interfaces with type arguments of type ISymbolModifier and TypeClassDescription(package private) final classIs the type the named built-in type itself, or does it have it as a trait: IS-A by the type hierarchy.final classTHE test of a built-in OUTPUT CHANNEL (Steve, 2026-10-27: "> udpConnectionand> stdout,> stderrall feel normal"): the type IS-Aorg.ek9.lang::IO- Stdout, Stderr, a file output, a UDP or TCP connection, a StringOutput, and a user type taking those traits.final classA sink is write-through - it never accumulates what it is given - only when its type IS-Aorg.ek9.lang::StringOutput(Stdout, Stderr, a StringOutput).final classTrue when a TERMINAL's target is aList(the built-in, any parameterisation):collect as List of X,> list,>> listand atee ... in listtarget append each element with the List's+=(_addAss), which keeps an unset element, never with its|(_pipe), which drops it (Steve, 2026-10-21: "keep them through+=").final classTrue when a TERMINAL's target is aList(the built-in, any parameterisation):collect as List of X,> list,>> listand atee ... in listtarget append each element with the List's+=(_addAss), which keeps an unset element, never with its|(_pipe), which drops it (Steve, 2026-10-21: "keep them through+=").final classTHE decision of whichOutputStepa termination gives its sink:>into an output channel clears,>>appends, anything that is not a channel (a collection, a fold, a user type) gets none.final classTHE decision ofSinkBufferfor a target type (asked besideReplacesTargetOnCompletion, which is defined by it).(package private) final classIstargetthe built-ingenericitself or a parameterisation of it.(package private) final classIstargetthe built-ingenericitself or a parameterisation of it.Methods in org.ek9lang.compiler.support.streams that return ISymbolModifier and TypeMethodDescriptionStreamTermination.target()Returns the value of thetargetrecord component.Methods in org.ek9lang.compiler.support.streams with parameters of type ISymbolModifier and TypeMethodDescriptionbooleanbooleanbooleanbooleanbooleanConstructors in org.ek9lang.compiler.support.streams with parameters of type ISymbolModifierConstructorDescriptionStreamTermination(int terminationOp, ISymbol target) Creates an instance of aStreamTerminationrecord class. -
Uses of ISymbol in org.ek9lang.compiler.symbolic
Method parameters in org.ek9lang.compiler.symbolic with type arguments of type ISymbolModifier and TypeMethodDescriptionGuardCouplingReader.read(org.antlr.v4.runtime.tree.ParseTree constructCtx, List<ISymbol> callParameters, ParsedModule module) Read every coupling expressed by a control condition inconstructCtx.RequirePredicateReader.read(org.antlr.v4.runtime.tree.ParseTree constructCtx, List<ISymbol> callParameters, ParsedModule module) Read every modellablerequireprecondition inconstructCtx. -
Uses of ISymbol in org.ek9lang.compiler.symbols
Subinterfaces of ISymbol in org.ek9lang.compiler.symbolsModifier and TypeInterfaceDescriptioninterfaceInterface for an aggregate, typically a class or something like that.interfaceReally a Marker interface for generic classes and generic functions.interfaceInterface to abstract FunctionSymbol away as concrete implementation.interfaceFor symbols that are both a pure symbol but can also define a scope.Classes in org.ek9lang.compiler.symbols that implement ISymbolModifier and TypeClassDescriptionclassThis is typically a 'class' or an interface type where it can include the definitions of new properties.classAn aggregate, but one that can have zero or more traits (like interfaces).classSpecial type that is super of Aggregate and super of Function (if they don't have supers).classEK9 assertDoesNotThrow expression - validates that an expression does not throw.classEK9 assertPanic expression - asserts that the wrapped expression fires anorg.ek9.lang::Panic.classEK9 assertThrows expression - captures an expected exception type and expression.classJust re-uses the bulk of method symbol for when we want to make a symbol that is a call to an actual method.classJust focuses on the ability to possible capture variables from an enclosing scope.classA very simple type that holds a single distinct value.classEK9 switch/try control type symbol - this can effectively return a value if it is configured with returning part.classWhile we don't add these in the scoped structures when compiling.classEK9 'for' type symbol - we need a scope because we declare a new variable as the loop variable.classScope for functions that are part of a module.classRepresents some type of method that exists on an aggregate type scope.classWhile we don't add these in the scoped structures when compiling.classAdded as a common symbol type for both Functions and Aggregates that could possibly be generic in nature and also be a parameterised type.classRepresents a symbol that also has a scope.classScope for callable methods (operations) that are part of a Service.classUsed when duplicate symbols are found, where we need to add a placeholder.classJust re-uses the bulk of method symbol.classIntended to model the pipeline flow in a streaming of cat or for loop though | and map etc.classEK9 switch statement - this can effectively return a value if it is configured with returning part.classA bit of a beast.classEK9 try statement - this can effectively return a value if it is configured with returning part.classModels a variable.classEK9 'while' or 'do/while' type symbol - we need a scope because we can declare new variables as part of the pre-flow semantics.Methods in org.ek9lang.compiler.symbols that return ISymbolModifier and TypeMethodDescriptionClone the symbol and re-parent if this symbol like a method should have a parent.Ek9Types.ek9Bits()Returns the value of theek9Bitsrecord component.Ek9Types.ek9Boolean()Returns the value of theek9Booleanrecord component.Ek9Types.ek9Character()Returns the value of theek9Characterrecord component.Ek9Types.ek9Comparator()Returns the value of theek9Comparatorrecord component.Ek9Types.ek9Consumer()Returns the value of theek9Consumerrecord component.Ek9Types.ek9Date()Returns the value of theek9Daterecord component.Ek9Types.ek9DateTime()Returns the value of theek9DateTimerecord component.Ek9Types.ek9Dictionary()Returns the value of theek9Dictionaryrecord component.Ek9Types.ek9DictionaryEntry()Returns the value of theek9DictionaryEntryrecord component.Ek9Types.ek9Duration()Returns the value of theek9Durationrecord component.Ek9Types.ek9Exception()Returns the value of theek9Exceptionrecord component.Ek9Types.ek9Float()Returns the value of theek9Floatrecord component.Ek9Types.ek9Function()Returns the value of theek9Functionrecord component.Ek9Types.ek9Http()Returns the value of theek9Httprecord component.Ek9Types.ek9HttpContext()Returns the value of theek9HttpContextrecord component.Ek9Types.ek9HttpRequest()Returns the value of theek9HttpRequestrecord component.Ek9Types.ek9HttpResponse()Returns the value of theek9HttpResponserecord component.Ek9Types.ek9Integer()Returns the value of theek9Integerrecord component.Ek9Types.ek9IO()Returns the value of theek9IOrecord component.Ek9Types.ek9Iterator()Returns the value of theek9Iteratorrecord component.Ek9Types.ek9Json()Returns the value of theek9Jsonrecord component.Ek9Types.ek9List()Returns the value of theek9Listrecord component.Ek9Types.ek9Locale()Returns the value of theek9Localerecord component.Ek9Types.ek9Millisecond()Returns the value of theek9Millisecondrecord component.Ek9Types.ek9MutexKey()Returns the value of theek9MutexKeyrecord component.Ek9Types.ek9MutexLock()Returns the value of theek9MutexLockrecord component.Ek9Types.ek9Optional()Returns the value of theek9Optionalrecord component.Ek9Types.ek9Panic()Returns the value of theek9Panicrecord component.Ek9Types.ek9Path()Returns the value of theek9Pathrecord component.Ek9Types.ek9Predicate()Returns the value of theek9Predicaterecord component.Ek9Types.ek9PriorityQueue()Returns the value of theek9PriorityQueuerecord component.Ek9Types.ek9Privileged()Returns the value of theek9Privilegedrecord component.Ek9Types.ek9Result()Returns the value of theek9Resultrecord component.Ek9Types.ek9Routine()Returns the value of theek9Routinerecord component.Ek9Types.ek9Sensitive()Returns the value of theek9Sensitiverecord component.Ek9Types.ek9Set()Returns the value of theek9Setrecord component.Ek9Types.ek9Signals()Returns the value of theek9Signalsrecord component.Ek9Types.ek9Stderr()Returns the value of theek9Stderrrecord component.Ek9Types.ek9Stdin()Returns the value of theek9Stdinrecord component.Ek9Types.ek9Stdout()Returns the value of theek9Stdoutrecord component.Ek9Types.ek9String()Returns the value of theek9Stringrecord component.Ek9Types.ek9Supplier()Returns the value of theek9Supplierrecord component.Ek9Types.ek9Tcp()Returns the value of theek9Tcprecord component.Ek9Types.ek9TcpConnection()Returns the value of theek9TcpConnectionrecord component.Ek9Types.ek9Time()Returns the value of theek9Timerecord component.Ek9Types.ek9Udp()Returns the value of theek9Udprecord component.Ek9Types.ek9UnaryOperator()Returns the value of theek9UnaryOperatorrecord component.Ek9Types.ek9Version()Returns the value of theek9Versionrecord component.Ek9Types.ek9Void()Returns the value of theek9Voidrecord component.StreamCallSymbol.getConsumesSymbolType()StreamCallSymbol.getProducesSymbolType()RegistrationData.implementationSymbol()Returns the value of theimplementationSymbolrecord component.RegistrationData.interfaceSymbol()Returns the value of theinterfaceSymbolrecord component.default ISymbolMethods in org.ek9lang.compiler.symbols that return types with arguments of type ISymbolModifier and TypeMethodDescriptionRegistrationData.aspectSymbols()Returns the value of theaspectSymbolsrecord component.AggregateSymbol.getAllSymbolsMatchingName(String symbolName) AggregateWithTraitsSymbol.getAllSymbolsMatchingName(String symbolName) IScope.getAllSymbolsMatchingName(String symbolName) Return a list of all the symbols that match the name.ScopedSymbol.getAllSymbolsMatchingName(String symbolName) SymbolTable.getAllSymbolsMatchingName(String symbolName) ICanBeGeneric.getAnyConceptualTypeParameters()PossibleGenericSymbol.getAnyConceptualTypeParameters()If this scope has been parameterised, then go through those parameters and return a list of all those that are generic 'T' in nature and not actually concrete types.FunctionSymbol.getCallParameters()Added convenience method to make the parameters a bit more obvious.IFunctionSymbol.getCallParameters()MethodSymbol.getCallParameters()Added convenience method to make the parameters a bit more obvious.AggregateSymbol.getInjectionFields()Get all fields marked for injection on this aggregate.ParamExpressionSymbol.getParameters()AggregateSymbol.getProperties()Provides access to the properties on this aggregate - but only this aggregate.IAggregateSymbol.getProperties()Just access to the properties in this aggregate - no supers.ModuleScope.getReferencedSymbols()The declaredreferencesmanifest of this module scope — the short-name to resolved-symbol map for every reference entry.ModuleScope.getSymbolsAcrossModule()THE symbols defined in this module across ALL of its source files - use this, neverSymbolTable.getSymbolsForThisScope(), for any question about the whole module.IScope.getSymbolsForThisScope()Provide a list of all the parameters held in this scope and only this scope.ScopedSymbol.getSymbolsForThisScope()SymbolTable.getSymbolsForThisScope()Get all the symbols in this table.SymbolTable.getSymbolsForThisScopeOfCategory(SymbolCategory category) Find symbols in a specific category.AggregateSymbol.getType()FunctionSymbol.getType()ISymbol.getType()Symbol.getType()ICanBeGeneric.getTypeParameterOrArguments()PossibleGenericSymbol.getTypeParameterOrArguments()ModuleScope.referencedByModule(String moduleName, String shortName) DIAGNOSTIC ONLY - never a resolution route: a qualified name resolves only to what its module defines.IScope.resolve(SymbolSearch search) Find the nearest symbol of that name up the scope tree.MethodSymbol.resolve(SymbolSearch search) ModuleScope.resolve(SymbolSearch search) PossibleGenericSymbol.resolve(SymbolSearch search) So this is where we alter the mechanism of normal symbol resolution.ScopedSymbol.resolve(SymbolSearch search) StackConsistencyScope.resolve(SymbolSearch search) SymbolTable.resolve(SymbolSearch search) Search and resolve from a symbol search.SymbolTable.resolveByShortName(SymbolSearch search, String shortName) SymbolTable.resolveInThisScopeOnly(SymbolSearch)for a caller that has ALREADY established the search is for this scope and holds its unqualified name -ModuleScope, which otherwise had both re-derived on every module-scope hop.CaptureScopedSymbol.resolveExcludingCapturedVariables(SymbolSearch search) ICanCaptureVariables.resolveExcludingCapturedVariables(SymbolSearch search) Try and resolve a symbol but exclude looking in captured variables.StackConsistencyScope.resolveExcludingCapturedVariables(SymbolSearch search) PossibleGenericSymbol.resolveFromParameterTypes(SymbolSearch search) Used when the type/function is one that is generic/template.ModuleScope.resolveInThisModuleOnly(SymbolSearch search) Looks to resolve search in either the references held or the symbols in all the scopes for this module.CaptureScopedSymbol.resolveInThisScopeOnly(SymbolSearch search) FunctionSymbol.resolveInThisScopeOnly(SymbolSearch search) IScope.resolveInThisScopeOnly(SymbolSearch search) Just look in own scope.MethodSymbol.resolveInThisScopeOnly(SymbolSearch search) ModuleScope.resolveInThisScopeOnly(SymbolSearch search) Just does a search in this particular module scope.PossibleGenericSymbol.resolveInThisScopeOnly(SymbolSearch search) ScopedSymbol.resolveInThisScopeOnly(SymbolSearch search) StackConsistencyScope.resolveInThisScopeOnly(SymbolSearch search) SymbolTable.resolveInThisScopeOnly(SymbolSearch search) Resolve a symbol in this symbol table only.AggregateSymbol.resolveMember(SymbolSearch search) Just try and resolve a member in this or super scopes.AggregateWithTraitsSymbol.resolveMember(SymbolSearch search) IAggregateSymbol.resolveMember(SymbolSearch search) Just try and resolve a member in this or super scopes.IScope.resolveMember(SymbolSearch search) Just resolve on this or supers/traits - but not anything outside of the class hierarchy.ScopedSymbol.resolveMember(SymbolSearch search) SymbolTable.resolveMember(SymbolSearch search) ModuleScope.resolveOrDefine(PossibleGenericSymbol parameterisedSymbol, SemanticErrorReporter errorListener) Used when resolving or needing to define a parameterised type, like 'List of String' for example.ModuleScope.resolveReferenceInThisScopeOnly(SymbolSearch search) Does a check if there is a references of that symbol already held in this module scope.CaptureScope.resolveWithEnclosingScope(SymbolSearch search) LocalScope.resolveWithEnclosingScope(SymbolSearch search) ModuleScope.resolveWithEnclosingScope(SymbolSearch search) SymbolTable.resolveWithEnclosingScope(SymbolSearch search) This class is the root and so there is no enclosing scope.AggregateWithTraitsSymbol.resolveWithParentScope(SymbolSearch search) Resolve using super aggregate and or any traits we have.FunctionSymbol.resolveWithParentScope(SymbolSearch search) A function's body never resolves names through its super function - only through its enclosing scope.ScopedSymbol.resolveWithParentScope(SymbolSearch search) Resolve with super type/function or via enclosing scope.Methods in org.ek9lang.compiler.symbols with parameters of type ISymbolModifier and TypeMethodDescriptionvoidAggregateSymbol.addInjectionField(ISymbol field) Record that a field on this aggregate is marked for injection.voidParamExpressionSymbol.addParameter(ISymbol symbol) voidICanBeGeneric.addTypeParameterOrArgument(ISymbol typeParameterOrArgument) voidPossibleGenericSymbol.addTypeParameterOrArgument(ISymbol typeParameterOrArgument) Add a parameter type to this scope.voidvoidvoidDefine a Symbol in this scope.voidEvery module-level define invalidates any memoised "absent" that was answered from this module.voidvoidbooleanModuleScope.defineOrError(ISymbol symbol, SymbolChecker symbolChecker) Defines a new symbol and returns true if all when OK But if there were errors created then false is returned.voidModuleScope.defineReference(IToken token, ISymbol symbol) Add a reference to another construct in another module, so it can be used in shorthand form in this module.booleanModuleScope.errorsIfNameDiffersOnlyByCase(ISymbol symbol, SymbolChecker symbolChecker) THE case-variant name check for module scope - call this from every path that defines a module-level construct, including any that bypassesModuleScope.defineOrError(ISymbol, SymbolChecker)with a rawdefine.doubleAggregateWithTraitsSymbol.getAssignableCostTo(ISymbol s) doubleFunctionSymbol.getAssignableCostTo(ISymbol s) doubleISymbol.getAssignableCostTo(ISymbol s) doubleSymbol.getAssignableCostTo(ISymbol s) doubleAggregateSymbol.getUnCoercedAssignableCostTo(ISymbol s) doubleAggregateWithTraitsSymbol.getUnCoercedAssignableCostTo(ISymbol s) doubleFunctionSymbol.getUnCoercedAssignableCostTo(ISymbol s) doubleISymbol.getUnCoercedAssignableCostTo(ISymbol s) doubleSymbol.getUnCoercedAssignableCostTo(ISymbol s) booleanISymbol.isAssignableTo(ISymbol s) booleanSymbol.isAssignableTo(ISymbol s) booleanISymbol.isExactSameType(ISymbol symbolType) If is the symbol is an exact match.booleanSymbol.isExactSameType(ISymbol symbolType) Checks if the type match exactly.booleanISymbol.isPromotionSupported(ISymbol s) For some symbols we might support the _promote method via coercion.booleanSymbol.isPromotionSupported(ISymbol s) voidStreamCallSymbol.setConsumesSymbolType(ISymbol consumesSymbolType) This sets the type of symbol that stream can consume.voidStreamCallSymbol.setProducesSymbolType(ISymbol producesSymbolType) This sets the type of symbol that stream can produce.default ISymbolMethod parameters in org.ek9lang.compiler.symbols with type arguments of type ISymbolModifier and TypeMethodDescriptionprotected StringFunctionSymbol.doGetFriendlyName(String withName, Optional<ISymbol> theType) protected StringMethodSymbol.doGetFriendlyName(String withName, Optional<ISymbol> theType) doubleISymbol.getAssignableCostTo(Optional<ISymbol> s) doubleSymbol.getAssignableCostTo(Optional<ISymbol> s) protected StringSymbol.getSymbolTypeAsString(Optional<ISymbol> type) booleanISymbol.isAssignableTo(Optional<ISymbol> s) booleanSymbol.isAssignableTo(Optional<ISymbol> s) booleanMethodSymbol.isParameterSignatureMatchTo(List<ISymbol> params) Very important method; that checks if the parameter list provided can match the parameters declared for this method.booleanFunctionSymbol.isSignatureMatchTo(Optional<ISymbol> theirReturnType, List<ISymbol> theirParams) Check if the parameter types and return types match.booleanFunctionSymbol.isSignatureMatchTo(Optional<ISymbol> theirReturnType, List<ISymbol> theirParams) Check if the parameter types and return types match.voidMethodSymbol.setCallParameters(List<ISymbol> params) Typically used when making synthetic methods you want to add in all the params from another method or something.Constructors in org.ek9lang.compiler.symbols with parameters of type ISymbolModifierConstructorDescriptionConstantSymbol(String name, ISymbol type) ConstantSymbol(String name, ISymbol type, boolean fromLiteral) Ek9Types(AnyTypeSymbol ek9Any, ISymbol ek9Void, ISymbol ek9Boolean, ISymbol ek9Integer, ISymbol ek9Float, ISymbol ek9String, ISymbol ek9Character, ISymbol ek9Bits, ISymbol ek9Date, ISymbol ek9DateTime, ISymbol ek9Time, ISymbol ek9Duration, ISymbol ek9Json, ISymbol ek9Millisecond, ISymbol ek9Path, ISymbol ek9Version, ISymbol ek9HttpRequest, ISymbol ek9HttpResponse, ISymbol ek9HttpContext, ISymbol ek9Exception, ISymbol ek9Panic, ISymbol ek9List, ISymbol ek9Set, ISymbol ek9PriorityQueue, ISymbol ek9MutexLock, ISymbol ek9MutexKey, ISymbol ek9Tcp, ISymbol ek9Signals, ISymbol ek9Http, ISymbol ek9Iterator, ISymbol ek9Optional, ISymbol ek9Dictionary, ISymbol ek9DictionaryEntry, ISymbol ek9Result, ISymbol ek9Supplier, ISymbol ek9Consumer, ISymbol ek9Function, ISymbol ek9Routine, ISymbol ek9UnaryOperator, ISymbol ek9Predicate, ISymbol ek9Comparator, ISymbol ek9IO, ISymbol ek9Sensitive, ISymbol ek9Privileged, ISymbol ek9Stdin, ISymbol ek9Stdout, ISymbol ek9Stderr, ISymbol ek9Udp, ISymbol ek9TcpConnection, ISymbol ek9Locale) Creates an instance of aEk9Typesrecord class.ExpressionSymbol(ISymbol symbol) Create a new expression based around an existing symbol.MethodSymbol(String name, ISymbol type, IScope enclosingScope) Typically used for cloning constructors.RegistrationData(ISymbol implementationSymbol, ISymbol interfaceSymbol, List<ISymbol> aspectSymbols, IToken sourceToken) Creates an instance of aRegistrationDatarecord class.VariableSymbol(String name, ISymbol type) Constructor parameters in org.ek9lang.compiler.symbols with type arguments of type ISymbolModifierConstructorDescriptionAggregateSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) A simple straight forward aggregate type, like a class or record.AggregateSymbol(String name, IScope enclosingScope, List<ISymbol> typeParameterOrArguments) An aggregate that can be parameterised, i.e.AggregateWithTraitsSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) CaptureScopedSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) ConstantSymbol(String name, Optional<ISymbol> type) ConstantSymbol(String name, Optional<ISymbol> type, boolean fromLiteral) Construction of a Constant.MethodSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) Create new method symbol of a specific name with an enclosing scope (i.e.PossibleGenericSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) RegistrationData(ISymbol implementationSymbol, ISymbol interfaceSymbol, List<ISymbol> aspectSymbols, IToken sourceToken) Creates an instance of aRegistrationDatarecord class.ScopedSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) ServiceOperationSymbol(String name, Optional<ISymbol> type, IScope enclosingScope) VariableSymbol(String name, Optional<ISymbol> type)