Terminal-based user interface toolkit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1378 lines
34 KiB

package cview
import (
"bytes"
"fmt"
"strings"
"sync"
"github.com/gdamore/tcell/v2"
)
// ListItem represents an item in a List.
type ListItem struct {
2 years ago
disabled bool // Whether or not the list item is selectable.
mainText []byte // The main text of the list item.
secondaryText []byte // A secondary text to be shown underneath the main text.
shortcut rune // The key to select the list item directly, 0 if there is no shortcut.
selected func() // The optional function which is called when the item is selected.
reference interface{} // An optional reference object.
sync.RWMutex
}
// NewListItem returns a new item for a list.
func NewListItem(mainText string) *ListItem {
return &ListItem{
mainText: []byte(mainText),
}
}
// SetMainBytes sets the main text of the list item.
func (l *ListItem) SetMainBytes(val []byte) {
l.Lock()
defer l.Unlock()
l.mainText = val
}
// SetMainText sets the main text of the list item.
func (l *ListItem) SetMainText(val string) {
l.SetMainBytes([]byte(val))
}
// GetMainBytes returns the item's main text.
func (l *ListItem) GetMainBytes() []byte {
l.RLock()
defer l.RUnlock()
return l.mainText
}
// GetMainText returns the item's main text.
func (l *ListItem) GetMainText() string {
return string(l.GetMainBytes())
}
// SetSecondaryBytes sets a secondary text to be shown underneath the main text.
func (l *ListItem) SetSecondaryBytes(val []byte) {
l.Lock()
defer l.Unlock()
l.secondaryText = val
}
// SetSecondaryText sets a secondary text to be shown underneath the main text.
func (l *ListItem) SetSecondaryText(val string) {
l.SetSecondaryBytes([]byte(val))
}
// GetSecondaryBytes returns the item's secondary text.
func (l *ListItem) GetSecondaryBytes() []byte {
l.RLock()
defer l.RUnlock()
return l.secondaryText
}
// GetSecondaryText returns the item's secondary text.
func (l *ListItem) GetSecondaryText() string {
return string(l.GetSecondaryBytes())
}
// SetShortcut sets the key to select the ListItem directly, 0 if there is no shortcut.
func (l *ListItem) SetShortcut(val rune) {
l.Lock()
defer l.Unlock()
l.shortcut = val
}
// GetShortcut returns the ListItem's shortcut.
func (l *ListItem) GetShortcut() rune {
l.RLock()
defer l.RUnlock()
return l.shortcut
}
// SetSelectedFunc sets a function which is called when the ListItem is selected.
func (l *ListItem) SetSelectedFunc(handler func()) {
l.Lock()
defer l.Unlock()
l.selected = handler
}
// SetReference allows you to store a reference of any type in the item
func (l *ListItem) SetReference(val interface{}) {
l.Lock()
defer l.Unlock()
l.reference = val
}
// GetReference returns the item's reference object.
func (l *ListItem) GetReference() interface{} {
l.RLock()
defer l.RUnlock()
return l.reference
}
// List displays rows of items, each of which can be selected.
type List struct {
*Box
3 years ago
*ContextMenu
// The items of the list.
items []*ListItem
// The index of the currently selected item.
currentItem int
// Whether or not to show the secondary item texts.
showSecondaryText bool
// The item main text color.
mainTextColor tcell.Color
// The item secondary text color.
secondaryTextColor tcell.Color
// The item shortcut text color.
shortcutColor tcell.Color
// The text color for selected items.
selectedTextColor tcell.Color
// The style attributes for selected items.
selectedTextAttributes tcell.AttrMask
// Visibility of the scroll bar.
scrollBarVisibility ScrollBarVisibility
// The scroll bar color.
scrollBarColor tcell.Color
// The background color for selected items.
selectedBackgroundColor tcell.Color
// If true, the selection is only shown when the list has focus.
selectedFocusOnly bool
// If true, the selection must remain visible when scrolling.
selectedAlwaysVisible bool
// If true, the selection must remain centered when scrolling.
selectedAlwaysCentered bool
// If true, the entire row is highlighted when selected.
highlightFullLine bool
// Whether or not navigating the list will wrap around.
wrapAround bool
3 years ago
// Whether or not hovering over an item will highlight it.
hover bool
// The number of list items and columns by which the list is scrolled
// down/to the right.
itemOffset, columnOffset int
// An optional function which is called when the user has navigated to a list
// item.
changed func(index int, item *ListItem)
// An optional function which is called when a list item was selected. This
// function will be called even if the list item defines its own callback.
selected func(index int, item *ListItem)
// An optional function which is called when the user presses the Escape key.
done func()
// The height of the list the last time it was drawn.
height int
// Prefix and suffix strings drawn for unselected elements.
unselectedPrefix, unselectedSuffix []byte
// Prefix and suffix strings drawn for selected elements.
selectedPrefix, selectedSuffix []byte
// Maximum prefix and suffix width.
prefixWidth, suffixWidth int
sync.RWMutex
}
// NewList returns a new form.
func NewList() *List {
3 years ago
l := &List{
Box: NewBox(),
showSecondaryText: true,
scrollBarVisibility: ScrollBarAuto,
mainTextColor: Styles.PrimaryTextColor,
secondaryTextColor: Styles.TertiaryTextColor,
shortcutColor: Styles.SecondaryTextColor,
selectedTextColor: Styles.PrimitiveBackgroundColor,
scrollBarColor: Styles.ScrollBarColor,
selectedBackgroundColor: Styles.PrimaryTextColor,
}
3 years ago
l.ContextMenu = NewContextMenu(l)
l.focus = l
return l
}
// SetCurrentItem sets the currently selected item by its index, starting at 0
// for the first item. If a negative index is provided, items are referred to
// from the back (-1 = last item, -2 = second-to-last item, and so on). Out of
// range indices are clamped to the beginning/end.
//
// Calling this function triggers a "changed" event if the selection changes.
func (l *List) SetCurrentItem(index int) {
l.Lock()
if index < 0 {
index = len(l.items) + index
}
if index >= len(l.items) {
index = len(l.items) - 1
}
if index < 0 {
index = 0
}
previousItem := l.currentItem
l.currentItem = index
l.updateOffset()
if index != previousItem && index < len(l.items) && l.changed != nil {
item := l.items[index]
l.Unlock()
l.changed(index, item)
} else {
l.Unlock()
}
}
// GetCurrentItem returns the currently selected list item,
// Returns nil if no item is selected.
func (l *List) GetCurrentItem() *ListItem {
l.RLock()
defer l.RUnlock()
if len(l.items) == 0 || l.currentItem >= len(l.items) {
return nil
}
return l.items[l.currentItem]
}
// GetCurrentItemIndex returns the index of the currently selected list item,
// starting at 0 for the first item and its struct.
func (l *List) GetCurrentItemIndex() int {
l.RLock()
defer l.RUnlock()
return l.currentItem
}
// GetItems returns all list items.
func (l *List) GetItems() []*ListItem {
l.RLock()
defer l.RUnlock()
return l.items
}
// RemoveItem removes the item with the given index (starting at 0) from the
// list. If a negative index is provided, items are referred to from the back
// (-1 = last item, -2 = second-to-last item, and so on). Out of range indices
// are clamped to the beginning/end, i.e. unless the list is empty, an item is
// always removed.
//
// The currently selected item is shifted accordingly. If it is the one that is
// removed, a "changed" event is fired.
func (l *List) RemoveItem(index int) {
l.Lock()
if len(l.items) == 0 {
l.Unlock()
return
}
// Adjust index.
if index < 0 {
index = len(l.items) + index
}
if index >= len(l.items) {
index = len(l.items) - 1
}
if index < 0 {
index = 0
}
// Remove item.
l.items = append(l.items[:index], l.items[index+1:]...)
// If there is nothing left, we're done.
if len(l.items) == 0 {
l.Unlock()
return
}
// Shift current item.
previousItem := l.currentItem
3 years ago
if l.currentItem >= index && l.currentItem > 0 {
l.currentItem--
}
// Fire "changed" event for removed items.
if previousItem == index && index < len(l.items) && l.changed != nil {
item := l.items[l.currentItem]
l.Unlock()
l.changed(l.currentItem, item)
} else {
l.Unlock()
}
}
// SetOffset sets the number of list items and columns by which the list is
// scrolled down/to the right.
func (l *List) SetOffset(items, columns int) {
l.Lock()
defer l.Unlock()
if items < 0 {
items = 0
}
if columns < 0 {
columns = 0
}
l.itemOffset, l.columnOffset = items, columns
}
// GetOffset returns the number of list items and columns by which the list is
// scrolled down/to the right.
func (l *List) GetOffset() (int, int) {
l.Lock()
defer l.Unlock()
return l.itemOffset, l.columnOffset
}
// SetMainTextColor sets the color of the items' main text.
func (l *List) SetMainTextColor(color tcell.Color) {
l.Lock()
defer l.Unlock()
l.mainTextColor = color
}
// SetSecondaryTextColor sets the color of the items' secondary text.
func (l *List) SetSecondaryTextColor(color tcell.Color) {
l.Lock()
defer l.Unlock()
l.secondaryTextColor = color
}
// SetShortcutColor sets the color of the items' shortcut.
func (l *List) SetShortcutColor(color tcell.Color) {
l.Lock()
defer l.Unlock()
l.shortcutColor = color
}
// SetSelectedTextColor sets the text color of selected items.
func (l *List) SetSelectedTextColor(color tcell.Color) {
l.Lock()
defer l.Unlock()
l.selectedTextColor = color
}
// SetSelectedTextAttributes sets the style attributes of selected items.
func (l *List) SetSelectedTextAttributes(attr tcell.AttrMask) {
l.Lock()
defer l.Unlock()
l.selectedTextAttributes = attr
}
// SetSelectedBackgroundColor sets the background color of selected items.
func (l *List) SetSelectedBackgroundColor(color tcell.Color) {
l.Lock()
defer l.Unlock()
l.selectedBackgroundColor = color
}
// SetSelectedFocusOnly sets a flag which determines when the currently selected
// list item is highlighted. If set to true, selected items are only highlighted
// when the list has focus. If set to false, they are always highlighted.
func (l *List) SetSelectedFocusOnly(focusOnly bool) {
l.Lock()
defer l.Unlock()
l.selectedFocusOnly = focusOnly
}
// SetSelectedAlwaysVisible sets a flag which determines whether the currently
// selected list item must remain visible when scrolling.
func (l *List) SetSelectedAlwaysVisible(alwaysVisible bool) {
l.Lock()
defer l.Unlock()
l.selectedAlwaysVisible = alwaysVisible
}
// SetSelectedAlwaysCentered sets a flag which determines whether the currently
// selected list item must remain centered when scrolling.
func (l *List) SetSelectedAlwaysCentered(alwaysCentered bool) {
l.Lock()
defer l.Unlock()
l.selectedAlwaysCentered = alwaysCentered
}
// SetHighlightFullLine sets a flag which determines whether the colored
// background of selected items spans the entire width of the view. If set to
// true, the highlight spans the entire view. If set to false, only the text of
// the selected item from beginning to end is highlighted.
func (l *List) SetHighlightFullLine(highlight bool) {
l.Lock()
defer l.Unlock()
l.highlightFullLine = highlight
}
// ShowSecondaryText determines whether or not to show secondary item texts.
func (l *List) ShowSecondaryText(show bool) {
l.Lock()
defer l.Unlock()
l.showSecondaryText = show
return
}
// SetScrollBarVisibility specifies the display of the scroll bar.
func (l *List) SetScrollBarVisibility(visibility ScrollBarVisibility) {
l.Lock()
defer l.Unlock()
l.scrollBarVisibility = visibility
}
// SetScrollBarColor sets the color of the scroll bar.
func (l *List) SetScrollBarColor(color tcell.Color) {
l.Lock()
defer l.Unlock()
l.scrollBarColor = color
}
3 years ago
// SetHover sets the flag that determines whether hovering over an item will
// highlight it (without triggering callbacks set with SetSelectedFunc).
func (l *List) SetHover(hover bool) {
3 years ago
l.Lock()
defer l.Unlock()
l.hover = hover
}
// SetWrapAround sets the flag that determines whether navigating the list will
// wrap around. That is, navigating downwards on the last item will move the
// selection to the first item (similarly in the other direction). If set to
// false, the selection won't change when navigating downwards on the last item
// or navigating upwards on the first item.
func (l *List) SetWrapAround(wrapAround bool) {
l.Lock()
defer l.Unlock()
l.wrapAround = wrapAround
}
// SetChangedFunc sets the function which is called when the user navigates to
// a list item. The function receives the item's index in the list of items
// (starting with 0) and the list item.
//
// This function is also called when the first item is added or when
// SetCurrentItem() is called.
func (l *List) SetChangedFunc(handler func(index int, item *ListItem)) {
l.Lock()
defer l.Unlock()
l.changed = handler
}
// SetSelectedFunc sets the function which is called when the user selects a
// list item by pressing Enter on the current selection. The function receives
// the item's index in the list of items (starting with 0) and its struct.
func (l *List) SetSelectedFunc(handler func(int, *ListItem)) {
l.Lock()
defer l.Unlock()
l.selected = handler
}
// SetDoneFunc sets a function which is called when the user presses the Escape
// key.
func (l *List) SetDoneFunc(handler func()) {
l.Lock()
defer l.Unlock()
l.done = handler
}
// AddItem calls InsertItem() with an index of -1.
func (l *List) AddItem(item *ListItem) {
l.InsertItem(-1, item)
}
// InsertItem adds a new item to the list at the specified index. An index of 0
// will insert the item at the beginning, an index of 1 before the second item,
// and so on. An index of GetItemCount() or higher will insert the item at the
// end of the list. Negative indices are also allowed: An index of -1 will
// insert the item at the end of the list, an index of -2 before the last item,
// and so on. An index of -GetItemCount()-1 or lower will insert the item at the
// beginning.
//
// An item has a main text which will be highlighted when selected. It also has
// a secondary text which is shown underneath the main text (if it is set to
// visible) but which may remain empty.
//
// The shortcut is a key binding. If the specified rune is entered, the item
// is selected immediately. Set to 0 for no binding.
//
// The "selected" callback will be invoked when the user selects the item. You
// may provide nil if no such callback is needed or if all events are handled
// through the selected callback set with SetSelectedFunc().
//
// The currently selected item will shift its position accordingly. If the list
// was previously empty, a "changed" event is fired because the new item becomes
// selected.
func (l *List) InsertItem(index int, item *ListItem) {
l.Lock()
// Shift index to range.
if index < 0 {
index = len(l.items) + index + 1
}
if index < 0 {
index = 0
} else if index > len(l.items) {
index = len(l.items)
}
// Shift current item.
if l.currentItem < len(l.items) && l.currentItem >= index {
l.currentItem++
}
// Insert item (make space for the new item, then shift and insert).
l.items = append(l.items, nil)
if index < len(l.items)-1 { // -1 because l.items has already grown by one item.
copy(l.items[index+1:], l.items[index:])
}
l.items[index] = item
// Fire a "change" event for the first item in the list.
if len(l.items) == 1 && l.changed != nil {
item := l.items[0]
l.Unlock()
l.changed(0, item)
} else {
l.Unlock()
}
}
// GetItem returns the ListItem at the given index.
// Returns nil when index is out of bounds.
func (l *List) GetItem(index int) *ListItem {
if index > len(l.items)-1 {
return nil
}
return l.items[index]
}
// GetItemCount returns the number of items in the list.
func (l *List) GetItemCount() int {
l.RLock()
defer l.RUnlock()
return len(l.items)
}
// GetItemText returns an item's texts (main and secondary). Panics if the index
// is out of range.
func (l *List) GetItemText(index int) (main, secondary string) {
l.RLock()
defer l.RUnlock()
return string(l.items[index].mainText), string(l.items[index].secondaryText)
}
// SetItemText sets an item's main and secondary text. Panics if the index is
// out of range.
func (l *List) SetItemText(index int, main, secondary string) {
l.Lock()
defer l.Unlock()
item := l.items[index]
item.mainText = []byte(main)
item.secondaryText = []byte(secondary)
}
3 years ago
// SetItemEnabled sets whether an item is selectable. Panics if the index is
// out of range.
func (l *List) SetItemEnabled(index int, enabled bool) {
3 years ago
l.Lock()
defer l.Unlock()
item := l.items[index]
2 years ago
item.disabled = !enabled
3 years ago
}
// SetIndicators is used to set prefix and suffix indicators for selected and unselected items.
func (l *List) SetIndicators(selectedPrefix, selectedSuffix, unselectedPrefix, unselectedSuffix string) {
l.Lock()
defer l.Unlock()
l.selectedPrefix = []byte(selectedPrefix)
l.selectedSuffix = []byte(selectedSuffix)
l.unselectedPrefix = []byte(unselectedPrefix)
l.unselectedSuffix = []byte(unselectedSuffix)
l.prefixWidth = len(selectedPrefix)
if len(unselectedPrefix) > l.prefixWidth {
l.prefixWidth = len(unselectedPrefix)
}
l.suffixWidth = len(selectedSuffix)
if len(unselectedSuffix) > l.suffixWidth {
l.suffixWidth = len(unselectedSuffix)
}
}
// FindItems searches the main and secondary texts for the given strings and
// returns a list of item indices in which those strings are found. One of the
// two search strings may be empty, it will then be ignored. Indices are always
// returned in ascending order.
//
// If mustContainBoth is set to true, mainSearch must be contained in the main
// text AND secondarySearch must be contained in the secondary text. If it is
// false, only one of the two search strings must be contained.
//
// Set ignoreCase to true for case-insensitive search.
func (l *List) FindItems(mainSearch, secondarySearch string, mustContainBoth, ignoreCase bool) (indices []int) {
l.RLock()
defer l.RUnlock()
if mainSearch == "" && secondarySearch == "" {
return
}
if ignoreCase {
mainSearch = strings.ToLower(mainSearch)
secondarySearch = strings.ToLower(secondarySearch)
}
mainSearchBytes := []byte(mainSearch)
secondarySearchBytes := []byte(secondarySearch)
for index, item := range l.items {
mainText := item.mainText
secondaryText := item.secondaryText
if ignoreCase {
mainText = bytes.ToLower(mainText)
secondaryText = bytes.ToLower(secondaryText)
}
// strings.Contains() always returns true for a "" search.
mainContained := bytes.Contains(mainText, mainSearchBytes)
secondaryContained := bytes.Contains(secondaryText, secondarySearchBytes)
if mustContainBoth && mainContained && secondaryContained ||
!mustContainBoth && (len(mainText) > 0 && mainContained || len(secondaryText) > 0 && secondaryContained) {
indices = append(indices, index)
}
}
return
}
// Clear removes all items from the list.
func (l *List) Clear() {
l.Lock()
defer l.Unlock()
l.items = nil
l.currentItem = 0
l.itemOffset = 0
l.columnOffset = 0
}
3 years ago
// Focus is called by the application when the primitive receives focus.
func (l *List) Focus(delegate func(p Primitive)) {
l.Box.Focus(delegate)
if l.ContextMenu.open {
delegate(l.ContextMenu.list)
}
}
// HasFocus returns whether or not this primitive has focus.
func (l *List) HasFocus() bool {
if l.ContextMenu.open {
return l.ContextMenu.list.HasFocus()
}
l.RLock()
defer l.RUnlock()
3 years ago
return l.hasFocus
}
// Transform modifies the current selection.
func (l *List) Transform(tr Transformation) {
l.Lock()
previousItem := l.currentItem
l.transform(tr)
if l.currentItem != previousItem && l.currentItem < len(l.items) && l.changed != nil {
item := l.items[l.currentItem]
l.Unlock()
l.changed(l.currentItem, item)
} else {
l.Unlock()