cmd

type Cmd struct {
	// the prompt string
	Prompt string

	// the continuation prompt string
	ContinuationPrompt string

	// the history file
	HistoryFile string

	// this function is called to fetch the current prompt
	// so it can be overridden to provide a dynamic prompt
	GetPrompt func(bool) string

	// this function is called before starting the command loop
	PreLoop func()

	// this function is called before terminating the command loop
	PostLoop func()

	// this function is called before executing the selected command
	PreCmd func(string)

	// this function is called after a command has been executed
	// return true to terminate the interpreter, false to continue
	PostCmd func(string, bool) bool

	// this function is called to execute one command
	OneCmd func(string) bool

	// this function is called if the last typed command was an empty line
	EmptyLine func()

	// this function is called if the command line doesn't match any existing command
	// by default it displays an error message
	Default func(string)

	// this function is called when the user types the "help" command.
	// It is implemented so that it can be overwritten, mainly to support plugins.
	Help func(string) bool

	// this function is called to implement command completion.
	// it should return a list of words that match the input text
	Complete func(string, string) []string

	// this function is called when a variable change (via set/var command).
	// it should return the new value to set the variable to (to force type casting)
	//
	// oldv will be nil if a new varabile is being created
	//
	// newv will be nil if the variable is being deleted
	OnChange func(name string, oldv, newv interface{}) interface{}

	// this function is called when the user tries to interrupt a running
	// command. If it returns true, the application will be terminated.
	Interrupt func(os.Signal) bool

	// this function is called when recovering from a panic.
	// If it returns true, the application will be terminated.
	Recover func(interface{}) bool

	// if true, enable shell commands
	EnableShell bool

	// if true, print elapsed time
	Timing bool

	// if true, print command before executing
	Echo bool

	// if true, don't print result of some operations (stored in result variables)
	Silent bool

	// this is the list of available commands indexed by command name
	Commands map[string]Command

	sync.RWMutex
	// contains filtered or unexported fields
}

type Command struct {
	// command name
	Name string
	// command description
	Help string
	// the function to call to execute the command
	Call func(string) bool
	// the function to call to print the help string
	HelpFunc func()
}

type Completer interface {
	Complete(string, string) []string // Complete(start, full-line) returns matches
}

type CompleterCond func(start, line string) bool

type CompleterWords func() []string

type GoRunner interface {
	Run(task func())
	Wait()
}

type Plugin interface {
	PluginInit(cmd *Cmd, ctx *internal.Context) error
}

type WordCompleter struct {
	// a function that returns the list of words to match on
	Words CompleterWords
	// a function that returns true if this completer should be executed
	Cond CompleterCond
}