option.go

package fzf

import (
	"errors"
	"fmt"
	"strconv"
	"strings"
	"sync"

	"github.com/charmbracelet/bubbles/key"
)

var defaultOption = option{
	limit:         1,
	noLimit:       false,
	caseSensitive: false,

	prompt:           "> ",
	cursor:           "> ",
	selectedPrefix:   "● ",
	unselectedPrefix: "◯ ",
	inputPlaceholder: "Filter...",
	styles:           NewStyles(),

	keymap: &keymap{
		Up:     key.NewBinding(key.WithKeys("up", "ctrl+p")),
		Down:   key.NewBinding(key.WithKeys("down", "ctrl+n")),
		Toggle: key.NewBinding(key.WithKeys("tab")),
		Choose: key.NewBinding(key.WithKeys("enter")),
		Abort:  key.NewBinding(key.WithKeys("ctrl+c", "esc")),
	},

	inputPosition: InputPositionTop,

	countViewEnabled: true,
	countViewFunc: func(meta CountViewMeta) string {
		var v strings.Builder
		_, _ = v.WriteString(strconv.Itoa(meta.MatchesCount))
		_, _ = v.WriteRune('/')
		_, _ = v.WriteString(strconv.Itoa(meta.ItemsCount))
		_, _ = v.WriteRune(' ')
		if meta.Limit > 1 || meta.NoLimit {
			_, _ = v.WriteString("(")
			_, _ = v.WriteString(strconv.Itoa(meta.SelectedCount))
			if !meta.NoLimit {
				_, _ = v.WriteRune('/')
				_, _ = v.WriteString(strconv.Itoa(meta.Limit))
			}
			_, _ = v.WriteString(") ")
		}

		borderw := meta.Width - v.Len()
		if borderw < 0 {
			borderw = 0
		}
		_, _ = v.WriteString(strings.Repeat("─", borderw))
		return v.String()
	},

	hotReloadLocker: nil,
}

// CountViewMeta provides information used in count view.
type CountViewMeta struct {
	ItemsCount    int
	MatchesCount  int
	SelectedCount int
	Width         int
	Limit         int
	NoLimit       bool
}

// InputPosition represents the position of input.
type InputPosition string

const (
	InputPositionTop    InputPosition = "top"
	InputPositionBottom InputPosition = "bottom"
)

// Valid validates the value of InputPosition.
func (p InputPosition) Valid() error {
	switch p {
	case InputPositionTop, InputPositionBottom:
		return nil
	default:
		return fmt.Errorf("invalid input position: %s", p)
	}
}

type option struct {
	limit         int
	noLimit       bool
	caseSensitive bool

	prompt           string
	cursor           string
	selectedPrefix   string
	unselectedPrefix string
	inputPlaceholder string
	styles           *Styles

	keymap *keymap

	inputPosition InputPosition

	countViewEnabled bool
	countViewFunc    func(meta CountViewMeta) string

	hotReloadLocker sync.Locker
}

func (o *option) valid() error {
	if o.limit < 1 {
		return errors.New("limit must be at least 1")
	}

	if err := o.inputPosition.Valid(); err != nil {
		return err
	}

	return nil
}

func (o *option) multiple() bool {
	return o.noLimit || o.limit > 1
}

// Option represents a option for the Fuzzy Finder.
type Option func(o *option)

// WithLimit sets the number of items that can be selected.
func WithLimit(l int) Option {
	return func(o *option) {
		o.limit = l
	}
}

// WithNoLimit can be set to `true` to allow unlimited item selection.
func WithNoLimit(n bool) Option {
	return func(o *option) {
		o.noLimit = n
	}
}

// WithPrompt sets the prompt text.
func WithPrompt(p string) Option {
	return func(o *option) {
		o.prompt = p
	}
}

// WithCursor sets the cursor.
func WithCursor(c string) Option {
	return func(o *option) {
		o.cursor = c
	}
}

// WithSelectedPrefix sets the prefix of the selected item.
func WithSelectedPrefix(p string) Option {
	return func(o *option) {
		o.selectedPrefix = p
	}
}

// WithUnselectedPrefix sets the prefix of the unselected item.
func WithUnselectedPrefix(p string) Option {
	return func(o *option) {
		o.unselectedPrefix = p
	}
}

// WithStyles sets the various styles.
func WithStyles(opts ...StylesOption) Option {
	return func(o *option) {
		o.styles = NewStyles(opts...)
	}
}

// WithKeyMap sets the key mapping.
func WithKeyMap(km KeyMap) Option {
	return func(o *option) {
		if len(km.Up) > 0 {
			o.keymap.Up = key.NewBinding(key.WithKeys(km.Up...))
		}
		if len(km.Down) > 0 {
			o.keymap.Down = key.NewBinding(key.WithKeys(km.Down...))
		}
		if len(km.Toggle) > 0 {
			o.keymap.Toggle = key.NewBinding(key.WithKeys(km.Toggle...))
		}
		if len(km.Choose) > 0 {
			o.keymap.Choose = key.NewBinding(key.WithKeys(km.Choose...))
		}
		if len(km.Abort) > 0 {
			o.keymap.Abort = key.NewBinding(key.WithKeys(append(km.Abort, "ctrl+c")...))
		}
	}
}

// WithInputPlaceholder sets the placeholder for input.
func WithInputPlaceholder(p string) Option {
	return func(o *option) {
		o.inputPlaceholder = p
	}
}

// WithCountViewEnabled enables or disables count view.
func WithCountViewEnabled(b bool) Option {
	return func(o *option) {
		o.countViewEnabled = b
	}
}

// WithCountView sets the function to create the count view.
func WithCountView(f func(meta CountViewMeta) string) Option {
	return func(o *option) {
		o.countViewFunc = f
	}
}

// WithHotReload sets the locker for read items.
func WithHotReload(locker sync.Locker) Option {
	return func(o *option) {
		o.hotReloadLocker = locker
	}
}

// WithCaseSensitive sets the case sensitivity.
func WithCaseSensitive(s bool) Option {
	return func(o *option) {
		o.caseSensitive = s
	}
}

// WithInputPosition sets the position of input.
func WithInputPosition(p InputPosition) Option {
	return func(o *option) {
		o.inputPosition = p
	}
}