docs
API
Generated with
docs/scalus/scalus.compiler/scalus.compiler.sir/scalus.compiler.sir.lowering/scalus.compiler.sir.lowering.typegens/DataConstrEmitter

DataConstrEmitter

scalus.compiler.sir.lowering.typegens.DataConstrEmitter
object DataConstrEmitter extends SirTypeUplcGenerator

DataConstr representation emitter for sum case-class types.

Owns the DataConstr-specific emission shapes for a Scala 3 sum (sealed-trait + case-class hierarchy lowered to Cardano Constr(tag, [field-data, ...])):

  • genConstrLowered: forwards to the variant case-class's own typegen (variants live as Prod types that know how to assemble their own bytes).
  • genMatchDataConstr / genMatchDataConstrCase: tag/field extraction via unConstrData, with lvCaseInteger (V4+) or if-then-else chain (V3) for branch dispatch.
  • upcastOne: synthesizes a parent-sum Constr by reusing the child's bytes under the parent's variant tag.

Pre-Phase-4c-step-3 this was named SumCaseSirTypeGenerator; the rename aligns terminology with the design doc (per-repr emitters at §3.2). prepareCases, findConstructors, and retrieveDataDecl stay here as shared helpers because SumUplcConstrOps and ProductCaseEmitter both reuse them.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class PreparedCase(sirCase: Case, constrIndex: Option[Int], originIndex: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

override def canBeConvertedToData(tp: SIRType)(using lctx: LoweringContext): Boolean

Attributes

Definition Classes
override def defaultDataRepresentation(tp: SIRType)(using LoweringContext): LoweredValueRepresentation

Get default representation for data representation of this type. This representation is used when converting to data instrucutres, which holds value as data.

Get default representation for data representation of this type. This representation is used when converting to data instrucutres, which holds value as data.

Attributes

Definition Classes
override def defaultRepresentation(tp: SIRType)(using LoweringContext): LoweredValueRepresentation

Get default representation. Assumed that input parameters of functions and vars and are in this representation.

Get default representation. Assumed that input parameters of functions and vars and are in this representation.

Attributes

Definition Classes
override def defaultTypeVarReperesentation(tp: SIRType)(using lctx: LoweringContext): LoweredValueRepresentation

Get default representation for type variable. This representation is used when converting to parameters of scala functions with type parameters. (Usually the same as defaultDataRepresentation, except Lambdas).

Get default representation for type variable. This representation is used when converting to parameters of scala functions with type parameters. (Usually the same as defaultDataRepresentation, except Lambdas).

Attributes

Definition Classes
def emitConvert(input: LoweredValue, target: LoweredValueRepresentation, pos: SIRPosition)(using lctx: LoweringContext): LoweredValue

Convert from a DataConstr source to target. TypeVar-source/target handling lives in SumDispatch.sumCaseImpl; the cases below cover every target that fan-out reaches us for. Other shapes are unreachable.

Convert from a DataConstr source to target. TypeVar-source/target handling lives in SumDispatch.sumCaseImpl; the cases below cover every target that fan-out reaches us for. Other shapes are unreachable.

Attributes

def findConstructors(sirType: SIRType, pos: SIRPosition): Seq[ConstrDecl]
override def genConstrLowered(constr: Constr, loweredArgs: List[LoweredValue], optTargetType: Option[SIRType])(using lctx: LoweringContext): LoweredValue

Generate constructor for this type — the workhorse, takes pre-lowered arguments. Implementations override this. Always called on DataDecl.tp (or a more specific case-class type for Sum→Product dispatch).

Generate constructor for this type — the workhorse, takes pre-lowered arguments. Implementations override this. Always called on DataDecl.tp (or a more specific case-class type for Sum→Product dispatch).

Value parameters

constr
  • constructor SIR node (carries name, decl, parentTypeArgs, anns, tp)
loweredArgs
  • already-lowered constructor arguments, in declaration order. Length matches constr.args.
optTargetType
  • optional target type (e.g., for Nil typing where the constr's declared tp is List[Nothing]).

Attributes

Definition Classes
override def genMatch(matchData: Match, loweredScrutinee: LoweredValue, optTargetType: Option[SIRType])(using lctx: LoweringContext): LoweredValue

Attributes

Definition Classes
def genMatchDataConstr(matchData: Match, loweredScrutinee: LoweredValue, optTargetType: Option[SIRType])(using lctx: LoweringContext): LoweredValue
def genMatchDataConstrCase(sirCase: Case, dataListVar: IdentifiableLoweredValue, optTargetType: Option[SIRType], addDataListToScope: Boolean)(using lctx: LoweringContext): LoweredValue
override def genSelect(sel: Select, loweredScrutinee: LoweredValue)(using lctx: LoweringContext): LoweredValue

Attributes

Definition Classes
override def upcastOne(input: LoweredValue, targetType: SIRType, pos: SIRPosition)(using lctx: LoweringContext): LoweredValue

Attributes

Definition Classes

Inherited methods

final def genConstr(constr: Constr, optTargetType: Option[SIRType] = ...)(using lctx: LoweringContext): LoweredValue

Convenience entry point — pre-lowers constr.args and delegates to genConstrLowered. Use this when the caller hasn't already lowered the arguments; callers that have pre-lowered arguments (like the main lowering driver) should call genConstrLowered directly to avoid double-lowering. Marked final so all dispatch decisions live in genConstrLowered and its overrides.

Convenience entry point — pre-lowers constr.args and delegates to genConstrLowered. Use this when the caller hasn't already lowered the arguments; callers that have pre-lowered arguments (like the main lowering driver) should call genConstrLowered directly to avoid double-lowering. Marked final so all dispatch decisions live in genConstrLowered and its overrides.

Attributes

Inherited from:
SirTypeUplcGenerator
Generated with