Class CalleeRetention
java.lang.Object
org.ek9lang.compiler.support.retention.CalleeRetention
- All Implemented Interfaces:
Function<ScopedSymbol, CalleeRetention.Facts>
public final class CalleeRetention
extends Object
implements Function<ScopedSymbol, CalleeRetention.Facts>
THE reading of a callee's RETAINS as the ESCAPE facts of one call (E1.1, 2026-11-12,
EK9_IR_ESCAPE_LIFETIME_AND_SHARING_FACTS.md ยง3 "argument sinks"): for each argument, which holders may come to hold
it (the receiver, other parameters by name - the whole argument or a part of it), whether it may be kept somewhere
no argument names (
ambient, or an abstract declaration nothing implements), and whether it may be handed
back in the result; for the receiver, which parameters it (or a part of it) is kept into and whether it is kept
ambiently; for the result, whether it may be a view of the receiver, and the fail-closed default of an un-annotated
extern (UndeclaredExternResult); and the unknown opt-out, under which nothing may be assumed. One
reading per callee, in one place, so the escape walk never parses the RETAINS text and asks every question of one
answer; the single-question readers of this package (KeptArgumentHolders, HandsBackArgument, ...)
stay for the front end's checks. Hold one; memoise the answer per callee in the caller.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordWhat becomes of one argument.static final recordThe escape facts of one callee. -
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
CalleeRetention
public CalleeRetention()
-
-
Method Details
-
apply
- Specified by:
applyin interfaceFunction<ScopedSymbol, CalleeRetention.Facts>
-