console

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: May 2, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source
const (
	TextBlack = iota + 30
	TextRed
	TextGreen
	TextYellow
	TextBlue
	TextMagenta
	TextCyan
	TextWhite
)
View Source
const DefaultPrompt = "> "

DefaultPrompt is the default prompt line prefix to use for user input querying.

View Source
const (
	ErrorNoHandlerCode = global.ErrorCodeConsoleBase + 1 + iota
)
View Source
const HistoryFile = "history"

HistoryFile is the file within the data directory to store input scrollback.

Variables

View Source
var (
	Newline  = []byte{'\n'}
	Space    = []byte{' '}
	CmdSplit = " "
)
View Source
var ErrorNoHandler = func(msg string) *model.ErrorModel {
	return model.NewErrModelByStr(ErrorNoHandlerCode, "no handler: [%v]", msg)
}
View Source
var Stdin = newTerminalPrompter()

Stdin holds the stdin line reader (also using stdout for printing prompts). Only this reader may be used for input because it keeps an internal buffer.

Functions

func Black

func Black(msg string) string

func Blue

func Blue(msg string) string

func Cyan

func Cyan(msg string) string

func Green

func Green(msg string) string

func Magenta

func Magenta(msg string) string

func Prompt

func Prompt()

func Red

func Red(msg string) string

func SetColor

func SetColor(msg string, conf, bg, text int) string

func White

func White(msg string) string

func Yellow

func Yellow(msg string) string

Types

type ApiHandleFunc

type ApiHandleFunc func(ctx context.Context, ch chan string, params ...string) model.RespModel

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(printer io.Writer) *Client

func (*Client) DoHandler

func (c *Client) DoHandler(apName string, args ...string) model.RespModel

func (*Client) RegisterApiHandler

func (c *Client) RegisterApiHandler(api, name string, f ApiHandleFunc)

type Config

type Config struct {
	DataDir         string       // Data directory to store the console history at
	DocRoot         string       // Filesystem path from where to load JavaScript files from
	Prompt          string       // Input prompt prefix string (defaults to DefaultPrompt)
	Prompter        UserPrompter // Input prompter to allow interactive user feedback (defaults to TerminalPrompter)
	Printer         io.Writer    // Output writer to serialize any display strings to (defaults to os.Stdout)
	Preload         []string     // Absolute paths to JavaScript files to preload
	DefaultCategory string       // the default cmd category
}

func NewConsoleConfig

func NewConsoleConfig() Config

type Console

type Console struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) (*Console, error)

func (*Console) AutoCompleteInput

func (c *Console) AutoCompleteInput(line string, pos int) (string, []string, string)

AutoCompleteInput is a pre-assembled word completer to be used by the user input prompter to provide hints to the user about the methods available.

func (*Console) Evaluate

func (c *Console) Evaluate(statement string)

Evaluate executes code and pretty prints the result to the specified output stream.

func (*Console) Interactive

func (c *Console) Interactive()

Interactive starts an interactive user session, where input is prompted from the configured user prompter.

func (*Console) Print

func (c *Console) Print(msg string, opt ...interface{})

func (*Console) RegisterHandler

func (c *Console) RegisterHandler(api, name string, handler ApiHandleFunc)

func (*Console) Stop

func (c *Console) Stop(graceful bool) error

Stop cleans up the console and terminates the runtime environment.

func (*Console) StopInteractive

func (c *Console) StopInteractive()

StopInteractive causes Interactive to return as soon as possible.

func (*Console) Welcome

func (c *Console) Welcome()

Welcome show summary of current Geth instance and some metadata about the console's available modules.

type UserPrompter

type UserPrompter interface {
	// PromptInput displays the given prompt to the user and requests some textual
	// data to be entered, returning the input of the user.
	PromptInput(prompt string) (string, error)

	// PromptPassword displays the given prompt to the user and requests some textual
	// data to be entered, but one which must not be echoed out into the terminal.
	// The method returns the input provided by the user.
	PromptPassword(prompt string) (string, error)

	// PromptConfirm displays the given prompt to the user and requests a boolean
	// choice to be made, returning that choice.
	PromptConfirm(prompt string) (bool, error)

	// SetHistory sets the input scrollback history that the prompter will allow
	// the user to scroll back to.
	SetHistory(history []string)

	// AppendHistory appends an entry to the scrollback history. It should be called
	// if and only if the prompt to append was a valid command.
	AppendHistory(command string)

	// ClearHistory clears the entire history
	ClearHistory()

	// SetWordCompleter sets the completion function that the prompter will call to
	// fetch completion candidates when the user presses tab.
	SetWordCompleter(completer WordCompleter)
}

UserPrompter defines the methods needed by the console to prompt the user for various types of inputs.

type WordCompleter

type WordCompleter func(line string, pos int) (string, []string, string)

WordCompleter takes the currently edited line with the cursor position and returns the completion candidates for the partial word to be completed. If the line is "Hello, wo!!!" and the cursor is before the first '!', ("Hello, wo!!!", 9) is passed to the completer which may returns ("Hello, ", {"world", "Word"}, "!!!") to have "Hello, world!!!".

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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