gocui/eventBindings.go

// Copyright 2017-2025 WIT.COM Inc. All rights reserved.
// Use of this source code is (now) governed by the GPL 3.0

package main

import (
	"fmt"
	"syscall"

	"github.com/awesome-gocui/gocui"
	"go.wit.com/log"
)

//    THIS IS A STANDARD.

// register how the 'gocui' will work as a GO toolkit plugin
// all applications will use these keys. they are universal.

// tells 'gocui' where to send events
func registerHandlers(g *gocui.Gui) {
	keyForced, modForced := gocui.MustParse("ctrl+z") // setup ctrl+z

	// mouse handlers
	g.SetKeybinding("", gocui.MouseLeft, gocui.ModNone, mouseDown)     // normal left mouse down
	g.SetKeybinding("", gocui.MouseLeft, gocui.ModMouseCtrl, ctrlDown) // mouse with the ctrl key held down
	g.SetKeybinding("", gocui.MouseRelease, gocui.ModNone, mouseUp)    // mouse button release

	// Ctrl key handlers
	g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, doExit)        // CTRL-C : exits the application
	g.SetKeybinding("", gocui.KeyCtrlV, gocui.ModNone, doPanic)       // CTRL-V : force a panic()
	g.SetKeybinding("", gocui.KeyCtrlD, gocui.ModNone, openDebuggger) // CTRL-D : open the (D)ebugger
	g.SetKeybinding("", keyForced, modForced, handle_ctrl_z)          // CTRL-Z :cleverly let's you background gocui (breaks cursor mouse on return)

	// regular keys
	g.SetKeybinding("", '?', gocui.ModNone, theHelp)       // '?' toggles on and off the help menu
	g.SetKeybinding("", 'w', gocui.ModNone, doWindow)      // 'w' close all windows
	g.SetKeybinding("", 'r', gocui.ModNone, widgetRefresh) // 'r' screen refresh
	g.SetKeybinding("", 'q', gocui.ModNone, doExit)        // 'q' exit

	// debugging
	g.SetKeybinding("", 'f', gocui.ModNone, theFind)             // 'f' shows what is under your mouse
	g.SetKeybinding("", 'S', gocui.ModNone, setSuperMouse)       // 'S' Super Mouse mode!
	g.SetKeybinding("", 'h', gocui.ModNone, theHide)             // 'h' hide all widgets
	g.SetKeybinding("", 'M', gocui.ModNone, dumpWidgetPlacement) // 'M' list all widgets with positions
	g.SetKeybinding("", 'L', gocui.ModNone, dumpWidgets)         // 'L' list all widgets in tree view
	g.SetKeybinding("", 'd', gocui.ModNone, theLetterD)          // 'd' toggles on and off debugging buttons
	g.SetKeybinding("", 'q', gocui.ModNone, quit)                // 'q' only exits gocui. plugin stays alive (?)
}

// flips on 'super mouse' mode
// while this is turned on, it will print out every widget found under the mouse
func setSuperMouse(g *gocui.Gui, v *gocui.View) error {
	if me.supermouse {
		log.Log(GOCUI, "supermouse off")
		me.supermouse = false
	} else {
		me.supermouse = true
		log.Log(GOCUI, "supermouse on")
	}
	return nil
}

func theHide(g *gocui.Gui, v *gocui.View) error {
	var w *guiWidget
	w = me.treeRoot.TK.(*guiWidget)
	w.hideWidgets()
	return nil
}

func theShow(g *gocui.Gui, v *gocui.View) error {
	var w *guiWidget
	w = me.treeRoot.TK.(*guiWidget)
	w.showWidgets()
	return nil
}

func doExit(g *gocui.Gui, v *gocui.View) error {
	standardExit()
	return nil
}

func doPanic(g *gocui.Gui, v *gocui.View) error {
	log.Log(GOCUI, "do panic() here")
	standardClose()
	panic("forced panic in gocui")
	return nil
}

func dumpWidgets(g *gocui.Gui, v *gocui.View) error {
	me.treeRoot.ListWidgets()

	tk := me.logStdout.TK.(*guiWidget)
	// msg := fmt.Sprintf("test out kb %d\n", ecount)
	// tk.Write([]byte(msg))
	if tk == nil {
		log.Log(ERROR, "tk = nil")
	}
	if tk.v == nil {
		log.Log(ERROR, "tk.v = nil")
	} else {
		log.Log(ERROR, "setting log.CaptureMode(tk.v)")
		log.Log(ERROR, "setting log.CaptureMode(tk.v)")
		log.CaptureMode(tk)
	}
	return nil
}

func dumpWidgetPlacement(g *gocui.Gui, v *gocui.View) error {
	w := me.treeRoot.TK.(*guiWidget)
	w.dumpTree("MM")
	return nil
}

func openDebuggger(g *gocui.Gui, v *gocui.View) error {
	me.myTree.SendEnableDebugger()
	return nil
}

func theFind(g *gocui.Gui, v *gocui.View) error {
	w, h := g.MousePosition()
	for _, tk := range findByXY(w, h) {
		log.Log(GOCUI, fmt.Sprintf("findByXY() 'f' key  %-8s wId=%4d at (%3d,%3d) %s", tk.WidgetType, tk.node.WidgetId, w, h, tk.node.String()))
	}
	return nil
}

// is run whenever anyone hits 'd' (in an open space)
func theLetterD(g *gocui.Gui, v *gocui.View) error {
	// widgets that don't have physical existance in
	// a display toolkit are hidden. In the case
	// of gocui, they are set as not 'visible' and put offscreen
	// or have the size set to zero
	// (hopefully anyway) lots of things with the toolkit
	// still don't work

	fakeStartWidth = me.FakeW
	fakeStartHeight = me.TabH + me.FramePadH
	if showDebug {
		showFake()
		showDebug = false
	} else {
		hideFake()
		showDebug = true
	}
	return nil
}

func theHelp(g *gocui.Gui, v *gocui.View) error {
	if showHelp {
		helplayout()
		showHelp = false
		if me.dropdownV == nil {
			me.dropdownV = makeDropdownView("addWidget() ddview")
		}
		me.dropdownV.Show()
	} else {
		me.baseGui.DeleteView("help")
		showHelp = true
		me.dropdownV.Hide()
	}
	return nil
}

func widgetRefresh(g *gocui.Gui, v *gocui.View) error {
	log.Log(GOCUI, "todo: refresh windows here")
	return nil
}

func doWindow(g *gocui.Gui, v *gocui.View) error {
	log.Log(GOCUI, "todo: close all windows here")
	return nil
}

// todo: find and give credit to the person that I found this patch in their forked repo
// handle ctrl+z
func handle_ctrl_z(g *gocui.Gui, v *gocui.View) error {
	gocui.Suspend()
	log.Info("got ctrl+z")
	syscall.Kill(syscall.Getpid(), syscall.SIGSTOP)
	log.Info("got ctrl+z syscall() done")
	gocui.Resume()
	return nil
}