Gopher2600/gui/sdlimgui/manager_window.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 sdlimgui

import (
	"fmt"

	"github.com/inkyblackness/imgui-go/v4"
)

// the window type represents all the windows used in the sdlimgui.
type window interface {
	// initialisation function. by the first call to manager.draw()
	init()

	// id should return a unique identifier for the window. note that the
	// window title and any menu entry do not have to have the same value as
	// the id() but it can.
	id() string
}

// windows that require special destruction implement the windowDestroy interface
type windowDestroy interface {
	destroy()
}

// information about the window, including window geometry
//
// is embedded in playmodeWin and debuggerWin interfaces. for window type that
// implent interfaces then windowGeom method calls will need to disambiguate
// which geometry to use
type windowGeom struct {
	position imgui.Vec2
	size     imgui.Vec2

	// information about the window after the most recent window draw
	focused bool
	hovered bool

	// whether the window manager should give raise priority to this window on
	// the next draw
	raiseOnNextDraw bool

	// whether the window manager should monitor this window to see if it is
	// focused or not. the manager uses this information to help decide which
	// window to give focus to when a mouse capture ends
	noFocusTracking bool
}

// update should be called just before the imgui.End() is called
func (g *windowGeom) update() {
	g.position = imgui.WindowPos()
	g.size = imgui.WindowSize()
	g.focused = imgui.IsWindowFocusedV(imgui.FocusedFlagsChildWindows)
	g.hovered = imgui.IsWindowHoveredV(imgui.HoveredFlagsChildWindows)
}

type playmodeWindow interface {
	window
	playmodeDraw() bool
	playmodeIsOpen() bool
	playmodeIsHovered() bool
	playmodeSetOpen(bool)
}

// playmodeWin is a partial implementation of the playmodeWindow interface. it
// does not implement playmodeDraw or the any of the plain window interface.
type playmodeWin struct {
	playmodeWindow
	playmodeGeom windowGeom
	playmodeOpen bool
}

func (w playmodeWin) playmodeID(id string) string {
	return fmt.Sprintf("%s##playmode", id)
}

func (w playmodeWin) playmodeIsOpen() bool {
	return w.playmodeOpen
}

func (w playmodeWin) playmodeIsHovered() bool {
	return w.playmodeGeom.hovered && w.playmodeOpen
}

func (w *playmodeWin) playmodeSetOpen(open bool) {
	w.playmodeOpen = open
}

type debuggerWindow interface {
	window
	debuggerDraw() bool
	debuggerIsOpen() bool
	debuggerIsHovered() bool
	debuggerSetOpen(bool)

	// using the window geometry should be used with care. for example the
	// hovered field may be stale
	debuggerGeometry() *windowGeom
}

// debuggerWin is a partial implementation of the debuggerWindow interface. it
// does not implement debuggerDraw or the any of the plain window interface.
type debuggerWin struct {
	debuggerWindow
	debuggerOpen bool
	debuggerGeom windowGeom
}

func (w debuggerWin) debuggerID(id string) string {
	return fmt.Sprintf("%s##debugger", id)
}

func (w *debuggerWin) debuggerIsOpen() bool {
	return w.debuggerOpen
}

func (w *debuggerWin) debuggerIsHovered() bool {
	return w.debuggerGeom.hovered && w.debuggerOpen
}

func (w *debuggerWin) debuggerSetOpen(open bool) {
	w.debuggerOpen = open
}

func (w *debuggerWin) debuggerGeometry() *windowGeom {
	return &w.debuggerGeom
}

// toggles a window open according to emulation state
func (wm *manager) toggleOpen(winID string) bool {
	if wm.img.isPlaymode() {
		w, ok := wm.playmodeWindows[winID]
		if !ok {
			return false
		}
		w.playmodeSetOpen(!w.playmodeIsOpen())
		return w.playmodeIsOpen()
	}

	w, ok := wm.debuggerWindows[winID]
	if !ok {
		return false
	}
	w.debuggerSetOpen(!w.debuggerIsOpen())
	return w.debuggerIsOpen()
}