terminal

Documentation

Overview

Package terminal implements functions for responding to user input and dispatching to appropriate backend commands.

Index

• Variables
• type Commands
  • func DebugCommands(client service.Client) *Commands
  • func (c *Commands) Call(cmdstr string, t *Term) error
  • func (c *Commands) CallWithContext(cmdstr string, t *Term, ctx callContext) error
  • func (c *Commands) Find(cmdstr string, prefix cmdPrefix) command
  • func (c *Commands) Merge(allAliases map[string][]string)
  • func (c *Commands) Register(cmdstr string, cf cmdfunc, helpMsg string)
  • func (commands *Commands) WriteMarkdown(w io.Writer)
• type ExitRequestError
  • func (ere ExitRequestError) Error() string
• type Term
  • func New(client service.Client, conf *config.Config) *Term
  • func (t *Term) Close()
  • func (t *Term) IsTraceNonInteractive() bool
  • func (t *Term) RedirectTo(w io.Writer)
  • func (t *Term) Run() (int, error)
  • func (t *Term) SetTraceNonInteractive()

Variables

var (

	// ShortLoadConfig loads less information, not following pointers
	// and limiting struct fields loaded to 3.
	ShortLoadConfig = api.LoadConfig{MaxStringLen: 64, MaxStructFields: 3}
)

Types

type Commands

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

Commands represents the commands for Delve terminal process.

func DebugCommands

func DebugCommands(client service.Client) *Commands

DebugCommands returns a Commands struct with default commands defined.

func (*Commands) Call

func (c *Commands) Call(cmdstr string, t *Term) error

Call takes a command to execute.

func (*Commands) CallWithContext

func (c *Commands) CallWithContext(cmdstr string, t *Term, ctx callContext) error

CallWithContext takes a command and a context that command should be executed in.

func (*Commands) Find

func (c *Commands) Find(cmdstr string, prefix cmdPrefix) command

Find will look up the command function for the given command input. If it cannot find the command it will default to noCmdAvailable(). If the command is an empty string it will replay the last command.

func (*Commands) Merge

func (c *Commands) Merge(allAliases map[string][]string)

Merge takes aliases defined in the config struct and merges them with the default aliases.

func (*Commands) Register

func (c *Commands) Register(cmdstr string, cf cmdfunc, helpMsg string)

Register custom commands. Expects cf to be a func of type cmdfunc, returning only an error.

func (*Commands) WriteMarkdown

func (commands *Commands) WriteMarkdown(w io.Writer)

type ExitRequestError

type ExitRequestError struct{}

ExitRequestError is returned when the user exits Delve.

func (ExitRequestError) Error

func (ere ExitRequestError) Error() string

type Term

type Term struct {
	InitFile string
	// contains filtered or unexported fields
}

Term represents the terminal running dlv.

func New

func New(client service.Client, conf *config.Config) *Term

New returns a new Term.

func (*Term) Close

func (t *Term) Close()

Close returns the terminal to its previous mode.

func (*Term) IsTraceNonInteractive

func (t *Term) IsTraceNonInteractive() bool

func (*Term) RedirectTo

func (t *Term) RedirectTo(w io.Writer)

RedirectTo redirects the output of this terminal to the specified writer.

func (*Term) Run

func (t *Term) Run() (int, error)

Run begins running dlv in the terminal.

func (*Term) SetTraceNonInteractive

func (t *Term) SetTraceNonInteractive()