gui

Documentation

Overview

Package gui is an abstraction layer for real GUI implementations. It defines the Events that can be passed from the GUI to the emulation code and also the Requests that can be made from the emulation code to the GUI. Implementations need to convert their specific signals and requests to and from these abstractions.

Index

• Constants
• type FeatureReq
• type FeatureReqData
• type GUI
• type Stub
  • func (s Stub) SetFeature(request FeatureReq, args ...FeatureReqData) error

Constants

const (
	UnsupportedGuiFeature = "unsupported gui feature: %v"
)

Sentinal error returned if GUI does no support requested feature.

Types

type FeatureReq

type FeatureReq string

FeatureReq is used to request the setting of a gui attribute eg. toggling the overlay.

const (
	// notify gui of the underlying emulation mode.
	ReqSetEmulationMode FeatureReq = "ReqSetEmulationMode" // emulation.Mode

	// program is ending. gui should do anything required before final exit.
	ReqEnd FeatureReq = "ReqEnd" // nil

	// whether gui should try to sync with the monitor refresh rate. not all
	// gui modes have to obey this but for presentation/play modes it's a good
	// idea to have it set.
	ReqMonitorSync FeatureReq = "ReqMonitorSync" // bool

	// whether the gui is visible or not. results in an error if requested in
	// playmode.
	ReqSetVisibility FeatureReq = "ReqSetVisibility" // bool

	// put gui output into full-screen mode (ie. no window border and content
	// the size of the monitor).
	ReqFullScreen FeatureReq = "ReqFullScreen" // bool

	// special request for PlusROM cartridges.
	ReqPlusROMFirstInstallation FeatureReq = "ReqPlusROMFirstInstallation" // none

	// controller has changed for one of the ports. the string is a description
	// of the controller.
	ReqControllerChange FeatureReq = "ReqControllerChange" // plugging.PortID, plugging.PeripheralID

	// an event generated by the emulation has occured. for example, the
	// emulation has been paused.
	ReqEmulationEvent FeatureReq = "ReqEmulationEvent" // emulation.Event

	// an event generated by the cartridge has occured. for example, network
	// activity from a PlusROM cartridge.
	ReqCartridgeEvent FeatureReq = "ReqCartridgeEvent" // mapper.Event

	// open ROM selector and return selection over channel. channel is unused
	// if emulation is a debugging emulation, in which case the 'chan string'
	// can be nil
	ReqROMSelector FeatureReq = "ReqROMSelector" // nil

	// request for a comparison window to be opened
	ReqComparison FeatureReq = "ReqComparison" // chan *image.RGBA, chan *image.RGBA

	// request for bot features to be enabled. a nil argument will cause the
	// bot features to be removed
	ReqBotFeedback FeatureReq = "ReqBotFeedback" // *bots.Feedback
)

List of valid feature requests. argument must be of the type specified or else the interface{} type conversion will fail and the application will probably crash.

Note that, like the name suggests, these are requests, they may or may not be satisfied depending other conditions in the GUI.

type FeatureReqData

type FeatureReqData interface{}

FeatureReqData represents the information associated with a FeatureReq. See commentary for the defined FeatureReq values for the underlying type.

type GUI

type GUI interface {
	// Send a request to set a GUI feature. Returns an error so that it can be
	// shown in the appropriate context (terminal or the log depending on what
	// was being requested)
	SetFeature(request FeatureReq, args ...FeatureReqData) error
}

GUI defines the operations that can be performed on visual user interfaces.

type Stub

type Stub struct{}

func (Stub) SetFeature

func (s Stub) SetFeature(request FeatureReq, args ...FeatureReqData) error

SetFeature implements the GUI interface.