openalgo-script 0.1.0-alpha.1 → 0.4.0

package/dist/editor/complete.js

@@ -0,0 +1,206 @@
+/**
+ * `complete`: what may be written at a position.
+ *
+ * Four kinds of answer, and every one of them is read out of something the
+ * compiler already holds:
+ *
+ *     the members of a namespace   `membersOf`, after `draw.`
+ *     the named arguments of the   the manifest's parameters for the call the
+ *     call being written           brackets say the cursor is inside
+ *     the file's own names         the checker's bindings, filtered by the two
+ *                                  scope rules of `scope.ts`
+ *     the library's names          `libraryNames`, the same index the checker
+ *                                  resolves against and the example check reads
+ *                                  its globals from
+ *
+ * **A hand written list of function names is the exact failure this project
+ * keeps removing.** It would be right on the day it was written and wrong at the
+ * next release, and nobody would report it, because a missing completion is
+ * indistinguishable from a completion that has not loaded yet. Nothing below
+ * names a single function of the language.
+ *
+ * ## A planned call is offered, and is marked as one
+ *
+ * `stdlib.md` lists calls that are named and not implemented, so that the gap in
+ * the surface is visible rather than looking like an oversight. Writing one is
+ * OS2020.
+ *
+ * Three answers were possible: leave them out, offer them as though they worked,
+ * or offer them marked. Leaving them out is the worst of the three, because the
+ * writer then types the name from the documentation, gets no completion, and
+ * learns nothing about why; offering them unmarked walks somebody into OS2020
+ * with a plot that will not compile.
+ *
+ * So they are offered, they sort after everything a script may write today, and
+ * each one carries `refusal`, which is **the catalogue's own OS2020 message
+ * filled with that name**. A host greys the row, shows the sentence, or drops
+ * the row with one field, and the sentence it shows is the same sentence the
+ * compiler would produce, because it came from the same catalogue.
+ */
+import { NAMESPACES, entryFor, fillTemplate, isNamespace, libraryEntries, libraryNames, membersOf, proseFor, typeText, } from '../core/index.js';
+import { entryAt, parametersOf, signatureTextOf } from './manifest.js';
+import { readChecked } from './reading.js';
+import { inScopeAt } from './scope.js';
+import { siteAt } from './site.js';
+/** The order a host shows them in, decided here so two hosts agree. */
+const ORDER = {
+    argument: 0,
+    variable: 1,
+    function: 2,
+    member: 2,
+    value: 3,
+    namespace: 4,
+};
+/**
+ * The order, and the two things that decide it.
+ *
+ * Named arguments keep the order the signature states them in, because that is
+ * the order they are written in and an alphabetical list of them would put
+ * `len` before `src` in a call whose first argument is the source. Everything
+ * else is sorted: a planned call after every call a script may write today,
+ * then the kinds above, then the name.
+ *
+ * The name comparison has no locale in it. `compiled-program.md` 8.4 forbids
+ * one, and it is the same rule here for the same reason: two machines set
+ * differently would order a list differently, and the machine set differently is
+ * the one nobody is looking at.
+ */
+function ordered(completions) {
+    const written = completions.filter((one) => one.kind === 'argument');
+    const rest = completions.filter((one) => one.kind !== 'argument');
+    rest.sort((a, b) => {
+        if (a.planned !== b.planned)
+            return a.planned ? 1 : -1;
+        const kind = (ORDER[a.kind] ?? 0) - (ORDER[b.kind] ?? 0);
+        if (kind !== 0)
+            return kind;
+        if (a.label === b.label)
+            return 0;
+        return a.label < b.label ? -1 : 1;
+    });
+    return [...written, ...rest];
+}
+/** The OS2020 sentence, filled with the name, for a call that is not here yet. */
+function refusalFor(name) {
+    return fillTemplate(entryFor('OS2020').message, { name });
+}
+function fromEntry(entry, label, kind, replace) {
+    return {
+        label,
+        insert: label,
+        kind,
+        detail: signatureTextOf(entry),
+        summary: proseFor(entry.name)?.summary,
+        planned: entry.planned,
+        refusal: entry.planned ? refusalFor(entry.name) : undefined,
+        replace,
+    };
+}
+/**
+ * One row per library name, taking the first signature for the detail.
+ *
+ * A name with several signatures is one row and not several: `clear` is one
+ * thing to write and two things to write it about, and a list that showed it
+ * twice would be a list about the manifest rather than about the language.
+ * `signature` is what tells a writer which one they are in once they have
+ * opened the bracket.
+ */
+function libraryRow(name, replace) {
+    const entries = libraryEntries(name);
+    const entry = entries[0];
+    if (entry === undefined)
+        return undefined;
+    return fromEntry(entry, name, entry.callable ? 'function' : 'value', replace);
+}
+/** A name the file declared, with the type and the storage the checker gave it. */
+function declaredRow(binding, replace) {
+    const kind = binding.kind === 'function' ? 'function' : 'variable';
+    const persistence = binding.persistence === 'none' ? '' : `${binding.persistence} `;
+    return {
+        label: binding.name,
+        insert: binding.name,
+        kind,
+        detail: `${persistence}${binding.name}: ${typeText(binding.type)}`,
+        summary: undefined,
+        planned: false,
+        refusal: undefined,
+        replace,
+    };
+}
+/**
+ * Everything that may be written at an offset, most useful first.
+ *
+ * Rows are filtered by the word already typed, which is compared exactly:
+ * `language.md` makes names case sensitive, so `EM` is not a start of `ema` and
+ * offering it would be offering a name that does not compile.
+ */
+export function complete(source, offset) {
+    const { file, tokens, checked } = readChecked(source);
+    const site = siteAt(file, tokens, offset);
+    const at = site.replace.offset;
+    const rows = [];
+    // After a dot, the only thing that may be written is a member of the
+    // namespace, and only where the name before the dot is one. A dotted read of
+    // anything else is not a member read at all in version 1 (`language.md` 15.2),
+    // so there is nothing to offer rather than the whole library offered wrongly.
+    if (site.afterDot) {
+        const namespace = site.namespace;
+        if (namespace !== undefined && isNamespace(namespace)) {
+            for (const member of membersOf(namespace)) {
+                const entry = libraryEntries(`${namespace}.${member}`)[0];
+                if (entry !== undefined)
+                    rows.push(fromEntry(entry, member, 'member', site.replace));
+            }
+        }
+        return ordered(rows.filter((row) => row.label.startsWith(site.word)));
+    }
+    // The named arguments of the call being written, where one is being written
+    // and the label of this argument has not been decided yet.
+    const call = site.call;
+    if (call !== undefined && call.label === undefined) {
+        const entry = entryAt(call.name, call.argument + 1);
+        if (entry !== undefined) {
+            for (const parameter of parametersOf(entry)) {
+                if (call.labels.includes(parameter.name))
+                    continue;
+                rows.push({
+                    label: parameter.name,
+                    insert: `${parameter.name} = `,
+                    kind: 'argument',
+                    detail: `${parameter.name}: ${parameter.type}` +
+                        (parameter.defaultText === undefined ? '' : ` = ${parameter.defaultText}`),
+                    summary: undefined,
+                    planned: entry.planned,
+                    refusal: entry.planned ? refusalFor(entry.name) : undefined,
+                    replace: site.replace,
+                });
+            }
+        }
+    }
+    for (const binding of inScopeAt(checked, at)) {
+        rows.push(declaredRow(binding, site.replace));
+    }
+    for (const name of libraryNames()) {
+        // A dotted name is reached through its namespace and not written whole from
+        // nothing, so the namespace is the row and `membersOf` is the rest.
+        if (name.includes('.'))
+            continue;
+        const row = libraryRow(name, site.replace);
+        if (row !== undefined)
+            rows.push(row);
+    }
+    for (const namespace of NAMESPACES) {
+        rows.push({
+            label: namespace,
+            insert: `${namespace}.`,
+            kind: 'namespace',
+            detail: `${namespace}.`,
+            summary: undefined,
+            planned: false,
+            refusal: undefined,
+            replace: site.replace,
+        });
+    }
+    return ordered(rows.filter((row) => row.label.startsWith(site.word)));
+}
+//# sourceMappingURL=complete.js.map

package/dist/editor/complete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complete.js","sourceRoot":"","sources":["../../src/editor/complete.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,OAAO,EACL,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAwCnC,uEAAuE;AACvE,MAAM,KAAK,GAA6C;IACtD,QAAQ,EAAE,CAAC;IACX,QAAQ,EAAE,CAAC;IACX,QAAQ,EAAE,CAAC;IACX,MAAM,EAAE,CAAC;IACT,KAAK,EAAE,CAAC;IACR,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,SAAS,OAAO,CAAC,WAAkC;IACjD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAClE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACjB,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO;YAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,IAAI,IAAI,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC5B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC;QAClC,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,kFAAkF;AAClF,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,SAAS,CAChB,KAAmB,EACnB,KAAa,EACb,IAAoB,EACpB,OAAa;IAEb,OAAO;QACL,KAAK;QACL,MAAM,EAAE,KAAK;QACb,IAAI;QACJ,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC;QAC9B,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO;QACtC,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;QAC3D,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,OAAa;IAC7C,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAChF,CAAC;AAED,mFAAmF;AACnF,SAAS,WAAW,CAAC,OAAgB,EAAE,OAAa;IAClD,MAAM,IAAI,GAAmB,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC;IACnF,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,GAAG,CAAC;IACpF,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,IAAI;QACnB,MAAM,EAAE,OAAO,CAAC,IAAI;QACpB,IAAI;QACJ,MAAM,EAAE,GAAG,WAAW,GAAG,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAClE,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,SAAS;QAClB,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAc,EAAE,MAAc;IACrD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAE/B,MAAM,IAAI,GAAiB,EAAE,CAAC;IAE9B,qEAAqE;IACrE,6EAA6E;IAC7E,+EAA+E;IAC/E,8EAA8E;IAC9E,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;YACtD,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1C,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,KAAK,KAAK,SAAS;oBAAE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,4EAA4E;IAC5E,2DAA2D;IAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACnD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;QACpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC;oBAAE,SAAS;gBACnD,IAAI,CAAC,IAAI,CAAC;oBACR,KAAK,EAAE,SAAS,CAAC,IAAI;oBACrB,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,KAAK;oBAC9B,IAAI,EAAE,UAAU;oBAChB,MAAM,EACJ,GAAG,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,EAAE;wBACtC,CAAC,SAAS,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;oBAC5E,OAAO,EAAE,SAAS;oBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;oBAC3D,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,EAAE,CAAC;QAClC,4EAA4E;QAC5E,oEAAoE;QACpE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,SAAS;QACjC,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,GAAG,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC;YACR,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,GAAG,SAAS,GAAG;YACvB,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,GAAG,SAAS,GAAG;YACvB,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC"}

package/dist/editor/diagnose.d.ts

@@ -0,0 +1,18 @@
+import type { Diagnostic } from '../core/index.js';
+/**
+ * Every diagnostic a compile of this source produces, in the order a reader
+ * walks the file.
+ *
+ * Each one carries its code, its span, its message and its fix, because that is
+ * what a `Diagnostic` is: the stage that raised it supplied the code and the
+ * span, and everything a person reads came from the error catalogue. There is no
+ * editor-shaped diagnostic type here for the same reason there is no editor
+ * compiler. A host that renders one in a panel and a terminal that renders the
+ * same one under a caret are looking at the same record.
+ *
+ * The order is the bag's own: by offset, then by the span's length, then by code
+ * point of the code. It depends on nothing outside the file, so two machines
+ * list them identically.
+ */
+export declare function diagnose(source: string): readonly Diagnostic[];
+//# sourceMappingURL=diagnose.d.ts.map

package/dist/editor/diagnose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnose.d.ts","sourceRoot":"","sources":["../../src/editor/diagnose.ts"],"names":[],"mappings":"AAgDA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAGnD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,UAAU,EAAE,CAI9D"}

package/dist/editor/diagnose.js

@@ -0,0 +1,70 @@
+/**
+ * `diagnose`: source text in, everything the compiler has to say about it out.
+ *
+ * This is the one a trader sees most. It runs on a debounce while somebody
+ * types, so two things about it are decisions rather than details: what it
+ * costs, and what it does with a file that does not parse.
+ *
+ * ## It is the whole compile, on purpose
+ *
+ * Lexer, parser, checker, emitter. Not a subset, and not a faster partial
+ * compiler written for the editor, because a second implementation of the
+ * language is the thing this project refuses to have: the editor is the compiler
+ * wearing a different hat.
+ *
+ * It matters concretely as well as in principle. There are codes a script can
+ * carry that the emitter raises and nothing before it does, so an editor that
+ * stopped after the checker would show a clean file and then refuse it the
+ * moment somebody pressed apply. What a host sees here is exactly what a compile
+ * produces, so nothing new can appear at apply, and a test holds that by taking
+ * a file whose only fault the emitter is the one to find.
+ *
+ * ## What it costs
+ *
+ * A full compile of a ninety line study is a third of a millisecond, and the
+ * same file with a bracket left open mid way through, which is what a file looks
+ * like the moment somebody types one, is about a millisecond. Both are in the
+ * benchmark suite with a budget, as `diagnose-heavy` and `diagnose-typing`, so a
+ * change that makes the editor cost ten times what it costs today fails the
+ * build rather than being felt by a trader.
+ *
+ * That is why there is no partial compiler here. At this price, one is not worth
+ * the second implementation it would cost; if a script ever arrives that makes
+ * it worth one, the number to beat is in the benchmark table rather than in
+ * somebody's impression.
+ *
+ * ## A file that does not parse
+ *
+ * That is the normal state of a file being typed into, so it is the case this
+ * has to be good at rather than the case it survives. Every stage of this
+ * compiler recovers and reports instead of throwing: a lexical error costs its
+ * own character, a statement that will not parse costs its own line, a name that
+ * does not resolve becomes `unknown` and the lines around it are still checked.
+ * So a half typed file produces the diagnostics its finished lines have earned,
+ * plus the one about the line being typed, and nothing here needs a try block to
+ * make that true. `tests/editor/diagnose.test.ts` puts a corpus of malformed
+ * files through it, including text that is not the language at all.
+ */
+import { check, emit } from '../core/index.js';
+import { readTree } from './reading.js';
+/**
+ * Every diagnostic a compile of this source produces, in the order a reader
+ * walks the file.
+ *
+ * Each one carries its code, its span, its message and its fix, because that is
+ * what a `Diagnostic` is: the stage that raised it supplied the code and the
+ * span, and everything a person reads came from the error catalogue. There is no
+ * editor-shaped diagnostic type here for the same reason there is no editor
+ * compiler. A host that renders one in a panel and a terminal that renders the
+ * same one under a caret are looking at the same record.
+ *
+ * The order is the bag's own: by offset, then by the span's length, then by code
+ * point of the code. It depends on nothing outside the file, so two machines
+ * list them identically.
+ */
+export function diagnose(source) {
+    const { file, bag, script } = readTree(source);
+    emit(file, check(file, script, bag), bag, {});
+    return bag.ordered();
+}
+//# sourceMappingURL=diagnose.js.map

package/dist/editor/diagnose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnose.js","sourceRoot":"","sources":["../../src/editor/diagnose.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAc;IACrC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAC9C,OAAO,GAAG,CAAC,OAAO,EAAE,CAAC;AACvB,CAAC"}

package/dist/editor/format.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The canonical layout of a source, or the source itself where it cannot be
+ * given one safely.
+ *
+ * The output always ends in a single line ending and uses LF, because a file is
+ * normalised before anything reads it (`language.md` 3.1). A host holding CRLF
+ * text gets LF back, which is the same file to the compiler and to every other
+ * part of this project.
+ */
+export declare function format(source: string): string;
+//# sourceMappingURL=format.d.ts.map

package/dist/editor/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/editor/format.ts"],"names":[],"mappings":"AAgEA;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAW7C"}

package/dist/editor/format.js

@@ -0,0 +1,50 @@
+import { layOut } from './layout.js';
+import { readTree } from './reading.js';
+import { scan } from './scan.js';
+import { shapesOf } from './spacing.js';
+/**
+ * Whether two token streams are the same stream.
+ *
+ * Kind and text for everything, except the indent token, whose text is the
+ * leading whitespace of the line it opens and is exactly what a formatter is
+ * allowed to change. It is the only token that carries layout as text: a
+ * newline, a dedent and the end of the file have none.
+ *
+ * Spans are not compared, and must not be: every one of them moves when a line
+ * is re-indented, which is the whole point of the exercise.
+ */
+function sameStream(before, after) {
+    if (before.length !== after.length)
+        return false;
+    for (const [at, token] of before.entries()) {
+        const other = after[at];
+        if (other === undefined || other.kind !== token.kind)
+            return false;
+        if (token.kind !== 'indent' && other.text !== token.text)
+            return false;
+    }
+    return true;
+}
+/**
+ * The canonical layout of a source, or the source itself where it cannot be
+ * given one safely.
+ *
+ * The output always ends in a single line ending and uses LF, because a file is
+ * normalised before anything reads it (`language.md` 3.1). A host holding CRLF
+ * text gets LF back, which is the same file to the compiler and to every other
+ * part of this project.
+ */
+export function format(source) {
+    const held = readTree(source);
+    if (!held.bag.isEmpty)
+        return source;
+    const shapes = shapesOf(held.script, held.tokens);
+    const out = layOut(held.file, held.tokens, scan(held.file, held.tokens), shapes);
+    const again = readTree(out);
+    if (!again.bag.isEmpty)
+        return source;
+    if (!sameStream(held.tokens, again.tokens))
+        return source;
+    return out;
+}
+//# sourceMappingURL=format.js.map

package/dist/editor/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/editor/format.ts"],"names":[],"mappings":"AAsCA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC;;;;;;;;;;GAUG;AACH,SAAS,UAAU,CAAC,MAAwB,EAAE,KAAuB;IACnE,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACjD,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QACnE,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;IACzE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAAC,MAAc;IACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC9B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC;IAErC,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IAEjF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC;IACtC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAC1D,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/editor/highlight.d.ts

@@ -0,0 +1,28 @@
+import type { Highlight } from './scan.js';
+/** One line's pieces, with the line they are on so a caller counts nothing. */
+export interface HighlightedLine {
+    /** One-based, the same line a diagnostic's span carries. */
+    readonly line: number;
+    readonly pieces: readonly Highlight[];
+}
+/**
+ * The pieces of a file, in order, covering every character exactly once.
+ *
+ * Nothing here throws and nothing here reports. A file being typed into is
+ * malformed most of the time, and a highlighter that stopped at the first
+ * character the language does not have would leave the rest of a trader's
+ * script grey while they finished the word. `diagnose` is where the compiler
+ * says what is wrong with it.
+ */
+export declare function highlight(source: string): readonly Highlight[];
+/**
+ * The same pieces, grouped by line, with every line of the file present.
+ *
+ * A piece that runs across a line ending is cut at it, and the line ending
+ * itself belongs to no line: a renderer draws the text of a line and puts the
+ * break there itself. A blank line is an entry with no pieces rather than a
+ * missing entry, so a caller can walk lines one to `lineCount` and never index
+ * past the end of a shorter list.
+ */
+export declare function highlightLines(source: string): readonly HighlightedLine[];
+//# sourceMappingURL=highlight.d.ts.map

package/dist/editor/highlight.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlight.d.ts","sourceRoot":"","sources":["../../src/editor/highlight.ts"],"names":[],"mappings":"AAqCA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,SAAS,EAAE,CAG9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,eAAe,EAAE,CAazE"}

package/dist/editor/highlight.js

@@ -0,0 +1,65 @@
+import { read } from './reading.js';
+import { scan } from './scan.js';
+/**
+ * The pieces of a file, in order, covering every character exactly once.
+ *
+ * Nothing here throws and nothing here reports. A file being typed into is
+ * malformed most of the time, and a highlighter that stopped at the first
+ * character the language does not have would leave the rest of a trader's
+ * script grey while they finished the word. `diagnose` is where the compiler
+ * says what is wrong with it.
+ */
+export function highlight(source) {
+    const held = read(source);
+    return scan(held.file, held.tokens);
+}
+/**
+ * The same pieces, grouped by line, with every line of the file present.
+ *
+ * A piece that runs across a line ending is cut at it, and the line ending
+ * itself belongs to no line: a renderer draws the text of a line and puts the
+ * break there itself. A blank line is an entry with no pieces rather than a
+ * missing entry, so a caller can walk lines one to `lineCount` and never index
+ * past the end of a shorter list.
+ */
+export function highlightLines(source) {
+    const { file, tokens } = read(source);
+    const pieces = scan(file, tokens);
+    const lines = [];
+    for (let line = 0; line < file.lineCount; line += 1)
+        lines.push([]);
+    for (const piece of pieces) {
+        for (const part of split(file, piece)) {
+            lines[part.span.line - 1]?.push(part);
+        }
+    }
+    return lines.map((held, index) => ({ line: index + 1, pieces: held }));
+}
+/**
+ * One piece as the pieces of the lines it covers, the line endings dropped.
+ *
+ * Only whitespace can reach here holding a line ending, since no token and no
+ * comment crosses one, but the split is written for any piece rather than for
+ * that one case: a piece shape that grows a new kind should not need this
+ * function to be revisited to stay correct.
+ */
+function split(file, piece) {
+    if (!piece.text.includes('\n'))
+        return [piece];
+    const out = [];
+    let from = 0;
+    for (let i = 0; i <= piece.text.length; i += 1) {
+        const ending = i === piece.text.length || piece.text.charCodeAt(i) === 10;
+        if (!ending)
+            continue;
+        if (i > from)
+            out.push(partOf(file, piece, from, i));
+        from = i + 1;
+    }
+    return out;
+}
+function partOf(file, piece, from, to) {
+    const span = file.spanAt(piece.span.offset + from, to - from);
+    return { kind: piece.kind, span, text: piece.text.slice(from, to) };
+}
+//# sourceMappingURL=highlight.js.map

package/dist/editor/highlight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlight.js","sourceRoot":"","sources":["../../src/editor/highlight.ts"],"names":[],"mappings":"AAmCA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAUjC;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,MAAc;IACtC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc;IAC3C,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAClC,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEpE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,KAAK,CAAC,IAAgB,EAAE,KAAgB;IAC/C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAE/C,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAC1E,IAAI,CAAC,MAAM;YAAE,SAAS;QACtB,IAAI,CAAC,GAAG,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,MAAM,CAAC,IAAgB,EAAE,KAAgB,EAAE,IAAY,EAAE,EAAU;IAC1E,MAAM,IAAI,GAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACpE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;AACtE,CAAC"}

package/dist/editor/hover.d.ts

@@ -0,0 +1,40 @@
+import type { Colour, Span } from '../core/index.js';
+export type HoverKind = 'library' | 'declared' | 'keyword';
+export interface Hover {
+    readonly kind: HoverKind;
+    /** The word the pointer is over, which is what a host underlines. */
+    readonly span: Span;
+    /** The name as written, dotted where the word is half of a namespaced name. */
+    readonly name: string;
+    /**
+     * Every signature the name has, in the order the manifest holds them.
+     *
+     * More than one where the language gives the name more than one, which
+     * `stdlib.md` 2.2 allows: a hover has no arguments to choose between them
+     * with, so it shows both rather than picking.
+     */
+    readonly signatures: readonly string[];
+    /** The line the specification gives it, where it gives one. */
+    readonly summary: string | undefined;
+    /** The first bar it can produce a value for, as its own row states it. */
+    readonly warmup: string | undefined;
+    /** The type the checker gave a declared name. */
+    readonly type: string | undefined;
+    /** Where a declared name was declared, which is what a host jumps to. */
+    readonly declaredAt: Span | undefined;
+    /** The channels of a named colour, for a swatch. */
+    readonly colour: Colour | undefined;
+    /** Named in the library and not implemented in this version: OS2020. */
+    readonly planned: boolean;
+    /** The catalogue's OS2020 message for this name, on a planned name and no other. */
+    readonly refusal: string | undefined;
+}
+/**
+ * What the word at an offset is, or nothing where the offset is not on a word.
+ *
+ * A pointer over a space, a bracket, a number or a string gets nothing: those
+ * are not names, and a tooltip that appeared over a comma would be in the way
+ * rather than useful. A host that wants a literal's value has it in the text.
+ */
+export declare function hover(source: string, offset: number): Hover | undefined;
+//# sourceMappingURL=hover.d.ts.map

package/dist/editor/hover.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../src/editor/hover.ts"],"names":[],"mappings":"AAkDA,OAAO,KAAK,EAAE,MAAM,EAAc,IAAI,EAAS,MAAM,kBAAkB,CAAC;AAOxE,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3D,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,0EAA0E;IAC1E,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,iDAAiD;IACjD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,yEAAyE;IACzE,QAAQ,CAAC,UAAU,EAAE,IAAI,GAAG,SAAS,CAAC;IACtC,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,wEAAwE;IACxE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,oFAAoF;IACpF,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC;AAmDD;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAqDvE"}