Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | 5x 5x 5x 5x 5x 5x 50x 5x 5x 5x 5x 5x 16x 15x 15x 60x 1495x 430x 50x 50x 10x 15x 15x 60x 60x 15x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 285x 2x 285x 285x 285x 285x 8x 8x 285x 285x 16x 293x 293x 293x 293x 293x 109x 109x 293x 24x 14x 14x 293x 2103x 146x 140x 140x 140x 140x 140x 140x 287x 287x 287x 8x 8x 8x 8x 1x 1x 7x 7x 7x 8x 1x 1x 6x 6x 1x 1x 5x 5x 16x 161x 161x 161x 14x 14x 14x 161x 16x 16x 16x 16x 16x 96x 65x 4x 2x 2x 2x 2x 1x 1x 1x 1x 20x 20x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 415x 353x 353x 174x 174x 174x 174x 174x 174x 174x 1218x 1218x 1218x 1218x 1218x 174x 174x 174x 174x 174x 174x 174x 8x 8x 5x 5x 2x 5x 166x 166x 8x 166x 174x 174x 174x 174x 174x 174x 174x 174x 174x 2x 174x 174x 174x 1x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 15x 15x 15x 353x 353x 7x 7x 7x 7x 7x 7x 7x 6x 5x 5x 5x 2x 2x 3x 7x 6x 5x 5x 7x 7x 7x 293x 293x 4x 11x 11x 3x 3x 3x 2x 2x 2x 1x 1240x 109x 138x 111x 109x 109x | import { SidewaysEnd, SidewaysStart } from "../paging.js";
import { machineSheilaBlocks } from "../sheila.js";
import { addressRange } from "./debug-dom.js";
import { PopupMenu, setText, textButton } from "./dom-utils.js";
import { DebugGroup, MenuGroup, panelShell } from "./floating-panel.js";
import { EndEdge } from "./panel-layout.js";
import { readStored, writeStored } from "./stored-json.js";
const MinPanelSize = { w: 360, h: 100 };
const StorageKey = "debugBreakpoints";
const StoreVersion = 1;
const SavedFields = ["kind", "start", "end", "bank", "line", "condition", "hitCount", "enabled", "action", "label"];
const AddressKinds = [
{ kind: "execute", short: "X", name: "Execute", title: "Acts before the CPU runs an instruction here" },
{ kind: "read", short: "R", name: "Read", title: "Acts after an instruction reads here, fetches included" },
{ kind: "write", short: "W", name: "Write", title: "Acts after an instruction writes here" },
{ kind: "access", short: "RW", name: "Read or write", title: "Acts after an instruction reads or writes here" },
];
const EventKinds = [
{ kind: "brk", short: "BRK", name: "BRK", where: "any BRK", title: "Acts before the CPU runs a BRK" },
{
kind: "undocumented",
short: "UND",
name: "Undocumented opcode",
where: "any undocumented opcode",
title: "Acts before the CPU runs an opcode its makers left undocumented",
},
{
kind: "irq",
short: "IRQ",
name: "IRQ",
where: "IRQ entry",
title: "Acts as the CPU takes an IRQ, before its handler runs",
},
{
kind: "nmi",
short: "NMI",
name: "NMI",
where: "NMI entry",
title: "Acts as the CPU takes an NMI, before its handler runs",
},
{
kind: "vsync",
short: "VS",
name: "Vsync",
where: "vsync start",
title: "Acts before the first instruction in vsync",
},
{
kind: "line",
short: "LN",
name: "Raster line",
where: "line",
title: "Acts before the first instruction on the TV line typed in the field beside, counted from vsync",
},
];
const KindOf = new Map([...AddressKinds, ...EventKinds].map((kind) => [kind.kind, kind]));
const RangeSeparator = /\s*-\s*/;
const WholeNumber = /^\d+$/;
const IoStart = 0xfc00;
const IoEnd = 0xfeff;
// The System VIA's port B drives IC32's latch; a write of 0 to its low four bits clears bit 0, the sound chip's
// write enable.
const SoundWriteCondition = "(value AND 15) = 0";
/**
* Common stops that are ordinary address breakpoints on the machine `cpu` emulates, each at the SHEILA register it
* watches, so left out where the machine has no such register.
*/
function presetStops(cpu) {
if (cpu.model.isAtom) return [];
const blocks = machineSheilaBlocks(cpu);
/** The first address taking a write to `name`, or the whole of its block where it is the block's one register. */
const written = (name) => {
for (const block of blocks) {
const index = block.registers.findIndex((register) => register.write === name);
if (index < 0) continue;
const start = block.start + index;
return { start, end: block.registers.length === 1 ? block.end - 1 : start };
}
return null;
};
const presets = [
{
name: "Code in I/O",
title: "Acts before the CPU runs an instruction in &FC00-&FEFF",
spec: { kind: "execute", start: IoStart, end: IoEnd, label: "I/O" },
},
];
for (const [register, name, label, title, condition] of [
["ROMSEL", "ROMSEL write", "ROMSEL", "Acts after a write to ROMSEL, paging a sideways bank", undefined],
["ACCCON", "ACCCON write", "ACCCON", "Acts after a write to ACCCON, paging shadow and other RAM", undefined],
[
"COMMAND",
"Disc command",
"disc command",
"Acts after a command is written to the disc controller",
undefined,
],
[
"ORB",
"Sound write",
"sound",
"Acts after a System VIA write that strobes the sound chip",
SoundWriteCondition,
],
]) {
const range = written(register);
if (range) presets.push({ name, title, spec: { kind: "write", ...range, condition, label } });
}
return presets;
}
/**
* The Breakpoints panel: every breakpoint the CPU has, however it was set, each enabled or not, stopping or logging,
* with its condition and hit count, and a form to add one. It saves the user's breakpoints in browser storage, and
* puts them back on the next visit.
*/
export class BreakpointsPanel {
/**
* @param {object} options
* @param {import("./floating-panel.js").PanelArrangement} options.arrangement
* @param {(text: string) => {address: number, name: string | undefined} | undefined} options.resolve - the address
* a name or number gives, and the name if it was one
* @param {(address: number, bank: number | undefined) => string | undefined} options.nameOf - the name the
* debugger gives an address, in sideways `bank` if a breakpoint is pinned to one
* @param {(address: number, bank: number | undefined) => void} options.showCode - in `bank`, or as paged
* @param {(address: number, bank: number | undefined) => void} options.showMemory - in `bank`, or as paged
* @param {(() => Storage) | null} options.storage - where breakpoints are kept between visits, or null
*/
constructor({ arrangement, resolve, nameOf, showCode, showMemory, storage }) {
this._resolve = resolve;
this._nameOf = nameOf;
this._showCode = showCode;
this._showMemory = showMemory;
this._storage = storage;
this._cpu = null;
/** @type {import("../breakpoints.js").Breakpoints | null} */
this._breakpoints = null;
this._unrestored = [];
this._stoppedBy = null;
this._hitCells = new Map();
this._nameCells = new Map();
/** @type {{id: number, field: string, input: HTMLInputElement} | null} */
this._editing = null;
this._rendering = false;
this._newKind = AddressKinds[0];
const { floating, body } = panelShell({
id: "breakpoints",
title: "Breakpoints",
feature: "breakpoints",
menuGroup: MenuGroup.cpu,
group: DebugGroup,
place: () => ({ x: EndEdge, y: EndEdge }),
minSize: MinPanelSize,
arrangement,
});
this.floating = floating;
this.panel = floating.panel;
body.innerHTML = `
<table class="bp-list"><tbody></tbody></table>
<div class="bp-empty">None set. Click beside an instruction in the disassembly, or add one here.</div>
<form class="bp-add-form" role="form">
<input type="text" class="form-control form-control-sm panel-field bp-add"
aria-label="Address, range or name to break on" placeholder="Address, range or name, then Enter" />
</form>`;
this._list = body.querySelector("tbody");
this._empty = body.querySelector(".bp-empty");
const form = body.querySelector(".bp-add-form");
this._input = form.querySelector(".bp-add");
this._kindButton = textButton("bp-add-kind", "", "");
form.prepend(this._kindButton);
this._showNewKind(this._newKind);
this._kindButton.addEventListener("click", () =>
this._showNewKind(AddressKinds[(AddressKinds.indexOf(this._newKind) + 1) % AddressKinds.length]),
);
this._stopOn = textButton("bp-stop-on", "Stop on…", "Add a stop that has no address, or a common one");
form.append(this._stopOn);
this._input.addEventListener("input", () => this._invalid(this._input, null));
form.addEventListener("submit", (e) => {
e.preventDefault();
this._addTyped();
});
floating.whileOpen(() => this.update());
this._stopMenu = new PopupMenu({
opener: this._stopOn,
className: "bp-stop-menu",
floating: this.floating,
build: () => this._stopChoices(),
});
}
/** Shows `cpu`'s breakpoints, first putting back the ones saved on an earlier visit. */
setCpu(cpu) {
this._stopMenu.show(false);
this._cpu = cpu;
this._breakpoints = cpu.breakpoints;
this._restore();
this._breakpoints.onChange(() => {
this._save();
this._render();
});
this._breakpoints.onHit((hit) => {
if (hit.action !== "stop" || this._stoppedBy === hit.id) return;
this._stoppedBy = hit.id;
this._render();
});
this._render();
}
/** Shows each breakpoint's hits as they are now, and its address's name, which can come with symbols later. */
update() {
// Naming asks for the symbols, which a closed panel has no need of.
if (!this._breakpoints || !this.floating.isOpen) return;
for (const { id, start, bank, hits, hitCount, label } of this._breakpoints.list()) {
const hitText = hitCount > 1 ? `${hits} of ${hitCount}` : `${hits}`;
const hitCell = this._hitCells.get(id);
Eif (hitCell) setText(hitCell, hitText);
const nameText = label ?? (start === undefined ? undefined : this._nameOf(start, bank)) ?? "";
const nameCell = this._nameCells.get(id);
Eif (nameCell) setText(nameCell, nameText);
}
}
_showNewKind(kind) {
this._newKind = kind;
this._kindButton.textContent = kind.name;
this._kindButton.title = `${kind.title}; click for another kind`;
}
_addTyped() {
const text = this._input.value.trim();
Iif (!text) return;
const parts = text.split(RangeSeparator);
if (parts.length > 2) {
this._invalid(this._input, `"${text}" is not an address or a range of two`);
return;
}
const [from, to] = parts;
const start = this._resolve(from);
const end = to === undefined ? start : this._resolve(to);
if (!start || !end) {
this._invalid(this._input, `No address called "${!start ? from : to}"`);
return;
}
try {
this._breakpoints.add({
kind: this._newKind.kind,
start: start.address,
end: end.address,
label: to === undefined ? start.name : undefined,
});
} catch (error) {
this._invalid(this._input, error.message);
return;
}
this._input.value = "";
this._input.blur();
}
_stopChoices() {
const choice = ({ name, title }, add) => {
const button = textButton("bp-stop-choice", name, title);
button.setAttribute("role", "menuitem");
button.addEventListener("click", () => {
this._stopMenu.show(false);
add();
this._input.blur();
});
return button;
};
const presets = presetStops(this._cpu);
const rule = document.createElement("hr");
rule.className = "bp-stop-rule";
rule.hidden = presets.length === 0;
return [
...EventKinds.map((kind) => choice(kind, () => this._addEvent(kind.kind))),
rule,
...presets.map((preset) => choice(preset, () => this._breakpoints.add(preset.spec))),
];
}
_addEvent(kind) {
if (kind !== "line") {
this._breakpoints.add({ kind });
return;
}
const text = this._input.value.trim();
if (!WholeNumber.test(text)) {
this._invalid(this._input, "Type the TV line to stop at here, then pick Raster line");
return;
}
this._breakpoints.add({ kind, line: Number(text) });
this._input.value = "";
}
_invalid(input, message) {
input.classList.toggle("is-invalid", message !== null);
input.title = message ?? "";
}
/** Lists the breakpoints again, keeping a field being edited, with the keyboard, in its breakpoint's new row. */
_render() {
this._rendering = true;
try {
this._list.replaceChildren();
this._hitCells.clear();
this._nameCells.clear();
const all = this._breakpoints.list();
for (const breakpoint of all) this._list.append(this._row(breakpoint));
this._empty.hidden = all.length > 0;
this.update();
} finally {
this._rendering = false;
}
const editing = this._editing;
if (editing && this._list.contains(editing.input)) editing.input.focus();
else this._editing = null;
}
/** `button`, or the field editing `field` of breakpoint `id` in its place. */
_orEditing(button, id, field) {
const editing = this._editing;
return editing?.id === id && editing.field === field ? editing.input : button;
}
_row(breakpoint) {
const { id, kind, start, end, bank, condition, enabled, action, owner } = breakpoint;
const change = (changes) => this._breakpoints.update(id, changes);
const row = document.createElement("tr");
row.dataset.id = String(id);
row.classList.toggle("bp-stopped", this._stoppedBy === id);
if (this._stoppedBy === id) row.title = "This breakpoint stopped the machine last";
const cell = (className, ...content) => {
const td = document.createElement("td");
td.className = className;
td.append(...content);
row.append(td);
return td;
};
const enable = textButton(
`bp-enabled bp_gutter ${enabled ? "active" : "disabled"}`,
"",
enabled ? "Enabled; click to disable" : "Disabled; click to enable",
);
enable.addEventListener("click", () => change({ enabled: !enabled }));
cell("", enable);
const { short, where: eventWhere, title } = KindOf.get(kind);
cell("bp-kind", short).title = title;
const whereCell = cell("bp-address");
if (start === undefined) {
whereCell.append(eventWhere);
if (kind === "line") {
const line = textButton("bp-line", String(breakpoint.line), "");
this._editOnClick(line, { id, field: "line" }, String(breakpoint.line), "TV line", (text) =>
change({ line: WholeNumber.test(text.trim()) ? Number(text) : text }),
);
whereCell.append(" ", this._orEditing(line, id, "line"));
}
} else {
const where = textButton("bp-where", addressRange(breakpoint), `Show ${addressRange(breakpoint)}`);
where.addEventListener("click", () =>
kind === "execute" ? this._showCode(start, bank) : this._showMemory(start, bank),
);
whereCell.append(where);
}
const name = document.createElement("span");
name.className = "bp-name";
this._nameCells.set(id, name);
whereCell.append(name);
if (owner !== "user") whereCell.append(` (from ${owner})`);
const sideways = !this._cpu.model.isAtom && start >= SidewaysStart && end < SidewaysEnd;
if (sideways || bank !== undefined) whereCell.append(this._bankButton(bank, change));
const conditionButton = textButton(condition ? "" : "bp-placeholder", condition ?? "always", "");
this._editOnClick(conditionButton, { id, field: "condition" }, condition ?? "", "Condition", (text) =>
change({ condition: text }),
);
cell("bp-condition", this._orEditing(conditionButton, id, "condition"));
const hits = textButton("bp-hits", "", "");
this._editOnClick(
hits,
{ id, field: "hitCount" },
String(breakpoint.hitCount),
"Hits so far; the hit to stop from",
(text) => change({ hitCount: Number(text) }),
);
this._hitCells.set(id, hits);
cell("bp-hit-count", this._orEditing(hits, id, "hitCount"));
const actionButton = textButton(
"bp-action",
action,
action === "stop"
? "Stops the machine; click to log hits to the console instead"
: "Logs each hit to the console; click to stop instead",
);
actionButton.addEventListener("click", () => change({ action: action === "stop" ? "log" : "stop" }));
cell("", actionButton);
const what =
start === undefined ? `the ${eventWhere} breakpoint` : `the breakpoint at ${addressRange(breakpoint)}`;
const remove = textButton("bp-remove", "×", `Remove ${what}`);
remove.setAttribute("aria-label", remove.title);
remove.addEventListener("click", () => this._breakpoints.remove(id));
cell("", remove);
return row;
}
_bankButton(bank, change) {
const button = textButton(
"bp-bank",
bank === undefined ? "any ROM" : `ROM ${bank}`,
bank === undefined
? "Stops whichever ROM is paged in; click to stop only in the one paged in then"
: `Stops only while ROM ${bank} is paged in; click for any ROM`,
);
button.addEventListener("click", () => change({ bank: bank === undefined ? this._cpu.pagedBank : undefined }));
return button;
}
/**
* Makes `button` turn into a field editing `what` (`field` of breakpoint `id`), holding `text`, when clicked. It
* commits on Enter, and puts the button back, as it was, on Escape or on leaving it. A change the field cannot
* take marks it, with the reason as its tooltip.
*/
_editOnClick(button, { id, field }, text, what, commit) {
button.title = `${what}; click to change`;
button.addEventListener("click", () => {
const input = document.createElement("input");
input.type = "text";
input.className = "form-control form-control-sm panel-field bp-edit";
input.value = text;
input.setAttribute("aria-label", what);
input.addEventListener("input", () => this._invalid(input, null));
input.addEventListener("keydown", (e) => {
if (e.key !== "Enter") return;
e.preventDefault();
try {
commit(input.value);
} catch (error) {
this._invalid(input, error.message);
return;
}
input.blur();
});
// Moving the field into a redrawn row, or the window losing focus (say to the browser's console), blurs it
// without leaving it.
input.addEventListener("blur", () => {
if (this._rendering || !document.hasFocus()) return;
if (this._editing?.input === input) this._editing = null;
this._render();
});
this._editing = { id, field, input };
button.replaceWith(input);
input.focus();
});
}
_restore() {
const saved = readStored(this._storage, StorageKey, "the saved breakpoints");
if (saved?.version !== StoreVersion || !Array.isArray(saved.breakpoints)) return;
for (const spec of saved.breakpoints) {
try {
this._breakpoints.add(this._specOf(spec));
} catch (error) {
if (this._fitsAnotherBank(spec)) this._unrestored.push(spec);
console.warn(`Could not put back a saved breakpoint: ${error.message}`);
}
}
}
/** Whether `spec` is a breakpoint but for its bank, which another model may have a socket for. */
_fitsAnotherBank(spec) {
if (spec?.bank === undefined) return false;
try {
this._breakpoints.check({ ...this._specOf(spec), bank: undefined });
return true;
} catch {
return false;
}
}
_specOf(saved) {
return Object.fromEntries(SavedFields.map((field) => [field, saved?.[field]]));
}
_save() {
const breakpoints = this._breakpoints
.list()
.filter(({ owner }) => owner === "user")
.map((breakpoint) => this._specOf(breakpoint));
const saved = { version: StoreVersion, breakpoints: [...breakpoints, ...this._unrestored] };
writeStored(this._storage, StorageKey, saved, "the breakpoints");
}
}
|