summaryrefslogtreecommitdiffstats
path: root/cmd/grv/help_bar_view.go
blob: 52add5788790c241a8eb74a812de25cdcd369944 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
package main

import (
	log "github.com/Sirupsen/logrus"
)

// HelpBarView manages displaying help information in the help bar
type HelpBarView struct {
	helpRenderer HelpRenderer
}

// ActionMessage groups a description to an action
type ActionMessage struct {
	action  ActionType
	message string
}

// NewHelpBarView creates a new instance of the help bar view
func NewHelpBarView(helpRenderer HelpRenderer) *HelpBarView {
	return &HelpBarView{
		helpRenderer: helpRenderer,
	}
}

// Initialise does nothing
func (helpBarView *HelpBarView) Initialise() (err error) {
	return
}

// Dispose of any resources held by the view
func (helpBarView *HelpBarView) Dispose() {

}

// HandleEvent does nothing
func (helpBarView *HelpBarView) HandleEvent(event Event) (err error) {
	return
}

// HandleAction does nothing
func (helpBarView *HelpBarView) HandleAction(Action) (err error) {
	return
}

// OnStateChange does nothing
func (helpBarView *HelpBarView) OnStateChange(viewState ViewState) {

}

// ViewID returns the help bar view ID
func (helpBarView *HelpBarView) ViewID() ViewID {
	return ViewHelpBar
}

// Render generates and writes the help view to the provided window
func (helpBarView *HelpBarView) Render(win RenderWindow) (err error) {
	log.Debug("Rendering HelpBarView")

	lineBuilder, err := win.LineBuilder(0, 1)
	if err != nil {
		return
	}

	lineBuilder.Append(" ")

	return helpBarView.helpRenderer.RenderHelpBar(lineBuilder)
}

// RenderHelpBar does nothing
func (helpBarView *HelpBarView) RenderHelpBar(lineBuilder *LineBuilder) (err error) {
	return
}

// RenderKeyBindingHelp is a helper method for views to generate key binding help
func RenderKeyBindingHelp(viewID ViewID, lineBuilder *LineBuilder, config Config, actionMessages []ActionMessage) {
	viewHierarchy := ViewHierarchy{viewID, ViewAll}

	for _, actionMessage := range actionMessages {
		keystrings := config.KeyStrings(actionMessage.action, viewHierarchy)

		if len(keystrings) > 0 {
			lineBuilder.
				AppendWithStyle(CmpHelpbarviewSpecial, "%v ", keystrings[len(keystrings)-1].keystring).
				AppendWithStyle(CmpHelpbarviewNormal, "%v   ", actionMessage.message)
		}
	}
}