nucleation 0.10.22 → 0.10.24

package/renderer/TypedCircuitExecutor.d.mts

@@ -0,0 +1,101 @@
+// generated by diplomat-tool
+import type { ExecutionMode } from "./ExecutionMode.mjs"
+import type { IoLayout } from "./IoLayout.mjs"
+import type { MchprsWorld } from "./MchprsWorld.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { Value } from "./Value.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A typed circuit executor. Wraps
+ * {@link crate::simulation::typed_executor::TypedCircuitExecutor}.
+ */
+export class TypedCircuitExecutor {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create from a world and layout. Builds a fresh world from the
+     * world's schematic (matches the old ABI, which cloned internally).
+     */
+    static fromLayout(world: MchprsWorld, layout: IoLayout): TypedCircuitExecutor;
+
+    /**
+     * Create from a world and layout with simulation options.
+     */
+    static fromLayoutWithOptions(world: MchprsWorld, layout: IoLayout, optimize: boolean, ioOnly: boolean): TypedCircuitExecutor;
+
+    /**
+     * Create from Insign annotations in a schematic.
+     */
+    static fromInsign(schematic: Schematic): TypedCircuitExecutor;
+
+    /**
+     * Create from Insign annotations with options.
+     */
+    static fromInsignWithOptions(schematic: Schematic, optimize: boolean, ioOnly: boolean): TypedCircuitExecutor;
+
+    /**
+     * Set the state mode ("stateless" | "stateful" | "manual").
+     */
+    setStateMode(mode: string): void;
+
+    /**
+     * Reset the executor to its initial state.
+     */
+    reset(): void;
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks: number): void;
+
+    /**
+     * Flush pending changes.
+     */
+    flush(): void;
+
+    /**
+     * Set a single input value.
+     */
+    setInput(name: string, value: Value): void;
+
+    /**
+     * Read a single output value.
+     */
+    readOutput(name: string): Value;
+
+    /**
+     * Execute the circuit. `inputs_json` is a JSON object like
+     * `{"input_name": {"type": "u32", "value": 42}}`; writes a JSON
+     * object with `outputs`, `ticks_elapsed` and `condition_met`.
+     */
+    execute(inputsJson: string, mode: ExecutionMode): string;
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson(): string;
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson(): string;
+
+    /**
+     * Layout info as a JSON object string
+     * (old ABI: `typed_executor_get_layout_info`).
+     */
+    layoutInfoJson(): string;
+
+    /**
+     * Sync the simulation state and return the schematic (cloned).
+     */
+    syncToSchematic(): Schematic;
+}

package/renderer/TypedCircuitExecutor.d.ts

@@ -0,0 +1,101 @@
+// generated by diplomat-tool
+import type { ExecutionMode } from "./ExecutionMode.mjs"
+import type { IoLayout } from "./IoLayout.mjs"
+import type { MchprsWorld } from "./MchprsWorld.mjs"
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { Value } from "./Value.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A typed circuit executor. Wraps
+ * {@link crate::simulation::typed_executor::TypedCircuitExecutor}.
+ */
+export class TypedCircuitExecutor {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create from a world and layout. Builds a fresh world from the
+     * world's schematic (matches the old ABI, which cloned internally).
+     */
+    static fromLayout(world: MchprsWorld, layout: IoLayout): TypedCircuitExecutor;
+
+    /**
+     * Create from a world and layout with simulation options.
+     */
+    static fromLayoutWithOptions(world: MchprsWorld, layout: IoLayout, optimize: boolean, ioOnly: boolean): TypedCircuitExecutor;
+
+    /**
+     * Create from Insign annotations in a schematic.
+     */
+    static fromInsign(schematic: Schematic): TypedCircuitExecutor;
+
+    /**
+     * Create from Insign annotations with options.
+     */
+    static fromInsignWithOptions(schematic: Schematic, optimize: boolean, ioOnly: boolean): TypedCircuitExecutor;
+
+    /**
+     * Set the state mode ("stateless" | "stateful" | "manual").
+     */
+    setStateMode(mode: string): void;
+
+    /**
+     * Reset the executor to its initial state.
+     */
+    reset(): void;
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks: number): void;
+
+    /**
+     * Flush pending changes.
+     */
+    flush(): void;
+
+    /**
+     * Set a single input value.
+     */
+    setInput(name: string, value: Value): void;
+
+    /**
+     * Read a single output value.
+     */
+    readOutput(name: string): Value;
+
+    /**
+     * Execute the circuit. `inputs_json` is a JSON object like
+     * `{"input_name": {"type": "u32", "value": 42}}`; writes a JSON
+     * object with `outputs`, `ticks_elapsed` and `condition_met`.
+     */
+    execute(inputsJson: string, mode: ExecutionMode): string;
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson(): string;
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson(): string;
+
+    /**
+     * Layout info as a JSON object string
+     * (old ABI: `typed_executor_get_layout_info`).
+     */
+    layoutInfoJson(): string;
+
+    /**
+     * Sync the simulation state and return the schematic (cloned).
+     */
+    syncToSchematic(): Schematic;
+}

package/renderer/TypedCircuitExecutor.mjs

@@ -0,0 +1,378 @@
+// generated by diplomat-tool
+import { ExecutionMode } from "./ExecutionMode.mjs"
+import { IoLayout } from "./IoLayout.mjs"
+import { MchprsWorld } from "./MchprsWorld.mjs"
+import { NucleationError } from "./NucleationError.mjs"
+import { Schematic } from "./Schematic.mjs"
+import { Value } from "./Value.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const TypedCircuitExecutor_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.TypedCircuitExecutor_destroy(ptr);
+});
+
+/**
+ * A typed circuit executor. Wraps
+ * {@link crate::simulation::typed_executor::TypedCircuitExecutor}.
+ */
+export class TypedCircuitExecutor {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("TypedCircuitExecutor is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            TypedCircuitExecutor_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Create from a world and layout. Builds a fresh world from the
+     * world's schematic (matches the old ABI, which cloned internally).
+     */
+    static fromLayout(world, layout) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_from_layout(diplomatReceive.buffer, world.ffiValue, layout.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new TypedCircuitExecutor(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Create from a world and layout with simulation options.
+     */
+    static fromLayoutWithOptions(world, layout, optimize, ioOnly) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_from_layout_with_options(diplomatReceive.buffer, world.ffiValue, layout.ffiValue, optimize, ioOnly);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new TypedCircuitExecutor(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Create from Insign annotations in a schematic.
+     */
+    static fromInsign(schematic) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_from_insign(diplomatReceive.buffer, schematic.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new TypedCircuitExecutor(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Create from Insign annotations with options.
+     */
+    static fromInsignWithOptions(schematic, optimize, ioOnly) {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_from_insign_with_options(diplomatReceive.buffer, schematic.ffiValue, optimize, ioOnly);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new TypedCircuitExecutor(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Set the state mode ("stateless" | "stateful" | "manual").
+     */
+    setStateMode(mode) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const modeSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, mode)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_set_state_mode(diplomatReceive.buffer, this.ffiValue, modeSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Reset the executor to its initial state.
+     */
+    reset() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_reset(diplomatReceive.buffer, this.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks) {
+    wasm.TypedCircuitExecutor_tick(this.ffiValue, ticks);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Flush pending changes.
+     */
+    flush() {
+    wasm.TypedCircuitExecutor_flush(this.ffiValue);
+
+        try {}
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Set a single input value.
+     */
+    setInput(name, value) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const nameSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, name)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_set_input(diplomatReceive.buffer, this.ffiValue, nameSlice.ptr, value.ffiValue);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Read a single output value.
+     */
+    readOutput(name) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const nameSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, name)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.TypedCircuitExecutor_read_output(diplomatReceive.buffer, this.ffiValue, nameSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new Value(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Execute the circuit. `inputs_json` is a JSON object like
+     * `{"input_name": {"type": "u32", "value": 42}}`; writes a JSON
+     * object with `outputs`, `ticks_elapsed` and `condition_met`.
+     */
+    execute(inputsJson, mode) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const inputsJsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, inputsJson)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.TypedCircuitExecutor_execute(diplomatReceive.buffer, this.ffiValue, inputsJsonSlice.ptr, mode.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Input names as a JSON array string.
+     */
+    inputNamesJson() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.TypedCircuitExecutor_input_names_json(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * Output names as a JSON array string.
+     */
+    outputNamesJson() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.TypedCircuitExecutor_output_names_json(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * Layout info as a JSON object string
+     * (old ABI: `typed_executor_get_layout_info`).
+     */
+    layoutInfoJson() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.TypedCircuitExecutor_layout_info_json(this.ffiValue, write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * Sync the simulation state and return the schematic (cloned).
+     */
+    syncToSchematic() {
+
+        const result = wasm.TypedCircuitExecutor_sync_to_schematic(this.ffiValue);
+
+        try {
+            return new Schematic(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/Value.d.mts

@@ -0,0 +1,73 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A typed circuit value (payload-carrying enum; PORTING rule 10).
+ */
+export class Value {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create an unsigned 32-bit integer value.
+     */
+    static fromU32(v: number): Value;
+
+    /**
+     * Create a signed 32-bit integer value.
+     */
+    static fromI32(v: number): Value;
+
+    /**
+     * Create a 32-bit IEEE 754 float value.
+     */
+    static fromF32(v: number): Value;
+
+    /**
+     * Create a boolean value.
+     */
+    static fromBool(v: boolean): Value;
+
+    /**
+     * Create a string value. Fails if the bytes are not valid UTF-8.
+     */
+    static fromString(s: string): Value;
+
+    /**
+     * The value as u32. Also accepts u64/non-negative signed ints that
+     * fit, and bool (false → 0, true → 1); fails otherwise.
+     */
+    asU32(): number;
+
+    /**
+     * The value as i32. Also accepts i64 values in i32 range; fails for
+     * other types.
+     */
+    asI32(): number;
+
+    /**
+     * The value as f32; fails if this is not an f32 value.
+     */
+    asF32(): number;
+
+    /**
+     * The value as bool; fails if this is not a bool value.
+     */
+    asBool(): boolean;
+
+    /**
+     * The string payload; fails if this is not a string value.
+     */
+    asString(): string;
+
+    /**
+     * The type name (e.g. "u32", "bool", "string").
+     */
+    typeName(): string;
+}