Gopher2600/debugger/script.go

package debugger

import (
	"fmt"
	"gopher2600/debugger/ui"
	"gopher2600/errors"
	"os"
	"strings"
)

func (dbg *Debugger) loadScript(scriptfile string) ([]string, error) {

	// open script and defer closing
	sf, err := os.Open(scriptfile)
	if err != nil {
		return nil, errors.NewGopherError(errors.ScriptFileCannotOpen, err)
	}
	defer func() {
		_ = sf.Close()
	}()

	// get file info
	sfi, err := sf.Stat()
	if err != nil {
		return nil, err
	}

	// allocate enough memory for new cartridge
	buffer := make([]uint8, sfi.Size())

	// read script file
	n, err := sf.Read(buffer)
	if err != nil {
		return nil, err
	}
	if n != len(buffer) {
		return nil, errors.NewGopherError(errors.ScriptFileError, errors.FileTruncated)
	}

	// convert buffer to an array of lines
	s := fmt.Sprintf("%s", buffer)
	return strings.Split(s, "\n"), nil
}

// RunScript uses a text file as a source for a sequence of commands
func (dbg *Debugger) RunScript(scriptfile string, silent bool) error {

	// the silent flag passed to this function is meant to silence commands for
	// the duration of the script only. store existing state of dbg.silent so we
	// can restore it when script has concluded
	uiSilentRestore := dbg.uiSilent
	dbg.uiSilent = silent
	defer func() {
		dbg.uiSilent = uiSilentRestore
	}()

	// load file
	lines, err := dbg.loadScript(scriptfile)
	if err != nil {
		return err
	}

	// parse each line as user input
	for i := 0; i < len(lines); i++ {
		if strings.Trim(lines[i], " ") != "" {
			if !silent {
				dbg.print(ui.Script, lines[i])
			}
			next, err := dbg.parseInput(lines[i])
			if err != nil {
				dbg.print(ui.Error, fmt.Sprintf("script error (%s): %s", scriptfile, err.Error()))
			}
			if next {
				dbg.print(ui.Error, fmt.Sprintf("script error (%s): use of '%s' is not recommended in scripts", scriptfile, lines[i]))

				// make sure run state is still sane
				dbg.runUntilHalt = false
			}
		}
	}

	return nil
}