implement help

gui.go

@@ -40,6 +40,8 @@ type Ui struct {
 	// modals
 	addToPlaylistList *tview.List
 	messageBox        *tview.Modal
+	helpModal         tview.Primitive
+	helpWidget        *HelpWidget
 
 	starIdList map[string]struct{}
 
@@ -63,6 +65,7 @@ const (
 	PageNewPlaylist    = "newPlaylist"
 	PageAddToPlaylist  = "addToPlaylist"
 	PageMessageBox     = "messageBox"
+	PageHelpBox        = "helpBox"
 )
 
 func InitGui(indexes *[]subsonic.SubsonicIndex,
@@ -100,7 +103,8 @@ func InitGui(indexes *[]subsonic.SubsonicIndex,
 		SetDynamicColors(true).
 		SetScrollable(false)
 
-	ui.menuWidget = NewMenuWidget(ui)
+	ui.menuWidget = ui.createMenuWidget()
+	ui.helpWidget = ui.createHelpWidget()
 
 	// same as 'playlistList' except for the addToPlaylistModal
 	// - we need a specific version of this because we need different keybinds
@@ -115,6 +119,13 @@ func InitGui(indexes *[]subsonic.SubsonicIndex,
 		return event
 	})
 
+	// help box modal
+	ui.helpModal = makeModal(ui.helpWidget.Root, 80, 30)
+	ui.helpWidget.Root.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
+		ui.CloseHelp()
+		return event
+	})
+
 	// top bar: status text
 	topBarFlex := tview.NewFlex().SetDirection(tview.FlexColumn).
 		AddItem(ui.startStopStatus, 0, 1, false).
@@ -139,6 +150,7 @@ func InitGui(indexes *[]subsonic.SubsonicIndex,
 		AddPage(PageNewPlaylist, ui.playlistPage.NewPlaylistModal, true, false).
 		AddPage(PageAddToPlaylist, ui.browserPage.AddToPlaylistModal, true, false).
 		AddPage(PageMessageBox, ui.messageBox, true, false).
+		AddPage(PageHelpBox, ui.helpModal, true, false).
 		AddPage(PageLog, ui.logPage.Root, true, false)
 
 	rootFlex := tview.NewFlex().
@@ -171,6 +183,18 @@ func (ui *Ui) Run() error {
 	return ui.app.Run()
 }
 
+func (ui *Ui) ShowHelp() {
+	activePage := ui.menuWidget.GetActivePage()
+	ui.helpWidget.RenderHelp(activePage)
+
+	ui.pages.ShowPage(PageHelpBox)
+	ui.app.SetFocus(ui.helpModal)
+}
+
+func (ui *Ui) CloseHelp() {
+	ui.pages.HidePage(PageHelpBox)
+}
+
 func (ui *Ui) showMessageBox(text string) {
 	ui.pages.ShowPage(PageMessageBox)
 	ui.messageBox.SetText(text)

gui_handlers.go

@@ -29,6 +29,9 @@ func (ui *Ui) handlePageInput(event *tcell.EventKey) *tcell.EventKey {
 	case '4':
 		ui.ShowPage(PageLog)
 
+	case '?':
+		ui.ShowHelp()
+
 	case 'Q':
 		ui.Quit()
 

help_text.go

@@ -0,0 +1,34 @@
+package main
+
+const helpPlayback = `
+p     play/pause
+P     stop
+>     next song
+-/=   volume down/volume up
+,/.   seek -10/+10 seconds
+r     add 50 random songs to queue
+`
+
+const helpPageBrowser = `
+ENTER play song (clears current queue)
+a     add album or song to queue
+A     add song to playlist
+y     toggle star on song/album
+R     refresh the list
+/     Search artists
+n     Continue search forward
+N     Continue search backwards
+ESC   Close search
+`
+
+const helpPageQueue = `
+d/DEL remove currently selected song from the queue
+D     remove all songs from queue
+y     toggle star on song
+`
+
+const helpPagePlaylists = `
+n     new playlist
+d     delete playlist
+a     add playlist or song to queue
+`

widget_help.go

@@ -0,0 +1,76 @@
+package main
+
+import (
+	"strings"
+
+	"github.com/rivo/tview"
+)
+
+type HelpWidget struct {
+	Root *tview.Flex
+
+	helpBook                *tview.Flex
+	leftColumn, rightColumn *tview.TextView
+
+	// external references
+	ui *Ui
+}
+
+func (ui *Ui) createHelpWidget() (m *HelpWidget) {
+	m = &HelpWidget{
+		ui: ui,
+	}
+
+	// two help columns side by side
+	m.leftColumn = tview.NewTextView().SetTextAlign(tview.AlignLeft)
+	m.rightColumn = tview.NewTextView().SetTextAlign(tview.AlignLeft)
+	m.helpBook = tview.NewFlex().
+		SetDirection(tview.FlexColumn)
+
+	// button at the bottom
+	closeButton := tview.NewButton("Close")
+	closeButton.SetSelectedFunc(func() {
+		ui.CloseHelp()
+	})
+
+	m.Root = tview.NewFlex().
+		SetDirection(tview.FlexRow).
+		AddItem(m.helpBook, 0, 1, false).
+		AddItem(closeButton, 1, 0, true)
+
+	m.Root.Box.SetBorder(true).SetTitle(" Help ")
+
+	return
+}
+
+func (h *HelpWidget) RenderHelp(context string) {
+	leftText := "[Playback]\n" + tview.Escape(strings.TrimSpace(helpPlayback))
+	h.leftColumn.SetText(leftText)
+
+	rightText := ""
+	switch context {
+	case PageBrowser:
+		rightText = "[Browser]\n" + tview.Escape(strings.TrimSpace(helpPageBrowser))
+
+	case PageQueue:
+		rightText = "[Queue]\n" + tview.Escape(strings.TrimSpace(helpPageQueue))
+
+	case PagePlaylists:
+		rightText = "[Playlists]\n" + tview.Escape(strings.TrimSpace(helpPagePlaylists))
+
+	case PageLog:
+		fallthrough
+	default:
+		// no text
+	}
+
+	h.rightColumn.SetText(rightText)
+
+	h.helpBook.Clear()
+	if rightText != "" {
+		h.helpBook.AddItem(h.leftColumn, 38, 0, false).
+			AddItem(h.rightColumn, 0, 1, true) // gets focus for scrolling
+	} else {
+		h.helpBook.AddItem(h.leftColumn, 0, 1, false)
+	}
+}

widget_menu.go

@@ -25,7 +25,7 @@ type MenuWidget struct {
 
 var buttonOrder = []string{PageBrowser, PageQueue, PagePlaylists, PageLog}
 
-func NewMenuWidget(ui *Ui) (m *MenuWidget) {
+func (ui *Ui) createMenuWidget() (m *MenuWidget) {
 	m = &MenuWidget{
 		activeButton: buttonOrder[0],
 		buttons:      make(map[string]*tview.Button),
@@ -54,7 +54,7 @@ func NewMenuWidget(ui *Ui) (m *MenuWidget) {
 		SetStyle(m.buttonStyle).
 		SetActivatedStyle(m.buttonStyle).
 		SetSelectedFunc(func() {
-			ui.showMessageBox("not yet implemented, sorry")
+			ui.ShowHelp()
 		})
 
 	m.buttonsRight = tview.NewFlex().
@@ -118,3 +118,7 @@ func (m *MenuWidget) SetActivePage(name string) {
 	m.activeButton = name
 	m.updatePageButtons()
 }
+
+func (m *MenuWidget) GetActivePage() string {
+	return m.activeButton
+}