promptx

package module

Go to main page

Versions in this module

v1

v1.0.2

Aug 24, 2023

Changes in this version

type Context

+ MustInput func(tip string, checker InputChecker) string

type Promptx

+ func (p *Promptx) MustInput(tip string, checker InputChecker) string

v1.0.1

Aug 23, 2023

Changes in this version

type CmdContext

+ func (ctx *CmdContext) ArgSelectString(index int, tip string, list []string, defaultSelect ...int) string

type CommandContext

+ ArgSelectString func(index int, tip string, list []string, defaultSelect ...int) string

type Context

+ InputFloat32 func(tip string, val float32, check ...func(in float32) error) (_ float32, eof error)

+ InputFloat32Slice func(tip string, val []float32, check ...func(in []float32) error) (_ []float32, eof error)

+ InputFloat64 func(tip string, val float64, check ...func(in float64) error) (_ float64, eof error)

+ InputFloat64Slice func(tip string, val []float64, check ...func(in []float64) error) (_ []float64, eof error)

+ InputInt func(tip string, val int, check ...func(in int) error) (_ int, eof error)

+ InputInt32 func(tip string, val int32, check ...func(in int32) error) (_ int32, eof error)

+ InputInt32Slice func(tip string, val []int32, check ...func(in []int32) error) (_ []int32, eof error)

+ InputInt64 func(tip string, val int64, check ...func(in int64) error) (_ int64, eof error)

+ InputInt64Slice func(tip string, val []int64, check ...func(in []int64) error) (_ []int64, eof error)

+ InputIntSlice func(tip string, val []int, check ...func(in []int) error) (_ []int, eof error)

+ InputString func(tip string, val string, check ...func(in string) error) (_ string, eof error)

+ InputStringSlice func(tip string, val []string, check ...func(in []string) error) (_ []string, eof error)

+ MulSelString func(tip string, list []string, defaultSelects ...int) (result []string)

+ MultInput func(tip string, checker InputChecker) string

+ MustInputFloat32 func(tip string, val float32, check ...func(in float32) error) float32

+ MustInputFloat32Slice func(tip string, val []float32, check ...func(in []float32) error) []float32

+ MustInputFloat64 func(tip string, val float64, check ...func(in float64) error) float64

+ MustInputFloat64Slice func(tip string, val []float64, check ...func(in []float64) error) []float64

+ MustInputInt func(tip string, val int, check ...func(in int) error) int

+ MustInputInt32 func(tip string, val int32, check ...func(in int32) error) int32

+ MustInputInt32Slice func(tip string, val []int32, check ...func(in []int32) error) []int32

+ MustInputInt64 func(tip string, val int64, check ...func(in int64) error) int64

+ MustInputInt64Slice func(tip string, val []int64, check ...func(in []int64) error) []int64

+ MustInputIntSlice func(tip string, val []int, check ...func(in []int) error) []int

+ MustInputString func(tip string, val string, check ...func(in string) error) string

+ MustInputStringSlice func(tip string, val []string, check ...func(in []string) error) []string

+ MustMulSel func(tip string, list []string, defaultSelects ...int) (result []int)

+ MustMulSelString func(tip string, list []string, defaultSelects ...int) (result []string)

+ MustSelect func(tip string, list []string, defaultSelect ...int) (result int)

+ MustSelectString func(tip string, list []string, defaultSelect ...int) string

+ RawInput func(tip string, opts ...InputOption) (result string, err error)

+ RawMulSel func(tip string, list []string, opts ...SelectOption) (result []int)

+ RawSelect func(tip string, list []string, opts ...SelectOption) (result int)

+ SelectString func(tip string, list []string, defaultSelect ...int) (_ string, cancel bool)

type InputChecker

+ func InputFloat32() InputChecker

+ func InputFloat32Slice() InputChecker

+ func InputFloat64() InputChecker

+ func InputFloat64Slice() InputChecker

type InputOption

+ func WithInputOptionDefaultText(v string) InputOption

+ func WithInputOptionDefaultTextAny(v interface{}) InputOption

+ func WithInputOptionDefaultTextBGColor(v Color) InputOption

+ func WithInputOptionDefaultTextColor(v Color) InputOption

type InputOptions

+ DefaultText string

+ DefaultTextBGColor Color

+ DefaultTextColor Color

type Promptx

+ func (p *Promptx) InputFloat32(tip string, val float32, check ...func(in float32) error) (_ float32, eof error)

+ func (p *Promptx) InputFloat32Slice(tip string, val []float32, check ...func(in []float32) error) (_ []float32, eof error)

+ func (p *Promptx) InputFloat64(tip string, val float64, check ...func(in float64) error) (_ float64, eof error)

+ func (p *Promptx) InputFloat64Slice(tip string, val []float64, check ...func(in []float64) error) (_ []float64, eof error)

+ func (p *Promptx) InputInt(tip string, val int, check ...func(in int) error) (_ int, eof error)

+ func (p *Promptx) InputInt32(tip string, val int32, check ...func(in int32) error) (_ int32, eof error)

+ func (p *Promptx) InputInt32Slice(tip string, val []int32, check ...func(in []int32) error) (_ []int32, eof error)

+ func (p *Promptx) InputInt64(tip string, val int64, check ...func(in int64) error) (_ int64, eof error)

+ func (p *Promptx) InputInt64Slice(tip string, val []int64, check ...func(in []int64) error) (_ []int64, eof error)

+ func (p *Promptx) InputIntSlice(tip string, val []int, check ...func(in []int) error) (_ []int, eof error)

+ func (p *Promptx) InputString(tip string, val string, check ...func(in string) error) (_ string, eof error)

+ func (p *Promptx) InputStringSlice(tip string, val []string, check ...func(in []string) error) (_ []string, eof error)

+ func (p *Promptx) MulSelString(tip string, list []string, defaultSelects ...int) (result []string)

+ func (p *Promptx) MultInput(tip string, checker InputChecker) string

+ func (p *Promptx) MustInputFloat32(tip string, val float32, check ...func(in float32) error) float32

+ func (p *Promptx) MustInputFloat32Slice(tip string, val []float32, check ...func(in []float32) error) []float32

+ func (p *Promptx) MustInputFloat64(tip string, val float64, check ...func(in float64) error) float64

+ func (p *Promptx) MustInputFloat64Slice(tip string, val []float64, check ...func(in []float64) error) []float64

+ func (p *Promptx) MustInputInt(tip string, val int, check ...func(in int) error) int

+ func (p *Promptx) MustInputInt32(tip string, val int32, check ...func(in int32) error) int32

+ func (p *Promptx) MustInputInt32Slice(tip string, val []int32, check ...func(in []int32) error) []int32

+ func (p *Promptx) MustInputInt64(tip string, val int64, check ...func(in int64) error) int64

+ func (p *Promptx) MustInputInt64Slice(tip string, val []int64, check ...func(in []int64) error) []int64

+ func (p *Promptx) MustInputIntSlice(tip string, val []int, check ...func(in []int) error) []int

+ func (p *Promptx) MustInputString(tip string, val string, check ...func(in string) error) string

+ func (p *Promptx) MustInputStringSlice(tip string, val []string, check ...func(in []string) error) []string

+ func (p *Promptx) MustMulSel(tip string, list []string, defaultSelects ...int) (result []int)

+ func (p *Promptx) MustMulSelString(tip string, list []string, defaultSelects ...int) (result []string)

+ func (p *Promptx) MustSelect(tip string, list []string, defaultSelect ...int) (result int)

+ func (p *Promptx) MustSelectString(tip string, list []string, defaultSelect ...int) string

+ func (p *Promptx) RawInput(tip string, opts ...InputOption) (result string, err error)

+ func (p *Promptx) RawMulSel(tip string, list []string, opts ...SelectOption) (result []int)

+ func (p *Promptx) RawSelect(tip string, list []string, opts ...SelectOption) (result int)

+ func (p *Promptx) SelectString(tip string, list []string, defaultSelect ...int) (_ string, cancel bool)

type SelectOption

+ func WithSelectOptionDefaultSelects(v ...int) SelectOption

type SelectOptions

+ DefaultSelects []int

v0

v0.0.7

Aug 21, 2023

Changes in this version

type CmdContext

+ func (ctx *CmdContext) ArgInput(index int, tip string, opts ...InputOption) (result string, eof error)

+ func (ctx *CmdContext) ArgSelect(index int, tip string, list []string, opts ...SelectOption) int

+ func (ctx *CmdContext) GetArgs() []string

type CommandContext

+ ArgInput func(index int, tip string, opts ...InputOption) (result string, eof error)

+ ArgSelect func(index int, tip string, list []string, opts ...SelectOption) int

+ GetArgs func() []string

type InputChecker

+ func InputNotEmptyAndSpace() InputChecker

v0.0.6

Jun 7, 2023

Changes in this version

type SelectBlockManager

+ func (m *SelectBlockManager) TearDown()

v0.0.5

May 24, 2023

v0.0.4

May 23, 2023

Changes in this version

+ type PromptMain interface

+ ExecCommand func(args []string)

+ Run func() error

v0.0.3

Jan 28, 2023

v0.0.2

Jan 28, 2023

Changes in this version

+ func InstallCommandSetOptionsWatchDog(dog func(cc *CommandSetOptions))

type Cmd

+ func NewCommand(name, help string, args ...CommandParameter) *Cmd

+ func NewCommandWithFunc(name, help string, f func(ctx CommandContext), args ...CommandParameter) *Cmd

+ func (c *Cmd) DeleteSubCommand(name string)

+ func (c *Cmd) DynamicTip(f func(line string) []*Suggest) *Cmd

+ func (c *Cmd) ExecFunc(f func(ctx CommandContext)) *Cmd

+ func (c *Cmd) FixCommandLine(line string, args []string) string

+ func (c *Cmd) LogHelp(long string) *Cmd

+ type CmdContext struct

+ Args []string

+ ChangeFlag bool

+ Cmds []*Cmd

+ Cur *Cmd

+ InputCC *InputOptions

+ Line string

+ Root *Cmd

+ SelectCC *SelectOptions

+ func (ctx *CmdContext) CheckAddrs(index int) (addrs []string)

+ func (ctx *CmdContext) CheckIPPort(index int) (ip, port string)

+ func (ctx *CmdContext) CheckInteger(index int) int64

+ func (ctx *CmdContext) CheckSelectIndex(index int) int

+ func (ctx *CmdContext) CheckString(index int) string

type CommandContext

+ CheckAddrs func(index int) (addrs []string)

+ CheckIPPort func(index int) (ip, port string)

+ CheckInteger func(index int) int64

+ CheckSelectIndex func(index int) int

+ CheckString func(index int) string

+ type CommandParameter interface

+ Check func(ctx *CmdContext, index int) (err error)

+ func WithArgSelect(tip string, list []string, opts ...SelectOption) CommandParameter

+ func WithArgsInput(tip string, check InputChecker, opts ...InputOption) CommandParameter

+ type CommandSetOption func(cc *CommandSetOptions) CommandSetOption

+ func WithCommandSetOptionChangeNotify(v func(ctx Context, args []interface{})) CommandSetOption

+ func WithCommandSetOptionHistoryFile(v string) CommandSetOption

+ func WithCommandSetOptionPreCheck(v func(ctx Context) error) CommandSetOption

+ func WithCommandSetOptionPrompt(prompt string) CommandSetOption

+ func WithCommandSetOptionPromptWords(v ...*Word) CommandSetOption

+ type CommandSetOptions struct

+ ChangeNotify func(ctx Context, args []interface{})

+ Commands []*Cmd

+ HistoryFile string

+ Name string

+ PreCheck func(ctx Context) error

+ PromptWords []*Word

+ func NewCommandSetOptions(opts ...CommandSetOption) *CommandSetOptions

+ func (cc *CommandSetOptions) ApplyOption(opts ...CommandSetOption)

+ func (cc *CommandSetOptions) GetSetOption(opt CommandSetOption) CommandSetOption

+ func (cc *CommandSetOptions) SetOption(opt CommandSetOption)

type CommonBlockManager

+ func (m *CommonBlockManager) AddHistory(line string)

+ func (m *CommonBlockManager) RemoveHistory(line string)

+ func (m *CommonBlockManager) ResetCommands(cmds ...*Cmd)

+ func (m *CommonBlockManager) ResetHistoryFile(filename string)

+ func (m *CommonBlockManager) SetCommandPreCheck(f func(ctx Context) error)

type CommonOption

+ func WithCommonOptionCommandPreCheck(v func(ctx Context) error) CommonOption

type CommonOptions

+ CommandPreCheck func(ctx Context) error

type Context

+ AddCommandSet func(name string, cmds []*Cmd, opts ...CommandSetOption)

+ AddHistory func(line string)

+ RemoveHistory func(line string)

+ ResetCommands func(commands ...*Cmd)

+ ResetHistoryFile func(filename string)

+ SetCommandPreCheck func(f func(ctx Context) error)

+ SwitchCommandSet func(name string, args ...interface{})

+ type InputChecker func(d *Document) (err error)

+ func InputAddrsArray() InputChecker

+ func InputIPPort() InputChecker

+ func InputInteger() InputChecker

+ func InputIntegerRange(min, max int64) InputChecker

+ func InputNaturalNumber() InputChecker

+ func InputNotEmpty() InputChecker

+ func InputNotZeroInteger() InputChecker

type Promptx

+ func (p *Promptx) AddCommandSet(name string, cmds []*Cmd, opts ...CommandSetOption)

+ func (p *Promptx) AddHistory(line string)

+ func (p *Promptx) RemoveHistory(line string)

+ func (p *Promptx) ResetCommands(commands ...*Cmd)

+ func (p *Promptx) ResetHistoryFile(filename string)

+ func (p *Promptx) SetCommandPreCheck(f func(ctx Context) error)

+ func (p *Promptx) SwitchCommandSet(name string, args ...interface{})

v0.0.1

Aug 3, 2022

Changes in this version

+ const Any

+ const BackTab

+ const Backspace

+ const Black

+ const Blue

+ const BracketedPaste

+ const Brown

+ const CPRResponse

+ const CancelStatus

+ 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 ControlK

+ const ControlL

+ const ControlLeft

+ 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 Cyan

+ const DarkBlue

+ const DarkGray

+ const DarkGreen

+ const DarkRed

+ const DefaultColor

+ 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 FinishStatus

+ const Fuchsia

+ const Green

+ const Home

+ const Ignore

+ const Insert

+ const Left

+ const LightGray

+ const MetaA

+ const MetaB

+ const MetaC

+ const MetaD

+ const MetaE

+ const MetaF

+ const MetaG

+ const MetaH

+ const MetaI

+ const MetaJ

+ const MetaK

+ const MetaL

+ const MetaM

+ const MetaN

+ const MetaO

+ const MetaP

+ const MetaQ

+ const MetaR

+ const MetaS

+ const MetaShiftA

+ const MetaShiftB

+ const MetaShiftC

+ const MetaShiftD

+ const MetaShiftE

+ const MetaShiftF

+ const MetaShiftG

+ const MetaShiftH

+ const MetaShiftI

+ const MetaShiftJ

+ const MetaShiftK

+ const MetaShiftL

+ const MetaShiftM

+ const MetaShiftN

+ const MetaShiftO

+ const MetaShiftP

+ const MetaShiftQ

+ const MetaShiftR

+ const MetaShiftS

+ const MetaShiftT

+ const MetaShiftU

+ const MetaShiftV

+ const MetaShiftW

+ const MetaShiftX

+ const MetaShiftY

+ const MetaShiftZ

+ const MetaT

+ const MetaU

+ const MetaV

+ const MetaW

+ const MetaX

+ const MetaY

+ const MetaZ

+ const NormalStatus

+ const NotDefined

+ const PageDown

+ const PageUp

+ const Purple

+ const Red

+ const Right

+ const ShiftDelete

+ const ShiftDown

+ const ShiftLeft

+ const ShiftRight

+ const ShiftUp

+ const Tab

+ const Turquoise

+ const Up

+ const Vt100MouseEvent

+ const White

+ const WindowsMouseEvent

+ const Yellow

+ var AskWord = Word

+ var FailureWord = Word

+ var NewLineWord = Word

+ var SelectWord = Word

+ var SuccessWord = Word

+ func CommonOptionsOptionDeclareWithDefault() interface

+ func CompleteOptionsOptionDeclareWithDefault() interface

+ func Equal(a, b []rune) bool

+ func HasPrefix(r, prefix []rune) bool

+ func InputOptionsOptionDeclareWithDefault() interface

+ func InstallCommonOptionsWatchDog(dog func(cc *CommonOptions))

+ func InstallCompleteOptionsWatchDog(dog func(cc *CompleteOptions))

+ func InstallInputOptionsWatchDog(dog func(cc *InputOptions))

+ func InstallPromptOptionsWatchDog(dog func(cc *PromptOptions))

+ func InstallSelectOptionsWatchDog(dog func(cc *SelectOptions))

+ func PromptOptionsOptionDeclareWithDefault() interface

+ func SelectOptionsOptionDeclareWithDefault() interface

+ func TrimFirstSpace(in []rune) []rune

+ func TrimSpaceLeft(in []rune) []rune

+ type ASCIICode = input.ASCIICode

+ type BlocksBaseManager struct

+ func (m *BlocksBaseManager) AddMirrorMode(mode ...ConsoleBlocks)

+ func (m *BlocksBaseManager) Backward(from, n int) int

+ func (m *BlocksBaseManager) ChangeStatus()

+ func (m *BlocksBaseManager) Clear()

+ func (m *BlocksBaseManager) Columns() int

+ func (m *BlocksBaseManager) Event(key Key, in []byte) (exit bool)

+ func (m *BlocksBaseManager) ExitSign(code int)

+ func (m *BlocksBaseManager) GetContext() Context

+ func (m *BlocksBaseManager) IsInTask() bool

+ func (m *BlocksBaseManager) LineWrap(cursor int)

+ func (m *BlocksBaseManager) Move(from, to int) int

+ func (m *BlocksBaseManager) OnEventBefore(ctx PressContext, key Key, in []byte) (exit bool)

+ func (m *BlocksBaseManager) OnEventBehind(ctx PressContext, key Key, in []byte) (exit bool)

+ func (m *BlocksBaseManager) PrepareArea(lines int)

+ func (m *BlocksBaseManager) Refresh()

+ func (m *BlocksBaseManager) Render(status int)

+ func (m *BlocksBaseManager) Rows() int

+ func (m *BlocksBaseManager) SetBeforeEvent(f EventCall)

+ func (m *BlocksBaseManager) SetBehindEvent(f EventCall)

+ func (m *BlocksBaseManager) SetCallBack(f func(status int, doc *Buffer) bool)

+ func (m *BlocksBaseManager) SetCancelKey(k Key)

+ func (m *BlocksBaseManager) SetCancelKeyAutoExit(exit bool)

+ func (m *BlocksBaseManager) SetChangeStatus(st int)

+ func (m *BlocksBaseManager) SetExecContext(ctx Context)

+ func (m *BlocksBaseManager) SetFinishKey(k Key)

+ func (m *BlocksBaseManager) SetPreCheck(f func(status int, doc *Buffer) bool)

+ func (m *BlocksBaseManager) SetWriter(out ConsoleWriter)

+ func (m *BlocksBaseManager) Setup(size *WinSize)

+ func (m *BlocksBaseManager) TearDown()

+ func (m *BlocksBaseManager) ToPos(cursor int) (x, y int)

+ func (m *BlocksBaseManager) UpdateWinSize(size *WinSize)

+ func (m *BlocksBaseManager) Writer() ConsoleWriter

+ type BlocksCompletion struct

+ Cfg *CompleteOptions

+ Completions *CompletionManager

+ func (c *BlocksCompletion) ApplyOptions(opt ...CompleteOption)

+ func (c *BlocksCompletion) EnterSelect(buf *Buffer) (ok bool)

+ func (c *BlocksCompletion) InitBlocks()

+ func (c *BlocksCompletion) Render(ctx PrintContext, preCursor int) int

+ func (c *BlocksCompletion) Update(doc *Document)

+ type BlocksEmacsBuffer struct

+ BGColor Color

+ TextColor Color

+ func (c *BlocksEmacsBuffer) GetBuffer() *Buffer

+ func (c *BlocksEmacsBuffer) InitBlocks()

+ func (c *BlocksEmacsBuffer) Render(ctx PrintContext, preCursor int) int

+ func (c *BlocksEmacsBuffer) ResetBuffer()

+ type BlocksManager interface

+ ChangeStatus func()

+ Clear func()

+ Columns func() int

+ Event func(key Key, in []byte) (exit bool)

+ ExitSign func(code int)

+ GetContext func() Context

+ IsInTask func() bool

+ Refresh func()

+ Render func(status int)

+ Rows func() int

+ SetChangeStatus func(st int)

+ SetExecContext func(ctx Context)

+ SetWriter func(out ConsoleWriter)

+ Setup func(size *WinSize)

+ TearDown func()

+ UpdateWinSize func(size *WinSize)

+ Writer func() ConsoleWriter

+ type BlocksNewLine struct

+ BGColor Color

+ Text string

+ TextColor Color

+ func (c *BlocksNewLine) Render(ctx PrintContext, preCursor int) int

+ type BlocksPrefix struct

+ BGColor Color

+ Text string

+ TextColor Color

+ Words []*Word

+ func (c *BlocksPrefix) Render(ctx PrintContext, preCursor int) int

+ type BlocksSelect struct

+ SelectFunc func(sels []int)

+ func (c *BlocksSelect) GetSelects() []int

+ func (c *BlocksSelect) InitBlocks()

+ func (c *BlocksSelect) Next(ctx PressContext) (exit bool)

+ func (c *BlocksSelect) Previous(ctx PressContext) (exit bool)

+ func (c *BlocksSelect) Render(ctx PrintContext, preCursor int) int

+ func (c *BlocksSelect) Select(ctx PressContext) (exit bool)

+ type BlocksSuffix struct

+ BGColor Color

+ Text string

+ TextColor Color

+ func (c *BlocksSuffix) Render(ctx PrintContext, preCursor int) int

+ type BlocksWords struct

+ Words []*Word

+ func (c *BlocksWords) Render(ctx PrintContext, preCursor int) (nextCursor int)

+ type Buffer = buffer.Buffer

+ type Cmd struct

+ Aliases []string

+ DynamicCmd func(line string) []*Suggest

+ Func func(c *CommandContext)

+ Help string

+ LongHelp string

+ Name string

+ NewFlags func(set *pflag.FlagSet) interface{}

+ SubCommands []*Cmd

+ func (c *Cmd) AddCmd(cmds ...*Cmd)

+ func (c *Cmd) Children() []*Cmd

+ func (c *Cmd) DeleteCmd(name string)

+ func (c *Cmd) FindSuggest(doc *Document) []*Suggest

+ func (c *Cmd) ParseInput(line string, reset bool) (cmds []*Cmd, args []string, err error)

+ func (c Cmd) HelpText() string

+ type Color = output.Color

+ type CommandContext struct

+ Args []string

+ Cmds []*Cmd

+ Line string

+ Root *Cmd

+ type CommonBlockManager struct

+ Completion *BlocksCompletion

+ Input *BlocksEmacsBuffer

+ PreWords *BlocksWords

+ Tip *BlocksWords

+ Validate *BlocksNewLine

+ func NewDefaultBlockManger(opts ...CommonOption) (m *CommonBlockManager)

+ func (m *CommonBlockManager) ApplyOption(opts ...CommonOption)

+ func (m *CommonBlockManager) BeforeEvent(ctx PressContext, key Key, in []byte) (exit bool)

+ func (m *CommonBlockManager) BehindEvent(ctx PressContext, key Key, in []byte) (exit bool)

+ func (m *CommonBlockManager) ExecCommand(args []string)

+ func (m *CommonBlockManager) FinishCallBack(status int, buf *Buffer) bool

+ func (m *CommonBlockManager) PreCheckCallBack(status int, buf *Buffer) (success bool)

+ func (m *CommonBlockManager) SetOption(opt CommonOption)

+ func (m *CommonBlockManager) SetPrompt(text string)

+ func (m *CommonBlockManager) SetPromptWords(words ...*Word)

+ func (m *CommonBlockManager) TearDown()

+ type CommonOption func(cc *CommonOptions) CommonOption

+ func WithCommonOptionAlwaysCheckCommand(v bool) CommonOption

+ func WithCommonOptionCancelKey(v Key) CommonOption

+ func WithCommonOptionCommands(v ...*Cmd) CommonOption

+ func WithCommonOptionCompletion(v ...CompleteOption) CommonOption

+ func WithCommonOptionExecFunc(v func(ctx Context, command string)) CommonOption

+ func WithCommonOptionFinishKey(v Key) CommonOption

+ func WithCommonOptionHistory(v string) CommonOption

+ func WithCommonOptionPrefixBGColor(v Color) CommonOption

+ func WithCommonOptionPrefixText(v string) CommonOption

+ func WithCommonOptionPrefixTextColor(v Color) CommonOption

+ func WithCommonOptionTipBGColor(v Color) CommonOption

+ func WithCommonOptionTipText(v string) CommonOption

+ func WithCommonOptionTipTextColor(v Color) CommonOption

+ func WithCommonOptionValidBGColor(v Color) CommonOption

+ func WithCommonOptionValidFunc(v func(status int, in *Document) error) CommonOption

+ func WithCommonOptionValidTextColor(v Color) CommonOption

+ type CommonOptions struct

+ AlwaysCheckCommand bool

+ CancelKey Key

+ Commands []*Cmd

+ Completion []CompleteOption

+ ExecFunc func(ctx Context, command string)

+ FinishKey Key

+ History string

+ PrefixBGColor Color

+ PrefixText string

+ PrefixTextColor Color

+ TipBGColor Color

+ TipText string

+ TipTextColor Color

+ ValidBGColor Color

+ ValidFunc func(status int, in *Document) error

+ ValidTextColor Color

+ func NewCommonOptions(opts ...CommonOption) *CommonOptions

+ func (cc *CommonOptions) ApplyOption(opts ...CommonOption)

+ func (cc *CommonOptions) GetSetOption(opt CommonOption) CommonOption

+ func (cc *CommonOptions) SetOption(opt CommonOption)

+ type CompleteOption func(cc *CompleteOptions) CompleteOption

+ func WithCompleteOptionCompleteMax(v int) CompleteOption

+ func WithCompleteOptionCompleter(v Completer) CompleteOption

+ func WithCompleteOptionCompletionFillSpace(v bool) CompleteOption

+ func WithCompleteOptionDescriptionBGColor(v Color) CompleteOption

+ func WithCompleteOptionDescriptionTextColor(v Color) CompleteOption

+ func WithCompleteOptionScrollbarBGColor(v Color) CompleteOption

+ func WithCompleteOptionScrollbarThumbColor(v Color) CompleteOption

+ func WithCompleteOptionSelectedDescriptionBGColor(v Color) CompleteOption

+ func WithCompleteOptionSelectedDescriptionTextColor(v Color) CompleteOption

+ func WithCompleteOptionSelectedSuggestionBGColor(v Color) CompleteOption

+ func WithCompleteOptionSelectedSuggestionTextColor(v Color) CompleteOption

+ func WithCompleteOptionSuggestionBGColor(v Color) CompleteOption

+ func WithCompleteOptionSuggestionTextColor(v Color) CompleteOption

+ type CompleteOptions struct

+ CompleteMax int

+ Completer Completer

+ CompletionFillSpace bool

+ DescriptionBGColor Color

+ DescriptionTextColor Color

+ ScrollbarBGColor Color

+ ScrollbarThumbColor Color

+ SelectedDescriptionBGColor Color

+ SelectedDescriptionTextColor Color

+ SelectedSuggestionBGColor Color

+ SelectedSuggestionTextColor Color

+ SuggestionBGColor Color

+ SuggestionTextColor Color

+ func NewCompleteOptions(opts ...CompleteOption) *CompleteOptions

+ func (cc *CompleteOptions) ApplyOption(opts ...CompleteOption)

+ func (cc *CompleteOptions) GetSetOption(opt CompleteOption) CompleteOption

+ func (cc *CompleteOptions) SetOption(opt CompleteOption)

+ type Completer func(in Document) []*Suggest

+ type CompletionManager = completion.CompletionManager

+ type ConsoleBlocks interface

+ Active func() bool

+ GetBuffer func() *Buffer

+ InitBlocks func()

+ IsDraw func(status int) bool

+ OnEvent func(ctx PressContext, key Key, in []byte) (exit bool)

+ Render func(ctx PrintContext, preCursor int) (cursor int)

+ ResetBuffer func()

+ SetActive func(active bool)

+ type ConsoleParser = input.ConsoleParser

+ type ConsoleWriter = output.ConsoleWriter

+ type Context interface

+ ClearScreen func()

+ ClearTitle func()

+ EnterRawMode func() (err error)

+ ExitRawMode func() (err error)

+ Input func(tip string, opts ...InputOption) (result string, eof error)

+ MulSel func(tip string, list []string, opts ...SelectOption) (sel []int)

+ Print func(v ...interface{})

+ Printf func(fmt string, v ...interface{})

+ Println func(v ...interface{})

+ Select func(tip string, list []string, opts ...SelectOption) (sel int)

+ SetPrompt func(prompt string)

+ SetPromptWords func(words ...*Word)

+ SetTitle func(title string)

+ Stderr func() io.Writer

+ Stdout func() io.Writer

+ Stop func()

+ WPrint func(words ...*Word)

+ WPrintln func(words ...*Word)

+ type Document = buffer.Document

+ type EmptyBlocks struct

+ func (m *EmptyBlocks) Active() bool

+ func (m *EmptyBlocks) BindASCII(bind KeyBindFunc, ins ...byte)

+ func (m *EmptyBlocks) BindKey(bind KeyBindFunc, keys ...Key)

+ func (m *EmptyBlocks) GetBuffer() *Buffer

+ func (m *EmptyBlocks) InitBlocks()

+ func (m *EmptyBlocks) IsBind(key Key) bool

+ func (m *EmptyBlocks) IsDraw(status int) bool

+ func (m *EmptyBlocks) OnEvent(ctx PressContext, key Key, in []byte) (exit bool)

+ func (m *EmptyBlocks) Render(ctx PrintContext, preCursor int) (cursor int)

+ func (m *EmptyBlocks) SetActive(active bool)

+ func (m *EmptyBlocks) SetIsDraw(f func(status int) (draw bool))

+ func (m EmptyBlocks) ResetBuffer()

+ type EventCall func(ctx PressContext, key Key, in []byte) (exit bool)

+ type Filter = completion.Filter

+ type InputBlockManager struct

+ Input *BlocksEmacsBuffer

+ PreWords *BlocksWords

+ Validate *BlocksNewLine

+ func NewInputManager(cc *InputOptions) (m *InputBlockManager)

+ func (m *InputBlockManager) BeforeEvent(ctx PressContext, key Key, in []byte) (exit bool)

+ func (m *InputBlockManager) FinishCallBack(status int, buf *Buffer) bool

+ func (m *InputBlockManager) PreCheckCallBack(status int, buf *Buffer) (success bool)

+ type InputFinishTextFunc func(cc *InputOptions, status int, doc *Document) (words []*Word)

+ type InputOption func(cc *InputOptions) InputOption

+ func WithInputOptionCancelKey(v Key) InputOption

+ func WithInputOptionFinishFunc(v func(input string, eof error)) InputOption

+ func WithInputOptionFinishKey(v Key) InputOption

+ func WithInputOptionPrefixBGColor(v Color) InputOption

+ func WithInputOptionPrefixText(v string) InputOption

+ func WithInputOptionPrefixTextColor(v Color) InputOption

+ func WithInputOptionResultBGColor(v Color) InputOption

+ func WithInputOptionResultText(v InputFinishTextFunc) InputOption

+ func WithInputOptionResultTextColor(v Color) InputOption

+ func WithInputOptionTipBGColor(v Color) InputOption

+ func WithInputOptionTipText(v string) InputOption

+ func WithInputOptionTipTextColor(v Color) InputOption

+ func WithInputOptionValidBGColor(v Color) InputOption

+ func WithInputOptionValidFunc(v func(*Document) error) InputOption

+ func WithInputOptionValidTextColor(v Color) InputOption

+ type InputOptions struct

+ CancelKey Key

+ FinishFunc func(input string, eof error)

+ FinishKey Key

+ PrefixBGColor Color

+ PrefixText string

+ PrefixTextColor Color

+ ResultBGColor Color

+ ResultText InputFinishTextFunc

+ ResultTextColor Color

+ TipBGColor Color

+ TipText string

+ TipTextColor Color

+ ValidBGColor Color

+ ValidFunc func(*Document) error

+ ValidTextColor Color

+ func NewInputOptions(opts ...InputOption) *InputOptions

+ func (cc *InputOptions) ApplyOption(opts ...InputOption)

+ func (cc *InputOptions) GetSetOption(opt InputOption) InputOption

+ func (cc *InputOptions) SetOption(opt InputOption)

+ type Key = input.Key

+ type KeyBind struct

+ Fn KeyBindFunc

+ Key Key

+ type KeyBindFunc func(ctx PressContext) (exit bool)

+ type PressContext interface

+ GetBuffer func() *Buffer

+ GetInput func() []byte

+ GetKey func() Key

+ Writer func() ConsoleWriter

+ type PrintContext interface

+ Backward func(from, n int) int

+ Columns func() int

+ GetBuffer func() *Buffer

+ InputCursor func() int

+ LineWrap func(cursor int)

+ Move func(from, to int) int

+ Prepare func() bool

+ PrepareArea func(lines int)

+ Rows func() int

+ SetBuffer func(buf *Buffer)

+ Status func() int

+ ToPos func(cursor int) (x, y int)

+ Writer func() ConsoleWriter

+ type PromptOption func(cc *PromptOptions) PromptOption

+ func WithBlocksManager(v BlocksManager) PromptOption

+ func WithCommonOpions(v ...CommonOption) PromptOption

+ func WithInput(v input.ConsoleParser) PromptOption

+ func WithInputOptions(v ...InputOption) PromptOption

+ func WithOutput(v output.ConsoleWriter) PromptOption

+ func WithSelectOptions(v ...SelectOption) PromptOption

+ func WithStderr(v output.ConsoleWriter) PromptOption

+ type PromptOptions struct

+ BlocksManager BlocksManager

+ CommonOpions []CommonOption

+ Input input.ConsoleParser

+ InputOptions []InputOption

+ Output output.ConsoleWriter

+ SelectOptions []SelectOption

+ Stderr output.ConsoleWriter

+ func NewPromptOptions(opts ...PromptOption) *PromptOptions

+ func (cc *PromptOptions) ApplyOption(opts ...PromptOption)

+ func (cc *PromptOptions) GetSetOption(opt PromptOption) PromptOption

+ func (cc *PromptOptions) SetOption(opt PromptOption)

+ type Promptx struct

+ func NewCommandPromptx(cmds ...*Cmd) *Promptx

+ func NewOptionCommandPromptx(cc *PromptOptions, cmds ...*Cmd) *Promptx

+ func NewPromptx(opts ...PromptOption) *Promptx

+ func (p *Promptx) ClearScreen()

+ func (p *Promptx) ClearTitle()

+ func (p *Promptx) EnterRawMode() (err error)

+ func (p *Promptx) ExecCommand(args []string)

+ func (p *Promptx) ExitRawMode() (err error)

+ func (p *Promptx) Input(tip string, opts ...InputOption) (result string, err error)

+ func (p *Promptx) MulSel(tip string, list []string, opts ...SelectOption) (result []int)

+ func (p *Promptx) Print(v ...interface{})

+ func (p *Promptx) Printf(format string, v ...interface{})

+ func (p *Promptx) Println(v ...interface{})

+ func (p *Promptx) Run() (err error)

+ func (p *Promptx) Select(tip string, list []string, opts ...SelectOption) (result int)

+ func (p *Promptx) SetPrompt(prompt string)

+ func (p *Promptx) SetPromptWords(words ...*Word)

+ func (p *Promptx) SetTitle(title string)

+ func (p *Promptx) Stderr() io.Writer

+ func (p *Promptx) Stdout() io.Writer

+ func (p *Promptx) Stop()

+ func (p *Promptx) WPrint(words ...*Word)

+ func (p *Promptx) WPrintln(words ...*Word)

+ type SelFinishTextFunc func(cc *SelectOptions, result []int) (words []*Word)

+ type SelHelpTextFunc func(mul bool) (help string)

+ type SelectBlockManager struct

+ PreWords *BlocksWords

+ Select *BlocksSelect

+ Validate *BlocksNewLine

+ func NewSelectManager(cc *SelectOptions) (m *SelectBlockManager)

+ func (m *SelectBlockManager) FinishCallBack(status int, buf *Buffer) bool

+ func (m *SelectBlockManager) PreCheckCallBack(status int, buf *Buffer) (success bool)

+ type SelectOption func(cc *SelectOptions) SelectOption

+ func WithSelectOptionCancelKey(v Key) SelectOption

+ func WithSelectOptionDescriptionBGColor(v Color) SelectOption

+ func WithSelectOptionDescriptionTextColor(v Color) SelectOption

+ func WithSelectOptionFinishFunc(v func(sels []int)) SelectOption

+ func WithSelectOptionFinishKey(v Key) SelectOption

+ func WithSelectOptionFinishText(v SelFinishTextFunc) SelectOption

+ func WithSelectOptionHelpBGColor(v Color) SelectOption

+ func WithSelectOptionHelpText(v SelHelpTextFunc) SelectOption

+ func WithSelectOptionHelpTextColor(v Color) SelectOption

+ func WithSelectOptionMulti(v bool) SelectOption

+ func WithSelectOptionOptions(v ...*Suggest) SelectOption

+ func WithSelectOptionResultBGColor(v Color) SelectOption

+ func WithSelectOptionResultShowItem(v bool) SelectOption

+ func WithSelectOptionResultTextColor(v Color) SelectOption

+ func WithSelectOptionRowsLimit(v int) SelectOption

+ func WithSelectOptionScrollbarBGColor(v Color) SelectOption

+ func WithSelectOptionScrollbarThumbColor(v Color) SelectOption

+ func WithSelectOptionSelectedDescriptionBGColor(v Color) SelectOption

+ func WithSelectOptionSelectedDescriptionTextColor(v Color) SelectOption

+ func WithSelectOptionSelectedSuggestionBGColor(v Color) SelectOption

+ func WithSelectOptionSelectedSuggestionTextColor(v Color) SelectOption

+ func WithSelectOptionShowHelpText(v bool) SelectOption

+ func WithSelectOptionSuggestionBGColor(v Color) SelectOption

+ func WithSelectOptionSuggestionTextColor(v Color) SelectOption

+ func WithSelectOptionTipBGColor(v Color) SelectOption

+ func WithSelectOptionTipText(v string) SelectOption

+ func WithSelectOptionTipTextColor(v Color) SelectOption

+ func WithSelectOptionValidBGColor(v Color) SelectOption

+ func WithSelectOptionValidFunc(v func(sels []int) error) SelectOption

+ func WithSelectOptionValidTextColor(v Color) SelectOption

+ type SelectOptions struct

+ CancelKey Key

+ DescriptionBGColor Color

+ DescriptionTextColor Color

+ FinishFunc func(sels []int)

+ FinishKey Key

+ FinishText SelFinishTextFunc

+ HelpBGColor Color

+ HelpText SelHelpTextFunc

+ HelpTextColor Color

+ Multi bool

+ Options []*Suggest

+ ResultBGColor Color

+ ResultShowItem bool

+ ResultTextColor Color

+ RowsLimit int

+ ScrollbarBGColor Color

+ ScrollbarThumbColor Color

+ SelectedDescriptionBGColor Color

+ SelectedDescriptionTextColor Color

+ SelectedSuggestionBGColor Color

+ SelectedSuggestionTextColor Color

+ ShowHelpText bool

+ SuggestionBGColor Color

+ SuggestionTextColor Color

+ TipBGColor Color

+ TipText string

+ TipTextColor Color

+ ValidBGColor Color

+ ValidFunc func(sels []int) error

+ ValidTextColor Color

+ func NewSelectOptions(opts ...SelectOption) *SelectOptions

+ func (cc *SelectOptions) ApplyOption(opts ...SelectOption)

+ func (cc *SelectOptions) GetSetOption(opt SelectOption) SelectOption

+ func (cc *SelectOptions) SetOption(opt SelectOption)

+ type Suggest = completion.Suggest

+ type SugguestPrint []*Suggest

+ func (s SugguestPrint) String() string

+ type WinSize = input.WinSize

+ type Word struct

+ BGColor Color

+ Bold bool

+ Text string

+ TextColor Color

+ func WordBlue(str string) *Word

+ func WordBrown(str string) *Word

+ func WordCyan(str string) *Word

+ func WordDefault(str string) *Word

+ func WordGreen(str string) *Word

+ func WordPurple(str string) *Word

+ func WordRed(str string) *Word

+ func WordTurquoise(str string) *Word

+ func WordWhite(str string) *Word

+ func WordYellow(str string) *Word

+ func (w *Word) Render(ctx PrintContext, preCursor int) (nextCursor int)

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