nucleation 0.10.22 → 0.10.23

package/renderer/LayoutFunction.mjs

@@ -0,0 +1,159 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const LayoutFunction_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.LayoutFunction_destroy(ptr);
+});
+
+/**
+ * Maps logical bits to physical positions (PORTING rule 10).
+ */
+export class LayoutFunction {
+    // 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("LayoutFunction 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) {
+            LayoutFunction_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * One bit per position: signal strength 0 = false, 15 = true.
+     * The most common layout for traditional redstone circuits.
+     */
+    static oneToOne() {
+
+        const result = wasm.LayoutFunction_one_to_one();
+
+        try {
+            return new LayoutFunction(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Four bits per position, packed as a hex nibble (0-15) with the
+     * lowest bit first; uses `ceil(bits / 4)` positions (4x denser than
+     * one-to-one).
+     */
+    static packed4() {
+
+        const result = wasm.LayoutFunction_packed4();
+
+        try {
+            return new LayoutFunction(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Custom bit-to-position mapping.
+     */
+    static custom(mapping) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const mappingSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, mapping, "u32")));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.LayoutFunction_custom(diplomatReceive.buffer, mappingSlice.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 LayoutFunction(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * 2D matrix layout, elements laid out row by row; element bits are
+     * packed 4 per position (nibbles).
+     */
+    static rowMajor(rows, cols, bitsPerElement) {
+
+        const result = wasm.LayoutFunction_row_major(rows, cols, bitsPerElement);
+
+        try {
+            return new LayoutFunction(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * 2D matrix layout, elements laid out column by column; element bits
+     * are packed 4 per position (nibbles).
+     */
+    static columnMajor(rows, cols, bitsPerElement) {
+
+        const result = wasm.LayoutFunction_column_major(rows, cols, bitsPerElement);
+
+        try {
+            return new LayoutFunction(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Screen layout: pixels laid out row by row, left to right; pixel
+     * bits are packed 4 per position (nibbles).
+     */
+    static scanline(width, height, bitsPerPixel) {
+
+        const result = wasm.LayoutFunction_scanline(width, height, bitsPerPixel);
+
+        try {
+            return new LayoutFunction(diplomatRuntime.internalConstructor, result, []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/MchprsWorld.d.mts

@@ -0,0 +1,131 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { RedstoneGraph } from "./RedstoneGraph.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A running MCHPRS redstone simulation. Wraps {@link crate::simulation::MchprsWorld}.
+ */
+export class MchprsWorld {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a simulation world from a schematic with default options.
+     */
+    static create(schematic: Schematic): MchprsWorld;
+
+    /**
+     * Create a simulation world with explicit options.
+     */
+    static createWithOptions(schematic: Schematic, optimize: boolean, ioOnly: boolean): MchprsWorld;
+
+    /**
+     * Create a simulation world with custom IO positions
+     * (`custom_io_positions` is flat `[x,y,z, x,y,z, ...]`).
+     */
+    static createWithCustomIo(schematic: Schematic, optimize: boolean, ioOnly: boolean, customIoPositions: Array<number>): MchprsWorld;
+
+    /**
+     * One-shot convenience (old ABI: `schematic_simulate_use_block`):
+     * build a world from `schematic`, fire an `on_use_block` event per
+     * triple in `events_xyz`, run `ticks` ticks, and return the simulated
+     * schematic. Unlike the old ABI (which mutated in place), this returns
+     * a new `Schematic`.
+     */
+    static simulateUseBlock(schematic: Schematic, ticks: number, eventsXyz: Array<number>): Schematic;
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks: number): void;
+
+    /**
+     * Flush pending changes from the compiler to the world.
+     */
+    flush(): void;
+
+    /**
+     * Set the power state of a lever.
+     */
+    setLeverPower(x: number, y: number, z: number, powered: boolean): void;
+
+    /**
+     * Get the power state of a lever.
+     */
+    getLeverPower(x: number, y: number, z: number): boolean;
+
+    /**
+     * Whether a redstone lamp is lit at the given position.
+     */
+    isLit(x: number, y: number, z: number): boolean;
+
+    /**
+     * Set the signal strength (0-15) at a custom IO position.
+     */
+    setSignalStrength(x: number, y: number, z: number, strength: number): void;
+
+    /**
+     * Get the signal strength (0-15) at a position.
+     */
+    getSignalStrength(x: number, y: number, z: number): number;
+
+    /**
+     * Simulate a right-click on a block (typically a lever).
+     */
+    onUseBlock(x: number, y: number, z: number): void;
+
+    /**
+     * Sync the simulation state back to the internal schematic.
+     */
+    syncToSchematic(): void;
+
+    /**
+     * A clone of the world's schematic.
+     */
+    getSchematic(): Schematic;
+
+    /**
+     * The redstone power level (0-15) at a position.
+     */
+    getRedstonePower(x: number, y: number, z: number): number;
+
+    /**
+     * Check for custom IO changes since the last check. Call before
+     * `poll_custom_io_changes_json`.
+     */
+    checkCustomIoChanges(): void;
+
+    /**
+     * Queued custom IO changes as a JSON array
+     * (`[{"x":..,"y":..,"z":..,"old_power":..,"new_power":..}, ...]`),
+     * clearing the queue.
+     */
+    pollCustomIoChangesJson(): string;
+
+    /**
+     * Queued custom IO changes as JSON without clearing the queue.
+     */
+    peekCustomIoChangesJson(): string;
+
+    /**
+     * Clear all queued custom IO changes.
+     */
+    clearCustomIoChanges(): void;
+
+    /**
+     * Extract the compiled (post-optimization) redstone logic graph.
+     */
+    exportGraph(): RedstoneGraph;
+
+    /**
+     * Extract the structural (pre-fold, as-built) redstone logic graph.
+     */
+    exportGraphStructural(): RedstoneGraph;
+}

package/renderer/MchprsWorld.d.ts

@@ -0,0 +1,131 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { RedstoneGraph } from "./RedstoneGraph.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A running MCHPRS redstone simulation. Wraps {@link crate::simulation::MchprsWorld}.
+ */
+export class MchprsWorld {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a simulation world from a schematic with default options.
+     */
+    static create(schematic: Schematic): MchprsWorld;
+
+    /**
+     * Create a simulation world with explicit options.
+     */
+    static createWithOptions(schematic: Schematic, optimize: boolean, ioOnly: boolean): MchprsWorld;
+
+    /**
+     * Create a simulation world with custom IO positions
+     * (`custom_io_positions` is flat `[x,y,z, x,y,z, ...]`).
+     */
+    static createWithCustomIo(schematic: Schematic, optimize: boolean, ioOnly: boolean, customIoPositions: Array<number>): MchprsWorld;
+
+    /**
+     * One-shot convenience (old ABI: `schematic_simulate_use_block`):
+     * build a world from `schematic`, fire an `on_use_block` event per
+     * triple in `events_xyz`, run `ticks` ticks, and return the simulated
+     * schematic. Unlike the old ABI (which mutated in place), this returns
+     * a new `Schematic`.
+     */
+    static simulateUseBlock(schematic: Schematic, ticks: number, eventsXyz: Array<number>): Schematic;
+
+    /**
+     * Advance the simulation by `ticks` ticks.
+     */
+    tick(ticks: number): void;
+
+    /**
+     * Flush pending changes from the compiler to the world.
+     */
+    flush(): void;
+
+    /**
+     * Set the power state of a lever.
+     */
+    setLeverPower(x: number, y: number, z: number, powered: boolean): void;
+
+    /**
+     * Get the power state of a lever.
+     */
+    getLeverPower(x: number, y: number, z: number): boolean;
+
+    /**
+     * Whether a redstone lamp is lit at the given position.
+     */
+    isLit(x: number, y: number, z: number): boolean;
+
+    /**
+     * Set the signal strength (0-15) at a custom IO position.
+     */
+    setSignalStrength(x: number, y: number, z: number, strength: number): void;
+
+    /**
+     * Get the signal strength (0-15) at a position.
+     */
+    getSignalStrength(x: number, y: number, z: number): number;
+
+    /**
+     * Simulate a right-click on a block (typically a lever).
+     */
+    onUseBlock(x: number, y: number, z: number): void;
+
+    /**
+     * Sync the simulation state back to the internal schematic.
+     */
+    syncToSchematic(): void;
+
+    /**
+     * A clone of the world's schematic.
+     */
+    getSchematic(): Schematic;
+
+    /**
+     * The redstone power level (0-15) at a position.
+     */
+    getRedstonePower(x: number, y: number, z: number): number;
+
+    /**
+     * Check for custom IO changes since the last check. Call before
+     * `poll_custom_io_changes_json`.
+     */
+    checkCustomIoChanges(): void;
+
+    /**
+     * Queued custom IO changes as a JSON array
+     * (`[{"x":..,"y":..,"z":..,"old_power":..,"new_power":..}, ...]`),
+     * clearing the queue.
+     */
+    pollCustomIoChangesJson(): string;
+
+    /**
+     * Queued custom IO changes as JSON without clearing the queue.
+     */
+    peekCustomIoChangesJson(): string;
+
+    /**
+     * Clear all queued custom IO changes.
+     */
+    clearCustomIoChanges(): void;
+
+    /**
+     * Extract the compiled (post-optimization) redstone logic graph.
+     */
+    exportGraph(): RedstoneGraph;
+
+    /**
+     * Extract the structural (pre-fold, as-built) redstone logic graph.
+     */
+    exportGraphStructural(): RedstoneGraph;
+}