mirror of
https://github.com/JetSetIlly/Gopher2600.git
synced 2024-05-20 13:48:02 -04:00
64 lines
2.7 KiB
Go
64 lines
2.7 KiB
Go
// This file is part of Gopher2600.
|
|
//
|
|
// Gopher2600 is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Gopher2600 is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Gopher2600. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
// Package debugger implements a reaonably comprehensive debugging tool.
|
|
// Features include:
|
|
//
|
|
// - cartridge disassembly
|
|
// - memory peek and poke
|
|
// - cpu and video cycle stepping
|
|
// - basic scripting
|
|
// - breakpoints
|
|
// - traps
|
|
// - watches
|
|
//
|
|
// Some of these features come courtesy of other packages, described elsewhere,
|
|
// and some are inherent in the gopher2600's emulation strategy, but all are
|
|
// nicely exposed via the debugger package.
|
|
//
|
|
// Initialisation of the debugger is done with the NewDebugger() function
|
|
//
|
|
// dbg, _ := debugger.NewDebugger(television, gui, term)
|
|
//
|
|
// The tv, gui and term arguments must be instances of types that satisfy the
|
|
// respective interfaces. This gives the debugger great flexibility and should
|
|
// allow easy porting to new platforms
|
|
//
|
|
// Interaction with the debugger is primarily through a terminal. The Terminal
|
|
// interface is defined in the terminal package. The colorterm and plainterm
|
|
// sub-packages provide good reference implementations.
|
|
//
|
|
// The GUI helps visualise the television and coordinates events (keyboard,
|
|
// mouse) which the debugger can then poll. A good reference implementation of
|
|
// a debugging GUI can be in found the gui.sdldebug package.
|
|
//
|
|
// The television argument should be an instance of TV. For all practical
|
|
// purposes this will be instance createed with television.NewTelevision(), but
|
|
// other implementations are possible if not yet available.
|
|
//
|
|
// Once initialised, the debugger can be started with the Start() function.
|
|
//
|
|
// dbg.Start(initScript, cartloader)
|
|
//
|
|
// The initscript is a script previously created either by the script.Scribe
|
|
// package or by hand. The cartloader argument must be an instance of
|
|
// cartloader.
|
|
//
|
|
// Interaction with the debugger for both user and programs that use the
|
|
// debugger, is through the Terminal interface (see terminal package). Where
|
|
// this is not possible, functions have been provided. For interaction from
|
|
// other goroutines, PushFunction() should be used.
|
|
package debugger
|