readline

type AutoCompleter interface {
	// Do will pass the whole line and current offset to it
	// Completer need to pass all the candidates, and how long they shared the same characters in line
	// Example:
	//   [go, git, git-shell, grep]
	//   Do("g", 1) => ["o", "it", "it-shell", "rep"], 1
	//   Do("gi", 2) => ["t", "t-shell"], 2
	//   Do("git", 3) => ["", "-shell"], 3
	Do(line []rune, pos int) (newLine [][]rune, length int)
}

type Config struct {
	// Prompt is the input prompt (ANSI escape sequences are supported on all platforms)
	Prompt string

	// HistoryFile is the path to the file where persistent history will be stored
	// (empty string disables).
	HistoryFile string

	// HistoryLimit is the maximum number of history entries to store. If it is 0
	// or unset, the default value is 500; set to -1 to disable.
	HistoryLimit int

	// DisableAutoSaveHistory disables automatically saving input lines to history; if true, lines will only be added to history if SaveToHistory is called explicitly.
	DisableAutoSaveHistory bool

	// HistorySearchFold enables case-insensitive history searching.
	HistorySearchFold bool

	// AutoComplete defines the tab-completion behavior. See the documentation for the AutoCompleter interface for details.
	AutoComplete AutoCompleter

	// Listener is an optional callback to intercept keypresses.
	Listener Listener

	// Painter is an optional callback to rewrite the buffer for display.
	Painter Painter

	// FuncFilterInputRune is an optional callback to translate keyboard inputs;
	// it takes in the input rune and returns (translation, ok). If ok is false,
	// the rune is skipped.
	FuncFilterInputRune func(rune) (rune, bool)

	// VimMode enables Vim-style insert mode by default.
	VimMode bool

	// InterruptPrompt is the string to display when the user sends an interrupt signal (e.g. Ctrl+C). If set to "\n", no prompt will be displayed.
	InterruptPrompt string

	// EOFPrompt is the string to display when the user sends an EOF signal (e.g. Ctrl+D). If set to "\n", no prompt will be displayed.
	EOFPrompt string

	// EnableMask enables password masking mode, where input characters are not displayed on screen. MaskRune specifies the character to display for each input character (default '*').
	EnableMask bool

	// MaskRune is the character to display for each input character when EnableMask is true (default '*').
	MaskRune rune

	// Undo controls whether to maintain an undo buffer (if enabled, Ctrl+_ will undo the previous action).
	Undo bool

	// Stdin is the input source for the shell instance (default os.Stdin).
	Stdin io.Reader

	// Stdout is the output destination for the shell instance (default os.Stdout).
	Stdout io.Writer

	// Stderr is the error output destination for the shell instance (default os.Stderr).
	Stderr io.Writer

	// FuncIsTerminal is a function that returns true if the current environment is a terminal, false otherwise. If not provided, it defaults to checking if both stdin and stdout are terminals.
	FuncIsTerminal func() bool

	// FuncGetSize is a function that returns the width and height of the terminal. If not provided, it defaults to a platform-specific implementation.
	FuncMakeRaw func() error

	// FuncExitRaw is a function that restores the terminal to its previous state after FuncMakeRaw has been called. If not provided, it defaults to a platform-specific implementation.
	FuncExitRaw func() error

	// FuncMakeRaw is a function that puts the terminal into raw mode, which allows for more direct control over input and output. If not provided, it defaults to a platform-specific implementation.
	FuncGetSize func() (width int, height int)

	// FuncOnWidthChanged is a function that registers a callback to be called when the terminal width changes. If not provided, it defaults to a platform-specific implementation that listens for terminal resize events.
	FuncOnWidthChanged func(func())
	// contains filtered or unexported fields
}

type Instance struct {
	// contains filtered or unexported fields
}

type Listener func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)

type Painter func(line []rune, pos int) []rune

type PrefixCompleter struct {
	// Name is the name of a command, subcommand, or argument eligible for completion.
	Name string
	// Callback is optional; if defined, it takes the current line and returns
	// a list of possible completions associated with the current node (i.e.
	// in place of Name).
	Callback func(string) []string
	// Children is a list of possible completions that can follow the current node.
	Children []*PrefixCompleter
	// contains filtered or unexported fields
}