openalgo-script 0.1.0-alpha.1 → 0.2.0

package/dist/core/emit/defaults.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The effective value of every declaration option a script left out.
+ *
+ * `compiled-program.md` 2.3 is unusually firm about this: every field of
+ * `meta`, of `meta.strategy` and of every declaration in `outputs` is written
+ * with the value that option resolved to, defaults included, rather than
+ * omitted or written as null. So an engine never needs a table of defaults, and
+ * a default that changes in a later language version cannot silently change an
+ * old program, because the old program carries the old value in writing.
+ *
+ * That is also why this file exists and why it is only this. These are the
+ * defaults of `language.md` 13.2 and 13.3 and of `stdlib.md` 14.2, 14.3, 16 and
+ * 10.7, transcribed once. Nothing here is a runtime argument default: those
+ * belong to the library manifest, and `calls.ts` says what happens where the
+ * two are confused.
+ */
+import type { Value } from './values.js';
+/** `language.md` 13.2. `title` is required and `short` falls back to it. */
+export declare const STUDY_DEFAULTS: Readonly<Record<string, Value>>;
+/** `language.md` 13.3, the options only a `strategy()` adds. */
+export declare const STRATEGY_DEFAULTS: Readonly<Record<string, Value>>;
+/** The order `meta.strategy` lists them in, 2.3. */
+export declare const STRATEGY_OPTIONS: readonly string[];
+/**
+ * `stdlib.md` 14.2.
+ *
+ * `lineStyle` has no argument on `plot` at all: the call's `style` names the
+ * column's shape and becomes the entry's `type`. A plot therefore always
+ * carries the one line style a host draws an undecorated line with.
+ */
+export declare const PLOT_DEFAULTS: Readonly<Record<string, Value>>;
+export declare const PLOT_LINE_STYLE: Value;
+/** `stdlib.md` 14.2. A candle's border takes a plot's own width and style. */
+export declare const CANDLE_DEFAULTS: Readonly<Record<string, Value>>;
+export declare const FILL_DEFAULTS: Readonly<Record<string, Value>>;
+export declare const LEVEL_DEFAULTS: Readonly<Record<string, Value>>;
+/** `stdlib.md` 14.3. `title`, `rows` and `cols` have no default. */
+export declare const TABLE_DEFAULTS: Readonly<Record<string, Value>>;
+export declare const MARKER_DEFAULTS: Readonly<Record<string, Value>>;
+export declare const ALERT_DEFAULTS: Readonly<Record<string, Value>>;
+/** `stdlib.md` 13.2, the arguments every input kind accepts. */
+export declare const INPUT_DEFAULTS: Readonly<Record<string, Value>>;
+/** `language.md` 10.7 and 7.4, carried by `limits` whether or not it was written. */
+export declare const LOOP_BUDGET = 2000000;
+//# sourceMappingURL=defaults.d.ts.map

package/dist/core/emit/defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../src/core/emit/defaults.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAsBzC,4EAA4E;AAC5E,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAQ1D,CAAC;AAEF,gEAAgE;AAChE,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAY7D,CAAC;AAEF,oDAAoD;AACpD,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAY7C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CASzD,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,KAAuB,CAAC;AAEtD,8EAA8E;AAC9E,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAK3D,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAMzD,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAK1D,CAAC;AAEF,oEAAoE;AACpE,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAK1D,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAI3D,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAI1D,CAAC;AAEF,gEAAgE;AAChE,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAG1D,CAAC;AAEF,qFAAqF;AACrF,eAAO,MAAM,WAAW,UAAY,CAAC"}

package/dist/core/emit/defaults.js

@@ -0,0 +1,116 @@
+import { namedColour } from './colours.js';
+const ABSENT = { kind: 'absent' };
+function number(value) {
+    return { kind: 'number', value };
+}
+function string(value) {
+    return { kind: 'string', value };
+}
+function bool(value) {
+    return { kind: 'bool', value };
+}
+function colour(name) {
+    const value = namedColour(name);
+    return value === undefined ? ABSENT : { kind: 'colour', value };
+}
+/** `language.md` 13.2. `title` is required and `short` falls back to it. */
+export const STUDY_DEFAULTS = {
+    overlay: bool(false),
+    precision: number(4),
+    format: string('price'),
+    range: ABSENT,
+    scale: string('right'),
+    group: string(''),
+    onUnconfirmed: bool(false),
+};
+/** `language.md` 13.3, the options only a `strategy()` adds. */
+export const STRATEGY_DEFAULTS = {
+    capital: number(100000),
+    currency: string(''),
+    qty: number(1),
+    qtyType: string('units'),
+    product: string('intraday'),
+    fillOn: string('nextOpen'),
+    slippage: number(0),
+    commission: number(0),
+    commissionType: string('perTrade'),
+    pyramiding: number(1),
+    closeOnSessionEnd: bool(false),
+};
+/** The order `meta.strategy` lists them in, 2.3. */
+export const STRATEGY_OPTIONS = [
+    'capital',
+    'currency',
+    'qty',
+    'qtyType',
+    'product',
+    'fillOn',
+    'slippage',
+    'commission',
+    'commissionType',
+    'pyramiding',
+    'closeOnSessionEnd',
+];
+/**
+ * `stdlib.md` 14.2.
+ *
+ * `lineStyle` has no argument on `plot` at all: the call's `style` names the
+ * column's shape and becomes the entry's `type`. A plot therefore always
+ * carries the one line style a host draws an undecorated line with.
+ */
+export const PLOT_DEFAULTS = {
+    color: ABSENT,
+    width: number(1.5),
+    style: string('line'),
+    offset: number(0),
+    overlay: ABSENT,
+    precision: ABSENT,
+    format: ABSENT,
+    scale: string('right'),
+};
+export const PLOT_LINE_STYLE = string('solid');
+/** `stdlib.md` 14.2. A candle's border takes a plot's own width and style. */
+export const CANDLE_DEFAULTS = {
+    colorUp: colour('lime'),
+    colorDown: colour('red'),
+    wickColor: ABSENT,
+    borderColor: ABSENT,
+};
+export const FILL_DEFAULTS = {
+    color: ABSENT,
+    colorUp: ABSENT,
+    colorDown: ABSENT,
+    opacity: number(1),
+    overlay: ABSENT,
+};
+export const LEVEL_DEFAULTS = {
+    title: string(''),
+    color: colour('gray'),
+    style: string('dashed'),
+    width: number(1),
+};
+/** `stdlib.md` 14.3. `title`, `rows` and `cols` have no default. */
+export const TABLE_DEFAULTS = {
+    position: string('topRight'),
+    textColor: ABSENT,
+    bgColor: ABSENT,
+    borderWidth: number(0),
+};
+export const MARKER_DEFAULTS = {
+    color: ABSENT,
+    at: string('above'),
+    shape: string('label'),
+};
+export const ALERT_DEFAULTS = {
+    id: string(''),
+    title: string(''),
+    frequency: string('oncePerBar'),
+};
+/** `stdlib.md` 13.2, the arguments every input kind accepts. */
+export const INPUT_DEFAULTS = {
+    group: string(''),
+    tooltip: string(''),
+};
+/** `language.md` 10.7 and 7.4, carried by `limits` whether or not it was written. */
+export const LOOP_BUDGET = 2_000_000;
+//# sourceMappingURL=defaults.js.map

package/dist/core/emit/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/core/emit/defaults.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,MAAM,GAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAEzC,SAAS,MAAM,CAAC,KAAa;IAC3B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,MAAM,CAAC,KAAa;IAC3B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,IAAI,CAAC,KAAc;IAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAClE,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,MAAM,cAAc,GAAoC;IAC7D,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;IACjB,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC;CAC3B,CAAC;AAEF,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAoC;IAChE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;IACd,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC,UAAU,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACrB,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC;CAC/B,CAAC;AAEF,oDAAoD;AACpD,MAAM,CAAC,MAAM,gBAAgB,GAAsB;IACjD,SAAS;IACT,UAAU;IACV,KAAK;IACL,SAAS;IACT,SAAS;IACT,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,gBAAgB;IAChB,YAAY;IACZ,mBAAmB;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAoC;IAC5D,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACjB,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAU,MAAM,CAAC,OAAO,CAAC,CAAC;AAEtD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,eAAe,GAAoC;IAC9D,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC;IACxB,SAAS,EAAE,MAAM;IACjB,WAAW,EAAE,MAAM;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAoC;IAC5D,KAAK,EAAE,MAAM;IACb,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAClB,OAAO,EAAE,MAAM;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAoC;IAC7D,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;CACjB,CAAC;AAEF,oEAAoE;AACpE,MAAM,CAAC,MAAM,cAAc,GAAoC;IAC7D,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC;IAC5B,SAAS,EAAE,MAAM;IACjB,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;CACvB,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAoC;IAC9D,KAAK,EAAE,MAAM;IACb,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAoC;IAC7D,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC;CAChC,CAAC;AAEF,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAoC;IAC7D,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;CACpB,CAAC;AAEF,qFAAqF;AACrF,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAC"}

package/dist/core/emit/emit.d.ts

@@ -0,0 +1,13 @@
+import type { CheckedScript } from '../check/index.js';
+import type { DiagnosticSink } from '../diagnostics/index.js';
+import type { SourceFile } from '../source/index.js';
+import type { EmitOptions } from './context.js';
+import type { Gap } from './gaps.js';
+import type { CompiledProgram } from './program.js';
+export interface EmitResult {
+    /** The program, or nothing when a gap stopped a faithful one being produced. */
+    readonly program: CompiledProgram | undefined;
+    readonly gaps: readonly Gap[];
+}
+export declare function emit(file: SourceFile, checked: CheckedScript, sink: DiagnosticSink, options?: EmitOptions): EmitResult;
+//# sourceMappingURL=emit.d.ts.map

package/dist/core/emit/emit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/core/emit/emit.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAOrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAKrC,OAAO,KAAK,EAAE,eAAe,EAAwB,MAAM,cAAc,CAAC;AAM1E,MAAM,WAAW,UAAU;IACzB,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;CAC/B;AAKD,wBAAgB,IAAI,CAClB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,cAAc,EACpB,OAAO,GAAE,WAAgB,GACxB,UAAU,CA2EZ"}

package/dist/core/emit/emit.js

@@ -0,0 +1,281 @@
+/**
+ * A checked file in, a compiled program out.
+ *
+ * The order below is the order the format forces, and each step is here rather
+ * than inside a pass because each one needs a total the passes do not have
+ * until they have finished.
+ *
+ * Registers first, because the two instructions that keep a shadow register in
+ * step with a cell have to be the first and the last thing a bar does, and a
+ * prologue cannot be written after the list it belongs at the front of. Inputs
+ * next, because each one owns a slot the engine writes at step 5 and the slots
+ * have to exist before a statement reads one. Then the statements. Then the
+ * bases of every call site, which can only be assigned once the top level's own
+ * cells and state regions are counted.
+ *
+ * The last step is the one worth defending: the emitter walks its own
+ * instruction lists and computes the stack depth exactly as section 3.5 check 5
+ * says an engine will. A compiler that cannot compute that number does not know
+ * whether it emitted a program any engine will load, and finding out from a
+ * verifier in another language is finding out too late.
+ */
+import { CATALOGUE_LANGUAGE_VERSION } from '../catalogue/index.js';
+import { COMPILED_FORMAT_VERSION, VERSION } from '../version/index.js';
+import { sourceHash } from './canonical.js';
+import { orderChannels, renumberCode, renumberOutputs } from './channels.js';
+import { walkDepths } from './code.js';
+import { Emitter, Frame } from './context.js';
+import { assignRegions } from './functions.js';
+import { buildInputs } from './inputs.js';
+import { buildLimits, buildMeta } from './meta.js';
+import { placementOf, prepareRegisters } from './registers.js';
+import { linkRequestNames } from './requests.js';
+import { requiresOf } from './requires.js';
+import { emitStatement } from './statements.js';
+/** The library manifest version, tied to `openscript.language` (2.5). */
+const DEFAULT_MANIFEST = 1;
+export function emit(file, checked, sink, options = {}) {
+    const e = new Emitter(file, checked, sink, options);
+    const top = new Frame(true);
+    prepareRegisters(e);
+    buildInputs(e, top);
+    openCarriedRegisters(e, top);
+    linkRequestNames(e);
+    for (const item of checked.script.items) {
+        if (item.kind === 'functionDeclaration')
+            continue;
+        emitStatement(e, top, item);
+    }
+    closeShadowRegisters(e, top);
+    // `HALT` takes the position of whatever came before it, which is 12.2's own
+    // reading of a run of instructions costing one triple.
+    if (top.builder.here === 0)
+        top.builder.at(checked.script.span);
+    top.builder.push('HALT');
+    const { cells, states } = assignRegions(e, top);
+    // The channel table is written in the order `outputs` lists its groups, which
+    // is not the order the declarations were met in; `channels.ts` says why.
+    const order = orderChannels(e);
+    const code = renumberCode(top.builder.code, order.moved);
+    const functions = e.functions.map((one) => ({
+        ...one,
+        code: renumberCode(one.code, order.moved),
+    }));
+    checkDepths(e, top, code);
+    checkLimits(e, code, states.length);
+    const program = {
+        openscript: { format: COMPILED_FORMAT_VERSION, language: languageOf(checked) },
+        requires: requiresOf(e, code),
+        compiler: { name: 'openscript', version: VERSION },
+        source: { hash: sourceHash(file.text), lines: file.lineCount, file: file.name },
+        meta: buildMeta(e),
+        limits: buildLimits(e),
+        lib: { manifest: options.manifest ?? DEFAULT_MANIFEST, functions: e.libraryFunctions },
+        inputs: e.inputs,
+        channels: order.channels,
+        outputs: renumberOutputs(e, order.moved),
+        consts: e.pool.all,
+        series: e.layout.registers,
+        frame: { slots: top.layout.slotCount },
+        cells,
+        states,
+        functions,
+        callSites: e.sites.map((site) => ({
+            fn: site.fn,
+            argc: site.argc,
+            cellBase: site.cellBase,
+            stateBase: site.stateBase,
+            series: site.series,
+        })),
+        loops: e.loops,
+        code,
+        requests: e.requests,
+        debug: {
+            pos: top.builder.pos,
+            fnPos: e.functionPos,
+            names: {
+                slots: top.layout.slotNames,
+                cells: cells.map((one) => one.name ?? ''),
+                series: e.layout.registers.map((one) => one.name ?? ''),
+                channels: order.names,
+            },
+            retain: options.retain === true,
+        },
+    };
+    if (!e.gaps.blocked)
+        return { program, gaps: e.gaps.gaps };
+    reportRefusal(e);
+    return { program: undefined, gaps: e.gaps.gaps };
+}
+/**
+ * Why there is no program, said to the person who asked for one.
+ *
+ * A gap is a note between the parts of this project and nobody outside it ever
+ * reads one, so an emitter that returned nothing and logged a gap left a trader
+ * with a compile that produced no program, no message and nothing to ask a
+ * question about. That is the worst failure this compiler has available: the
+ * script may be perfectly good, and silence gives its author no way to find out
+ * whether it is.
+ *
+ * So every gap that stopped a program becomes a diagnostic. It carries the line
+ * that provoked it, what could not be done, and the section that asks for it,
+ * and it says where to take it. The sentence is careful about whose fault it
+ * is, because this runs whether or not an earlier stage refused the file: a
+ * checked tree the emitter cannot emit is a defect in the compiler only when
+ * nothing else was reported about it.
+ */
+function reportRefusal(e) {
+    for (const gap of e.gaps.gaps) {
+        if (!gap.blocking)
+            continue;
+        e.sink.report('OS6018', gap.span ?? e.checked.script.span, {
+            location: gap.specification,
+            reason: `${gap.what}; this compiler produced no program rather than a wrong one, and if ` +
+                'nothing else was reported about this script that is a defect in the compiler ' +
+                'rather than in the script: please report it, with the script that produced it',
+        });
+    }
+}
+function languageOf(checked) {
+    const line = checked.script.items.find((item) => item.kind === 'versionLine');
+    return line !== undefined && line.kind === 'versionLine'
+        ? line.version.value
+        : CATALOGUE_LANGUAGE_VERSION;
+}
+/**
+ * The register beside a `var` a function body reads, filled before the bar runs.
+ *
+ * The pair at the end of the bar (below) writes the entry for the bar. This one
+ * writes the value the bar starts with, so a body called before the first
+ * assignment reads what the cell carried in rather than an absence. On bar 0
+ * the cell has not been initialised yet and reads absent, which is what the
+ * name is worth before its declaration line (3.4).
+ */
+function openCarriedRegisters(e, top) {
+    for (const binding of e.checked.bindings) {
+        if (!e.carried.has(binding.id))
+            continue;
+        const register = e.layout.registerFor(binding);
+        if (register === undefined)
+            continue;
+        top.builder.at(binding.declaredAt);
+        top.builder.push('LOADC', top.layout.cellFor(binding));
+        top.builder.push('SSTORE', register);
+    }
+}
+/**
+ * The one instruction pair that keeps a persistent name's past readable.
+ *
+ * A cell has no history and a register has no persistence, so `x[1]` on a `var`
+ * needs both (`language.md` 8.3). The register's entry for a bar is written
+ * from the cell at the end of the bar rather than at each assignment, because a
+ * bar on which the `var` was not assigned still holds a value, and a register
+ * written only where the source writes the name would be absent there and say
+ * the value had never existed.
+ */
+function closeShadowRegisters(e, top) {
+    for (const binding of e.checked.bindings) {
+        if (!e.shadowed.has(binding.id))
+            continue;
+        if (placementOf(e, binding) !== 'cell')
+            continue;
+        if (!top.layout.hasCellFor(binding))
+            continue;
+        const register = e.layout.registerFor(binding);
+        if (register === undefined)
+            continue;
+        top.builder.at(binding.declaredAt);
+        top.builder.push('LOADC', top.layout.cellFor(binding));
+        top.builder.push('SSTORE', register);
+    }
+}
+/** Every instruction a read's body holds, its own reads included. */
+function instructionsIn(requests) {
+    let total = 0;
+    for (const request of requests) {
+        total += request.body.code.length;
+        for (const one of request.body.functions)
+            total += one.code.length;
+        total += instructionsIn(request.body.requests);
+    }
+    return total;
+}
+/** Section 3.5 check 5, run here so a defect is found where it was written. */
+function checkDepths(e, top, code) {
+    const argcOf = (site) => e.sites[site]?.argc ?? 0;
+    const lists = [code, ...e.functions.map((one) => one.code)];
+    for (const request of e.requests)
+        checkRequestDepths(e, request);
+    lists.forEach((list, index) => {
+        const walk = walkDepths(list, argcOf);
+        const at = walk.conflict ?? walk.underflow ?? walk.terminal;
+        if (at === undefined)
+            return;
+        e.gap(`the stack depth this compiler emitted does not survive its own walk at instruction ${at}, ` +
+            'so an engine would refuse the program at load', 'compiled-program.md 3.5 check 5', 
+        // The bar's own list is the one whose positions are to hand, and it is
+        // where all but one of these can happen. A line beats no line: whoever
+        // reads this next starts at the statement rather than at the file.
+        index === 0 ? lineOfInstruction(e, top, at) : undefined, true);
+    });
+}
+/**
+ * The same walk over a read's body, which counts its own call sites (2.16).
+ *
+ * A body has no positions in the bar's own table, so a failure here carries the
+ * read's line rather than a line from the wrong list.
+ */
+function checkRequestDepths(e, request) {
+    const argcOf = (site) => request.body.callSites[site]?.argc ?? 0;
+    const lists = [request.body.code, ...request.body.functions.map((one) => one.code)];
+    for (const list of lists) {
+        const walk = walkDepths(list, argcOf);
+        const at = walk.conflict ?? walk.underflow ?? walk.terminal;
+        if (at === undefined)
+            continue;
+        e.gap(`the stack depth this compiler emitted for a read's expression does not survive its ` +
+            `own walk at instruction ${at}, so an engine would refuse the program at load`, 'compiled-program.md 3.5 check 5 and 2.16', undefined, true);
+    }
+    for (const nested of request.body.requests)
+        checkRequestDepths(e, nested);
+}
+/** Where the instruction at this index came from, from the debug positions. */
+function lineOfInstruction(e, top, index) {
+    let found;
+    for (const position of top.builder.pos) {
+        if (position[0] > index)
+            break;
+        found = position;
+    }
+    if (found === undefined)
+        return undefined;
+    return e.file.spanAt(e.file.offsetAt({ line: found[1], column: found[2] }), 1);
+}
+/**
+ * OS5004 and OS5009, the two limits the compiler rather than the engine finds.
+ *
+ * Both are reported only against a ceiling a host actually declared. A compiler
+ * that invented one would refuse a program every engine present could run.
+ */
+function checkLimits(e, code, states) {
+    const span = e.checked.script.span;
+    const maxStates = e.options.maxStates;
+    if (maxStates !== undefined && states > maxStates) {
+        e.sink.report('OS5004', span, {
+            found: states,
+            max: maxStates,
+            first: e.functions[0]?.name ?? '',
+            second: e.functions[1]?.name ?? e.functions[0]?.name ?? '',
+        });
+    }
+    const maxInstructions = e.options.maxInstructions;
+    const total = code.length +
+        e.functions.reduce((sum, one) => sum + one.code.length, 0) +
+        // A read's expression is instructions an engine executes, once per
+        // requested bar, so it counts against the ceiling like any other (2.16).
+        instructionsIn(e.requests);
+    if (maxInstructions !== undefined && total > maxInstructions) {
+        e.sink.report('OS5009', span, { found: total, max: maxInstructions });
+    }
+}
+//# sourceMappingURL=emit.js.map

package/dist/core/emit/emit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../../src/core/emit/emit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAKnE,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAQhD,yEAAyE;AACzE,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,MAAM,UAAU,IAAI,CAClB,IAAgB,EAChB,OAAsB,EACtB,IAAoB,EACpB,UAAuB,EAAE;IAEzB,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;IAE5B,gBAAgB,CAAC,CAAC,CAAC,CAAC;IACpB,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpB,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC7B,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEpB,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,IAAI,KAAK,qBAAqB;YAAE,SAAS;QAClD,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC7B,4EAA4E;IAC5E,uDAAuD;IACvD,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC;QAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEzB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAChD,8EAA8E;IAC9E,yEAAyE;IACzE,MAAM,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1C,GAAG,GAAG;QACN,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC;KAC1C,CAAC,CAAC,CAAC;IACJ,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1B,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAEpC,MAAM,OAAO,GAAoB;QAC/B,UAAU,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAE,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;QAC9E,QAAQ,EAAE,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC;QAC7B,QAAQ,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE;QAClD,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;QAC/E,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAClB,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;QACtB,GAAG,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,gBAAgB,EAAE,SAAS,EAAE,CAAC,CAAC,gBAAgB,EAAE;QACtF,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;QACxC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG;QAClB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS;QAC1B,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE;QACtC,KAAK;QACL,MAAM;QACN,SAAS;QACT,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAChC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC;QACH,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,IAAI;QACJ,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,KAAK,EAAE;YACL,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG;YACpB,KAAK,EAAE,CAAC,CAAC,WAAW;YACpB,KAAK,EAAE;gBACL,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS;gBAC3B,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACvD,QAAQ,EAAE,KAAK,CAAC,KAAK;aACtB;YACD,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,IAAI;SAChC;KACF,CAAC;IAEF,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC3D,aAAa,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,aAAa,CAAC,CAAU;IAC/B,KAAK,MAAM,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,QAAQ;YAAE,SAAS;QAC5B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;YACzD,QAAQ,EAAE,GAAG,CAAC,aAAa;YAC3B,MAAM,EACJ,GAAG,GAAG,CAAC,IAAI,sEAAsE;gBACjF,+EAA+E;gBAC/E,+EAA+E;SAClF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,OAAsB;IACxC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;IAC9E,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,aAAa;QACtD,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK;QACpB,CAAC,CAAC,0BAA0B,CAAC;AACjC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,oBAAoB,CAAC,CAAU,EAAE,GAAU;IAClD,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACzC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAAE,SAAS;QACzC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,QAAQ,KAAK,SAAS;YAAE,SAAS;QACrC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACnC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACvD,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CAAC,CAAU,EAAE,GAAU;IAClD,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACzC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAAE,SAAS;QAC1C,IAAI,WAAW,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,MAAM;YAAE,SAAS;QACjD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC;YAAE,SAAS;QAC9C,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,QAAQ,KAAK,SAAS;YAAE,SAAS;QACrC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACnC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACvD,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAED,qEAAqE;AACrE,SAAS,cAAc,CAAC,QAA4B;IAClD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS;YAAE,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC;QACnE,KAAK,IAAI,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+EAA+E;AAC/E,SAAS,WAAW,CAAC,CAAU,EAAE,GAAU,EAAE,IAA4B;IACvE,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;IAClE,MAAM,KAAK,GAAwC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAEjG,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,QAAQ;QAAE,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAEjE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtC,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC5D,IAAI,EAAE,KAAK,SAAS;YAAE,OAAO;QAC7B,CAAC,CAAC,GAAG,CACH,sFAAsF,EAAE,IAAI;YAC1F,+CAA+C,EACjD,iCAAiC;QACjC,uEAAuE;QACvE,uEAAuE;QACvE,mEAAmE;QACnE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EACvD,IAAI,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,CAAU,EAAE,OAAgB;IACtD,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;IACjF,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtC,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC5D,IAAI,EAAE,KAAK,SAAS;YAAE,SAAS;QAC/B,CAAC,CAAC,GAAG,CACH,qFAAqF;YACnF,2BAA2B,EAAE,iDAAiD,EAChF,0CAA0C,EAC1C,SAAS,EACT,IAAI,CACL,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ;QAAE,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAC5E,CAAC;AAED,+EAA+E;AAC/E,SAAS,iBAAiB,CAAC,CAAU,EAAE,GAAU,EAAE,KAAa;IAC9D,IAAI,KAAoD,CAAC;IACzD,KAAK,MAAM,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACvC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK;YAAE,MAAM;QAC/B,KAAK,GAAG,QAAQ,CAAC;IACnB,CAAC;IACD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACjF,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,CAAU,EAAE,IAA4B,EAAE,MAAc;IAC3E,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IACnC,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IACtC,IAAI,SAAS,KAAK,SAAS,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;QAClD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE;YAC5B,KAAK,EAAE,MAAM;YACb,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE;YACjC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE;SAC3D,CAAC,CAAC;IACL,CAAC;IAED,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IAClD,MAAM,KAAK,GACT,IAAI,CAAC,MAAM;QACX,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,mEAAmE;QACnE,yEAAyE;QACzE,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC7B,IAAI,eAAe,KAAK,SAAS,IAAI,KAAK,GAAG,eAAe,EAAE,CAAC;QAC7D,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC;IACxE,CAAC;AACH,CAAC"}

package/dist/core/emit/events.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The four calls that draw something for one bar: a marker, an alert, a bar
+ * colour and a pane background.
+ *
+ * All four are `EMIT` and a declared channel, and none of them is a library
+ * call an engine performs. One instruction covers every drawing surface
+ * (`compiled-program.md` 4.11); an instruction per surface would have added six
+ * opcodes that all do the same thing and would have made every new surface a
+ * format change.
+ *
+ * The alert is the one worth reading. `stdlib.md` 16.1 says the compiler lifts
+ * each call into a watched condition whose predicate is the chain of guards
+ * that reaches it. Nothing has to be lifted: the call site is only reached when
+ * those guards passed, so writing `true` into the condition channel there is
+ * the predicate, exactly. On a bar the guards refused, nothing writes the
+ * channel and a channel nothing wrote is absent, which is no alert.
+ */
+import type { Call } from '../ast/index.js';
+import type { Emitter, Frame } from './context.js';
+export declare function emitEventCall(e: Emitter, f: Frame, call: Call, name: string): void;
+//# sourceMappingURL=events.d.ts.map

package/dist/core/emit/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/core/emit/events.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAKnD,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAiBlF"}

package/dist/core/emit/events.js

@@ -0,0 +1,112 @@
+import { alertKey } from '../check/index.js';
+import { ALERT_DEFAULTS, MARKER_DEFAULTS } from './defaults.js';
+import { emitExpression } from './expressions.js';
+import { argumentFor, fieldFor } from './outputs.js';
+export function emitEventCall(e, f, call, name) {
+    switch (name) {
+        case 'signal':
+            emitMarker(e, f, call);
+            return;
+        case 'alert':
+            emitAlert(e, f, call);
+            return;
+        case 'barColor':
+            e.barColor = { channel: emitPaint(e, f, call, e.barColor?.channel, 'bar colour') };
+            return;
+        case 'background':
+            e.background = { channel: emitPaint(e, f, call, e.background?.channel, 'background') };
+            return;
+        default:
+            return;
+    }
+}
+/**
+ * One entry per `signal()` call site, and a channel that is held back on a bar
+ * that is still moving.
+ *
+ * A marker is emitted when its channel holds a string for the bar and not
+ * otherwise, so a call site inside an `if` produces a marker on the bars the
+ * branch was taken and nothing anywhere else. The channel is not declared
+ * `once` for that reason: a signal may sit under a condition, which is the
+ * whole point of one.
+ */
+function emitMarker(e, f, call) {
+    const text = argumentFor(e, call, 'text');
+    // A marker's channel is named after the text it carries when that is a
+    // literal, which is what 12.2's `debug.names.channels` shows.
+    const literal = text === undefined ? undefined : e.fold(text.value);
+    const name = literal?.kind === 'string' ? literal.value : `marker ${e.markers.length}`;
+    const channel = e.layout.channel('string', true, false, name);
+    if (text === undefined) {
+        f.builder.at(call.span);
+        f.builder.push('CONST', e.pool.absent());
+    }
+    else {
+        emitExpression(e, f, text.value);
+    }
+    f.builder.at(call.span);
+    f.builder.push('EMIT', channel);
+    e.markers.push({
+        key: `m${e.markers.length}`,
+        channel,
+        position: fieldFor(e, call, 'at', MARKER_DEFAULTS),
+        shape: fieldFor(e, call, 'shape', MARKER_DEFAULTS),
+        color: fieldFor(e, call, 'color', MARKER_DEFAULTS),
+        // `markers[].textColor` has no argument in the library: `signal` takes one
+        // colour and it is the plate's. Null is the effective value of a field no
+        // script can express, which is 2.8's own reading of a table's text size.
+        textColor: null,
+    });
+}
+function emitAlert(e, f, call) {
+    const id = fieldFor(e, call, 'id', ALERT_DEFAULTS);
+    // `id` is the stable name of the entry, so a user's alert subscription
+    // survives an edit to the script. With none, the compiler derives one from
+    // the call's position, which is what OS8008 already warns about, and the
+    // checker refuses two alerts that would land under one name with OS3017.
+    const key = alertKey(typeof id === 'string' ? id : undefined, call.span.line);
+    const condChannel = e.layout.channel('bool', true, false, key);
+    const messageChannel = e.layout.channel('string', true, false, `${key} message`);
+    f.builder.at(call.span);
+    f.builder.push('CONST', e.pool.bool(true));
+    f.builder.push('EMIT', condChannel);
+    const message = argumentFor(e, call, 'message');
+    if (message === undefined) {
+        f.builder.at(call.span);
+        f.builder.push('CONST', e.pool.absent());
+    }
+    else {
+        emitExpression(e, f, message.value);
+    }
+    f.builder.at(call.span);
+    f.builder.push('EMIT', messageChannel);
+    e.alerts.push({
+        key,
+        title: fieldFor(e, call, 'title', ALERT_DEFAULTS),
+        condChannel,
+        messageChannel,
+        frequency: fieldFor(e, call, 'frequency', ALERT_DEFAULTS),
+    });
+}
+/**
+ * `barColor` and `background`: one channel each per program.
+ *
+ * A script with three `barColor()` calls writes the same channel three times
+ * and the last write on the bar wins, which is the same rule as any other
+ * channel and needs no sentence of its own (2.8).
+ */
+function emitPaint(e, f, call, existing, name) {
+    const channel = existing ?? e.layout.channel('color', false, false, name);
+    const colour = argumentFor(e, call, 'color');
+    if (colour === undefined) {
+        f.builder.at(call.span);
+        f.builder.push('CONST', e.pool.absent());
+    }
+    else {
+        emitExpression(e, f, colour.value);
+    }
+    f.builder.at(call.span);
+    f.builder.push('EMIT', channel);
+    return channel;
+}
+//# sourceMappingURL=events.js.map

package/dist/core/emit/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/core/emit/events.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAErD,MAAM,UAAU,aAAa,CAAC,CAAU,EAAE,CAAQ,EAAE,IAAU,EAAE,IAAY;IAC1E,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ;YACX,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACvB,OAAO;QACT,KAAK,OAAO;YACV,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtB,OAAO;QACT,KAAK,UAAU;YACb,CAAC,CAAC,QAAQ,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;YACnF,OAAO;QACT,KAAK,YAAY;YACf,CAAC,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;YACvF,OAAO;QACT;YACE,OAAO;IACX,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,UAAU,CAAC,CAAU,EAAE,CAAQ,EAAE,IAAU;IAClD,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,uEAAuE;IACvE,8DAA8D;IAC9D,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IACvF,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC9D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IACD,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QACb,GAAG,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE;QAC3B,OAAO;QACP,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC;QAClD,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,CAAC;QAClD,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,CAAC;QAClD,2EAA2E;QAC3E,0EAA0E;QAC1E,yEAAyE;QACzE,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;AACL,CAAC;AAED,SAAS,SAAS,CAAC,CAAU,EAAE,CAAQ,EAAE,IAAU;IACjD,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IACnD,uEAAuE;IACvE,2EAA2E;IAC3E,yEAAyE;IACzE,yEAAyE;IACzE,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC/D,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,GAAG,UAAU,CAAC,CAAC;IAEjF,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAEpC,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAChD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IACD,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAEvC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QACZ,GAAG;QACH,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,CAAC;QACjD,WAAW;QACX,cAAc;QACd,SAAS,EAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,CAAC;KAC1D,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,SAAS,CAChB,CAAU,EACV,CAAQ,EACR,IAAU,EACV,QAA4B,EAC5B,IAAY;IAEZ,MAAM,OAAO,GAAG,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IACD,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,OAAO,OAAO,CAAC;AACjB,CAAC"}