lineedit

type Candidate struct {
	// Value is the text inserted; Description is shown beside it in a
	// listing.
	Value       string `json:"value"`
	Description string `json:"description,omitempty"`
}

type Completer func(ctx context.Context, words []string, current string) (cands []Candidate, noSpace bool)

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

type Event struct {
	// Submit is set when Enter ended a line; Line is that line.
	Submit bool
	Line   string
	// Print are lines to show above the prompt (a candidate listing, a
	// question); the line is then shown again below them.
	Print []string
	// Interrupt is Ctrl-C on an empty or abandoned line ("^C").
	Interrupt bool
	// Clear is Ctrl-L: clear the screen, keep the line.
	Clear bool
	// EOF is Ctrl-D on an empty line.
	EOF bool
	// Bell is a key that did nothing (no completion, end of history).
	Bell bool
}

type Key struct {
	Code KeyCode
	Rune rune
}

type KeyCode int

type Options struct {
	// Prompt is shown before the line (default "$ ").
	Prompt string
	// Complete answers Tab; nil disables completion.
	Complete Completer
	// HistorySize bounds the history (default 500).
	HistorySize int
	// Cols is the display width used for listings (default 80); SetCols
	// changes it.
	Cols int
}

type Partial struct {
	// Words are the complete words before the one being typed.
	Words []string
	// Current is the word being typed, unquoted ("" for a new word).
	Current string
	// Start is the byte offset in the line where the current word begins.
	Start int
	// Quote is the quote the current word is still inside (' or "), or 0.
	Quote byte
}

type Reader struct {
	In  io.Reader
	Out io.Writer
	// Cols returns the terminal width (nil, or 0 or less: 80).
	Cols func() int
	// Complete answers Tab; nil disables completion.
	Complete Completer
	// HistorySize bounds the history (0: 500).
	HistorySize int
	// PromptStyle wraps the prompt as Renderer.PromptStyle does; "" is
	// none, which is what a shell wants (its prompt carries its own style).
	PromptStyle string
	// contains filtered or unexported fields
}

type Renderer struct {
	// Cols is the terminal width.
	Cols int
	// PromptStyle wraps the prompt (default bold cyan); "" for none.
	PromptStyle string
	// contains filtered or unexported fields
}

type State struct {
	Prompt string
	Line   string
	// Cursor is the cursor's position in Line, in runes.
	Cursor int
}