Record Class SynthesisScope

java.lang.Object

java.lang.Record

org.ek9lang.compiler.phase7.synthesis.support.SynthesisScope

Record Components:

debugInfo - Source location and debug information (may be null for synthetic operators)

scopeId - Current scope identifier for ARC memory management

returnVariable - The name of the body's return variable, or null when it returns nothing

public record SynthesisScope(DebugInfo debugInfo, String scopeId, String returnVariable)
extends Record

Bundles the scope parameters that flow through synthetic operator generation methods.

These two parameters appear together in virtually every synthesis method:

• debugInfo - Source location information for the generated instructions (may be null for synthetic code)
• scopeId - Current scope ID for memory management (SCOPE_REGISTER)

Using this record reduces parameter count and makes method signatures cleaner.

A scope that returns a value also carries the name of its RETURN VARIABLE, so every helper that stores into, releases or returns it uses the one name the body was set up with - normally rtn, but _rtn when the construct captures a variable named rtn (see AbstractSyntheticGenerator.returnVariableNameFor, D37). A scope with no return value has none.

Constructor Summary

Constructors

Constructor	Description
SynthesisScope(DebugInfo debugInfo, String scopeId)	A scope that returns nothing (a void body, or a stage of a larger body).
SynthesisScope(DebugInfo debugInfo, String scopeId, String returnVariable)	Validate that scopeId is not null.

Method Summary

Modifier and Type	Method	Description
DebugInfo	debugInfo()	Returns the value of the debugInfo record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	returnVariable()	The body's return variable - only for a scope set up with one.
String	scopeId()	Returns the value of the scopeId record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

SynthesisScope

public SynthesisScope(DebugInfo debugInfo,
 String scopeId,
 String returnVariable)

Validate that scopeId is not null. debugInfo may be null for synthetic code.

SynthesisScope

public SynthesisScope(DebugInfo debugInfo,
 String scopeId)

A scope that returns nothing (a void body, or a stage of a larger body).

Method Details

returnVariable

public String returnVariable()

The body's return variable - only for a scope set up with one.

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.

debugInfo

public DebugInfo debugInfo()

Returns the value of the debugInfo record component.

Returns:

the value of the debugInfo record component

scopeId

public String scopeId()

Returns the value of the scopeId record component.

Returns:

the value of the scopeId record component