k9s/internal/ui/action.go

129 lines
2.5 KiB
Go

// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of K9s
package ui
import (
"sort"
"github.com/derailed/k9s/internal/model"
"github.com/derailed/tcell/v2"
"github.com/rs/zerolog/log"
)
type (
// ActionHandler handles a keyboard command.
ActionHandler func(*tcell.EventKey) *tcell.EventKey
ActionOpts struct {
Visible bool
Shared bool
Plugin bool
HotKey bool
Dangerous bool
}
// KeyAction represents a keyboard action.
KeyAction struct {
Description string
Action ActionHandler
Opts ActionOpts
}
// KeyActions tracks mappings between keystrokes and actions.
KeyActions map[tcell.Key]KeyAction
)
// NewKeyAction returns a new keyboard action.
func NewKeyAction(d string, a ActionHandler, visible bool) KeyAction {
return NewKeyActionWithOpts(d, a, ActionOpts{
Visible: visible,
})
}
// NewSharedKeyAction returns a new shared keyboard action.
func NewSharedKeyAction(d string, a ActionHandler, visible bool) KeyAction {
return NewKeyActionWithOpts(d, a, ActionOpts{
Visible: visible,
Shared: true,
})
}
// NewKeyActionWithOpts returns a new keyboard action.
func NewKeyActionWithOpts(d string, a ActionHandler, opts ActionOpts) KeyAction {
return KeyAction{
Description: d,
Action: a,
Opts: opts,
}
}
func (a KeyActions) Reset(aa KeyActions) {
a.Clear()
a.Add(aa)
}
// Add sets up keyboard action listener.
func (a KeyActions) Add(aa KeyActions) {
for k, v := range aa {
a[k] = v
}
}
// Clear remove all actions.
func (a KeyActions) Clear() {
for k := range a {
delete(a, k)
}
}
// ClearDanger remove all dangerous actions.
func (a KeyActions) ClearDanger() {
for k, v := range a {
if v.Opts.Dangerous {
delete(a, k)
}
}
}
// Set replace actions with new ones.
func (a KeyActions) Set(aa KeyActions) {
for k, v := range aa {
a[k] = v
}
}
// Delete deletes actions by the given keys.
func (a KeyActions) Delete(kk ...tcell.Key) {
for _, k := range kk {
delete(a, k)
}
}
// Hints returns a collection of hints.
func (a KeyActions) Hints() model.MenuHints {
kk := make([]int, 0, len(a))
for k := range a {
if !a[k].Opts.Shared {
kk = append(kk, int(k))
}
}
sort.Ints(kk)
hh := make(model.MenuHints, 0, len(kk))
for _, k := range kk {
if name, ok := tcell.KeyNames[tcell.Key(int16(k))]; ok {
hh = append(hh,
model.MenuHint{
Mnemonic: name,
Description: a[tcell.Key(k)].Description,
Visible: a[tcell.Key(k)].Opts.Visible,
},
)
} else {
log.Error().Msgf("Unable to locate KeyName for %#v", k)
}
}
return hh
}