Record Class PromotionParams

java.lang.Object
java.lang.Record
org.ek9lang.compiler.phase7.support.PromotionParams
Record Components:
sourceType - The type of the value being promoted (e.g., Integer)
sourceVariable - The variable name holding the value to promote
debugInfo - Debug information for generated instructions
escaping - Whether the promoted value escapes the current scope (RETAIN-only) or is scope-local (RETAIN + SCOPE_REGISTER)
public record PromotionParams(ISymbol sourceType, String sourceVariable, DebugInfo debugInfo, boolean escaping) extends Record
Parameters for type promotion invocation using the #^ operator.

Encapsulates all data needed to generate a _promote() call with proper memory management.

escaping selects the ARC treatment of the promoted value, kept EXPLICIT in the IR so a later IR-optimisation pass (phase 12) can see the value's lifetime and stack-allocate it, eliding RETAIN/RELEASE, when it does not escape:

  • false (default): the promoted value is scope-local — a list/dict element, a range bound, a comparison operand — consumed in this scope by a consumer that takes its own retain. RETAIN + SCOPE_REGISTER; released at scope exit.
  • true: the promoted value ESCAPES the current scope (e.g. a coalescing body-result that becomes the expression's value). RETAIN only, no SCOPE_REGISTER; the consumer takes ownership — the same producer pattern the chain already uses for its escaping operands.

  • Constructor Details

    • PromotionParams

      public PromotionParams(ISymbol sourceType, String sourceVariable, DebugInfo debugInfo)
      Non-escaping (scope-local) promotion — the common case (list/dict element, range bound, comparison operand). The promoted value is used and released within the current scope.

    • PromotionParams

      public PromotionParams(ISymbol sourceType, String sourceVariable, DebugInfo debugInfo, boolean escaping)
      Creates an instance of a PromotionParams record class.
      Parameters:
      sourceType - the value for the sourceType record component
      sourceVariable - the value for the sourceVariable record component
      debugInfo - the value for the debugInfo record component
      escaping - the value for the escaping record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • sourceType

      public ISymbol sourceType()
      Returns the value of the sourceType record component.
      Returns:
      the value of the sourceType record component

    • sourceVariable

      public String sourceVariable()
      Returns the value of the sourceVariable record component.
      Returns:
      the value of the sourceVariable record component

    • debugInfo

      public DebugInfo debugInfo()
      Returns the value of the debugInfo record component.
      Returns:
      the value of the debugInfo record component

    • escaping

      public boolean escaping()
      Returns the value of the escaping record component.
      Returns:
      the value of the escaping record component