openalgo-script 0.1.0-alpha.1 → 0.2.0

package/dist/core/engine/library/volume.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"volume.js","sourceRoot":"","sources":["../../../../src/core/engine/library/volume.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EACL,SAAS,EACT,MAAM,EACN,OAAO,EACP,OAAO,EACP,cAAc,EACd,OAAO,EACP,OAAO,EACP,OAAO,EACP,kBAAkB,EAClB,cAAc,EACd,QAAQ,GACT,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,CAAC,MAAM,cAAc,GAA6B;IACtD,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACpC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE;QACtB,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACtB,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM;QACtB,mEAAmE;QACnE,2DAA2D;QAC3D,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,cAAc,KAAK,IAAI;KACvC,CAAC,CACH;IAED,QAAQ,CAAC,YAAY,EAAE,eAAe,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACpD,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE;QAC5B,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACtB,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM;QACtB,0EAA0E;QAC1E,mEAAmE;QACnE,wEAAwE;QACxE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,IAAI;KAChC,CAAC,CACH;IAED,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAE7D,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAE3D,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAC3C,SAAS,CACP,GAAG,CAAC,KAAK,EACT,EAAE,EACF,GAAG,CAAC,GAAG,EACP,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EACvC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CACxC,CACF;IAED,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CACtE;IAED,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CACtE;IAED,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAE7D,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CACtE;IAED,QAAQ,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAC1C,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CACpF;IAED,QAAQ,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAC9C,kBAAkB,CAChB,GAAG,CAAC,KAAK,EACT,EAAE,EACF,GAAG,CAAC,GAAG,CAAC,MAAM,EACd,QAAQ,CAAC,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAChD,CACF;CACF,CAAC"}

package/dist/core/engine/load.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Loading a compiled program, which is everything that happens before bar 0.
+ *
+ * Separate from the bar cycle because it is a different job with a different
+ * failure. A load either refuses, with a code and a reason, or hands back an
+ * engine that has already been proved able to run: verification in full
+ * (`compiled-program.md` 3.5), then the refusals a host makes, then the
+ * settings. Nothing is executed until all three pass, so a program that cannot
+ * run says so before a chart has drawn anything, rather than halfway through
+ * bar four thousand with half a study on the screen.
+ */
+import type { Diagnostic } from '../diagnostics/index.js';
+import type { SourceFile } from '../source/index.js';
+import type { Clock, EngineLimits } from './budget.js';
+import { Engine } from './engine.js';
+import type { EngineHost } from './host.js';
+import type { TimeResolver } from './inputs.js';
+export interface LoadOptions {
+    /** The host's settings, keyed by input `key`. */
+    readonly settings?: Readonly<Record<string, unknown>>;
+    readonly limits?: Partial<EngineLimits>;
+    /** The source, so a diagnostic's span can carry an offset as well as a line. */
+    readonly source?: SourceFile;
+    readonly host?: EngineHost;
+    /** A reading of the wall clock, for the per bar time budget. */
+    readonly clock?: Clock;
+    /** How a `"time"` input's stored wall clock string becomes a timestamp. */
+    readonly time?: TimeResolver;
+}
+export type LoadResult = {
+    readonly ok: true;
+    readonly engine: Engine;
+} | {
+    readonly ok: false;
+    readonly diagnostic: Diagnostic;
+};
+/**
+ * Loads a compiled program.
+ *
+ * Verification runs first and in full (3.5), then the refusals a host makes,
+ * then input resolution. Nothing is executed until all three pass, so a program
+ * that cannot run says so before a chart has drawn anything.
+ */
+export declare function load(program: unknown, options?: LoadOptions): LoadResult;
+//# sourceMappingURL=load.d.ts.map

package/dist/core/engine/load.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../src/core/engine/load.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGrD,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAKhD,MAAM,WAAW,WAAW;IAC1B,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACtD,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IACxC,gFAAgF;IAChF,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,MAAM,UAAU,GAClB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC9C;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC;AAE5D;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU,CAsD5E"}

package/dist/core/engine/load.js

@@ -0,0 +1,60 @@
+import { BAR_FIELDS } from './bars.js';
+import { limitsWith } from './budget.js';
+import { Engine } from './engine.js';
+import { NO_POSITION, failure, malformed } from './errors.js';
+import { resolveInputs, utcTime } from './inputs.js';
+import { planRequests } from './request-plan.js';
+import { recordProblem } from './session/index.js';
+import { capabilitiesFor, verify } from './verify.js';
+/**
+ * Loads a compiled program.
+ *
+ * Verification runs first and in full (3.5), then the refusals a host makes,
+ * then input resolution. Nothing is executed until all three pass, so a program
+ * that cannot run says so before a chart has drawn anything.
+ */
+export function load(program, options = {}) {
+    const limits = limitsWith(options.limits);
+    const host = options.host ?? {};
+    const checked = verify(program, {
+        capabilities: capabilitiesFor(host.route !== undefined, host.requestBars !== undefined),
+        limits,
+    });
+    if (!checked.ok)
+        return { ok: false, diagnostic: checked.diagnostic };
+    const unknownField = checked.program.series.find((one) => one.kind === 'bar' && (one.field === null || !BAR_FIELDS.includes(one.field)));
+    if (unknownField !== undefined) {
+        return {
+            ok: false,
+            diagnostic: malformed(`series[${unknownField.id}].field`, `${String(unknownField.field)} is not a bar field this engine can fill`),
+        };
+    }
+    // The instrument record is read once and is the same for every program, so a
+    // record that contradicts itself is refused here rather than turning into an
+    // absence each study explains for itself.
+    const record = recordProblem(host.instrument?.session, host.instrument?.timezone ?? null);
+    if (record !== undefined) {
+        return {
+            ok: false,
+            diagnostic: failure('OS6012', NO_POSITION, {
+                fact: record,
+                symbol: host.instrument?.symbol ?? 'the chart\'s instrument',
+            }),
+        };
+    }
+    const resolved = resolveInputs(checked.program, options.settings ?? {}, options.time ?? utcTime);
+    if (!resolved.ok)
+        return { ok: false, diagnostic: resolved.diagnostic };
+    // 2.16: a request's identity is fixed before bar 0, so it is settled here,
+    // along with the two refusals that are facts about the program and the chart
+    // rather than answers from the host: a timeframe the language does not know,
+    // and one that cannot be folded onto this chart's bars.
+    const planned = planRequests(checked.program.requests, resolved.inputs, host);
+    if (!planned.ok)
+        return { ok: false, diagnostic: planned.diagnostic };
+    return {
+        ok: true,
+        engine: new Engine(checked.program, resolved.inputs, options, limits, planned.plans),
+    };
+}
+//# sourceMappingURL=load.js.map

package/dist/core/engine/load.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.js","sourceRoot":"","sources":["../../../src/core/engine/load.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAmBtD;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,OAAgB,EAAE,UAAuB,EAAE;IAC9D,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE;QAC9B,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC;QACvF,MAAM;KACP,CAAC,CAAC;IACH,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;IAEtE,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAC9C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CACvF,CAAC;IACF,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO;YACL,EAAE,EAAE,KAAK;YACT,UAAU,EAAE,SAAS,CACnB,UAAU,YAAY,CAAC,EAAE,SAAS,EAClC,GAAG,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,0CAA0C,CACxE;SACF,CAAC;IACJ,CAAC;IAED,6EAA6E;IAC7E,6EAA6E;IAC7E,0CAA0C;IAC1C,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,IAAI,IAAI,CAAC,CAAC;IAC1F,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,UAAU,EAAE,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE;gBACzC,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,IAAI,yBAAyB;aAC7D,CAAC;SACH,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAC5B,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,QAAQ,IAAI,EAAE,EACtB,OAAO,CAAC,IAAI,IAAI,OAAO,CACxB,CAAC;IACF,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;IAExE,2EAA2E;IAC3E,6EAA6E;IAC7E,6EAA6E;IAC7E,wDAAwD;IACxD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9E,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;IAEtE,OAAO;QACL,EAAE,EAAE,IAAI;QACR,MAAM,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC;KACrF,CAAC;AACJ,CAAC"}

package/dist/core/engine/machine.d.ts

@@ -0,0 +1,107 @@
+/**
+ * The interpreter: step 6 of the bar cycle, and the whole architecture of the
+ * language in one loop.
+ *
+ * **It walks a list. There is no `eval`, no generated function and no code
+ * built from text anywhere in it**, which is what lets the language run inside
+ * an application under a content security policy that forbids turning text into
+ * code, and what lets a platform run many customers' scripts in one process.
+ * The compiler emits data and this walks it; that is the foundation of the
+ * whole design rather than a preference.
+ *
+ * **What verification already proved, this does not re-check.** A verified
+ * program cannot underflow the stack, cannot jump out of bounds, cannot address
+ * a slot that does not exist and cannot loop without charging the budget (3.5).
+ * So the loop below pops without testing for an empty stack and indexes without
+ * testing a bound, and every remaining failure is a script error with a source
+ * position, which is the only kind of failure a user should ever see.
+ *
+ * **The budget is checked on the path every instruction takes.** One increment
+ * and one comparison, because the alternative is a loop an engine hopes will
+ * end. The loop budget itself is charged by `TICK` and by nothing else, so two
+ * engines run out at the same iteration of the same loop on the same bar (8.5).
+ */
+import type { Span } from '../span/index.js';
+import type { Budget } from './budget.js';
+import type { Channels } from './channels.js';
+import type { BarView, Guard, HostFacts, ManifestEntry, PositionFacts } from './library/index.js';
+import type { Memory } from './memory.js';
+import type { Registers } from './registers.js';
+import type { CompiledProgram, Position } from './types.js';
+import type { Heap, Value } from './values/index.js';
+/** Everything the interpreter is handed once, at load. */
+export interface MachineParts {
+    readonly program: CompiledProgram;
+    readonly registers: Registers;
+    readonly memory: Memory;
+    readonly channels: Channels;
+    readonly heap: Heap;
+    readonly budget: Budget;
+    readonly guard: Guard;
+    readonly host: HostFacts;
+    /** The strategy's own position, read from the run's ledger. */
+    readonly position: PositionFacts;
+    /** The library entry behind each `lib.functions` index, resolved at load. */
+    readonly library: readonly ManifestEntry[];
+    /** The position table of each function body, by function index. */
+    readonly fnPositions: readonly (readonly Position[])[];
+    spanAt(line: number, column: number): Span;
+}
+export declare class Machine {
+    private readonly parts;
+    private readonly top;
+    private readonly callers;
+    private frame;
+    private view;
+    private barIndex;
+    /** The loop whose `TICK` executed most recently, for OS5001's line. */
+    private lastLoop;
+    /**
+     * The value a top level `RET` handed back, `compiled-program.md` 2.16.1.
+     *
+     * A program's own `code` ends in `HALT` and produces nothing, so this stays
+     * absent for it. A request body ends in `RET` and its value is the read's
+     * value for that requested bar, which is the one thing the interpreter has to
+     * hand out rather than write into a register or a channel.
+     */
+    private returned;
+    private readonly ctx;
+    private readonly ops;
+    constructor(parts: MachineParts, view: BarView);
+    /** Step 3: the stack, the slots and the frame stack all start empty. */
+    begin(view: BarView, index: number): void;
+    /** What the last `run` handed back, for an instruction list that ends in `RET`. */
+    result(): Value;
+    /** The slot array of frame 0, which inputs and grids are written into. */
+    slots(): Value[];
+    /** Where the instruction that just executed came from. */
+    here(): Span;
+    /**
+     * Runs the bar.
+     *
+     * The dispatch is a switch over the opcode name. A name rather than a number
+     * is what the format carries (2.14) so that a program is readable and
+     * diffable by hand; an engine may map names to its own integers at load and
+     * must not depend on any numbering, because none is defined.
+     */
+    run(): void;
+    private loopLine;
+    /** What the operations in `operations.ts` need, built once. */
+    private operations;
+    /** `ADD` with the string ceiling applied, since it is the one that grows one. */
+    private joined;
+    /**
+     * `CALL_LIB`.
+     *
+     * A call whose manifest entry carries an effect does not perform it: it
+     * appends a record holding the function index and the argument values as they
+     * stood, and pushes absent. The machine does that here rather than in the
+     * entry, so an effect cannot be forgotten by whoever writes the next one.
+     */
+    private callLibrary;
+    /** `CALL_FN`: everything it needs is in the call site, 4.10. */
+    private callFunction;
+    /** The name a value goes by, which a library call asks for by the same route. */
+    nameOf(value: Value): string;
+}
+//# sourceMappingURL=machine.d.ts.map

package/dist/core/engine/machine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"machine.d.ts","sourceRoot":"","sources":["../../../src/core/engine/machine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAe7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAG9C,OAAO,KAAK,EACV,OAAO,EAEP,KAAK,EACL,SAAS,EACT,aAAa,EACb,aAAa,EAEd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAU1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAe,QAAQ,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAGrD,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,SAAS,aAAa,EAAE,CAAC;IAC3C,mEAAmE;IACnE,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,SAAS,QAAQ,EAAE,CAAC,EAAE,CAAC;IACvD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAsBD,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IACrC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,IAAI,CAAU;IACtB,OAAO,CAAC,QAAQ,CAAK;IACrB,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAAM;IACtB;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAiB;IACrC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAM;gBAEd,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO;IA6B9C,wEAAwE;IACxE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAYzC,mFAAmF;IACnF,MAAM,IAAI,KAAK;IAIf,0EAA0E;IAC1E,KAAK,IAAI,KAAK,EAAE;IAIhB,0DAA0D;IAC1D,IAAI,IAAI,IAAI;IAKZ;;;;;;;OAOG;IACH,GAAG,IAAI,IAAI;IA+JX,OAAO,CAAC,QAAQ;IAKhB,+DAA+D;IAC/D,OAAO,CAAC,UAAU;IAalB,iFAAiF;IACjF,OAAO,CAAC,MAAM;IAMd;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;IAyBnB,gEAAgE;IAChE,OAAO,CAAC,YAAY;IAoBpB,iFAAiF;IACjF,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;CAG7B"}

package/dist/core/engine/machine.js

@@ -0,0 +1,337 @@
+import { add, and, compare, divide, equals, isFalsey, multiply, negate, not, or, remainder, subtract, } from './arithmetic.js';
+import { makeFrame, positionAt } from './frames.js';
+import { constantValueOf, elementRead, forInit, forNext, historyRead, nameOf, } from './operations.js';
+import { ABSENT, reference } from './values/index.js';
+/**
+ * The region a stateless call is handed.
+ *
+ * Shared rather than allocated per call, because an entry declared without
+ * state never touches it and an allocation on the path of every `max` and every
+ * colour would be the engine's largest per bar cost for nothing.
+ */
+const NO_STATE = {};
+export class Machine {
+    parts;
+    top;
+    callers = [];
+    frame;
+    view;
+    barIndex = 0;
+    /** The loop whose `TICK` executed most recently, for OS5001's line. */
+    lastLoop = -1;
+    /**
+     * The value a top level `RET` handed back, `compiled-program.md` 2.16.1.
+     *
+     * A program's own `code` ends in `HALT` and produces nothing, so this stays
+     * absent for it. A request body ends in `RET` and its value is the read's
+     * value for that requested bar, which is the one thing the interpreter has to
+     * hand out rather than write into a register or a channel.
+     */
+    returned = ABSENT;
+    ctx;
+    ops;
+    constructor(parts, view) {
+        this.parts = parts;
+        this.view = view;
+        const { program } = parts;
+        this.top = makeFrame(program.code, program.frame.slots, 0, 0, [], program.debug.pos);
+        this.frame = this.top;
+        this.ops = this.operations();
+        // One context, reused by every call, with the two fields that change per
+        // call read through getters. A fresh object per `CALL_LIB` would be an
+        // allocation on the hottest path in the engine, and the span is a binary
+        // search that most calls never ask for.
+        const machine = this;
+        this.ctx = {
+            heap: parts.heap,
+            host: parts.host,
+            position: parts.position,
+            guard: parts.guard,
+            state: NO_STATE,
+            get span() {
+                return machine.here();
+            },
+            get bar() {
+                return machine.view;
+            },
+            nameOf: (value) => machine.nameOf(value),
+        };
+    }
+    /** Step 3: the stack, the slots and the frame stack all start empty. */
+    begin(view, index) {
+        this.view = view;
+        this.barIndex = index;
+        this.lastLoop = -1;
+        this.returned = ABSENT;
+        this.callers.length = 0;
+        this.frame = this.top;
+        this.top.pc = 0;
+        this.top.stack.length = 0;
+        this.top.slots.fill(ABSENT);
+    }
+    /** What the last `run` handed back, for an instruction list that ends in `RET`. */
+    result() {
+        return this.returned;
+    }
+    /** The slot array of frame 0, which inputs and grids are written into. */
+    slots() {
+        return this.top.slots;
+    }
+    /** Where the instruction that just executed came from. */
+    here() {
+        const at = positionAt(this.frame.positions, Math.max(this.frame.pc - 1, 0));
+        return this.parts.spanAt(at.line, at.column);
+    }
+    /**
+     * Runs the bar.
+     *
+     * The dispatch is a switch over the opcode name. A name rather than a number
+     * is what the format carries (2.14) so that a program is readable and
+     * diffable by hand; an engine may map names to its own integers at load and
+     * must not depend on any numbering, because none is defined.
+     */
+    run() {
+        const { budget, channels, memory, registers, heap } = this.parts;
+        for (;;) {
+            if (budget.step())
+                budget.overrun(this.here(), this.loopLine());
+            const frame = this.frame;
+            const instruction = frame.code[frame.pc];
+            frame.pc += 1;
+            const stack = frame.stack;
+            switch (instruction[0]) {
+                case 'CONST':
+                    stack.push(constantValueOf(this.parts.program.consts[instruction[1]]));
+                    break;
+                case 'DUP':
+                    stack.push(stack[stack.length - 1] ?? ABSENT);
+                    break;
+                case 'POP':
+                    stack.pop();
+                    break;
+                case 'LOAD':
+                    stack.push(frame.slots[instruction[1]] ?? ABSENT);
+                    break;
+                case 'STORE':
+                    frame.slots[instruction[1]] = pop(stack);
+                    break;
+                case 'CELL_INIT':
+                    if (memory.initialise(frame.cellBase + instruction[1])) {
+                        frame.pc = instruction[2];
+                    }
+                    break;
+                case 'LOADC':
+                    stack.push(memory.load(frame.cellBase + instruction[1]));
+                    break;
+                case 'STOREC':
+                    memory.store(frame.cellBase + instruction[1], pop(stack));
+                    break;
+                case 'SLOAD':
+                    stack.push(registers.get(instruction[1]));
+                    break;
+                case 'SSTORE':
+                    registers.set(instruction[1], pop(stack));
+                    break;
+                case 'HIST':
+                    stack.push(historyRead(this.ops, instruction[1], pop(stack)));
+                    break;
+                case 'HISTP':
+                    stack.push(historyRead(this.ops, frame.series[instruction[1]] ?? -1, pop(stack)));
+                    break;
+                case 'ADD':
+                    stack.push(this.joined(stack));
+                    break;
+                case 'SUB':
+                    stack.push(binary(stack, subtract));
+                    break;
+                case 'MUL':
+                    stack.push(binary(stack, multiply));
+                    break;
+                case 'DIV':
+                    stack.push(binary(stack, divide));
+                    break;
+                case 'MOD':
+                    stack.push(binary(stack, remainder));
+                    break;
+                case 'NEG':
+                    stack.push(negate(pop(stack)));
+                    break;
+                case 'LT':
+                case 'LE':
+                case 'GT':
+                case 'GE': {
+                    const b = pop(stack);
+                    stack.push(compare(instruction[0], pop(stack), b));
+                    break;
+                }
+                case 'EQ': {
+                    const b = pop(stack);
+                    stack.push(equals(pop(stack), b));
+                    break;
+                }
+                case 'NE': {
+                    const b = pop(stack);
+                    stack.push(!equals(pop(stack), b));
+                    break;
+                }
+                case 'NOT':
+                    stack.push(not(pop(stack)));
+                    break;
+                case 'AND':
+                    stack.push(binary(stack, and));
+                    break;
+                case 'OR':
+                    stack.push(binary(stack, or));
+                    break;
+                case 'AND_SHORT':
+                    if (stack[stack.length - 1] === false)
+                        frame.pc = instruction[1];
+                    break;
+                case 'OR_SHORT':
+                    if (stack[stack.length - 1] === true)
+                        frame.pc = instruction[1];
+                    break;
+                case 'JUMP':
+                    frame.pc = instruction[1];
+                    break;
+                case 'JUMP_FALSE':
+                    if (isFalsey(pop(stack)))
+                        frame.pc = instruction[1];
+                    break;
+                case 'TICK': {
+                    const loop = instruction[1];
+                    this.lastLoop = loop;
+                    budget.tick(this.here(), this.parts.program.loops[loop]?.line ?? 0);
+                    break;
+                }
+                case 'FOR_INIT':
+                    forInit(this.ops, instruction, frame);
+                    break;
+                case 'FOR_NEXT':
+                    forNext(instruction, frame);
+                    break;
+                case 'ARRAY': {
+                    const count = instruction[1];
+                    const items = stack.splice(stack.length - count, count);
+                    this.parts.guard.array(this.here(), 'the array', items.length);
+                    stack.push(reference(heap.allocate({ kind: 'array', items })));
+                    break;
+                }
+                case 'ELEM': {
+                    const index = pop(stack);
+                    stack.push(elementRead(this.ops, pop(stack), index));
+                    break;
+                }
+                case 'CALL_LIB':
+                    this.callLibrary(instruction, stack);
+                    break;
+                case 'CALL_FN':
+                    this.callFunction(instruction[1], stack);
+                    break;
+                case 'RET': {
+                    const value = pop(stack);
+                    const caller = this.callers.pop();
+                    if (caller === undefined) {
+                        this.returned = value;
+                        return;
+                    }
+                    this.frame = caller;
+                    caller.stack.push(value);
+                    break;
+                }
+                case 'EMIT':
+                    channels.write(instruction[1], pop(stack));
+                    break;
+                case 'HALT':
+                    return;
+                default:
+                    // Unreachable in a verified program: check 2 refused every opcode
+                    // this switch does not have an arm for.
+                    throw new Error(`${String(instruction[0])} is not an instruction`);
+            }
+        }
+    }
+    loopLine() {
+        if (this.lastLoop < 0)
+            return undefined;
+        return this.parts.program.loops[this.lastLoop]?.line;
+    }
+    /** What the operations in `operations.ts` need, built once. */
+    operations() {
+        const machine = this;
+        return {
+            program: this.parts.program,
+            registers: this.parts.registers,
+            memory: this.parts.memory,
+            heap: this.parts.heap,
+            slots: this.top.slots,
+            here: () => machine.here(),
+            barIndex: () => machine.barIndex,
+        };
+    }
+    /** `ADD` with the string ceiling applied, since it is the one that grows one. */
+    joined(stack) {
+        const b = pop(stack);
+        const value = add(pop(stack), b);
+        return typeof value === 'string' ? this.parts.guard.string(this.here(), value) : value;
+    }
+    /**
+     * `CALL_LIB`.
+     *
+     * A call whose manifest entry carries an effect does not perform it: it
+     * appends a record holding the function index and the argument values as they
+     * stood, and pushes absent. The machine does that here rather than in the
+     * entry, so an effect cannot be forgotten by whoever writes the next one.
+     */
+    callLibrary(instruction, stack) {
+        const index = instruction[1];
+        const count = instruction[2];
+        const state = instruction[3];
+        const args = stack.splice(stack.length - count, count);
+        const of = this.parts.library[index];
+        if (of.effect !== 'none') {
+            this.parts.channels.defer({
+                fn: index,
+                name: of.name,
+                effect: of.effect,
+                args,
+                params: of.params,
+                at: this.here(),
+            });
+            stack.push(ABSENT);
+            return;
+        }
+        this.ctx.state =
+            state < 0 ? NO_STATE : this.parts.memory.region(this.frame.stateBase + state);
+        stack.push(of.call(this.ctx, args));
+    }
+    /** `CALL_FN`: everything it needs is in the call site, 4.10. */
+    callFunction(site, stack) {
+        const { program, fnPositions } = this.parts;
+        const call = program.callSites[site];
+        if (call === undefined)
+            return;
+        const target = program.functions[call.fn];
+        if (target === undefined)
+            return;
+        const args = stack.splice(stack.length - call.argc, call.argc);
+        const frame = makeFrame(target.code, target.slots, call.cellBase, call.stateBase, call.series, fnPositions[call.fn] ?? []);
+        for (let i = 0; i < args.length; i += 1)
+            frame.slots[i] = args[i] ?? ABSENT;
+        this.callers.push(this.frame);
+        this.frame = frame;
+    }
+    /** The name a value goes by, which a library call asks for by the same route. */
+    nameOf(value) {
+        return nameOf(this.ops, value);
+    }
+}
+/** The stack cannot be empty here: the verifier's depth walk proved it. */
+function pop(stack) {
+    return stack.pop() ?? ABSENT;
+}
+function binary(stack, of) {
+    const b = pop(stack);
+    return of(pop(stack), b);
+}
+//# sourceMappingURL=machine.js.map

package/dist/core/engine/machine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"machine.js","sourceRoot":"","sources":["../../../src/core/engine/machine.ts"],"names":[],"mappings":"AAwBA,OAAO,EACL,GAAG,EACH,GAAG,EACH,OAAO,EACP,MAAM,EACN,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,GAAG,EACH,EAAE,EACF,SAAS,EACT,QAAQ,GACT,MAAM,iBAAiB,CAAC;AAIzB,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAWpD,OAAO,EACL,eAAe,EACf,WAAW,EACX,OAAO,EACP,OAAO,EACP,WAAW,EACX,MAAM,GACP,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAqBtD;;;;;;GAMG;AACH,MAAM,QAAQ,GAAgB,EAAE,CAAC;AAajC,MAAM,OAAO,OAAO;IACD,KAAK,CAAe;IACpB,GAAG,CAAQ;IACX,OAAO,GAAY,EAAE,CAAC;IAC/B,KAAK,CAAQ;IACb,IAAI,CAAU;IACd,QAAQ,GAAG,CAAC,CAAC;IACrB,uEAAuE;IAC/D,QAAQ,GAAG,CAAC,CAAC,CAAC;IACtB;;;;;;;OAOG;IACK,QAAQ,GAAU,MAAM,CAAC;IAChB,GAAG,CAAiB;IACpB,GAAG,CAAM;IAE1B,YAAY,KAAmB,EAAE,IAAa;QAC5C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAE7B,yEAAyE;QACzE,uEAAuE;QACvE,yEAAyE;QACzE,wCAAwC;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG;YACT,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,KAAK,EAAE,QAAQ;YACf,IAAI,IAAI;gBACN,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;YACxB,CAAC;YACD,IAAI,GAAG;gBACL,OAAO,OAAO,CAAC,IAAI,CAAC;YACtB,CAAC;YACD,MAAM,EAAE,CAAC,KAAY,EAAU,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;SACxD,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,IAAa,EAAE,KAAa;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,mFAAmF;IACnF,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,0EAA0E;IAC1E,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;IACxB,CAAC;IAED,0DAA0D;IAC1D,IAAI;QACF,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,GAAG;QACD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjE,SAAS,CAAC;YACR,IAAI,MAAM,CAAC,IAAI,EAAE;gBAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAgB,CAAC;YACxD,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAE1B,QAAQ,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvB,KAAK,OAAO;oBACV,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC,CAAC,CAAC,CAAC;oBACjF,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC;oBAC9C,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,GAAG,EAAE,CAAC;oBACZ,MAAM;gBACR,KAAK,MAAM;oBACT,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC,IAAI,MAAM,CAAC,CAAC;oBAC5D,MAAM;gBACR,KAAK,OAAO;oBACV,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;oBACnD,MAAM;gBACR,KAAK,WAAW;oBACd,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAI,WAAW,CAAC,CAAC,CAAY,CAAC,EAAE,CAAC;wBACnE,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBACtC,CAAC;oBACD,MAAM;gBACR,KAAK,OAAO;oBACV,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAI,WAAW,CAAC,CAAC,CAAY,CAAC,CAAC,CAAC;oBACrE,MAAM;gBACR,KAAK,QAAQ;oBACX,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,GAAI,WAAW,CAAC,CAAC,CAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;oBACtE,MAAM;gBACR,KAAK,OAAO;oBACV,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC,CAAC,CAAC;oBACpD,MAAM;gBACR,KAAK,QAAQ;oBACX,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAW,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;oBACpD,MAAM;gBACR,KAAK,MAAM;oBACT,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAW,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACxE,MAAM;gBACR,KAAK,OAAO;oBACV,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC5F,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC/B,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;oBACpC,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;oBACpC,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;oBAClC,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;oBACrC,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC/B,MAAM;gBACR,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI,CAAC,CAAC,CAAC;oBACV,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;oBACrB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBACnD,MAAM;gBACR,CAAC;gBACD,KAAK,IAAI,CAAC,CAAC,CAAC;oBACV,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;oBACrB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBAClC,MAAM;gBACR,CAAC;gBACD,KAAK,IAAI,CAAC,CAAC,CAAC;oBACV,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;oBACrB,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBACnC,MAAM;gBACR,CAAC;gBACD,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC5B,MAAM;gBACR,KAAK,KAAK;oBACR,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;oBAC/B,MAAM;gBACR,KAAK,IAAI;oBACP,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC9B,MAAM;gBACR,KAAK,WAAW;oBACd,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK;wBAAE,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBAC3E,MAAM;gBACR,KAAK,UAAU;oBACb,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI;wBAAE,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBAC1E,MAAM;gBACR,KAAK,MAAM;oBACT,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBACpC,MAAM;gBACR,KAAK,YAAY;oBACf,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;wBAAE,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBAC9D,MAAM;gBACR,KAAK,MAAM,CAAC,CAAC,CAAC;oBACZ,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;oBACrB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC;oBACpE,MAAM;gBACR,CAAC;gBACD,KAAK,UAAU;oBACb,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;oBACtC,MAAM;gBACR,KAAK,UAAU;oBACb,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;oBAC5B,MAAM;gBACR,KAAK,OAAO,CAAC,CAAC,CAAC;oBACb,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;oBACvC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,EAAE,KAAK,CAAC,CAAC;oBACxD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;oBAC/D,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC/D,MAAM;gBACR,CAAC;gBACD,KAAK,MAAM,CAAC,CAAC,CAAC;oBACZ,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;oBACzB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;oBACrD,MAAM;gBACR,CAAC;gBACD,KAAK,UAAU;oBACb,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;oBACrC,MAAM;gBACR,KAAK,SAAS;oBACZ,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAW,EAAE,KAAK,CAAC,CAAC;oBACnD,MAAM;gBACR,KAAK,KAAK,CAAC,CAAC,CAAC;oBACX,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;oBACzB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;oBAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;wBACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;wBACtB,OAAO;oBACT,CAAC;oBACD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;oBACpB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACzB,MAAM;gBACR,CAAC;gBACD,KAAK,MAAM;oBACT,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAW,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;oBACrD,MAAM;gBACR,KAAK,MAAM;oBACT,OAAO;gBACT;oBACE,kEAAkE;oBAClE,wCAAwC;oBACxC,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IAEO,QAAQ;QACd,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;YAAE,OAAO,SAAS,CAAC;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;IACvD,CAAC;IAED,+DAA+D;IACvD,UAAU;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC3B,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;YACzB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACrB,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK;YACrB,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE;YAC1B,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ;SACjC,CAAC;IACJ,CAAC;IAED,iFAAiF;IACzE,MAAM,CAAC,KAAc;QAC3B,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QACrB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QACjC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzF,CAAC;IAED;;;;;;;OAOG;IACK,WAAW,CAAC,WAAwB,EAAE,KAAc;QAC1D,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;QACvC,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;QACvC,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAW,CAAC;QACvC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,EAAE,KAAK,CAAC,CAAC;QACvD,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAkB,CAAC;QAEtD,IAAI,EAAE,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACxB,EAAE,EAAE,KAAK;gBACT,IAAI,EAAE,EAAE,CAAC,IAAI;gBACb,MAAM,EAAE,EAAE,CAAC,MAAM;gBACjB,IAAI;gBACJ,MAAM,EAAE,EAAE,CAAC,MAAM;gBACjB,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE;aAChB,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,KAAK;YACZ,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC;QAChF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,gEAAgE;IACxD,YAAY,CAAC,IAAY,EAAE,KAAc;QAC/C,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO;QACjC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAG,SAAS,CACrB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,KAAK,EACZ,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAC3B,CAAC;QACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;QAC5E,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,iFAAiF;IACjF,MAAM,CAAC,KAAY;QACjB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;CACF;AAED,2EAA2E;AAC3E,SAAS,GAAG,CAAC,KAAc;IACzB,OAAO,KAAK,CAAC,GAAG,EAAE,IAAI,MAAM,CAAC;AAC/B,CAAC;AAED,SAAS,MAAM,CAAC,KAAc,EAAE,EAAiC;IAC/D,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3B,CAAC"}

package/dist/core/engine/memory.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Cells and library state, and the checkpoint that rolls them back.
+ *
+ * `compiled-program.md` section 6 is one mechanism serving three purposes:
+ * making a moving bar idempotent, letting a debugger step backwards, and making
+ * a chart replay exact. They are the same problem, and an engine that
+ * implements the checkpoint gets all three.
+ *
+ * **The representation is an undo journal, and the specification allows it.**
+ * 6.2 is explicit that an engine may implement a checkpoint as a full copy,
+ * copy on write, an undo journal, or nothing at all when it can prove the state
+ * is unchanged, because the requirement is the semantics and not the shape. A
+ * full copy of every cell and every state region at every bar is a cost
+ * proportional to the program on a bar that changed one number, and a live
+ * chart pays it on every tick. So a cell's previous value is recorded the first
+ * time a bar writes it and a state region is copied the first time a bar
+ * touches it, and a bar that changes nothing costs nothing at all.
+ *
+ * **`live var` is the one exception, and it is the whole of 6.3.** Everything
+ * else rolls back, so executing a moving bar ten times gives the same answer as
+ * executing it once. A `"live"` cell keeps its current value, which is what
+ * makes a script using one not reproducible by design. Its previous value is
+ * still recorded, because a debugger stepping backwards has to be able to show
+ * what the value actually was rather than what a replay would recompute.
+ */
+import type { StateRecord } from './library/index.js';
+import type { Cell, StateRegion } from './types.js';
+import type { Value } from './values/index.js';
+export declare class Memory {
+    private readonly values;
+    private readonly initialised;
+    private readonly live;
+    private readonly regions;
+    private readonly undoCells;
+    private readonly undoRegions;
+    constructor(cells: readonly Cell[], states: readonly StateRegion[]);
+    /**
+     * `CELL_INIT`: whether the cell is already initialised.
+     *
+     * The cell is marked before the initialiser runs, not after. The two differ
+     * only if the initialiser could reach the same `CELL_INIT` again, which needs
+     * recursion, which is an error; marking first means the flag is set by one
+     * instruction rather than by a pair that must stay together across a jump.
+     */
+    initialise(cell: number): boolean;
+    load(cell: number): Value;
+    store(cell: number, value: Value): void;
+    /** The region a `CALL_LIB` names, created on first use and kept across bars. */
+    region(index: number): StateRecord;
+    private recordCell;
+    /** What each cell held when this bar began, which is what a debugger shows. */
+    previousCells(): ReadonlyMap<number, Value>;
+    /** 6.3: restore the checkpoint, except that `"live"` cells keep their value. */
+    rollback(): void;
+    /** The checkpoint at the end of this bar: everything since is accepted. */
+    commit(): void;
+    /** Every value a cell holds, for the heap's reachability walk. */
+    walk(visit: (value: Value) => void): void;
+}
+//# sourceMappingURL=memory.d.ts.map