prompt

package module

Go to main page

Versions in this module

v1

v1.0.1

Oct 9, 2024

v1.0.0

Jul 19, 2023

Changes in this version

+ var ASCIISequences = []*ASCIICode

+ func GoCmdBeginning(buf *Buffer)

+ func GoCmdEnd(buf *Buffer)

+ func NewReverseSearch(history *History) *reverseSearchState

type Buffer

+ func (b *Buffer) NewLineCount() int

+ func (b *Buffer) ReplaceTabs(tabWidth int) *Buffer

+ func (b *Buffer) SplitWideLines(maxWidth int) *Buffer

type ConsoleWriter

+ SetDisplayAttributes func(fg, bg Color, attrs ...DisplayAttribute)

type Document

+ func (d *Document) FindWordEndForwardCursor(isWordPart func(rune) bool) int

+ func (d *Document) FindWordStartBackwardCursor(isWordPart func(rune) bool) int

+ func (d *Document) GetCursorPosition() (row, col int)

+ func (d *Document) GetCustomCursorPosition(cursor int) (row, col int)

+ func (d *Document) LastKeyStroke() Key

+ func (d *Document) TranslateRowColToCursor(row int, column int) (index int)

+ type ExitChecker func(in string, breakline bool) bool

type History

+ func (h *History) FindMatch(input string, prefix int) int

+ func (h *History) SetCurrentCmd(cmd string)

type Key

+ func GetKey(b []byte) Key

type Option

+ func OptionBreakLineCallback(fn func(*Document)) Option

+ func OptionCompletionOnDown() Option

+ func OptionDisableAutoHistory() Option

+ func OptionEnableRenderSubscribeMode(socketUri string) Option

+ func OptionInitialBufferText(x string) Option

+ func OptionReverseSearch() Option

+ func OptionSetExitCheckerOnInput(fn ExitChecker) Option

type Prompt

+ func (p *Prompt) ClearScreen()

+ func (p *Prompt) PushToHistory(cmd string) error

type Render

+ func (r *Render) ClearScreen()

v0

v0.2.3

Oct 24, 2018

Changes in this version

type ConsoleWriter

+ func NewStderrWriter() ConsoleWriter

+ func NewStdoutWriter() ConsoleWriter

type Option

+ func OptionShowCompletionAtStart() Option

type Suggest

+ func FilterFuzzy(completions []Suggest, sub string, ignoreCase bool) []Suggest

v0.2.2

Jun 28, 2018

Changes in this version

+ func DeleteBeforeChar(buf *Buffer)

+ func DeleteChar(buf *Buffer)

+ func DeleteWord(buf *Buffer)

+ func GoLeftChar(buf *Buffer)

+ func GoLeftWord(buf *Buffer)

+ func GoLineBeginning(buf *Buffer)

+ func GoLineEnd(buf *Buffer)

+ func GoRightChar(buf *Buffer)

+ func GoRightWord(buf *Buffer)

+ type ASCIICodeBind struct

+ ASCIICode []byte

+ Fn KeyBindFunc

type Buffer

+ func (b *Buffer) DisplayCursorPosition() int

+ type DisplayAttribute int

+ const DisplayBlink

+ const DisplayBold

+ const DisplayCrossedOut

+ const DisplayDefaultFont

+ const DisplayInvisible

+ const DisplayItalic

+ const DisplayLowIntensity

+ const DisplayRapidBlink

+ const DisplayReset

+ const DisplayReverse

+ const DisplayUnderline

type Document

+ func (d *Document) DisplayCursorPosition() int

+ func (d *Document) FindEndOfCurrentWord() int

+ func (d *Document) FindEndOfCurrentWordUntilSeparator(sep string) int

+ func (d *Document) FindEndOfCurrentWordUntilSeparatorIgnoreNextToCursor(sep string) int

+ func (d *Document) FindEndOfCurrentWordWithSpace() int

+ func (d *Document) FindStartOfPreviousWordUntilSeparator(sep string) int

+ func (d *Document) FindStartOfPreviousWordUntilSeparatorIgnoreNextToCursor(sep string) int

+ func (d *Document) GetWordAfterCursor() string

+ func (d *Document) GetWordAfterCursorUntilSeparator(sep string) string

+ func (d *Document) GetWordAfterCursorUntilSeparatorIgnoreNextToCursor(sep string) string

+ func (d *Document) GetWordAfterCursorWithSpace() string

+ func (d *Document) GetWordBeforeCursorUntilSeparator(sep string) string

+ func (d *Document) GetWordBeforeCursorUntilSeparatorIgnoreNextToCursor(sep string) string

type Option

+ func OptionAddASCIICodeBind(b ...ASCIICodeBind) Option

+ func OptionCompletionWordSeparator(x string) Option

type Prompt

+ ASCIICodeBindings []ASCIICodeBind

type VT100Writer

+ func (w *VT100Writer) SetDisplayAttributes(fg, bg Color, attrs ...DisplayAttribute)

v0.2.1

Feb 14, 2018

v0.2.0

Feb 13, 2018

Changes in this version

type ConsoleParser

+ Read func() ([]byte, error)

type Option

+ func OptionLivePrefix(f func() (prefix string, useLivePrefix bool)) Option

+ func OptionScrollbarBGColor(x Color) Option

+ func OptionScrollbarThumbColor(x Color) Option

+ type PosixParser struct — darwin/amd64, js/wasm, linux/amd64

+ func NewStandardInputParser() *PosixParser

+ func (t *PosixParser) GetKey(b []byte) Key

+ func (t *PosixParser) GetWinSize() *WinSize

+ func (t *PosixParser) Read() ([]byte, error)

+ func (t *PosixParser) Setup() error

+ func (t *PosixParser) TearDown() error

+ type PosixWriter struct — darwin/amd64, js/wasm, linux/amd64

+ func NewStandardOutputWriter() *PosixWriter

+ func (w *PosixWriter) AskForCPR()

+ func (w *PosixWriter) ClearTitle()

+ func (w *PosixWriter) CursorBackward(n int)

+ func (w *PosixWriter) CursorDown(n int)

+ func (w *PosixWriter) CursorForward(n int)

+ func (w *PosixWriter) CursorGoTo(row, col int)

+ func (w *PosixWriter) CursorUp(n int)

+ func (w *PosixWriter) EraseDown()

+ func (w *PosixWriter) EraseEndOfLine()

+ func (w *PosixWriter) EraseLine()

+ func (w *PosixWriter) EraseScreen()

+ func (w *PosixWriter) EraseStartOfLine()

+ func (w *PosixWriter) EraseUp()

+ func (w *PosixWriter) Flush() error

+ func (w *PosixWriter) HideCursor()

+ func (w *PosixWriter) SaveCursor()

+ func (w *PosixWriter) ScrollDown()

+ func (w *PosixWriter) ScrollUp()

+ func (w *PosixWriter) SetColor(fg, bg Color, bold bool)

+ func (w *PosixWriter) SetTitle(title string)

+ func (w *PosixWriter) ShowCursor()

+ func (w *PosixWriter) UnSaveCursor()

+ func (w *PosixWriter) Write(data []byte)

+ func (w *PosixWriter) WriteRaw(data []byte)

+ func (w *PosixWriter) WriteRawStr(data string)

+ func (w *PosixWriter) WriteStr(data string)

+ type WindowsParser struct — windows/amd64

+ func NewStandardInputParser() *WindowsParser

+ func (p *WindowsParser) GetKey(b []byte) Key

+ func (p *WindowsParser) GetWinSize() *WinSize

+ func (p *WindowsParser) Read() ([]byte, error)

+ func (p *WindowsParser) Setup() error

+ func (p *WindowsParser) TearDown() error

+ type WindowsWriter struct — windows/amd64

+ func NewStandardOutputWriter() *WindowsWriter

+ func (w *WindowsWriter) AskForCPR()

+ func (w *WindowsWriter) ClearTitle()

+ func (w *WindowsWriter) CursorBackward(n int)

+ func (w *WindowsWriter) CursorDown(n int)

+ func (w *WindowsWriter) CursorForward(n int)

+ func (w *WindowsWriter) CursorGoTo(row, col int)

+ func (w *WindowsWriter) CursorUp(n int)

+ func (w *WindowsWriter) EraseDown()

+ func (w *WindowsWriter) EraseEndOfLine()

+ func (w *WindowsWriter) EraseLine()

+ func (w *WindowsWriter) EraseScreen()

+ func (w *WindowsWriter) EraseStartOfLine()

+ func (w *WindowsWriter) EraseUp()

+ func (w *WindowsWriter) Flush() error

+ func (w *WindowsWriter) HideCursor()

+ func (w *WindowsWriter) SaveCursor()

+ func (w *WindowsWriter) ScrollDown()

+ func (w *WindowsWriter) ScrollUp()

+ func (w *WindowsWriter) SetColor(fg, bg Color, bold bool)

+ func (w *WindowsWriter) SetTitle(title string)

+ func (w *WindowsWriter) ShowCursor()

+ func (w *WindowsWriter) UnSaveCursor()

+ func (w *WindowsWriter) Write(data []byte)

+ func (w *WindowsWriter) WriteRaw(data []byte)

+ func (w *WindowsWriter) WriteRawStr(data string)

+ func (w *WindowsWriter) WriteStr(data string)

v0.1.1

Oct 10, 2017

Changes in this version

type Document

+ func (d *Document) FindStartOfPreviousWordWithSpace() int

+ func (d *Document) GetWordBeforeCursorWithSpace() string

+ type Option func(prompt *Prompt) error

+ func OptionSwitchKeyBindMode(m KeyBindMode) Option

v0.1.0

Aug 14, 2017

Changes in this version

+ func BisectLeft(a []int, v int) int

+ func BisectRight(a []int, v int) int

+ func Choose(prefix string, choices []string, opts ...option) string

+ func Input(prefix string, completer Completer, opts ...option) string

+ func OptionAddKeyBind(b ...KeyBind) option

+ func OptionDescriptionBGColor(x Color) option

+ func OptionDescriptionTextColor(x Color) option

+ func OptionHistory(x []string) option

+ func OptionInputBGColor(x Color) option

+ func OptionInputTextColor(x Color) option

+ func OptionMaxSuggestion(x uint16) option

+ func OptionParser(x ConsoleParser) option

+ func OptionPrefix(x string) option

+ func OptionPrefixBackgroundColor(x Color) option

+ func OptionPrefixTextColor(x Color) option

+ func OptionPreviewSuggestionBGColor(x Color) option

+ func OptionPreviewSuggestionTextColor(x Color) option

+ func OptionSelectedDescriptionBGColor(x Color) option

+ func OptionSelectedDescriptionTextColor(x Color) option

+ func OptionSelectedSuggestionBGColor(x Color) option

+ func OptionSelectedSuggestionTextColor(x Color) option

+ func OptionSuggestionBGColor(x Color) option

+ func OptionSuggestionTextColor(x Color) option

+ func OptionTitle(x string) option

+ func OptionWriter(x ConsoleWriter) option

+ func SwitchKeyBindMode(m KeyBindMode) option

+ type ASCIICode struct

+ ASCIICode []byte

+ Key Key

+ type Buffer struct

+ CursorPosition int

+ func NewBuffer() (b *Buffer)

+ func (b *Buffer) CursorDown(count int)

+ func (b *Buffer) CursorLeft(count int)

+ func (b *Buffer) CursorRight(count int)

+ func (b *Buffer) CursorUp(count int)

+ func (b *Buffer) Delete(count int) (deleted string)

+ func (b *Buffer) DeleteBeforeCursor(count int) (deleted string)

+ func (b *Buffer) Document() (d *Document)

+ func (b *Buffer) InsertText(v string, overwrite bool, moveCursor bool)

+ func (b *Buffer) JoinNextLine(separator string)

+ func (b *Buffer) NewLine(copyMargin bool)

+ func (b *Buffer) SwapCharactersBeforeCursor()

+ func (b *Buffer) Text() string

+ type Color int

+ const Black

+ const Blue

+ const Brown

+ const Cyan

+ const DarkBlue

+ const DarkGray

+ const DarkGreen

+ const DarkRed

+ const DefaultColor

+ const Fuchsia

+ const Green

+ const LightGray

+ const Purple

+ const Red

+ const Turquoise

+ const White

+ const Yellow

+ type Completer func(Document) []Suggest

+ type CompletionManager struct

+ func NewCompletionManager(completer Completer, max uint16) *CompletionManager

+ func (c *CompletionManager) Completing() bool

+ func (c *CompletionManager) GetSelectedSuggestion() (s Suggest, ok bool)

+ func (c *CompletionManager) GetSuggestions() []Suggest

+ func (c *CompletionManager) Next()

+ func (c *CompletionManager) Previous()

+ func (c *CompletionManager) Reset()

+ func (c *CompletionManager) Update(in Document)

+ type ConsoleParser interface

+ GetKey func(b []byte) Key

+ GetWinSize func() *WinSize

+ Setup func() error

+ TearDown func() error

+ type ConsoleWriter interface

+ AskForCPR func()

+ ClearTitle func()

+ CursorBackward func(n int)

+ CursorDown func(n int)

+ CursorForward func(n int)

+ CursorGoTo func(row, col int)

+ CursorUp func(n int)

+ EraseDown func()

+ EraseEndOfLine func()

+ EraseLine func()

+ EraseScreen func()

+ EraseStartOfLine func()

+ EraseUp func()

+ Flush func() error

+ HideCursor func()

+ SaveCursor func()

+ ScrollDown func()

+ ScrollUp func()

+ SetColor func(fg, bg Color, bold bool)

+ SetTitle func(title string)

+ ShowCursor func()

+ UnSaveCursor func()

+ Write func(data []byte)

+ WriteRaw func(data []byte)

+ WriteRawStr func(data string)

+ WriteStr func(data string)

+ type Document struct

+ CursorPosition int

+ Text string

+ func NewDocument() *Document

+ func (d *Document) CurrentLine() string

+ func (d *Document) CurrentLineAfterCursor() string

+ func (d *Document) CurrentLineBeforeCursor() string

+ func (d *Document) CursorPositionCol() (col int)

+ func (d *Document) CursorPositionRow() (row int)

+ func (d *Document) FindStartOfPreviousWord() int

+ func (d *Document) GetCharRelativeToCursor(offset int) (r rune)

+ func (d *Document) GetCursorDownPosition(count int, preferredColumn int) int

+ func (d *Document) GetCursorLeftPosition(count int) int

+ func (d *Document) GetCursorRightPosition(count int) int

+ func (d *Document) GetCursorUpPosition(count int, preferredColumn int) int

+ func (d *Document) GetEndOfLinePosition() int

+ func (d *Document) GetWordBeforeCursor() string

+ func (d *Document) LineCount() int

+ func (d *Document) Lines() []string

+ func (d *Document) OnLastLine() bool

+ func (d *Document) TextAfterCursor() string

+ func (d *Document) TextBeforeCursor() string

+ func (d *Document) TranslateIndexToPosition(index int) (row int, col int)

+ func (d *Document) TranslateRowColToIndex(row int, column int) (index int)

+ type Exec struct

+ type Executor func(string)

+ type Filter func([]Suggest, string, bool) []Suggest

+ type History struct

+ func NewHistory() *History

+ func (h *History) Add(input string)

+ func (h *History) Clear()

+ func (h *History) Newer(buf *Buffer) (new *Buffer, changed bool)

+ func (h *History) Older(buf *Buffer) (new *Buffer, changed bool)

+ type Key int

+ const Any

+ const BackTab

+ const Backspace

+ const BracketedPaste

+ const CPRResponse

+ const ControlA

+ const ControlB

+ const ControlBackslash

+ const ControlC

+ const ControlCircumflex

+ const ControlD

+ const ControlDelete

+ const ControlDown

+ const ControlE

+ const ControlF

+ const ControlG

+ const ControlH

+ const ControlI

+ const ControlJ

+ const ControlK

+ const ControlL

+ const ControlLeft

+ const ControlM

+ const ControlN

+ const ControlO

+ const ControlP

+ const ControlQ

+ const ControlR

+ const ControlRight

+ const ControlS

+ const ControlSpace

+ const ControlSquareClose

+ const ControlT

+ const ControlU

+ const ControlUnderscore

+ const ControlUp

+ const ControlV

+ const ControlW

+ const ControlX

+ const ControlY

+ const ControlZ

+ const Delete

+ const Down

+ const End

+ const Enter

+ const Escape

+ const F1

+ const F10

+ const F11

+ const F12

+ const F13

+ const F14

+ const F15

+ const F16

+ const F17

+ const F18

+ const F19

+ const F2

+ const F20

+ const F21

+ const F22

+ const F23

+ const F24

+ const F3

+ const F4

+ const F5

+ const F6

+ const F7

+ const F8

+ const F9

+ const Home

+ const Ignore

+ const Insert

+ const Left

+ const NotDefined

+ const PageDown

+ const PageUp

+ const Right

+ const ShiftDelete

+ const ShiftDown

+ const ShiftLeft

+ const ShiftRight

+ const ShiftUp

+ const Tab

+ const Up

+ const Vt100MouseEvent

+ const WindowsMouseEvent

+ func (i Key) String() string

+ type KeyBind struct

+ Fn KeyBindFunc

+ Key Key

+ type KeyBindFunc func(*Buffer)

+ type KeyBindMode string

+ const CommonKeyBind

+ const EmacsKeyBind

+ type Prompt struct

+ func New(executor Executor, completer Completer, opts ...option) *Prompt

+ func (p *Prompt) Input() string

+ func (p *Prompt) Run()

+ type Render struct

+ func (r *Render) BreakLine(buffer *Buffer)

+ func (r *Render) Render(buffer *Buffer, completion *CompletionManager)

+ func (r *Render) Setup()

+ func (r *Render) TearDown()

+ func (r *Render) UpdateWinSize(ws *WinSize)

+ type Suggest struct

+ Description string

+ Text string

+ func FilterContains(completions []Suggest, sub string, ignoreCase bool) []Suggest

+ func FilterHasPrefix(completions []Suggest, sub string, ignoreCase bool) []Suggest

+ func FilterHasSuffix(completions []Suggest, sub string, ignoreCase bool) []Suggest

+ type VT100Parser struct

+ func NewVT100StandardInputParser() *VT100Parser

+ func (t *VT100Parser) GetKey(b []byte) Key

+ func (t *VT100Parser) GetWinSize() *WinSize

+ func (t *VT100Parser) Setup() error

+ func (t *VT100Parser) TearDown() error

+ type VT100Writer struct

+ func NewVT100StandardOutputWriter() *VT100Writer

+ func (w *VT100Writer) AskForCPR()

+ func (w *VT100Writer) ClearTitle()

+ func (w *VT100Writer) CursorBackward(n int)

+ func (w *VT100Writer) CursorDown(n int)

+ func (w *VT100Writer) CursorForward(n int)

+ func (w *VT100Writer) CursorGoTo(row, col int)

+ func (w *VT100Writer) CursorUp(n int)

+ func (w *VT100Writer) EraseDown()

+ func (w *VT100Writer) EraseEndOfLine()

+ func (w *VT100Writer) EraseLine()

+ func (w *VT100Writer) EraseScreen()

+ func (w *VT100Writer) EraseStartOfLine()

+ func (w *VT100Writer) EraseUp()

+ func (w *VT100Writer) Flush() error

+ func (w *VT100Writer) HideCursor()

+ func (w *VT100Writer) SaveCursor()

+ func (w *VT100Writer) ScrollDown()

+ func (w *VT100Writer) ScrollUp()

+ func (w *VT100Writer) SetColor(fg, bg Color, bold bool)

+ func (w *VT100Writer) SetTitle(title string)

+ func (w *VT100Writer) ShowCursor()

+ func (w *VT100Writer) UnSaveCursor()

+ func (w *VT100Writer) Write(data []byte)

+ func (w *VT100Writer) WriteRaw(data []byte)

+ func (w *VT100Writer) WriteRawStr(data string)

+ func (w *VT100Writer) WriteStr(data string)

+ type WinSize struct

+ Col uint16

+ Row uint16

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL