// 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/>.
//
// *** NOTE: all historical versions of this file, as found in any
// git repository, are also covered by the licence, even when this
// notice is not present ***

package errors

// error messages
const (
	// panics
	PanicError = "panic: %v: %v"

	// sentinals
	UserInterrupt        = "user interrupt"
	UserSuspend          = "user suspend"
	ScriptEnd            = "end of script (%v)"
	PowerOff             = "emulated machine has been powered off"
	InputDeviceUnplugged = "controller unplugged from %v"
	TVOutOfSpec          = "tv out of spec: %v"

	// program modes
	PlayError        = "error emulating vcs: %v"
	DebuggerError    = "error debugging vcs: %v"
	PerformanceError = "error during performance profiling: %v"
	DisassemblyError = "error during disassembly: %v"

	// debugger
	InvalidTarget = "invalid target (%v)"
	CommandError  = "%v"
	TerminalError = "%v"
	GUIEventError = "%v"

	// commandline
	ParserError     = "parser error: %v"
	HelpError       = "help error: %v"
	ValidationError = "%v"

	// dissassembly
	DisasmError = "disasm error: %v"

	// script
	ScriptFileError       = "script error: %v"
	ScriptFileUnavailable = "script error: cannot open script file (%v)"
	ScriptRunError        = "script error: use of '%v' is not allowed in scripts [%v::%d]"
	ScriptScribeError     = "script scribe error: %v"

	// recorder
	RecordingError    = "controller recording error: %v"
	PlaybackError     = "controller playback error: %v"
	PlaybackHashError = "controller playback error: hash error: %v"

	// database
	DatabaseError           = "database error: %v"
	DatabaseReadError       = "database error: %v [line %d]"
	DatabaseSelectEmpty     = "database error: no selected entries"
	DatabaseKeyError        = "database error: no such key in database [%v]"
	DatabaseFileUnavailable = "database error: cannot open database (%v)"

	// regression
	RegressionError         = "regression test error: %v"
	RegressionDigestError   = "digest entry: %v"
	RegressionPlaybackError = "playback entry: %v"

	// setup
	SetupError           = "setup error: %v"
	SetupPanelError      = "panel setup: %v"
	SetupPatchError      = "patch setup: %v"
	SetupTelevisionError = "tv setup: %v"

	// patch
	PatchError     = "patch error: %v"
	PatchFileError = "patch error: patch file not found (%v)"

	// symbols
	SymbolsFileError       = "symbols error: error processing symbols file: %v"
	SymbolsFileUnavailable = "symbols error: no symbols file for %v"
	SymbolUnknown          = "symbols error: unrecognised symbol (%v)"

	// cartridgeloader
	CartridgeLoader = "cartridge loading error: %v"

	// vcs
	PolycounterError = "polycounter error: %v"

	// cpu
	UnimplementedInstruction       = "cpu error: unimplemented instruction (%#02x) at (%#04x)"
	InvalidResult                  = "cpu error: %v"
	ProgramCounterCycled           = "cpu error: program counter cycled back to 0x0000"
	InvalidOperationMidInstruction = "cpu error: invalid operation mid-instruction (%v)"

	// memory
	MemoryError       = "memory error: %v"
	UnreadableAddress = "memory error: memory location is not readable (%#04x)"
	UnwritableAddress = "memory error: memory location is not writable (%#04x)"
	UnpokeableAddress = "memory error: cannot poke address (%v)"
	UnpeekableAddress = "memory error: cannot peek address (%v)"

	// cartridges
	CartridgeError      = "cartridge error: %v"
	CartridgeEjected    = "cartridge error: no cartridge attached"
	UnpatchableCartType = "cartridge error: cannot patch this cartridge type (%v)"

	// input
	InputDeviceUnavailable = "input error: controller hardware unavailable (%v)"
	UnknownInputEvent      = "input error: %v: unsupported event (%v)"

	// television
	UnknownTVRequest = "television error: unsupported request (%v)"
	Television       = "television error: %v"

	// digests
	VideoDigest = "video digest: %v"
	AudioDigest = "audio digest: %v"

	// audio2wav
	WavWriter = "wav writer: %v"

	// gui
	UnsupportedGUIRequest = "gui error: unsupported request (%v)"
	SDL                   = "SDL: %v"
)