Documentation
¶
Index ¶
- Constants
- Variables
- func Do(p PrefixCompleterInterface, line []rune, pos int) (newLine [][]rune, offset int)
- func Print(p PrefixCompleterInterface, prefix string, level int, buf *bytes.Buffer)
- func RetSegment(segments [][]rune, cands [][]rune, idx int) ([][]rune, int)
- func SplitSegment(line []rune, pos int) ([][]rune, int)
- type AutoCompleter
- type Config
- type DumpListener
- type DynamicCompleteFunc
- type DynamicPrefixCompleterInterface
- type Instance
- func (i *Instance) CaptureExitSignal()
- func (i *Instance) Clean()
- func (i *Instance) Close() error
- func (i *Instance) GenPasswordConfig() *Config
- func (i *Instance) GetConfig() *Config
- func (i *Instance) HistoryDisable()
- func (i *Instance) HistoryEnable()
- func (i *Instance) IsVimMode() bool
- func (i *Instance) ReadPassword(prompt string) ([]byte, error)
- func (i *Instance) ReadPasswordWithConfig(cfg *Config) ([]byte, error)
- func (i *Instance) ReadSlice() ([]byte, error)
- func (i *Instance) Readline() (string, error)
- func (i *Instance) ReadlineWithDefault(what string) (string, error)
- func (i *Instance) Refresh()
- func (i *Instance) ResetHistory()
- func (i *Instance) SaveHistory(content string) error
- func (i *Instance) SetConfig(cfg *Config) error
- func (i *Instance) SetDefault(defaultValue string)
- func (i *Instance) SetMaskRune(r rune)
- func (i *Instance) SetPrompt(s string)
- func (i *Instance) SetVimMode(on bool)
- func (i *Instance) Stderr() io.Writer
- func (i *Instance) Stdout() io.Writer
- func (i *Instance) Write(b []byte) (int, error)
- type Listener
- type Painter
- type PrefixCompleter
- func (p *PrefixCompleter) Do(line []rune, pos int) (newLine [][]rune, offset int)
- func (p *PrefixCompleter) GetChildren() []PrefixCompleterInterface
- func (p *PrefixCompleter) GetDynamicNames(line []rune) [][]rune
- func (p *PrefixCompleter) GetName() []rune
- func (p *PrefixCompleter) IsDynamic() bool
- func (p *PrefixCompleter) Print(prefix string, level int, buf *bytes.Buffer)
- func (p *PrefixCompleter) SetChildren(children []PrefixCompleterInterface)
- func (p *PrefixCompleter) Tree(prefix string) string
- type PrefixCompleterInterface
- type SegmentComplete
- type SegmentCompleter
- type TabCompleter
Constants ¶
const ( S_STATE_FOUND = iota S_STATE_FAILING )
const ( S_DIR_BCK = iota S_DIR_FWD )
const ( CharLineStart = 1 CharBackward = 2 CharInterrupt = 3 CharEOT = 4 CharLineEnd = 5 CharForward = 6 CharBell = 7 CharCtrlH = 8 CharTab = 9 CharCtrlJ = 10 CharKill = 11 CharCtrlL = 12 CharEnter = 13 CharNext = 14 CharPrev = 16 CharBckSearch = 18 CharFwdSearch = 19 CharTranspose = 20 CharCtrlU = 21 CharCtrlW = 23 CharCtrlY = 25 CharCtrlZ = 26 CharEsc = 27 CharO = 79 CharEscapeEx = 91 CharBackspace = 127 )
const ( MetaBackward rune = -iota - 1 MetaForward MetaDelete MetaBackspace MetaTranspose MetaShiftTab MetaDeleteKey )
const ( VIM_NORMAL = iota VIM_INSERT VIM_VISUAL )
Variables ¶
var (
ErrInterrupt = errors.New("Interrupt")
)
var NewEx = NewFromConfig
NewEx is an alias for NewFromConfig, for compatibility.
Functions ¶
Types ¶
type AutoCompleter ¶
type AutoCompleter interface {
// Readline 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)
}
func SegmentFunc ¶
func SegmentFunc(f func([][]rune, int) [][]rune) AutoCompleter
type Config ¶
type Config struct {
// prompt supports ANSI escape sequence, so we can color some characters even in windows
Prompt string
// readline will persist historys to file where HistoryFile specified
HistoryFile string
// specify the max length of historys, it's 500 by default, set it to -1 to disable history
HistoryLimit int
DisableAutoSaveHistory bool
// enable case-insensitive history searching
HistorySearchFold bool
// AutoCompleter will called once user press TAB
AutoComplete AutoCompleter
// Any key press will pass to Listener
// NOTE: Listener will be triggered by (nil, 0, 0) immediately
Listener Listener
Painter Painter
// If VimMode is true, readline will in vim.insert mode by default
VimMode bool
InterruptPrompt string
EOFPrompt string
FuncGetWidth func() int
// Function that returns width, height of the terminal or -1,-1 if unknown
FuncGetSize func() (width int, height int)
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
EnableMask bool
MaskRune rune
// erase the editing line after user submited it
// it use in IM usually.
UniqueEditLine bool
// filter input runes (may be used to disable CtrlZ or for translating some keys to different actions)
// -> output = new (translated) rune and true/false if continue with processing this one
FuncFilterInputRune func(rune) (rune, bool)
// force use interactive even stdout is not a tty
FuncIsTerminal func() bool
FuncMakeRaw func() error
FuncExitRaw func() error
FuncOnWidthChanged func(func())
ForceUseInteractive bool
// contains filtered or unexported fields
}
type DumpListener ¶
type DumpListener struct {
// contains filtered or unexported fields
}
type DynamicCompleteFunc ¶
Caller type for dynamic completion
type DynamicPrefixCompleterInterface ¶
type DynamicPrefixCompleterInterface interface {
PrefixCompleterInterface
IsDynamic() bool
GetDynamicNames(line []rune) [][]rune
}
type Instance ¶
type Instance struct {
// contains filtered or unexported fields
}
func NewFromConfig ¶
NewFromConfig creates a readline instance from the specified configuration.
func (*Instance) CaptureExitSignal ¶
func (i *Instance) CaptureExitSignal()
CaptureExitSignal registers handlers for common exit signals that will close the readline instance.
func (*Instance) Close ¶
Close() closes the readline instance, cleaning up state changes to the terminal. It interrupts any concurrent Readline() operation, so it can be asynchronously or from a signal handler. It is concurrency-safe and idempotent, so it can be called multiple times.
func (*Instance) GenPasswordConfig ¶
func (*Instance) HistoryDisable ¶
func (i *Instance) HistoryDisable()
HistoryDisable the save of the commands into the history
func (*Instance) HistoryEnable ¶
func (i *Instance) HistoryEnable()
HistoryEnable the save of the commands into the history (default on)
func (*Instance) ReadPasswordWithConfig ¶
we can generate a config by `i.GenPasswordConfig()`
func (*Instance) ReadlineWithDefault ¶
func (*Instance) ResetHistory ¶
func (i *Instance) ResetHistory()
func (*Instance) SaveHistory ¶
func (*Instance) SetDefault ¶ added in v0.0.3
SetDefault prefills a default value for the next call to Readline() or related methods. The value will appear after the prompt for the user to edit, with the cursor at the end of the line.
func (*Instance) SetMaskRune ¶
type Listener ¶
type PrefixCompleter ¶
type PrefixCompleter struct {
Name []rune
Dynamic bool
Callback DynamicCompleteFunc
Children []PrefixCompleterInterface
}
func NewPrefixCompleter ¶
func NewPrefixCompleter(pc ...PrefixCompleterInterface) *PrefixCompleter
func PcItem ¶
func PcItem(name string, pc ...PrefixCompleterInterface) *PrefixCompleter
func PcItemDynamic ¶
func PcItemDynamic(callback DynamicCompleteFunc, pc ...PrefixCompleterInterface) *PrefixCompleter
func (*PrefixCompleter) Do ¶
func (p *PrefixCompleter) Do(line []rune, pos int) (newLine [][]rune, offset int)
func (*PrefixCompleter) GetChildren ¶
func (p *PrefixCompleter) GetChildren() []PrefixCompleterInterface
func (*PrefixCompleter) GetDynamicNames ¶
func (p *PrefixCompleter) GetDynamicNames(line []rune) [][]rune
func (*PrefixCompleter) GetName ¶
func (p *PrefixCompleter) GetName() []rune
func (*PrefixCompleter) IsDynamic ¶
func (p *PrefixCompleter) IsDynamic() bool
func (*PrefixCompleter) Print ¶
func (p *PrefixCompleter) Print(prefix string, level int, buf *bytes.Buffer)
func (*PrefixCompleter) SetChildren ¶
func (p *PrefixCompleter) SetChildren(children []PrefixCompleterInterface)
func (*PrefixCompleter) Tree ¶
func (p *PrefixCompleter) Tree(prefix string) string
type SegmentComplete ¶
type SegmentComplete struct {
SegmentCompleter
}
func SegmentAutoComplete ¶
func SegmentAutoComplete(completer SegmentCompleter) *SegmentComplete
type SegmentCompleter ¶
type SegmentCompleter interface {
// a
// |- a1
// |--- a11
// |- a2
// b
// input:
// DoTree([], 0) [a, b]
// DoTree([a], 1) [a]
// DoTree([a, ], 0) [a1, a2]
// DoTree([a, a], 1) [a1, a2]
// DoTree([a, a1], 2) [a1]
// DoTree([a, a1, ], 0) [a11]
// DoTree([a, a1, a], 1) [a11]
DoSegment([][]rune, int) [][]rune
}
type TabCompleter ¶
type TabCompleter struct{}
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
example
|
|
|
readline-demo
command
|
|
|
readline-multiline
command
|
|
|
readline-pass-strength
command
This is a small example using readline to read a password and check it's strength while typing using the zxcvbn library.
|
This is a small example using readline to read a password and check it's strength while typing using the zxcvbn library. |
|
internal
|
|
|
term
Package term provides support functions for dealing with terminals, as commonly found on UNIX systems.
|
Package term provides support functions for dealing with terminals, as commonly found on UNIX systems. |