completion

type CallbackCompleter ¶

type CallbackCompleter struct {
	Completer
	// contains filtered or unexported fields
}

func NewCallbackCompleter(m ...Matcher) *CallbackCompleter

func (c *CallbackCompleter) Complete(line string, pos int, key rune) (string, int, bool)

type Combine ¶

type Combine struct {
	Matchers []Matcher
	Next     []Matcher
}

Combine aggregates the matches of it's children. If any of the Matchers match, Accept will return all the Next. Use this when you have multiple choices that all result in the same continuation, e.g.:

         /-- create --\
command ---- update ---- <id>
         \-- delete --/

The "create", "update" and "delete" are the Matchers of the Combine, "<id>" is the Next.

func (s *Combine) Accept(word string) (bool, []Matcher)

func (s *Combine) AddNext(m Matcher)

func (s *Combine) Help(esc *terminal.EscapeCodes) []string

func (s *Combine) Match(word string) []Word

type Completer ¶

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

A Completer provides line completion functionality based on Matchers.

func NewCompleter(m ...Matcher) Completer

func (c Completer) Complete(line string, pos int) (head string, comps []Word, tail string)

func (c Completer) PrintHelp(out io.Writer, esc *terminal.EscapeCodes)

type Literal ¶

type Literal struct {
	Value string
	Next  []Matcher
}

Literal matches any prefix to String, even the empty string.

func (l *Literal) Accept(word string) (bool, []Matcher)

func (l *Literal) AddNext(m Matcher)

func (l *Literal) Help(esc *terminal.EscapeCodes) []string

func (l *Literal) Match(word string) []Word

type Matcher ¶

type Matcher interface {
	Match(word string) []Word
	Accept(word string) (bool, []Matcher)
	AddNext(m Matcher)
	Help(*terminal.EscapeCodes) []string
}

A Matcher provides word completion functionality.

type Regexp ¶

type Regexp struct {
	Exp         *regexp.Regexp
	Placeholder string
	Optional    bool
	Next        []Matcher
}

Regexp matches any word that matches Exp.

func (r *Regexp) Accept(word string) (bool, []Matcher)

func (r *Regexp) AddNext(m Matcher)

func (r *Regexp) Help(esc *terminal.EscapeCodes) []string

func (r *Regexp) Match(word string) []Word

type Word ¶

type Word struct {
	Value       string
	Placeholder bool
}

type WordCompleter ¶

type WordCompleter struct {
	Completer
}

A WordCompleter provides line completion functionality based on Matchers.

func NewWordCompleter(m ...Matcher) WordCompleter

func (c WordCompleter) Complete(line string, pos int) (string, []string, string)