shell

Documentation

Overview

Package shell provides sources for the interactive shell

Index

• Variables
• func CommandLine(ctx context.Context, block []rune, _ string, _ bool, ...)
• func ConfigReadGetCursorPos() (interface{}, error)
• func ConfigWriteGetCursorPos(v interface{}) error
• func DynamicPreview(previewBlock string, exe string, params []string) readline.PreviewFuncT
• func HintCodeBlock() []rune
• func PreviewCommand(ctx context.Context, _cmdLine []rune, command string, _ bool, ...)
• func PreviewFile(ctx context.Context, _ []rune, filename string, incImages bool, ...)
• func PreviewParameter(ctx context.Context, block []rune, parameter string, incImages bool, ...)
• func PreviewParseAppendEvent(previous []string, p []byte, size *readline.PreviewSizeT, title string) ([]string, error)
• func Spellchecker(r []rune) []rune
• func Start()

Variables

var (
	// Prompt is the readline instance
	Prompt = readline.NewInstance()

	// Events is a callback for onPrompt & onPreview events
	EventsPrompt  func(string, []rune)
	EventsPreview func(context.Context, string, string, []rune, []string, *readline.PreviewSizeT, readline.PreviewFuncCallbackT)
)

Functions

func CommandLine

func CommandLine(ctx context.Context, block []rune, _ string, _ bool, size *readline.PreviewSizeT, callback readline.PreviewFuncCallbackT)

func ConfigReadGetCursorPos

func ConfigReadGetCursorPos() (interface{}, error)

ConfigReadGetCursorPos is a dynamic config wrapper function for Prompt.EnableGetCursorPos

func ConfigWriteGetCursorPos

func ConfigWriteGetCursorPos(v interface{}) error

ConfigWriteGetCursorPos is a dynamic config wrapper function for Prompt.EnableGetCursorPos

func DynamicPreview

func DynamicPreview(previewBlock string, exe string, params []string) readline.PreviewFuncT

func HintCodeBlock

func HintCodeBlock() []rune

func PreviewCommand

func PreviewCommand(ctx context.Context, _cmdLine []rune, command string, _ bool, size *readline.PreviewSizeT, callback readline.PreviewFuncCallbackT)

func PreviewFile

func PreviewFile(ctx context.Context, _ []rune, filename string, incImages bool, size *readline.PreviewSizeT, callback readline.PreviewFuncCallbackT)

func PreviewParameter

func PreviewParameter(ctx context.Context, block []rune, parameter string, incImages bool, size *readline.PreviewSizeT, callback readline.PreviewFuncCallbackT)

func PreviewParseAppendEvent

func PreviewParseAppendEvent(previous []string, p []byte, size *readline.PreviewSizeT, title string) ([]string, error)

func Spellchecker

func Spellchecker(r []rune) []rune

func Start

func Start()

Start the interactive shell