prompt

Documentation

Overview

Package prompt implements prompt-related functionalities of the editor.

Index

• func PromptInit() eval.Callable
• func RpromptInit() eval.Callable
• type Config
  • func (cfg *Config) MakeMaxWaitChan() <-chan time.Time
• type Editor
• type Updater
  • func NewUpdater(promptFn eval.Callable) *Updater
  • func (pu *Updater) Update(ed Editor) <-chan []*ui.Styled

Functions

func PromptInit

func PromptInit() eval.Callable

PromptInit returns an initial value for $edit:prompt.

func RpromptInit

func RpromptInit() eval.Callable

RpromptInit returns an initial value for $edit:rprompt.

Types

type Config

type Config struct {
	Prompt  eval.Callable
	Rprompt eval.Callable

	RpromptPersistent bool
	PromptsMaxWait    float64
}

func (*Config) MakeMaxWaitChan

func (cfg *Config) MakeMaxWaitChan() <-chan time.Time

MakeMaxWait makes a channel that sends the current time after $edit:-prompts-max-wait seconds if the time fits in a time.Duration value, or nil otherwise.

type Editor

type Editor interface {
	Evaler() *eval.Evaler
	Notify(string, ...interface{})
}

Editor is the interface used by the prompt to access the editor.

type Updater

type Updater struct {
	Staled []*ui.Styled
	// contains filtered or unexported fields
}

Updater manages the update of a prompt.

func NewUpdater

func NewUpdater(promptFn eval.Callable) *Updater

NewUpdater creates a new Updater.

func (*Updater) Update

func (pu *Updater) Update(ed Editor) <-chan []*ui.Styled

Update updates the prompt, returning a channel onto which the result will be written.