bmweb-cli 0.1.1 → 0.1.2

package/README.md

@@ -309,15 +309,19 @@ status line and the script's progress window are the two bottom lines.
 With no arguments it starts on the app's own home, an INPA script of the
 project's own (`home/bmweb-home.ips`): F1 picks a chassis then a module,
 F2 the chassis's whole-vehicle script, and `scriptchange` hands the screen
-to that script. The picks are numbered lists on the terminal; typing text
-filters, a number opens, Enter cancels. The home starts with or without a
-cable.
+to that script. A pick is a list the keyboard walks: Up/Down move the bar,
+typing narrows the list to the rows containing the text, Enter picks, Esc
+cancels. The home starts with or without a cable.
+
+The TUI runs on the terminal's alternate screen (the buffer vim and htop
+use), so the shell's scrollback is never touched and quitting restores it;
+a screen redraws in place, only the lines that changed.
 
 Every dialog INPA opens is a prompt: a message waits for Enter, an input
 asks for the number (or hex, or text) within the declared range, the
-two-word box takes y/n, the component picker (togglelist) lists the
-screen's lines by number, Select lists the named lines, save-as asks for a
-file name. **Every write is asked first**, exactly as the app asks: a key
+two-word box takes y/n, the component picker (togglelist) and Select are
+the same list picker (Space marks several where several may be picked),
+save-as asks for a file name. **Every write is asked first**, exactly as the app asks: a key
 whose body can send a write names the jobs and waits for y; a screen that
 sends one on every refresh asks once for as long as it is open; n or
 Enter abandons the key. On quit the leaving menu's Back job (the script's

package/dist/bmweb.js

@@ -1892,6 +1892,7 @@ function nodeTerminal() {
   };
   raw(true);
   input.resume();
+  output.write("\x1B[?1049h\x1B[H");
   const subs = /* @__PURE__ */ new Set();
   let paused = false;
   input.on(
@@ -1945,6 +1946,7 @@ function nodeTerminal() {
       }
     },
     close() {
+      output.write("\x1B[?1049l");
       raw(false);
       input.pause();
     }
@@ -1960,6 +1962,8 @@ var TuiUi = class {
   program = null;
   /** the lines of the frame on screen, when the cursor sits right below it */
   frame = [];
+  /** a picker owns the keyboard: the program's key handler must stand back */
+  modal = false;
   /** the terminal size the frame was drawn for; a change draws fresh */
   frameSize = "";
   leftResolve = null;
@@ -1988,10 +1992,7 @@ var TuiUi = class {
    * and drawn again for the new size.
    */
   resized() {
-    if (this.frame.length) {
-      this.term.write(`\x1B[${this.frame.length}A\r\x1B[J`);
-      this.frame = [];
-    }
+    this.frame = [];
     if (this.program) this.paint(this.program);
   }
   /**
@@ -2014,26 +2015,116 @@ var TuiUi = class {
       return null;
     }
     const title = step.what === "module" ? `Modules of ${step.arg}` : "Vehicles";
-    let shown = options;
-    for (; ; ) {
-      const rows = shown.map(
-        (o, i) => `  ${String(i + 1).padStart(3)}. ${o.label}${o.meta ? `  (${o.meta})` : ""}`
-      ).join("\n");
-      const a = await this.ask(
-        `
-${title}${shown.length !== options.length ? ` (${shown.length} of ${options.length})` : ""}
-${rows}
-Number to open, text to filter, Enter to cancel: `
-      );
-      if (a == null || !a.trim()) return null;
-      const n = Number(a.trim());
-      if (Number.isInteger(n) && n >= 1 && n <= shown.length)
-        return shown[n - 1].value;
-      const q = a.trim().toLowerCase();
-      const next = options.filter(
+    const picked = await this.pickList(title, options);
+    return picked ? picked[0] : null;
+  }
+  /**
+   * The picker: a list the keyboard walks. Up/Down (and PageUp/PageDown)
+   * move the bar, typing narrows the list to the rows containing the text,
+   * Backspace widens it again, Enter picks the row under the bar (Space
+   * marks a row when several may be picked, Enter then takes the marked
+   * ones, or the bar's row when none is marked), Esc cancels. Drawn as the
+   * frame, so it repaints in place like a screen.
+   * @param title - what is being picked
+   * @param options - the rows
+   * @param multiple - whether several rows may be picked
+   * @returns the picked values (one, unless multiple), or null for cancel
+   */
+  async pickList(title, options, multiple = false) {
+    let filter = "";
+    let cursor = 0;
+    let top = 0;
+    const marked = /* @__PURE__ */ new Set();
+    const shown = () => {
+      const q = filter.toLowerCase();
+      return q ? options.filter(
         (o) => `${o.label} ${o.meta || ""} ${o.value}`.toLowerCase().includes(q)
+      ) : options;
+    };
+    const draw = () => {
+      const rows = shown();
+      const w = this.term.columns;
+      const window = Math.max(3, this.term.rows - 7);
+      if (cursor >= rows.length) cursor = Math.max(0, rows.length - 1);
+      if (cursor < top) top = cursor;
+      if (cursor >= top + window) top = cursor - window + 1;
+      const count = rows.length === options.length ? `${options.length}` : `${rows.length} of ${options.length}`;
+      const lines = [
+        `${title}  \x1B[2m(${count})\x1B[0m`,
+        `\x1B[2mFilter:\x1B[0m ${filter}\x1B[7m \x1B[0m`,
+        ""
+      ];
+      for (const o of rows.slice(top, top + window)) {
+        const i = rows.indexOf(o);
+        const mark = multiple ? marked.has(o.value) ? "[x] " : "[ ] " : "";
+        const meta = o.meta ? `  ${o.meta}` : "";
+        const text = `${mark}${o.label}${meta}`.slice(0, w - 4);
+        lines.push(
+          i === cursor ? `\x1B[7m > ${text.padEnd(w - 4)} \x1B[0m` : `   ${o.meta ? `${mark}${o.label}\x1B[2m${meta}\x1B[0m` : text}`
+        );
+      }
+      if (!rows.length) lines.push("   \x1B[2m(nothing matches)\x1B[0m");
+      if (rows.length > top + window)
+        lines.push(`   \x1B[2m... ${rows.length - top - window} more\x1B[0m`);
+      lines.push("");
+      lines.push(
+        `\x1B[2m\u2191\u2193 move   type to filter   Enter picks${multiple ? "   Space marks" : ""}   Esc cancels\x1B[0m`
       );
-      shown = next.length ? next : options;
+      this.flush(lines);
+    };
+    this.modal = true;
+    try {
+      return await new Promise((resolve2) => {
+        const off = this.term.onKey((k) => {
+          const rows = shown();
+          const finish = (v) => {
+            off();
+            resolve2(v);
+          };
+          if (k.name === "escape" || k.ctrl && k.name === "c") {
+            finish(null);
+            return;
+          }
+          if (k.name === "return" || k.name === "enter") {
+            if (multiple && marked.size) {
+              finish(
+                options.filter((o2) => marked.has(o2.value)).map((o2) => o2.value)
+              );
+              return;
+            }
+            const o = rows[cursor];
+            finish(o ? [o.value] : null);
+            return;
+          }
+          if (k.name === "up" || k.ctrl && k.name === "p")
+            cursor = Math.max(0, cursor - 1);
+          else if (k.name === "down" || k.ctrl && k.name === "n")
+            cursor = Math.min(rows.length - 1, cursor + 1);
+          else if (k.name === "pageup")
+            cursor = Math.max(0, cursor - (this.term.rows - 7));
+          else if (k.name === "pagedown")
+            cursor = Math.min(rows.length - 1, cursor + (this.term.rows - 7));
+          else if (k.name === "home") cursor = 0;
+          else if (k.name === "end") cursor = Math.max(0, rows.length - 1);
+          else if (k.name === "backspace") filter = filter.slice(0, -1);
+          else if (multiple && k.name === "space") {
+            const o = rows[cursor];
+            if (o) {
+              if (marked.has(o.value)) marked.delete(o.value);
+              else marked.add(o.value);
+            }
+          } else if (k.ch && !k.ctrl && k.ch >= " " && k.ch !== "\x7F") {
+            filter += k.ch;
+            cursor = 0;
+          } else return;
+          draw();
+        });
+        draw();
+      });
+    } finally {
+      this.modal = false;
+      this.frame = [];
+      if (this.program) this.paint(this.program);
     }
   }
   /** Note the program once it exists, for the key handler. */
@@ -2041,10 +2132,9 @@ Number to open, text to filter, Enter to cancel: `
     this.program = p;
   }
   /**
-   * A prompt on the terminal. It scrolls the frame away from under the
-   * cursor, so the frame is forgotten and the next paint draws fresh below
-   * the answer (the prompt and its answer stay in the transcript, the way a
-   * tool call does).
+   * A typed prompt under the frame (readline, raw mode off). It moves the
+   * cursor, so the frame is forgotten and the next paint clears the screen
+   * and draws fresh.
    * @param prompt - the prompt text
    * @returns the answer, or null when cancelled
    */
@@ -2164,8 +2254,8 @@ Send ${job}${arg ? ` ${arg}` : ""} to the module (${ctx.label})?${every} [y/N] `
    * flag, every picked key ';'-joined).
    */
   async pickComponent(p, step) {
-    const rows = this.R.ipoScreenComponents(p.exec, p.screen).map((l, i2) => ({
-      key: step.argnum ? String(i2 + 1) : String(l.keys).split(";")[0] || "",
+    const rows = this.R.ipoScreenComponents(p.exec, p.screen).map((l, i) => ({
+      key: step.argnum ? String(i + 1) : String(l.keys).split(";")[0] || "",
       caption: l.label || String(l.keys).split(";")[0] || ""
     }));
     if (!rows.length) {
@@ -2175,30 +2265,27 @@ Send ${job}${arg ? ` ${arg}` : ""} to the module (${ctx.label})?${every} [y/N] `
       );
       return null;
     }
-    const list = rows.map((r, i2) => `  ${i2 + 1}. ${r.caption}  (${r.key})`).join("\n");
+    const options = rows.map((r) => ({
+      value: r.key,
+      label: r.caption,
+      meta: r.key !== r.caption ? r.key : ""
+    }));
     if (step.multiple) {
-      const a2 = await this.ask(
-        `
-${list}
-Components, comma-separated (Enter cancels): `
-      );
-      const picked = pickNumbers(a2, rows.length).map(
-        (i2) => rows[i2]
-      );
-      if (!picked.length) return null;
-      return { ort: picked.map((r) => r.key).join(";"), ein: 0 };
-    }
-    const a = await this.ask(`
-${list}
-Component number (Enter cancels): `);
-    const [i] = pickNumbers(a, rows.length);
-    if (i == null) return null;
-    const onOff = await this.ask(`On or off? [on/off] `);
-    if (onOff == null || !onOff.trim()) return null;
-    return {
-      ort: rows[i].key,
-      ein: /^on/i.test(onOff.trim()) ? 0 : 1
-    };
+      const picked2 = await this.pickList("Components", options, true);
+      if (!picked2 || !picked2.length) return null;
+      return { ort: picked2.join(";"), ein: 0 };
+    }
+    const picked = await this.pickList("Component", options);
+    if (!picked) return null;
+    const onOff = await this.pickList(
+      `${options.find((o) => o.value === picked[0])?.label || picked[0]}`,
+      [
+        { value: "on", label: "On" },
+        { value: "off", label: "Off" }
+      ]
+    );
+    if (!onOff) return null;
+    return { ort: picked[0], ein: onOff[0] === "on" ? 0 : 1 };
   }
   /** INPA's Select: which named logical lines to keep on screen. */
   async pickLines(_p, names, multiple, _current, hints) {
@@ -2210,16 +2297,14 @@ Component number (Enter cancels): `);
       );
       return null;
     }
-    const list = names.map((n, i) => `  ${i + 1}. ${n}`).join("\n");
-    const a = await this.ask(
-      `
-${list}
-Lines to show${multiple ? ", comma-separated" : ""} (a = all, Enter cancels): `
-    );
-    if (a == null) return null;
-    if (/^a(ll)?$/i.test(a.trim())) return [];
-    const picked = pickNumbers(a, names.length).map((i) => names[i]);
-    return picked.length ? picked : null;
+    const options = [
+      { value: "\0all", label: "(all lines)" },
+      ...names.map((n) => ({ value: n, label: n }))
+    ];
+    const picked = await this.pickList("Lines to show", options, multiple);
+    if (!picked || !picked.length) return null;
+    if (picked.includes("\0all")) return [];
+    return picked;
   }
   /** INPA's save-as dialog: a file name, written when the body ends. */
   async saveFile() {
@@ -2233,10 +2318,9 @@ Save as [fault-memory.txt]: `);
     this.status(_p, `wrote ${picked.name}`);
   }
   printScreen(p) {
-    this.term.write(`
-${this.gridLines(p).join("\n")}
-`);
-    this.frame = [];
+    const name = `bmweb-screen-${Date.now()}.txt`;
+    writeFileSync4(name, this.gridLines(p).join("\n") + "\n", "utf8");
+    this.status(p, `printed the screen to ${name}`);
   }
   /**
    * The module a scriptchange names. From the home script it is the car's
@@ -2322,12 +2406,13 @@ ${this.gridLines(p).join("\n")}
     );
   }
   /**
-   * Put a frame on the terminal over the last one. With a frame on screen
-   * the cursor is on the line under it: go up to its top, rewrite the lines
+   * Put a frame on the screen over the last one. The frame always starts
+   * at the top-left of the alternate screen: go there, rewrite the lines
    * that differ (each erased to the end of the row), step over the ones
    * that match, and erase whatever the old frame had below the new one.
-   * Without one (first paint, after a prompt, after a resize) the frame is
-   * written where the cursor is.
+   * With no frame to build on (first paint, after a prompt, after a
+   * resize) the screen is cleared first -- on the alternate screen that
+   * costs no scrollback.
    * @param lines - the new frame
    */
   flush(lines) {
@@ -2337,14 +2422,14 @@ ${this.gridLines(p).join("\n")}
     const prev = this.frame;
     if (prev.length === lines.length && prev.every((l, i) => l === lines[i]))
       return;
-    let s = prev.length ? `\x1B[${prev.length}A` : "";
+    let s = prev.length ? "\x1B[H" : "\x1B[2J\x1B[H";
     lines.forEach((line, i) => {
       if (i < prev.length && prev[i] === line) s += "\x1B[B";
       else s += `\r${line}\x1B[K\r
 `;
     });
     if (lines.length < prev.length) s += "\r\x1B[J";
-    if (s) this.term.write(s);
+    this.term.write(s);
     this.frame = lines;
   }
   /**
@@ -2404,10 +2489,6 @@ ${this.progressText}\r
     if (this.leftResolve) this.leftResolve();
   }
 };
-function pickNumbers(a, n) {
-  if (a == null) return [];
-  return a.split(/[,\s]+/).map((s) => Number(s)).filter((i) => Number.isInteger(i) && i >= 1 && i <= n).map((i) => i - 1);
-}
 function cellText(c) {
   const text = String(c.text || "");
   if (c.kind === "lamp") {
@@ -2496,6 +2577,7 @@ async function tuiCommand(chassis, sgbd, opts = {}) {
     }
     const program = p;
     const unsubscribe = term.onKey((k) => {
+      if (ui.modal) return;
       const what = keyToPress(k);
       if (what === null) return;
       if (what === "quit") {
@@ -2525,7 +2607,7 @@ async function tuiCommand(chassis, sgbd, opts = {}) {
 }
 
 // src/bmweb.ts
-var VERSION = true ? "0.1.1" : "0.0.0-dev";
+var VERSION = true ? "0.1.2" : "0.0.0-dev";
 var INCLUDE = {
   include: {
     kind: "list",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bmweb-cli",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "BMWeb's tools as a command line: read INPA .IPO scripts, compile .IPS sources, search the corpus job index, decode and diff shared Garage reports, and, over a K+DCAN cable, run jobs, whole-car scans and INPA screens in the terminal.",
   "license": "GPL-3.0-only",
   "type": "module",