@helios-lang/compiler/src/expressions/StructLiteralField.js

Helios is a Domain Specific Language that compiles to Plutus-Core (i.e. Cardano on-chain validator scripts). Helios is a non-Haskell alternative to Plutus. With this library you can compile Helios scripts and build Cardano transactions, all you need to bu

import { isDefined } from "@helios-lang/type-utils"
import { ToIRContext } from "../codegen/index.js"
import { Scope } from "../scopes/index.js"
import { Expr } from "./Expr.js"

/**
 * @import { Word } from "@helios-lang/compiler-utils"
 * @import { SourceMappedStringI } from "@helios-lang/ir"
 * @import { TypeCheckContext } from "../index.js"
 * @typedef {import("../typecheck/index.js").EvalEntity} EvalEntity
 */

/**
 * Struct field (part of a literal struct constructor)
 */
export class StructLiteralField {
    /**
     * @private
     * @readonly
     * @type {Word | undefined}
     */
    _name

    /**
     * @private
     * @readonly
     * @type {Expr}
     */
    _value

    /**
     * @param {Word | undefined} name
     * @param {Expr} value
     */
    constructor(name, value) {
        this._name = name
        this._value = value
    }

    /**
     * @type {Word}
     */
    get name() {
        if (!this._name) {
            throw new Error("name of field not given")
        } else {
            return this._name
        }
    }

    get site() {
        if (!this._name) {
            return this._value.site
        } else {
            return this._name.site
        }
    }

    /**
     * @param {TypeCheckContext} ctx
     * @param {Scope} scope
     * @returns {EvalEntity}
     */
    eval(ctx, scope) {
        return this._value.eval(ctx, scope)
    }

    /**
     * @returns {boolean}
     */
    isNamed() {
        return isDefined(this._name)
    }

    /**
     * @param {ToIRContext} ctx
     * @returns {SourceMappedStringI}
     */
    toIR(ctx) {
        return this._value.toIR(ctx)
    }

    /**
     * @returns {string}
     */
    toString() {
        if (!this._name) {
            return this._value.toString()
        } else {
            return `${this._name.toString()}: ${this._value.toString()}`
        }
    }
}