readline

package module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 2, 2023 License: MIT Imports: 18 Imported by: 21

README

readline

This is a pure Go implementation of functionality comparable to GNU Readline, i.e. line editing and command history for simple TUI programs.

It is a fork of chzyer/readline.

Documentation

Index

Constants

View Source 
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
)
View Source 
const (
	MetaBackward rune = -iota - 1
	MetaForward
	MetaDelete
	MetaBackspace
	MetaTranspose
	MetaShiftTab
	MetaDeleteKey
)
View Source 
const (
	VIM_NORMAL = iota
	VIM_INSERT
	VIM_VISUAL
)

Variables

View Source 
var (
	ErrInterrupt = errors.New("Interrupt")
)
View Source 
var NewEx = NewFromConfig

NewEx is an alias for NewFromConfig, for compatibility.

Functions

func Do 

func Do(p PrefixCompleterInterface, line []rune, pos int) (newLine [][]rune, offset int)

func Print 

func Print(p PrefixCompleterInterface, prefix string, level int, buf *bytes.Buffer)

func RetSegment 

func RetSegment(segments [][]rune, cands [][]rune, idx int) ([][]rune, int)

func SplitSegment 

func SplitSegment(line []rune, pos int) ([][]rune, int)

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

	// Listener is an optional callback to intercept keypresses.
	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 DynamicCompleteFunc 

type DynamicCompleteFunc func(string) []string

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 New 

func New(prompt string) (*Instance, error)

New creates a readline instance with default configuration.

func NewFromConfig 

func NewFromConfig(cfg *Config) (*Instance, error)

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) Clean 

func (i *Instance) Clean()

func (*Instance) Close 

func (i *Instance) Close() error

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) DisableHistory added in v0.0.4 

func (i *Instance) DisableHistory()

DisableHistory disables the saving of input lines in history.

func (*Instance) EnableHistory added in v0.0.4 

func (i *Instance) EnableHistory()

EnableHistory enables the saving of input lines in history.

func (*Instance) GeneratePasswordConfig added in v0.0.4 

func (i *Instance) GeneratePasswordConfig() *Config

GeneratePasswordConfig generates a suitable Config for reading passwords; this config can be modified and then used with ReadLineWithConfig, or SetConfig.

func (*Instance) GetConfig added in v0.0.3 

func (i *Instance) GetConfig() *Config

GetConfig returns a copy of the current config.

func (*Instance) IsVimMode 

func (i *Instance) IsVimMode() bool

func (*Instance) ReadLine added in v0.0.4 

func (i *Instance) ReadLine() (string, error)

ReadLine reads a line from the configured input source, allowing inline editing. The returned error is either nil, io.EOF, or readline.ErrInterrupt.

func (*Instance) ReadLineWithConfig added in v0.0.4 

func (i *Instance) ReadLineWithConfig(cfg *Config) (string, error)

func (*Instance) ReadLineWithDefault added in v0.0.4 

func (i *Instance) ReadLineWithDefault(defaultValue string) (string, error)

func (*Instance) ReadPassword 

func (i *Instance) ReadPassword(prompt string) ([]byte, error)

func (*Instance) ReadSlice 

func (i *Instance) ReadSlice() ([]byte, error)

same as readline

func (*Instance) Readline 

func (i *Instance) Readline() (string, error)

Readline is an alias for ReadLine, for compatibility.

func (*Instance) Refresh 

func (i *Instance) Refresh()

Refresh redraws the input buffer on screen.

func (*Instance) ResetHistory 

func (i *Instance) ResetHistory()

func (*Instance) SaveToHistory added in v0.0.4 

func (i *Instance) SaveToHistory(content string) error

SaveToHistory adds a string to the instance's stored history. This is particularly relevant when DisableAutoSaveHistory is configured.

func (*Instance) SetConfig 

func (i *Instance) SetConfig(cfg *Config) error

SetConfig modifies the current instance's config.

func (*Instance) SetDefault added in v0.0.3 

func (i *Instance) SetDefault(defaultValue string)

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) SetPrompt 

func (i *Instance) SetPrompt(s string)

func (*Instance) SetVimMode 

func (i *Instance) SetVimMode(on bool)

switch VimMode in runtime

func (*Instance) Stderr 

func (i *Instance) Stderr() io.Writer

readline will refresh automatic when write through Stdout()

func (*Instance) Stdout 

func (i *Instance) Stdout() io.Writer

readline will refresh automatic when write through Stdout()

func (*Instance) Write 

func (i *Instance) Write(b []byte) (int, error)

type Listener 

type Listener func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)

Listener is a callback type to listen for keypresses while the line is being edited. It is invoked initially with (nil, 0, 0), and then subsequently for any keypress until (but not including) the newline/enter keypress that completes the input.

type Painter 

type Painter func(line []rune, pos int) []rune

Painter is a callback type to allow modifying the buffer before it is rendered on screen, for example, to implement real-time syntax highlighting.

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 PrefixCompleterInterface 

type PrefixCompleterInterface interface {
	Print(prefix string, level int, buf *bytes.Buffer)
	Do(line []rune, pos int) (newLine [][]rune, length int)
	GetName() []rune
	GetChildren() []PrefixCompleterInterface
	SetChildren(children []PrefixCompleterInterface)
}

type SegmentComplete 

type SegmentComplete struct {
	SegmentCompleter
}

func SegmentAutoComplete 

func SegmentAutoComplete(completer SegmentCompleter) *SegmentComplete

func (*SegmentComplete) Do 

func (c *SegmentComplete) Do(line []rune, pos int) (newLine [][]rune, offset int)

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
}

Source Files

View all 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
ansi
platform
runes
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.