jsbeeb 1.23.0 → 1.24.0

package/README.md

@@ -96,8 +96,8 @@ Some things to know:
   was at fault.
 - On the Atom, use the Atom's own key names (`LOCK`, `UP_DOWN`, `LEFT_RIGHT` and so on) rather than the BBC's.
 
-The definitive lists are `keyCodes` (host) and `BBC` (BBC micro) in [`src/utils.js`](src/utils.js), and `ATOM` in
-[`src/utils_atom.js`](src/utils_atom.js).
+The definitive lists are `keyCodes` (host) and `BBC` (BBC micro) in [`src/keymap.js`](src/keymap.js), and `ATOM` in
+[`src/keymap-atom.js`](src/keymap-atom.js).
 
 ### Emulator Shortcuts
 

package/package.json

@@ -7,7 +7,7 @@
   "name": "jsbeeb",
   "description": "Emulate a BBC Micro",
   "repository": "git@github.com:mattgodbolt/jsbeeb.git",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "//engines": "If you change the version of Node, it must also be updated at the top of the Dockerfile.",
   "engines": {
     "node": ">=24.15.0"
@@ -15,14 +15,12 @@
   "type": "module",
   "main": "./src/app/app.js",
   "exports": {
-    ".": "./src/app/app.js",
+    ".": "./src/index.js",
     "./machine-session": "./src/machine-session.js",
-    "./src/*": "./src/*",
-    "./tests/test-machine.js": "./tests/test-machine.js"
+    "./src/*": "./src/*"
   },
   "files": [
     "src/",
-    "tests/test-machine.js",
     "public/roms/"
   ],
   "dependencies": {
@@ -32,11 +30,11 @@
     "bootstrap-icons": "^1.13.1",
     "bootswatch": "^5.3.8",
     "pako": "^3.0.1",
-    "sharp": "^0.35.3",
     "smoothie": "^1.36.1"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@playwright/test": "^1.62.1",
     "@vitest/coverage-v8": "^4.0.18",
     "eslint": "^10.7.0",
     "eslint-config-prettier": "^10.1.8",
@@ -54,6 +52,7 @@
   },
   "optionalDependencies": {
     "electron": "^44.0.0",
+    "sharp": "^0.35.3",
     "electron-builder": "^26.15.3",
     "electron-store": "^11.0.2"
   },
@@ -90,9 +89,12 @@
     "start": "vite",
     "build": "vite build",
     "preview": "vite preview",
-    "ci-checks": "eslint .",
-    "lint": "eslint . --fix",
+    "ci-checks": "npm-run-all lint format:check check-workflow-suites",
+    "check-workflow-suites": "node tools/check-workflow-suites.js",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
     "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "pre-commit": "lint-staged",
     "test": "npm-run-all test:*",
     "test:unit": "vitest run --silent=true tests/unit",
@@ -100,6 +102,7 @@
     "test:cpu": "node tests/test-suite.js",
     "test:shader": "vitest run --silent=true tests/shader",
     "coverage:unit": "vitest run tests/unit --coverage",
+    "dom-unit-tests": "vitest run --silent=true --project unit $(grep -rl domFromIndexHtml tests/unit)",
     "coverage:all-tests": "vitest run --coverage",
     "benchmark": "node src/app-bench.js",
     "mirror-sth": "node tools/mirror-sth.js --out .sth-mirror",
@@ -116,14 +119,15 @@
     "mirror-bbcdiscs:upload:index": "aws s3 cp .bbcdiscs-mirror/hfe/manifest.json s3://bbc.xania.org/archive/bbcdiscs/hfe/manifest.json --cache-control 'public, max-age=300' && aws s3 cp .bbcdiscs-mirror/manifest.json s3://bbc.xania.org/archive/bbcdiscs/manifest.json --cache-control 'public, max-age=300'",
     "electron": "npm run build && ELECTRON_DISABLE_SANDBOX=1 electron .",
     "electron:build": "electron-builder",
-    "test:smoke": "npm run build && node tests/browser/smoke.js"
+    "test:e2e": "npm run build && playwright test --project chrome"
   },
   "lint-staged": {
     "*.js": [
-      "vitest related --run --exclude tests/integration --exclude tests/shader --no-file-parallelism",
+      "vitest related --run --project unit --no-file-parallelism",
       "eslint --cache --fix",
       "prettier --write"
     ],
+    "index.html": "npm run dom-unit-tests --",
     "*.{md,json,yml,yaml,css,html}": "prettier --write"
   },
   "allowScripts": {

package/src/6502.js

@@ -1,5 +1,3 @@
-"use strict";
-import * as utils from "./utils.js";
 import * as via from "./via.js";
 import { Acia } from "./acia.js";
 import { Serial } from "./serial.js";
@@ -12,8 +10,10 @@ import { Filestore } from "./filestore.js";
 import { FakeRelayNoise } from "./relaynoise.js";
 import { AtomPPIA } from "./ppia.js";
 import { AtomMMC2 } from "./mmc.js";
-
-const signExtend = utils.signExtend;
+import { unzipRomImage } from "./archive.js";
+import { signExtend } from "./binary.js";
+import { hexbyte, hexword } from "./hex.js";
+import { loadData } from "./loader.js";
 
 function _set(byte, mask, set) {
     return (byte & ~mask) | (set ? mask : 0);
@@ -255,7 +255,7 @@ class Base6502 {
                 this.polltime(3);
             } else {
                 this.polltime(2);
-                // TODO: check 65c12 BRK interrupt poll timing.
+                // TODO(#1063) check 65c12 BRK interrupt poll timing.
                 this.checkInt();
                 this.polltime(1);
             }
@@ -540,7 +540,7 @@ class Tube6502 extends Base6502 {
     async loadOs() {
         console.log("Loading tube rom from roms/" + this.model.os);
         const tubeRom = this.rom;
-        const data = await utils.loadData("roms/" + this.model.os);
+        const data = await loadData("roms/" + this.model.os);
         const len = data.length;
         if (len !== 2048) throw new Error("Broken ROM file (length=" + len + ")");
         for (let i = 0; i < len; ++i) {
@@ -561,25 +561,6 @@ class FakeTube {
     reset() {}
 }
 
-class FakeUserPort {
-    write() {}
-
-    read() {
-        return 0xff;
-    }
-}
-
-function fixUpConfig(config) {
-    if (config === undefined) config = {};
-    if (!config.keyLayout) config.keyLayout = "physical";
-    if (!config.cpuMultiplier) config.cpuMultiplier = 1;
-    if (!config.userPort) config.userPort = new FakeUserPort();
-    if (config.printerPort === undefined) config.printerPort = null;
-    config.extraRoms = config.extraRoms || [];
-    config.debugFlags = config.debugFlags || {};
-    return config;
-}
-
 class DebugHook {
     constructor(cpu, functionName) {
         this.cpu = cpu;
@@ -645,7 +626,8 @@ export class Cpu6502 extends Base6502 {
         } = {},
     ) {
         super(model, { cycleAccurate });
-        this.config = fixUpConfig(config);
+        this.config = config;
+        this.keyLayout = config.keyLayout;
         this.debugFlags = this.config.debugFlags;
         this.cmos = cmos;
         this.debugger = dbgr;
@@ -702,12 +684,14 @@ export class Cpu6502 extends Base6502 {
             soundChip: this.soundChip,
             cmos: this.cmos,
             isMaster: this.model.isMaster,
-            initialLayout: this.config.keyLayout,
+            initialLayout: this.keyLayout,
             getGamepads: this.config.getGamepads,
         });
         this.uservia = new via.UserVia(this, this.scheduler, this.model.isMaster, this.config.userPort);
         this.acia = new Acia(this, this.soundChip.toneGenerator, this.scheduler, this.relayNoise);
         this.serial = new Serial(this.acia);
+        this.keyboardInterface = this.sysvia;
+        this.tapeInterface = this.acia;
         this.adconverter = new Adc(this.sysvia, this.scheduler);
         this.touchScreen = new TouchScreen(this.scheduler, this.model.cyclesPerSecond);
         this.soundChip.setScheduler(this.scheduler);
@@ -826,7 +810,7 @@ export class Cpu6502 extends Base6502 {
     readArea(addr, len) {
         let str = "";
         for (let i = 0; i < len; ++i) {
-            str += utils.hexbyte(this.readmem(addr + i));
+            str += hexbyte(this.readmem(addr + i));
         }
         return str;
     }
@@ -1003,7 +987,7 @@ export class Cpu6502 extends Base6502 {
             const offset = this.memLook[statOffset];
             return this.ramRomOs[offset + addr];
         } else {
-            return 0xff; // TODO; peekDevice -- this.peekDevice(addr);
+            return 0xff; // TODO(#1062) peekDevice: this.peekDevice(addr);
         }
     }
 
@@ -1165,9 +1149,9 @@ export class Cpu6502 extends Base6502 {
         if (name.indexOf("http") !== 0) name = "roms/" + name;
         console.log("Loading ROM from " + name);
         const ramRomOs = this.ramRomOs;
-        let data = await utils.loadData(name);
+        let data = await loadData(name);
         if (/\.zip/i.test(name)) {
-            data = (await utils.unzipRomImage(data)).data;
+            data = (await unzipRomImage(data)).data;
         }
         ramRomOs.set(data, offset);
     }
@@ -1177,7 +1161,7 @@ export class Cpu6502 extends Base6502 {
         os = "roms/" + os;
         console.log(`Loading OS from ${os}`);
         const ramRomOs = this.ramRomOs;
-        const data = await utils.loadData(os);
+        const data = await loadData(os);
         const len = data.length;
         if (len < 16384 || len & 16383) throw new Error(`Broken OS ROM file (length=${len})`);
         ramRomOs.set(data, this.osOffset);
@@ -1410,7 +1394,7 @@ export class Cpu6502 extends Base6502 {
     }
 
     updateKeyLayout() {
-        this.sysvia.setKeyLayout(this.config.keyLayout);
+        this.sysvia.setKeyLayout(this.keyLayout);
     }
 
     polltimeAddr(cycles, addr, isWrite) {
@@ -1555,6 +1539,12 @@ export class Cpu6502 extends Base6502 {
         this.halted = true;
     }
 
+    /** Changes the host key layout for the keyboard, and for every reset after it. */
+    setKeyLayout(layout) {
+        this.keyLayout = layout;
+        this.sysvia.setKeyLayout(layout);
+    }
+
     dumpTrace(maxToShow, func) {
         if (!maxToShow) maxToShow = 256;
         if (maxToShow > 256) maxToShow = 256;
@@ -1564,11 +1554,11 @@ export class Cpu6502 extends Base6502 {
             function (pc, a, x, y) {
                 const dis = disassembler.disassemble(pc, true)[0];
                 console.log(
-                    utils.hexword(pc),
+                    hexword(pc),
                     (dis + "                       ").substring(0, 15),
-                    utils.hexbyte(a),
-                    utils.hexbyte(x),
-                    utils.hexbyte(y),
+                    hexbyte(a),
+                    hexbyte(x),
+                    hexbyte(y),
                 );
             };
         for (let i = maxToShow - 2; i >= 0; --i) {
@@ -1613,12 +1603,19 @@ const NumBranquartBanks = 16;
 const AtomRomBlockSize = 0x1000; // 4KB
 
 export class AtomCpu6502 extends Cpu6502 {
+    setKeyLayout(layout) {
+        this.keyLayout = layout;
+        this.atomppia.setKeyLayout(layout);
+    }
+
     constructor(model, options) {
         super(model, options);
 
         // Atom peripherals
-        this.atomppia = new AtomPPIA(this, this.config.keyLayout, this.scheduler);
+        this.atomppia = new AtomPPIA(this, this.keyLayout, this.scheduler);
         this.atommc = new AtomMMC2(this);
+        this.keyboardInterface = this.atomppia;
+        this.tapeInterface = this.atomppia;
 
         // Branquart bank selection
         this.branquartLatch = 0;
@@ -1785,7 +1782,7 @@ export class AtomCpu6502 extends Cpu6502 {
         const bankRoms = this.model.banks || [];
         os = "roms/" + os;
         console.log(`Loading Atom OS from ${os}`);
-        const data = await utils.loadData(os);
+        const data = await loadData(os);
         const len = data.length;
 
         if (len < AtomRomBlockSize || len % AtomRomBlockSize !== 0) {
@@ -1825,9 +1822,9 @@ export class AtomCpu6502 extends Cpu6502 {
     // Override loadRom to accept 4KB ROMs
     async loadRom(name, offset) {
         if (name.indexOf("http") !== 0) name = "roms/" + name;
-        let data = await utils.loadData(name);
+        let data = await loadData(name);
         if (/\.zip/i.test(name)) {
-            data = (await utils.unzipRomImage(data)).data;
+            data = (await unzipRomImage(data)).data;
         }
         const len = data.length;
         if (len !== 16384 && len !== 8192 && len !== 4096) {
@@ -1838,7 +1835,7 @@ export class AtomCpu6502 extends Cpu6502 {
 
     // Atom key layout goes through PPIA, not SysVia
     updateKeyLayout() {
-        this.atomppia.setKeyLayout(this.config.keyLayout);
+        this.atomppia.setKeyLayout(this.keyLayout);
     }
 
     snapshotState(options) {

package/src/6502.opcodes.js

@@ -1,9 +1,5 @@
-"use strict";
-import * as utils from "./utils.js";
-
-const hexword = utils.hexword;
-const hexbyte = utils.hexbyte;
-const signExtend = utils.signExtend;
+import { signExtend } from "./binary.js";
+import { hexbyte, hexword } from "./hex.js";
 
 function rotate(left, logical) {
     const lines = [];
@@ -1072,13 +1068,13 @@ class Disassemble6502 {
             case "()": {
                 const zp = this.cpu.peekmem(addr + 1);
                 const destAddr = this.cpu.peekmem(zp) | (this.cpu.peekmem(zp + 1) << 8);
-                return [`${split[0]} ($${hexbyte(zp)})${suffix} ; $${utils.hexword(destAddr)}${suffix2}`, addr + 2];
+                return [`${split[0]} ($${hexbyte(zp)})${suffix} ; $${hexword(destAddr)}${suffix2}`, addr + 2];
             }
             case "(abs)": {
                 const destAddr = this.cpu.peekmem(addr + 1) | (this.cpu.peekmem(addr + 2) << 8);
                 const indDest = this.cpu.peekmem(destAddr) | (this.cpu.peekmem(destAddr + 1) << 8);
                 return [
-                    `${split[0]} ($${formatJumpAddr(destAddr)})${suffix} ; $${utils.hexword(indDest)}${suffix2}`,
+                    `${split[0]} ($${formatJumpAddr(destAddr)})${suffix} ; $${hexword(indDest)}${suffix2}`,
                     addr + 3,
                     indDest,
                 ];
@@ -1390,12 +1386,10 @@ function makeCpuFunctions(cpu, opcodes, undocumented, is65c12, cycleAccurate = t
             indent +
             [
                 '"use strict";',
-                `// ${utils.hexbyte(opcodeNum)} - ${opcode}
+                `// ${hexbyte(opcodeNum)} - ${opcode}
 `,
             ].concat(
-                opcode
-                    ? getInstruction(opcode, !!needsReg)
-                    : [`this.invalidOpcode(cpu, 0x${utils.hexbyte(opcodeNum)});`],
+                opcode ? getInstruction(opcode, !!needsReg) : [`this.invalidOpcode(cpu, 0x${hexbyte(opcodeNum)});`],
             ).join(`
 ${indent}`)
         );
@@ -1408,7 +1402,7 @@ ${indent}`)
         const funcs = [];
         for (let opcodeNum = 0; opcodeNum < 256; ++opcodeNum) {
             const opcodeFunc = new Function("cpu", getIndentedSource("  ", opcodeNum, true));
-            let funcName = `exec_${utils.hexbyte(opcodeNum)}_`;
+            let funcName = `exec_${hexbyte(opcodeNum)}_`;
             if (opcodes[opcodeNum]) {
                 const instrName = opcodes[opcodeNum]
                     .replace("()", "ind")

package/src/6847.js

@@ -1,7 +1,6 @@
-"use strict";
-import * as utils from "./utils.js";
 import * as fontData from "./6847_fontdata.js";
 import { encodeLineGrid } from "./video-filters/pixel-grid.js";
+import { makeFast32 } from "./binary.js";
 
 const VDISPENABLE = 1 << 0,
     HDISPENABLE = 1 << 1,
@@ -114,7 +113,7 @@ const MODE_AG = 0x10; // graphics mode
 
 // The MC6847 datasheet specifies 3.579545 MHz, but 3.638004 is used here as an
 // empirical correction to align VSync/interrupt timing with the CPU clock.
-// TODO: revisit once full integration is testable.
+// TODO(#1067) revisit once full integration is testable.
 const VdgClockMhz = 3.638004;
 
 export class Video6847 {
@@ -127,7 +126,7 @@ export class Video6847 {
 
         // 8 colours (alpha on MSB)
         //
-        this.collook = utils.makeFast32(
+        this.collook = makeFast32(
             new Uint32Array([
                 0xff000000, // #00000000, // black
                 0xff03b91e, // #00ff00, // green
@@ -496,7 +495,7 @@ export class Video6847 {
                     // Render data depending on display enable state.
                     if (this.bitmapX >= 0 && this.bitmapX < 1024 && this.bitmapY < 625) {
                         {
-                            // TODO: Add in the INTEXT modifiers to mode (if necessary)
+                            // TODO(#1067) Add in the INTEXT modifiers to mode (if necessary)
                             // blit into the fb32 buffer which is painted by VIDEO
                             const textMode = (mode & MODE_AG) === 0; // 0x10 is the AG bit
                             this.recordLineGrid(textMode);

package/src/6847_fontdata.js

@@ -1,5 +1,3 @@
-"use strict";
-
 // MC6847 internal character ROM data (PAL square pixel variant, 8x12).
 // Derived from the MAME project's MC6847 VDG emulation:
 //   https://github.com/mamedev/mame/blob/master/src/devices/video/mc6847.cpp

package/src/acia.js

@@ -1,4 +1,3 @@
-"use strict";
 // Some info:
 // http://www.playvectrex.com/designit/lecture/UP12.HTM
 // https://books.google.com/books?id=wUecAQAAQBAJ&pg=PA431&lpg=PA431&dq=acia+tdre&source=bl&ots=mp-yF-mK-P&sig=e6aXkFRfiIOb57WZmrvdIGsCooI&hl=en&sa=X&ei=0g2fVdDyFIXT-QG8-JD4BA&ved=0CCwQ6AEwAw#v=onepage&q=acia%20tdre&f=false
@@ -52,7 +51,7 @@ export class Acia extends EventTarget {
     }
 
     reset() {
-        // TODO: testing on a real beeb seems to suggest that reset also
+        // TODO(#1064) testing on a real beeb seems to suggest that reset also
         // clears CR bits (i.e. things stop working until CR is rewritten
         // with sane value). This disagrees with the datasheet.
         // CTS and DTD are based on external inputs so leave them alone.
@@ -199,7 +198,7 @@ export class Acia extends EventTarget {
         byte |= 0;
         if (this.sr & 0x01) {
             // Overrun.
-            // TODO: this doesn't match the datasheet:
+            // TODO(#1064) this doesn't match the datasheet:
             // "The Overrun does not occur in the Status Register until the
             // valid character prior to Overrun has been read."
             this.sr |= 0xa0;

package/src/app/app.js

@@ -1,4 +1,3 @@
-"use strict";
 import { app, BrowserWindow, dialog, ipcMain, Menu, shell, nativeImage } from "electron";
 import Store from "electron-store";
 import * as fs from "fs";

package/src/app/args.js

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Returns the command-line arguments the user actually passed to jsbeeb, with
  * the Electron binary path(s) and known runtime-injected flags stripped.

package/src/app/electron.js

@@ -1,10 +1,8 @@
-"use strict";
-
 // Electron integration for jsbeeb desktop application.
 // Handles IPC communication for loading disc/tape images and showing modals from Electron's main process.
 
 function init(args) {
-    const { loadDiscImage, loadTapeImage, loadStateFile, processor, modals, actions, config, media } = args;
+    const { loadDiscImage, loadTapeImage, loadStateFile, processor, modals, actions, settings, media } = args;
     const api = window.electronAPI;
 
     api.onLoadDisc(async (message) => {
@@ -16,7 +14,7 @@ function init(args) {
     api.onLoadTape(async (message) => {
         const { path } = message;
         const tape = await loadTapeImage(path);
-        processor.acia.setTape(tape);
+        processor.tapeInterface.setTape(tape);
     });
 
     api.onShowModal((message) => {
@@ -54,8 +52,8 @@ function init(args) {
     }
 
     // Save settings when they change
-    if (config) {
-        config.addEventListener("settings-changed", (e) => {
+    if (settings) {
+        settings.addEventListener("change", (e) => {
             api.saveSettings(e.detail);
         });
     }

package/src/app-bench.js

@@ -1,5 +1,3 @@
-"use strict";
-
 import { fake6502 } from "./fake6502.js";
 import * as models from "./models.js";
 import * as disc from "./fdc.js";
@@ -23,7 +21,7 @@ async function main() {
     const cpu = fake6502(models.findModel("B"));
     await cpu.initialise();
     const data = await disc.load("discs/" + discName + ".ssd");
-    cpu.fdc.loadDisc(0, disc.discFor(cpu.fdc, discName, data));
+    cpu.fdc.loadDisc(0, disc.discFor(discName, data));
     cpu.sysvia.keyDown(16);
     cpu.execute(10 * 1000 * 1000);
     cpu.sysvia.keyUp(16);