summaryrefslogtreecommitdiffstats
path: root/pkg/gui/context/base_context.go
blob: ca04a2fa95598e9ba534115d42bcffc4852071ea (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
package context

import (
	"github.com/jesseduffield/gocui"
	"github.com/jesseduffield/lazygit/pkg/gui/types"
)

type BaseContext struct {
	kind            types.ContextKind
	key             types.ContextKey
	view            *gocui.View
	viewTrait       types.IViewTrait
	windowName      string
	onGetOptionsMap func() map[string]string

	keybindingsFns      []types.KeybindingsFn
	mouseKeybindingsFns []types.MouseKeybindingsFn
	onClickFn           func() error
	onRenderToMainFn    func() error
	onFocusFn           onFocusFn
	onFocusLostFn       onFocusLostFn

	focusable                   bool
	transient                   bool
	hasControlledBounds         bool
	needsRerenderOnWidthChange  types.NeedsRerenderOnWidthChangeLevel
	needsRerenderOnHeightChange bool
	highlightOnFocus            bool

	*ParentContextMgr
}

type (
	onFocusFn     = func(types.OnFocusOpts) error
	onFocusLostFn = func(types.OnFocusLostOpts) error
)

var _ types.IBaseContext = &BaseContext{}

type NewBaseContextOpts struct {
	Kind                        types.ContextKind
	Key                         types.ContextKey
	View                        *gocui.View
	WindowName                  string
	Focusable                   bool
	Transient                   bool
	HasUncontrolledBounds       bool // negating for the sake of making false the default
	HighlightOnFocus            bool
	NeedsRerenderOnWidthChange  types.NeedsRerenderOnWidthChangeLevel
	NeedsRerenderOnHeightChange bool

	OnGetOptionsMap func() map[string]string
}

func NewBaseContext(opts NewBaseContextOpts) *BaseContext {
	viewTrait := NewViewTrait(opts.View)

	hasControlledBounds := !opts.HasUncontrolledBounds

	return &BaseContext{
		kind:                        opts.Kind,
		key:                         opts.Key,
		view:                        opts.View,
		windowName:                  opts.WindowName,
		onGetOptionsMap:             opts.OnGetOptionsMap,
		focusable:                   opts.Focusable,
		transient:                   opts.Transient,
		hasControlledBounds:         hasControlledBounds,
		highlightOnFocus:            opts.HighlightOnFocus,
		needsRerenderOnWidthChange:  opts.NeedsRerenderOnWidthChange,
		needsRerenderOnHeightChange: opts.NeedsRerenderOnHeightChange,
		ParentContextMgr:            &ParentContextMgr{},
		viewTrait:                   viewTrait,
	}
}

func (self *BaseContext) GetOptionsMap() map[string]string {
	if self.onGetOptionsMap != nil {
		return self.onGetOptionsMap()
	}
	return nil
}

func (self *BaseContext) SetWindowName(windowName string) {
	self.windowName = windowName
}

func (self *BaseContext) GetWindowName() string {
	return self.windowName
}

func (self *BaseContext) GetViewName() string {
	// for the sake of the global context which has no view
	if self.view == nil {
		return ""
	}

	return self.view.Name()
}

func (self *BaseContext) GetView() *gocui.View {
	return self.view
}

func (self *BaseContext) GetViewTrait() types.IViewTrait {
	return self.viewTrait
}

func (self *BaseContext) GetKind() types.ContextKind {
	return self.kind
}

func (self *BaseContext) GetKey() types.ContextKey {
	return self.key
}

func (self *BaseContext) GetKeybindings(opts types.KeybindingsOpts) []*types.Binding {
	bindings := []*types.Binding{}
	for i := range self.keybindingsFns {
		// the first binding in the bindings array takes precedence but we want the
		// last keybindingsFn to take precedence to we add them in reverse
		bindings = append(bindings, self.keybindingsFns[len(self.keybindingsFns)-1-i](opts)...)
	}

	return bindings
}

func (self *BaseContext) AddKeybindingsFn(fn types.KeybindingsFn) {
	self.keybindingsFns = append(self.keybindingsFns, fn)
}

func (self *BaseContext) AddMouseKeybindingsFn(fn types.MouseKeybindingsFn) {
	self.mouseKeybindingsFns = append(self.mouseKeybindingsFns, fn)
}

func (self *BaseContext) ClearAllBindingsFn() {
	self.keybindingsFns = []types.KeybindingsFn{}
	self.mouseKeybindingsFns = []types.MouseKeybindingsFn{}
}

func (self *BaseContext) AddOnClickFn(fn func() error) {
	if fn != nil {
		self.onClickFn = fn
	}
}

func (self *BaseContext) GetOnClick() func() error {
	return self.onClickFn
}

func (self *BaseContext) AddOnRenderToMainFn(fn func() error) {
	if fn != nil {
		self.onRenderToMainFn = fn
	}
}

func (self *BaseContext) GetOnRenderToMain() func() error {
	return self.onRenderToMainFn
}

func (self *BaseContext) AddOnFocusFn(fn onFocusFn) {
	if fn != nil {
		self.onFocusFn = fn
	}
}

func (self *BaseContext) GetOnFocus() onFocusFn {
	return self.onFocusFn
}

func (self *BaseContext) AddOnFocusLostFn(fn onFocusLostFn) {
	if fn != nil {
		self.onFocusLostFn = fn
	}
}

func (self *BaseContext) GetOnFocusLost() onFocusLostFn {
	return self.onFocusLostFn
}

func (self *BaseContext) GetMouseKeybindings(opts types.KeybindingsOpts) []*gocui.ViewMouseBinding {
	bindings := []*gocui.ViewMouseBinding{}
	for i := range self.mouseKeybindingsFns {
		// the first binding in the bindings array takes precedence but we want the
		// last keybindingsFn to take precedence to we add them in reverse
		bindings = append(bindings, self.mouseKeybindingsFns[len(self.mouseKeybindingsFns)-1-i](opts)...)
	}

	return bindings
}

func (self *BaseContext) IsFocusable() bool {
	return self.focusable
}

func (self *BaseContext) IsTransient() bool {
	return self.transient
}

func (self *BaseContext) HasControlledBounds() bool {
	return self.hasControlledBounds
}

func (self *BaseContext) NeedsRerenderOnWidthChange() types.NeedsRerenderOnWidthChangeLevel {
	return self.needsRerenderOnWidthChange
}

func (self *BaseContext) NeedsRerenderOnHeightChange() bool {
	return self.needsRerenderOnHeightChange
}

func (self *BaseContext) Title() string {
	return ""
}