Record Class ForRangePolymorphicInstr.ProgressCheck

java.lang.Object
java.lang.Record
org.ek9lang.compiler.ir.instructions.ForRangePolymorphicInstr.ProgressCheck
Enclosing class:
ForRangePolymorphicInstr
public static record ForRangePolymorphicInstr.ProgressCheck(List<IRInstr> evaluation, String primitive) extends Record
The run-time PROGRESS check of a range whose counter type can wrap or not move (Time, and every user-defined range type - decided at compile time by RangeProgressCheck, never by a back end). evaluation owns the STEP: inside one scope it copies the counter (the counter type's copy constructor) as the previous value, applies the step the case's loop_increment would, and compares counter <=> previous with 0. The back end emits it where it would emit the increment, and leaves the loop BEFORE the next iteration unless primitive is true (the counter moved toward the end): a counter that wrapped, stayed equal or compared unset ends the range. When present the case's loop_increment is EMPTY - the step is inside this evaluation, so it must never be applied twice. Absent for every built-in that goes unset at its limit.

  • Constructor Details

    • ProgressCheck

      public ProgressCheck(List<IRInstr> evaluation, String primitive)
      Creates an instance of a ProgressCheck record class.
      Parameters:
      evaluation - the value for the evaluation record component
      primitive - the value for the primitive 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • evaluation

      public List<IRInstr> evaluation()
      Returns the value of the evaluation record component.
      Returns:
      the value of the evaluation record component

    • primitive

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