SCRYMAMEReferenceBreakpointsAlso in DOSBox-X
The Breakpoints tools
These tools set breakpoints and watches and keep them. Each is saved as you named it, a symbol or an address, so the server sets it again at the next start, even after a rebuild moved the code.
The tools call a saved breakpoint or watch a declaration, as in declaration_list. The debugger holds what is set now; the saved breakpoints file holds what you asked for. What they share is in REFERENCE.md, Breakpoints and watches.
A registerpoint (regpoint in the tool names) is MAME's stop when a condition on the registers comes true.
What each state means
Every reply of these tools, and every row they list, carries a state.
state |
what it means |
|---|---|
armed |
Set in the debugger and able to fire. |
disabled |
The debugger lists it switched off. It does not fire until it is enabled there. |
evaluated |
A show or expr watch. Nothing is set in the debugger: the value is read at every stop. |
pending |
A count or capture watch sent to MAME and not installed yet. |
unresolved |
Its symbol, or a symbol its condition names, is not in this build. It stays saved and sets nothing until a build has it. |
null_pointer |
A watch through a pointer that reads zero. It stays saved and is looked up again at every stop. |
stale |
A raw address saved over another build: another ROM or symbol file. It stays saved and is not set until you declare it again. |
gone |
Saved, but the debugger no longer lists its row. |
aliased |
Another saved breakpoint holds the debugger's row at this address, so this one sets nothing. |
A row also says inherited: true when an earlier session saved it. foreign lists debugger rows the server did not set, such as one typed through debug: they are listed and never deleted.
The tools
breakpoint_atSet a breakpoint at a symbol or an address, to stop there or to count how often the code runs.regpoint_addStop the machine when a condition on the registers comes true, wherever the program is, to find who puts a value in a register.watch_addKeep a variable in view at every stop, stop the machine when it is written, or count every write to it, by name.declaration_listList the saved breakpoints, registerpoints and watches, each with its state checked against the debugger's own list.declaration_clearRemove saved breakpoints, registerpoints or watches: one by itsref, or every one of a kind.