package view import ( "fmt" "strings" "github.com/gdamore/tcell" "github.com/rivo/tview" "github.com/wtfutil/wtf/cfg" "github.com/wtfutil/wtf/utils" ) type helpItem struct { Key string Text string } // KeyboardWidget manages keyboard control for a widget type KeyboardWidget struct { app *tview.Application pages *tview.Pages view *tview.TextView settings *cfg.Common charMap map[string]func() keyMap map[tcell.Key]func() charHelp []helpItem keyHelp []helpItem maxKey int } // NewKeyboardWidget creates and returns a new instance of KeyboardWidget func NewKeyboardWidget(app *tview.Application, pages *tview.Pages, settings *cfg.Common) KeyboardWidget { keyWidget := KeyboardWidget{ app: app, pages: pages, settings: settings, charMap: make(map[string]func()), keyMap: make(map[tcell.Key]func()), charHelp: []helpItem{}, keyHelp: []helpItem{}, } return keyWidget } // SetKeyboardChar sets a character/function combination that responds to key presses // Example: // // widget.SetKeyboardChar("d", widget.deleteSelectedItem) // func (widget *KeyboardWidget) SetKeyboardChar(char string, fn func(), helpText string) { if char == "" { return } // Check to ensure that the key trying to be used isn't already being used for something if _, ok := widget.charMap[char]; ok { panic(fmt.Sprintf("Key is already mapped to a keyboard command: %s\n", char)) } widget.charMap[char] = fn widget.charHelp = append(widget.charHelp, helpItem{char, helpText}) } // SetKeyboardKey sets a tcell.Key/function combination that responds to key presses // Example: // // widget.SetKeyboardKey(tcell.KeyCtrlD, widget.deleteSelectedItem) // func (widget *KeyboardWidget) SetKeyboardKey(key tcell.Key, fn func(), helpText string) { widget.keyMap[key] = fn widget.keyHelp = append(widget.keyHelp, helpItem{tcell.KeyNames[key], helpText}) if len(tcell.KeyNames[key]) > widget.maxKey { widget.maxKey = len(tcell.KeyNames[key]) } } // InitializeCommonControls sets up the keyboard controls that are common to // all widgets that accept keyboard input func (widget *KeyboardWidget) InitializeCommonControls(refreshFunc func()) { widget.SetKeyboardChar("/", widget.ShowHelp, "Show/hide this help prompt") widget.SetKeyboardChar("\\", widget.OpenDocs, "Open the docs in a browser") if refreshFunc != nil { widget.SetKeyboardChar("r", refreshFunc, "Refresh widget") } } // InputCapture is the function passed to tview's SetInputCapture() function // This is done during the main widget's creation process using the following code: // // widget.View.SetInputCapture(widget.InputCapture) // func (widget *KeyboardWidget) InputCapture(event *tcell.EventKey) *tcell.EventKey { if event == nil { return nil } fn := widget.charMap[string(event.Rune())] if fn != nil { fn() return nil } fn = widget.keyMap[event.Key()] if fn != nil { fn() return nil } return event } // HelpText returns the help text and keyboard command info for this widget func (widget *KeyboardWidget) HelpText() string { str := " [green::b]Keyboard commands for " + strings.Title(widget.settings.Module.Type) + "[white]\n\n" for _, item := range widget.charHelp { str += fmt.Sprintf(" %s\t%s\n", item.Key, item.Text) } str += "\n\n" for _, item := range widget.keyHelp { str += fmt.Sprintf(" %-*s\t%s\n", widget.maxKey, item.Key, item.Text) } return str } // OpenDocs opens the module docs in a browser func (widget *KeyboardWidget) OpenDocs() { url := "https://wtfutil.com/modules/" + widget.settings.Name utils.OpenFile(url) } // SetView assigns the passed-in tview.TextView view to this widget func (widget *KeyboardWidget) SetView(view *tview.TextView) { widget.view = view } // ShowHelp displays the modal help dialog for a module func (widget *KeyboardWidget) ShowHelp() { closeFunc := func() { widget.pages.RemovePage("help") widget.app.SetFocus(widget.view) } modal := NewBillboardModal(widget.HelpText(), closeFunc) widget.pages.AddPage("help", modal, false, true) widget.app.SetFocus(modal) widget.app.QueueUpdate(func() { widget.app.Draw() }) }