package readline

Import Path
	github.com/chzyer/readline (on go.dev)

Dependency Relation
	imports 19 packages, and imported by one package

Involved Source Files

	      complete.go
	      complete_helper.go
	      complete_segment.go
	      history.go
	      operation.go
	      password.go
	   d➜ readline.go
		Readline is a pure go implementation for GNU-Readline kind library.

		example:
			rl, err := readline.New("> ")
			if err != nil {
				panic(err)
			}
			defer rl.Close()

			for {
				line, err := rl.Readline()
				if err != nil { // io.EOF
					break
				}
				println(line)
			}

	      remote.go
	      runebuf.go
	      runes.go
	      search.go
	      std.go
	   d➜ term.go
		Package terminal provides support functions for dealing with terminals, as
		commonly found on UNIX systems.

		Putting a terminal into raw mode is the most common requirement:

			oldState, err := terminal.MakeRaw(0)
			if err != nil {
			        panic(err)
			}
			defer terminal.Restore(0, oldState)

	      term_linux.go
	      term_unix.go
	      terminal.go
	      utils.go
	      utils_unix.go
	      vim.go
Package-Level Type Names (total 43, in which 28 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AutoCompleter (interface)

		Methods (only one, which is exported)
			( T) Do(line []rune, pos int) (newLine [][]rune, length int)
				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

		Implemented By (at least 5, all are exported)
			 DynamicPrefixCompleterInterface (interface)
			*PrefixCompleter
			 PrefixCompleterInterface (interface)
			*SegmentComplete
			*TabCompleter
		As Outputs Of (at least one exported)
			func SegmentFunc(f func([][]rune, int) [][]rune) AutoCompleter
		As Inputs Of (at least one exported)
			func SetAutoComplete(completer AutoCompleter)

	 type CancelableStdin (struct)

		Fields (total 8, none are exported)
			/* 8 unexporteds ... *//* 8 unexporteds: */
			closed int32
			data []byte
			err error
			mutex sync.Mutex
			notify chan struct{}
			r io.Reader
			read int
			stop chan struct{}
		Methods (total 3, in which 2 are exported)
			(*T) Close() error
			(*T) Read(b []byte) (n int, err error)
			/* one unexported ... *//* one unexported: */
			(*T) ioloop()
		Implements (at least 3, all are exported)
			*T : io.Closer
			*T : io.ReadCloser
			*T : io.Reader
		As Outputs Of (at least one exported)
			func NewCancelableStdin(r io.Reader) *CancelableStdin

	 type Config (struct)

		Fields (total 28, in which 25 are exported)
			AutoComplete AutoCompleter
				AutoCompleter will called once user press TAB

			DisableAutoSaveHistory bool
			EOFPrompt string
			EnableMask bool
			ForceUseInteractive bool
			FuncExitRaw func() error
			FuncFilterInputRune func(rune) (rune, 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

			FuncGetWidth func() int
			FuncIsTerminal func() bool
				force use interactive even stdout is not a tty

			FuncMakeRaw func() error
			FuncOnWidthChanged func(func())
			HistoryFile string
				readline will persist historys to file where HistoryFile specified

			HistoryLimit int
				specify the max length of historys, it's 500 by default, set it to -1 to disable history

			HistorySearchFold bool
				enable case-insensitive history searching

			InterruptPrompt string
			Listener Listener
				Any key press will pass to Listener
				NOTE: Listener will be triggered by (nil, 0, 0) immediately

			MaskRune rune
			Painter Painter
			Prompt string
				prompt supports ANSI escape sequence, so we can color some characters even in windows

			Stderr io.Writer
			Stdin io.ReadCloser
			StdinWriter io.Writer
			Stdout io.Writer
			UniqueEditLine bool
				erase the editing line after user submited it
				it use in IM usually.

			VimMode bool
				If VimMode is true, readline will in vim.insert mode by default

			/* 3 unexporteds ... *//* 3 unexporteds: */
			inited bool
				private fields

			opHistory *opHistory
			opSearch *opSearch
		Methods (total 5, in which 4 are exported)
			( T) Clone() *Config
			(*T) Init() error
			(*T) SetListener(f func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool))
			(*T) SetPainter(p Painter)
			/* one unexported ... *//* one unexported: */
			(*T) useInteractive() bool
		As Outputs Of (at least 7, all are exported)
			func Config.Clone() *Config
			func (*Instance).GenPasswordConfig() *Config
			func (*Instance).SetConfig(cfg *Config) *Config
			func (*Operation).GenPasswordConfig() *Config
			func (*Operation).GetConfig() *Config
			func (*Operation).SetConfig(cfg *Config) (*Config, error)
			func (*Terminal).GetConfig() *Config
		As Inputs Of (at least 15, in which 13 are exported)
			func HandleConn(cfg Config, conn net.Conn) (*Instance, error)
			func ListenRemote(n, addr string, cfg *Config, h func(*Instance), onListen ...func(net.Listener) error) error
			func NewEx(cfg *Config) (*Instance, error)
			func NewOperation(t *Terminal, cfg *Config) *Operation
			func NewRuneBuffer(w io.Writer, prompt string, cfg *Config, width int) *RuneBuffer
			func NewTerminal(cfg *Config) (*Terminal, error)
			func (*Instance).ReadPasswordWithConfig(cfg *Config) ([]byte, error)
			func (*Instance).SetConfig(cfg *Config) *Config
			func (*Operation).PasswordWithConfig(cfg *Config) ([]byte, error)
			func (*Operation).SetConfig(cfg *Config) (*Config, error)
			func (*RemoteSvr).HandleConfig(cfg *Config)
			func (*RuneBuffer).SetConfig(cfg *Config)
			func (*Terminal).SetConfig(c *Config) error
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func newOpHistory(cfg *Config) (o *opHistory)
			func newOpSearch(w io.Writer, buf *RuneBuffer, history *opHistory, cfg *Config, width int) *opSearch

	 type DumpListener (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			f func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)
		Methods (only one, which is exported)
			(*T) OnChange(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)
		Implements (at least one exported)
			*T : Listener

	 type DynamicCompleteFunc (func)
		Caller type for dynamic completion

		As Inputs Of (at least one exported)
			func PcItemDynamic(callback DynamicCompleteFunc, pc ...PrefixCompleterInterface) *PrefixCompleter

	 type DynamicPrefixCompleterInterface (interface)

		Methods (total 7, all are exported)
			( T) Do(line []rune, pos int) (newLine [][]rune, length int)
			( T) GetChildren() []PrefixCompleterInterface
			( T) GetDynamicNames(line []rune) [][]rune
			( T) GetName() []rune
			( T) IsDynamic() bool
			( T) Print(prefix string, level int, buf *bytes.Buffer)
			( T) SetChildren(children []PrefixCompleterInterface)
		Implemented By (at least one exported)
			*PrefixCompleter
		Implements (at least 2, both are exported)
			 T : AutoCompleter
			 T : PrefixCompleterInterface

	 type FillableStdin (struct)
		FillableStdin is a stdin reader which can prepend some data before
		reading into the real stdin

		Fields (total 7, in which 1 are exported)
			Mutex sync.Mutex
			/* 6 unexporteds ... *//* 6 unexporteds: */
			buf []byte
			bufErr error
			Mutex.sema uint32
			Mutex.state int32
			stdin io.Reader
			stdinBuffer io.ReadCloser
		Methods (total 7, in which 4 are exported)
			(*T) Close() error
			(*T) Lock()
				Lock locks m.
				If the lock is already in use, the calling goroutine
				blocks until the mutex is available.

			(*T) Read(p []byte) (n int, err error)
				Read will read from the local buffer and if no data, read from stdin

			(*T) Unlock()
				Unlock unlocks m.
				It is a run-time error if m is not locked on entry to Unlock.

				A locked Mutex is not associated with a particular goroutine.
				It is allowed for one goroutine to lock a Mutex and then
				arrange for another goroutine to unlock it.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*T) ioloop()
			(*T) lockSlow()
			(*T) unlockSlow(new int32)
		Implements (at least 4, all are exported)
			*T : io.Closer
			*T : io.ReadCloser
			*T : io.Reader
			*T : sync.Locker

	 type Instance (struct)

		Fields (total 3, all are exported)
			Config *Config
			Operation *Operation
			Terminal *Terminal
		Methods (total 25, all are exported)
			(*T) Clean()
			(*T) Close() error
				we must make sure that call Close() before process exit.

			(*T) GenPasswordConfig() *Config
			(*T) HistoryDisable()
				HistoryDisable the save of the commands into the history

			(*T) HistoryEnable()
				HistoryEnable the save of the commands into the history (default on)

			(*T) IsVimMode() bool
			(*T) Line() *Result
			(*T) ReadPassword(prompt string) ([]byte, error)
			(*T) ReadPasswordEx(prompt string, l Listener) ([]byte, error)
			(*T) ReadPasswordWithConfig(cfg *Config) ([]byte, error)
				we can generate a config by `i.GenPasswordConfig()`

			(*T) ReadSlice() ([]byte, error)
				same as readline

			(*T) Readline() (string, error)
				err is one of (nil, io.EOF, readline.ErrInterrupt)

			(*T) ReadlineWithDefault(what string) (string, error)
			(*T) Refresh()
			(*T) ResetHistory()
			(*T) SaveHistory(content string) error
			(*T) SetConfig(cfg *Config) *Config
			(*T) SetHistoryPath(p string)
				change history persistence in runtime

			(*T) SetMaskRune(r rune)
			(*T) SetPrompt(s string)
			(*T) SetVimMode(on bool)
				switch VimMode in runtime

			(*T) Stderr() io.Writer
				readline will refresh automatic when write through Stdout()

			(*T) Stdout() io.Writer
				readline will refresh automatic when write through Stdout()

			(*T) Write(b []byte) (int, error)
			(*T) WriteStdin(val []byte) (int, error)
				WriteStdin prefill the next Stdin fetch
				Next time you call ReadLine() this value will be writen before the user input
				ie :
				 i := readline.New()
				 i.WriteStdin([]byte("test"))
				 _, _= i.Readline()

				gives

				> test[cursor]

		Implements (at least 3, all are exported)
			*T : io.Closer
			*T : io.WriteCloser
			*T : io.Writer
		As Outputs Of (at least 4, in which 3 are exported)
			func HandleConn(cfg Config, conn net.Conn) (*Instance, error)
			func New(prompt string) (*Instance, error)
			func NewEx(cfg *Config) (*Instance, error)
			/* at least one unexported ... *//* at least one unexported: */
			func getInstance() *Instance
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var std *Instance

	 type InterruptError (struct)

		Fields (only one, which is exported)
			Line []rune
		Methods (only one, which is exported)
			(*T) Error() string
		Implements (at least one exported)
			*T : error

	 type Listener (interface)

		Methods (only one, which is exported)
			( T) OnChange(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)
		Implemented By (at least one exported)
			*DumpListener
		As Outputs Of (at least one exported)
			func FuncListener(f func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)) Listener
		As Inputs Of (at least 2, both are exported)
			func (*Instance).ReadPasswordEx(prompt string, l Listener) ([]byte, error)
			func (*Operation).PasswordEx(prompt string, l Listener) ([]byte, error)

	 type Message (struct)

		Fields (total 2, both are exported)
			Data []byte
			Type MsgType
		Methods (only one, which is exported)
			(*T) WriteTo(w io.Writer) (int, error)
		As Outputs Of (at least 2, both are exported)
			func NewMessage(t MsgType, data []byte) *Message
			func ReadMessage(r io.Reader) (*Message, error)
		As Inputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func newWriteCtx(msg *Message) *writeCtx
			func (*RemoteCli).writeMsg(m *Message) error
			func (*RemoteSvr).writeMsg(m *Message) error

	 type MsgType int16 (basic type)

		As Inputs Of (at least one exported)
			func NewMessage(t MsgType, data []byte) *Message
		As Types Of (total 7, all are exported)
			const T_DATA
			const T_EOF
			const T_ERAW
			const T_ISTTY_REPORT
			const T_RAW
			const T_WIDTH
			const T_WIDTH_REPORT

	 type Operation (struct)

		Fields (total 29, none are exported)
			/* 29 unexporteds ... *//* 29 unexporteds: */
			buf *RuneBuffer
			cfg *Config
			errchan chan error
			history *opHistory
			m sync.Mutex
			opCompleter *opCompleter
			opCompleter.candidate [][]rune
			opCompleter.candidateChoise int
			opCompleter.candidateColNum int
			opCompleter.candidateOff int
			opCompleter.candidateSource []rune
			opCompleter.inCompleteMode bool
			opCompleter.inSelectMode bool
			opPassword *opPassword
			opPassword.backupCfg *Config
			opPassword.o *Operation
			opSearch *opSearch
			opSearch.data []rune
			opSearch.dir int
			opSearch.inMode bool
			opSearch.markEnd int
			opSearch.markStart int
			opSearch.source *list.Element
			opSearch.state int
			opVim *opVim
			opVim.vimMode int
			outchan chan []rune
			t *Terminal
			w io.Writer
		Methods (total 56, in which 47 are exported)
			(*T) Clean()
			(*T) Close()
			( T) CompleteRefresh()
			( T) EnterCompleteMode(offset int, candidate [][]rune)
			( T) EnterCompleteSelectMode()
			( T) EnterPasswordMode(cfg *Config) (err error)
			( T) EnterVimInsertMode()
			( T) ExitCompleteMode(revent bool)
			( T) ExitCompleteSelectMode()
			( T) ExitPasswordMode()
			( T) ExitSearchMode(revert bool)
			( T) ExitVimInsertMode()
			( T) ExitVimMode()
			(*T) GenPasswordConfig() *Config
			(*T) GetConfig() *Config
			( T) HandleCompleteSelect(r rune) bool
			( T) HandleVim(r rune, readNext func() rune) rune
			( T) HandleVimNormal(r rune, readNext func() rune) (t rune)
			( T) IsEnableVimMode() bool
			( T) IsInCompleteMode() bool
			( T) IsInCompleteSelectMode() bool
			(*T) IsNormalMode() bool
			( T) IsSearchMode() bool
			( T) OnComplete() bool
			(*T) Password(prompt string) ([]byte, error)
			( T) PasswordConfig() *Config
			(*T) PasswordEx(prompt string, l Listener) ([]byte, error)
			(*T) PasswordWithConfig(cfg *Config) ([]byte, error)
			(*T) Refresh()
			(*T) ResetHistory()
			(*T) Runes() ([]rune, error)
			(*T) SaveHistory(content string) error
				if err is not nil, it just mean it fail to write to file
				other things goes fine.

			( T) SearchBackspace()
			( T) SearchChar(r rune)
			( T) SearchMode(dir int) bool
			( T) SearchRefresh(x int)
			(*T) SetBuffer(what string)
			(*T) SetConfig(cfg *Config) (*Config, error)
			(*T) SetHistoryPath(path string)
			(*T) SetMaskRune(r rune)
			(*T) SetPrompt(s string)
			(*T) SetTitle(t string)
			( T) SetVimMode(on bool)
			(*T) Slice() ([]byte, error)
			(*T) Stderr() io.Writer
			(*T) Stdout() io.Writer
			(*T) String() (string, error)
			/* 9 unexporteds ... *//* 9 unexporteds: */
			( T) aggCandidate(candidate [][]rune) int
			( T) doSelect()
			( T) findHistoryBy(isNewSearch bool) (int, *list.Element)
			( T) getMatrixSize() int
			( T) handleVimNormalEnterInsert(r rune, readNext func() rune) (t rune, handled bool)
			( T) handleVimNormalMovement(r rune, readNext func() rune) (t rune, handled bool)
			(*T) ioloop()
			( T) nextCandidate(i int)
			( T) search(isChange bool) bool
		As Outputs Of (at least 2, both are exported)
			func NewOperation(t *Terminal, cfg *Config) *Operation
			func (*Terminal).Readline() *Operation
		As Inputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func newOpCompleter(w io.Writer, op *Operation, width int) *opCompleter
			func newOpPassword(o *Operation) *opPassword
			func newVimMode(op *Operation) *opVim

	 type Painter (interface)

		Methods (only one, which is exported)
			( T) Paint(line []rune, pos int) []rune
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*defaultPainter
		As Inputs Of (at least one exported)
			func (*Config).SetPainter(p Painter)

	 type PrefixCompleter (struct)

		Fields (total 4, all are exported)
			Callback DynamicCompleteFunc
			Children []PrefixCompleterInterface
			Dynamic bool
			Name []rune
		Methods (total 8, all are exported)
			(*T) Do(line []rune, pos int) (newLine [][]rune, offset int)
			(*T) GetChildren() []PrefixCompleterInterface
			(*T) GetDynamicNames(line []rune) [][]rune
			(*T) GetName() []rune
			(*T) IsDynamic() bool
			(*T) Print(prefix string, level int, buf *bytes.Buffer)
			(*T) SetChildren(children []PrefixCompleterInterface)
			(*T) Tree(prefix string) string
		Implements (at least 3, all are exported)
			*T : AutoCompleter
			*T : DynamicPrefixCompleterInterface
			*T : PrefixCompleterInterface
		As Outputs Of (at least 3, all are exported)
			func NewPrefixCompleter(pc ...PrefixCompleterInterface) *PrefixCompleter
			func PcItem(name string, pc ...PrefixCompleterInterface) *PrefixCompleter
			func PcItemDynamic(callback DynamicCompleteFunc, pc ...PrefixCompleterInterface) *PrefixCompleter

	 type PrefixCompleterInterface (interface)

		Methods (total 5, all are exported)
			( T) Do(line []rune, pos int) (newLine [][]rune, length int)
			( T) GetChildren() []PrefixCompleterInterface
			( T) GetName() []rune
			( T) Print(prefix string, level int, buf *bytes.Buffer)
			( T) SetChildren(children []PrefixCompleterInterface)
		Implemented By (at least 2, both are exported)
			 DynamicPrefixCompleterInterface (interface)
			*PrefixCompleter
		Implements (at least one exported)
			 T : AutoCompleter
		As Outputs Of (at least 3, all are exported)
			func DynamicPrefixCompleterInterface.GetChildren() []PrefixCompleterInterface
			func (*PrefixCompleter).GetChildren() []PrefixCompleterInterface
			func PrefixCompleterInterface.GetChildren() []PrefixCompleterInterface
		As Inputs Of (at least 9, in which 8 are exported)
			func Do(p PrefixCompleterInterface, line []rune, pos int) (newLine [][]rune, offset int)
			func NewPrefixCompleter(pc ...PrefixCompleterInterface) *PrefixCompleter
			func PcItem(name string, pc ...PrefixCompleterInterface) *PrefixCompleter
			func PcItemDynamic(callback DynamicCompleteFunc, pc ...PrefixCompleterInterface) *PrefixCompleter
			func Print(p PrefixCompleterInterface, prefix string, level int, buf *bytes.Buffer)
			func DynamicPrefixCompleterInterface.SetChildren(children []PrefixCompleterInterface)
			func (*PrefixCompleter).SetChildren(children []PrefixCompleterInterface)
			func PrefixCompleterInterface.SetChildren(children []PrefixCompleterInterface)
			/* at least one unexported ... *//* at least one unexported: */
			func doInternal(p PrefixCompleterInterface, line []rune, pos int, origLine []rune) (newLine [][]rune, offset int)

	 type RawMode (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			state *State
		Methods (total 2, both are exported)
			(*T) Enter() (err error)
			(*T) Exit() error

	 type RemoteCli (struct)

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			conn net.Conn
			data bytes.Buffer
			dataM sync.Mutex
			inited int32
			isTerminal *bool
			raw RawMode
			receiveChan chan struct{}
		Methods (total 10, in which 5 are exported)
			(*T) Close()
			(*T) MarkIsTerminal(is bool)
			(*T) Serve() error
			(*T) ServeBy(source io.Reader) error
			(*T) Write(b []byte) (int, error)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) init() error
			(*T) readLoop()
			(*T) reportIsTerminal() error
			(*T) reportWidth() error
			(*T) writeMsg(m *Message) error
		Implements (at least one exported)
			*T : io.Writer
		As Outputs Of (at least one exported)
			func NewRemoteCli(conn net.Conn) (*RemoteCli, error)

	 type RemoteSvr (struct)

		Fields (total 11, none are exported)
			/* 11 unexporteds ... *//* 11 unexporteds: */
			closed int32
			conn net.Conn
			dataBuf bytes.Buffer
			dataBufM sync.Mutex
			eof int32
			funcWidthChan func()
			isTerminal bool
			reciveChan chan struct{}
			stopChan chan struct{}
			width int32
			writeChan chan *writeCtx
		Methods (total 15, in which 10 are exported)
			(*T) Close() error
			(*T) EnterRawMode() error
			(*T) ExitRawMode() error
			(*T) GetWidth() int
			(*T) GotIsTerminal(data []byte)
			(*T) GotReportWidth(data []byte)
			(*T) HandleConfig(cfg *Config)
			(*T) IsTerminal() bool
			(*T) Read(b []byte) (int, error)
			(*T) Write(b []byte) (int, error)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) checkEOF() error
			(*T) init(buf *bufio.Reader) error
			(*T) readLoop(buf *bufio.Reader)
			(*T) writeLoop()
			(*T) writeMsg(m *Message) error
		Implements (at least 7, all are exported)
			*T : io.Closer
			*T : io.ReadCloser
			*T : io.Reader
			*T : io.ReadWriteCloser
			*T : io.ReadWriter
			*T : io.WriteCloser
			*T : io.Writer
		As Outputs Of (at least one exported)
			func NewRemoteSvr(conn net.Conn) (*RemoteSvr, error)

	 type Result (struct)

		Fields (total 2, both are exported)
			Error error
			Line string
		Methods (total 2, both are exported)
			(*T) CanBreak() bool
			(*T) CanContinue() bool
		As Outputs Of (at least one exported)
			func (*Instance).Line() *Result

	 type RuneBuffer (struct)

		Fields (total 14, in which 1 are exported)
			Mutex sync.Mutex
			/* 13 unexporteds ... *//* 13 unexporteds: */
			bck *runeBufferBck
			buf []rune
			cfg *Config
			hadClean bool
			idx int
			interactive bool
			lastKill []rune
			Mutex.sema uint32
			Mutex.state int32
			offset string
			prompt []rune
			w io.Writer
			width int
		Methods (total 60, in which 46 are exported)
			(*T) BackEscapeWord()
			(*T) Backspace()
			(*T) Backup()
			(*T) Clean()
			(*T) CurrentWidth(x int) int
			(*T) CursorLineCount() int
			(*T) Delete() (success bool)
			(*T) DeleteWord()
			(*T) Erase()
			(*T) IdxLine(width int) int
			(*T) IsCursorInEnd() bool
			(*T) Kill()
			(*T) KillFront()
			(*T) Len() int
			(*T) LineCount(width int) int
			(*T) Lock()
				Lock locks m.
				If the lock is already in use, the calling goroutine
				blocks until the mutex is available.

			(*T) MoveBackward()
			(*T) MoveForward()
			(*T) MoveTo(ch rune, prevChar, reverse bool) (success bool)
			(*T) MoveToEndWord()
			(*T) MoveToLineEnd()
			(*T) MoveToLineStart()
			(*T) MoveToNextWord()
			(*T) MoveToPrevWord() (success bool)
			(*T) OnWidthChange(newWidth int)
			(*T) Pos() int
			(*T) PromptLen() int
			(*T) Refresh(f func())
			(*T) Replace(ch rune)
			(*T) Reset() []rune
			(*T) Restore()
			(*T) RuneSlice(i int) []rune
			(*T) Runes() []rune
			(*T) Set(buf []rune)
			(*T) SetConfig(cfg *Config)
			(*T) SetMask(m rune)
			(*T) SetOffset(offset string)
			(*T) SetPrompt(prompt string)
			(*T) SetStyle(start, end int, style string)
			(*T) SetWithIdx(idx int, buf []rune)
			(*T) Transpose()
			(*T) Unlock()
				Unlock unlocks m.
				It is a run-time error if m is not locked on entry to Unlock.

				A locked Mutex is not associated with a particular goroutine.
				It is allowed for one goroutine to lock a Mutex and then
				arrange for another goroutine to unlock it.

			(*T) WriteRune(s rune)
			(*T) WriteRunes(s []rune)
			(*T) WriteString(s string)
			(*T) Yank()
			/* 14 unexporteds ... *//* 14 unexporteds: */
			(*T) calWidth(m int) int
			(*T) clean()
			(*T) cleanOutput(w io.Writer, idxLine int)
			(*T) cleanWithIdxLine(idxLine int)
			(*T) getBackspaceSequence() []byte
			(*T) getSplitByLine(rs []rune) []string
			(*T) idxLine(width int) int
			(*T) isInLineEdge() bool
			(*T) lockSlow()
			(*T) output() []byte
			(*T) print()
			(*T) promptLen() int
			(*T) pushKill(text []rune)
			(*T) unlockSlow(new int32)
		Implements (at least one exported)
			*T : sync.Locker
		As Outputs Of (at least one exported)
			func NewRuneBuffer(w io.Writer, prompt string, cfg *Config, width int) *RuneBuffer
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newOpSearch(w io.Writer, buf *RuneBuffer, history *opHistory, cfg *Config, width int) *opSearch

	 type Runes (struct)

		Methods (total 18, all are exported)
			( T) Aggregate(candicate [][]rune) (same []rune, size int)
			( T) Backspace(r []rune) []byte
			( T) ColorFilter(r []rune) []rune
			( T) Copy(r []rune) []rune
			( T) Equal(a, b []rune) bool
			( T) EqualFold(a, b []rune) bool
			( T) EqualRune(a, b rune, fold bool) bool
			( T) EqualRuneFold(a, b rune) bool
			( T) HasPrefix(r, prefix []rune) bool
			( T) HasPrefixFold(r, prefix []rune) bool
			( T) Index(r rune, rs []rune) int
			( T) IndexAll(r, sub []rune) int
				Search in runes from front to end

			( T) IndexAllBck(r, sub []rune) int
				Search in runes from end to front

			( T) IndexAllBckEx(r, sub []rune, fold bool) int
			( T) IndexAllEx(r, sub []rune, fold bool) int
			( T) TrimSpaceLeft(in []rune) []rune
			( T) Width(r rune) int
			( T) WidthAll(r []rune) (length int)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var runes

	 type SegmentComplete (struct)

		Fields (only one, which is exported)
			SegmentCompleter SegmentCompleter
		Methods (total 2, both are exported)
			(*T) Do(line []rune, pos int) (newLine [][]rune, offset int)
			( T) DoSegment([][]rune, int) [][]rune
				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]

		Implements (at least 2, both are exported)
			*T : AutoCompleter
			 T : SegmentCompleter
		As Outputs Of (at least one exported)
			func SegmentAutoComplete(completer SegmentCompleter) *SegmentComplete

	 type SegmentCompleter (interface)

		Methods (only one, which is exported)
			( T) DoSegment([][]rune, int) [][]rune
				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]

		Implemented By (at least 2, in which 1 are exported)
			 SegmentComplete
			/* at least one unexported ... *//* at least one unexported: */
			*dumpSegmentCompleter
		As Inputs Of (at least one exported)
			func SegmentAutoComplete(completer SegmentCompleter) *SegmentComplete

	 type State (struct)
		State contains the state of a terminal.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			termios Termios
		As Outputs Of (at least 2, both are exported)
			func GetState(fd int) (*State, error)
			func MakeRaw(fd int) (*State, error)
		As Inputs Of (at least 2, in which 1 are exported)
			func Restore(fd int, state *State) error
			/* at least one unexported ... *//* at least one unexported: */
			func restoreTerm(fd int, state *State) error

	 type TabCompleter (struct)

		Methods (only one, which is exported)
			(*T) Do([]rune, int) ([][]rune, int)
		Implements (at least one exported)
			*T : AutoCompleter

	 type Terminal (struct)

		Fields (total 10, none are exported)
			/* 10 unexporteds ... *//* 10 unexporteds: */
			cfg *Config
			closed int32
			isReading int32
			kickChan chan struct{}
			m sync.Mutex
			outchan chan rune
			sizeChan chan string
			sleeping int32
			stopChan chan struct{}
			wg sync.WaitGroup
		Methods (total 18, in which 16 are exported)
			(*T) Bell()
			(*T) Close() error
			(*T) EnterRawMode() (err error)
			(*T) ExitRawMode() (err error)
			(*T) GetConfig() *Config
			(*T) GetOffset(f func(offset string))
			(*T) IsReading() bool
			(*T) KickRead()
			(*T) Print(s string)
			(*T) PrintRune(r rune)
			(*T) ReadRune() rune
				return rune(0) if meet EOF

			(*T) Readline() *Operation
			(*T) SetConfig(c *Config) error
			(*T) SleepToResume()
				SleepToResume will sleep myself, and return only if I'm resumed.

			(*T) Write(b []byte) (int, error)
			(*T) WriteStdin(b []byte) (int, error)
				WriteStdin prefill the next Stdin fetch
				Next time you call ReadLine() this value will be writen before the user input

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) getStdin() io.Reader
			(*T) ioloop()
		Implements (at least 3, all are exported)
			*T : io.Closer
			*T : io.WriteCloser
			*T : io.Writer
		As Outputs Of (at least one exported)
			func NewTerminal(cfg *Config) (*Terminal, error)
		As Inputs Of (at least one exported)
			func NewOperation(t *Terminal, cfg *Config) *Operation

	 type Termios syscall.Termios (struct)

		Fields (total 9, all are exported)
			Cc [32]uint8
			Cflag uint32
			Iflag uint32
			Ispeed uint32
			Lflag uint32
			Line uint8
			Oflag uint32
			Ospeed uint32
			Pad_cgo_0 [3]byte
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func getTermios(fd int) (*Termios, error)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func setTermios(fd int, termios *Termios) error

	/* 15 unexporteds ... *//* 15 unexporteds: */
	 type defaultPainter (struct)

		Methods (only one, which is exported)
			(*T) Paint(line []rune, _ int) []rune
		Implements (at least one exported)
			*T : Painter

	 type dumpSegmentCompleter (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			f func([][]rune, int) [][]rune
		Methods (only one, which is exported)
			(*T) DoSegment(segment [][]rune, n int) [][]rune
		Implements (at least one exported)
			*T : SegmentCompleter

	 type escapeKeyPair (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			attr string
			typ rune
		Methods (only one, which is exported)
			(*T) Get2() (int, int, bool)
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func readEscKey(r rune, reader *bufio.Reader) *escapeKeyPair
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func escapeExKey(key *escapeKeyPair) rune

	 type hisItem (struct)

		Fields (total 3, all are exported)
			Source []rune
			Tmp []rune
			Version int64
		Methods (only one, which is exported)
			(*T) Clean()

	 type opCompleter (struct)

		Fields (total 10, none are exported)
			/* 10 unexporteds ... *//* 10 unexporteds: */
			candidate [][]rune
			candidateChoise int
			candidateColNum int
			candidateOff int
			candidateSource []rune
			inCompleteMode bool
			inSelectMode bool
			op *Operation
			w io.Writer
			width int
		Methods (total 14, in which 10 are exported)
			(*T) CompleteRefresh()
			(*T) EnterCompleteMode(offset int, candidate [][]rune)
			(*T) EnterCompleteSelectMode()
			(*T) ExitCompleteMode(revent bool)
			(*T) ExitCompleteSelectMode()
			(*T) HandleCompleteSelect(r rune) bool
			(*T) IsInCompleteMode() bool
			(*T) IsInCompleteSelectMode() bool
			(*T) OnComplete() bool
			(*T) OnWidthChange(newWidth int)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) aggCandidate(candidate [][]rune) int
			(*T) doSelect()
			(*T) getMatrixSize() int
			(*T) nextCandidate(i int)
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newOpCompleter(w io.Writer, op *Operation, width int) *opCompleter

	 type opHistory (struct)

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			cfg *Config
			current *list.Element
			enable bool
			fd *os.File
			fdLock sync.Mutex
			history *list.List
			historyVer int64
		Methods (total 21, in which 16 are exported)
			(*T) Close()
			(*T) Compact()
			(*T) Disable()
				Disable the current history

			(*T) Enable()
				Enable the current history

			(*T) FindBck(isNewSearch bool, rs []rune, start int) (int, *list.Element)
			(*T) FindFwd(isNewSearch bool, rs []rune, start int) (int, *list.Element)
			(*T) Init()
			(*T) IsHistoryClosed() bool
			(*T) New(current []rune) (err error)
				save history

			(*T) Next() ([]rune, bool)
			(*T) Prev() []rune
			(*T) Push(s []rune)
			(*T) Reset()
			(*T) Revert()
			(*T) Rewrite()
			(*T) Update(s []rune, commit bool) (err error)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) debug()
			(*T) historyUpdatePath(path string)
				only called by newOpHistory

			(*T) initHistory()
			(*T) rewriteLocked()
			(*T) showItem(obj interface{}) []rune
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newOpHistory(cfg *Config) (o *opHistory)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newOpSearch(w io.Writer, buf *RuneBuffer, history *opHistory, cfg *Config, width int) *opSearch

	 type opPassword (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			backupCfg *Config
			o *Operation
		Methods (total 3, all are exported)
			(*T) EnterPasswordMode(cfg *Config) (err error)
			(*T) ExitPasswordMode()
			(*T) PasswordConfig() *Config
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newOpPassword(o *Operation) *opPassword

	 type opSearch (struct)

		Fields (total 12, none are exported)
			/* 12 unexporteds ... *//* 12 unexporteds: */
			buf *RuneBuffer
			cfg *Config
			data []rune
			dir int
			history *opHistory
			inMode bool
			markEnd int
			markStart int
			source *list.Element
			state int
			w io.Writer
			width int
		Methods (total 9, in which 7 are exported)
			(*T) ExitSearchMode(revert bool)
			(*T) IsSearchMode() bool
			(*T) OnWidthChange(newWidth int)
			(*T) SearchBackspace()
			(*T) SearchChar(r rune)
			(*T) SearchMode(dir int) bool
			(*T) SearchRefresh(x int)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) findHistoryBy(isNewSearch bool) (int, *list.Element)
			(*T) search(isChange bool) bool
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newOpSearch(w io.Writer, buf *RuneBuffer, history *opHistory, cfg *Config, width int) *opSearch

	 type opVim (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			cfg *Config
			op *Operation
			vimMode int
		Methods (total 9, in which 7 are exported)
			(*T) EnterVimInsertMode()
			(*T) ExitVimInsertMode()
			(*T) ExitVimMode()
			(*T) HandleVim(r rune, readNext func() rune) rune
			(*T) HandleVimNormal(r rune, readNext func() rune) (t rune)
			(*T) IsEnableVimMode() bool
			(*T) SetVimMode(on bool)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) handleVimNormalEnterInsert(r rune, readNext func() rune) (t rune, handled bool)
			(*T) handleVimNormalMovement(r rune, readNext func() rune) (t rune, handled bool)
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newVimMode(op *Operation) *opVim

	 type runeBufferBck (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			buf []rune
			idx int

	 type termSize (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			left int
			top int

	 type winsize (struct)

		Fields (total 4, all are exported)
			Col uint16
			Row uint16
			Xpixel uint16
			Ypixel uint16

	 type wrapWriter (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			r *Operation
			t *Terminal
			target io.Writer
		Methods (only one, which is exported)
			(*T) Write(b []byte) (int, error)
		Implements (at least one exported)
			*T : io.Writer

	 type writeCtx (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			msg *Message
			reply chan *writeReply
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newWriteCtx(msg *Message) *writeCtx

	 type writeReply (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			err error
			n int


Package-Level Functions (total 65, in which 48 are exported)

	 func AddHistory(content string) error
		add history to global instance manually
		raise error only if `SetHistoryPath` is set with a non-empty path

	 func ClearScreen(w io.Writer) (int, error)
		ClearScreen clears the console screen

	 func Debug(o ...interface{})
		append log info to another file

	 func DefaultIsTerminal() bool
	 func DefaultOnWidthChanged(f func())
	 func DialRemote(n, addr string) error
	 func Do(p PrefixCompleterInterface, line []rune, pos int) (newLine [][]rune, offset int)
	 func FuncListener(f func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)) Listener
	 func GetInt(s []string, def int) int
	 func GetScreenWidth() int
	 func GetSize(fd int) (int, int, error)
		GetSize returns the dimensions of the given terminal.

	 func GetState(fd int) (*State, error)
		GetState returns the current state of a terminal which may be useful to
		restore the terminal after a signal.

	 func GetStdin() int
	 func HandleConn(cfg Config, conn net.Conn) (*Instance, error)
	 func IsPrintable(key rune) bool
	 func IsTerminal(fd int) bool
		IsTerminal returns true if the given file descriptor is a terminal.

	 func IsWordBreak(i rune) bool
	 func Line(prompt string) (string, error)
		readline with global configs

	 func LineCount(screenWidth, w int) int
		calculate how many lines for N character

	 func ListenRemote(n, addr string, cfg *Config, h func(*Instance), onListen ...func(net.Listener) error) error
	 func MakeRaw(fd int) (*State, error)
		MakeRaw put the terminal connected to the given file descriptor into raw
		mode and returns the previous state of the terminal so that it can be
		restored.

	 func New(prompt string) (*Instance, error)
	 func NewCancelableStdin(r io.Reader) *CancelableStdin
	 func NewEx(cfg *Config) (*Instance, error)
	 func NewFillableStdin(stdin io.Reader) (io.ReadCloser, io.Writer)
		NewFillableStdin gives you FillableStdin

	 func NewMessage(t MsgType, data []byte) *Message
	 func NewOperation(t *Terminal, cfg *Config) *Operation
	 func NewPrefixCompleter(pc ...PrefixCompleterInterface) *PrefixCompleter
	 func NewRemoteCli(conn net.Conn) (*RemoteCli, error)
	 func NewRemoteSvr(conn net.Conn) (*RemoteSvr, error)
	 func NewRuneBuffer(w io.Writer, prompt string, cfg *Config, width int) *RuneBuffer
	 func NewTerminal(cfg *Config) (*Terminal, error)
	 func Password(prompt string) ([]byte, error)
	 func PcItem(name string, pc ...PrefixCompleterInterface) *PrefixCompleter
	 func PcItemDynamic(callback DynamicCompleteFunc, pc ...PrefixCompleterInterface) *PrefixCompleter
	 func Print(p PrefixCompleterInterface, prefix string, level int, buf *bytes.Buffer)
	 func ReadMessage(r io.Reader) (*Message, error)
	 func ReadPassword(fd int) ([]byte, error)
		ReadPassword reads a line of input from a terminal without local echo.  This
		is commonly used for inputting passwords and other sensitive data. The slice
		returned does not include the \n.

	 func Restore(fd int, state *State) error
	 func RetSegment(segments [][]rune, cands [][]rune, idx int) ([][]rune, int)
	 func SegmentAutoComplete(completer SegmentCompleter) *SegmentComplete
	 func SegmentFunc(f func([][]rune, int) [][]rune) AutoCompleter
	 func SetAutoComplete(completer AutoCompleter)
		set auto completer to global instance

	 func SetHistoryPath(fp string)
		let readline load history from filepath
		and try to persist history into disk
		set fp to "" to prevent readline persisting history to disk
		so the `AddHistory` will return nil error forever.

	 func SplitByLine(start, screenWidth int, rs []rune) []string
	 func SplitSegment(line []rune, pos int) ([][]rune, int)
	 func SuspendMe()
		SuspendMe use to send suspend signal to myself, when we in the raw mode.
		For OSX it need to send to parent's pid
		For Linux it need to send to myself

	 func WaitForResume() chan struct{}
		WaitForResume need to call before current process got suspend.
		It will run a ticker until a long duration is occurs,
		which means this process is resumed.

	/* 17 unexporteds ... *//* 17 unexporteds: */
	 func debugList(l *list.List)
		print a linked list to Debug()

	 func doInternal(p PrefixCompleterInterface, line []rune, pos int, origLine []rune) (newLine [][]rune, offset int)
	 func escapeExKey(key *escapeKeyPair) rune
		translate Esc[X

	 func escapeKey(r rune, reader *bufio.Reader) rune
		translate EscX to Meta+X

	 func getInstance() *Instance
		global instance will not submit history automatic

	 func getTermios(fd int) (*Termios, error)
	 func getWidth(stdoutFd int) int
		get width of the terminal

	 func newOpCompleter(w io.Writer, op *Operation, width int) *opCompleter
	 func newOpHistory(cfg *Config) (o *opHistory)
	 func newOpPassword(o *Operation) *opPassword
	 func newOpSearch(w io.Writer, buf *RuneBuffer, history *opHistory, cfg *Config, width int) *opSearch
	 func newVimMode(op *Operation) *opVim
	 func newWriteCtx(msg *Message) *writeCtx
	 func readEscKey(r rune, reader *bufio.Reader) *escapeKeyPair
	 func restoreTerm(fd int, state *State) error
		Restore restores the terminal connected to the given file descriptor to a
		previous state.

	 func setTermios(fd int, termios *Termios) error
	 func sleep(n int)
Package-Level Variables (total 13, in which 5 are exported)

	  var ErrInterrupt error
	  var Stderr io.WriteCloser
	  var Stdin io.ReadCloser
	  var Stdout io.WriteCloser
	  var TabWidth int
	/* 8 unexporteds ... *//* 8 unexporteds: */
	  var doubleWidth []*unicode.RangeTable
	  var isWindows bool
	  var runes Runes
	  var std *Instance
	  var stdOnce sync.Once
	  var widthChange sync.Once
	  var widthChangeCallback ()
	  var zeroWidth []*unicode.RangeTable
Package-Level Constants (total 46, in which 44 are exported)

	const CharBackspace = 127
	const CharBackward = 2
	const CharBckSearch = 18
	const CharBell = 7
	const CharCtrlH = 8
	const CharCtrlJ = 10
	const CharCtrlL = 12
	const CharCtrlU = 21
	const CharCtrlW = 23
	const CharCtrlY = 25
	const CharCtrlZ = 26
	const CharDelete = 4
	const CharEnter = 13
	const CharEsc = 27
	const CharEscapeEx = 91
	const CharForward = 6
	const CharFwdSearch = 19
	const CharInterrupt = 3
	const CharKill = 11
	const CharLineEnd = 5
	const CharLineStart = 1
	const CharNext = 14
	const CharPrev = 16
	const CharTab = 9
	const CharTranspose = 20
	const MetaBackspace rune = -4
	const MetaBackward rune = -1
	const MetaDelete rune = -3
	const MetaForward rune = -2
	const MetaTranspose rune = -5
	const S_DIR_BCK = 0
	const S_DIR_FWD = 1
	const S_STATE_FAILING = 1
	const S_STATE_FOUND = 0
	const T_DATA MsgType = 0
	const T_EOF MsgType = 6
	const T_ERAW MsgType = 5 // exit raw
	const T_ISTTY_REPORT MsgType = 3
	const T_RAW MsgType = 4
	const T_WIDTH MsgType = 1
	const T_WIDTH_REPORT MsgType = 2
	const VIM_INSERT = 1
	const VIM_NORMAL = 0
	const VIM_VISUAL = 2
	/* 2 unexporteds ... *//* 2 unexporteds: */
	const ioctlReadTermios = 21505 // syscall.TCGETS
		These constants are declared here, rather than importing
		them from the syscall package as some syscall packages, even
		on linux, for example gccgo, do not declare them.

	const ioctlWriteTermios = 21506 // syscall.TCSETS

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.