terminal

package
v3.115.0 Latest Latest
Warning

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

Go to latest
Published: May 3, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	KeyCtrlC    = "ctrl+c"
	KeyCtrlO    = "ctrl+o"
	KeyDown     = "down"
	KeyEnd      = "end"
	KeyHome     = "home"
	KeyPageDown = "page-down"
	KeyPageUp   = "page-up"
	KeyUp       = "up"
)

Variables

View Source
var ErrNotATerminal = errors.New("not a terminal")

Functions

This section is empty.

Types

type Info

type Info interface {
	Parse(attr string, params ...interface{}) (string, error)

	ClearEnd(out io.Writer)
	ClearLine(out io.Writer)
	CursorUp(out io.Writer, count int)
	CursorDown(out io.Writer, count int)
	HideCursor(out io.Writer)
	ShowCursor(out io.Writer)
}

func OpenInfo

func OpenInfo(terminal string) Info

type MockTerminal

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

func NewMockTerminal

func NewMockTerminal(dest io.Writer, width, height int, raw bool) *MockTerminal

func (*MockTerminal) ClearEnd added in v3.50.1

func (t *MockTerminal) ClearEnd()

func (*MockTerminal) ClearLine

func (t *MockTerminal) ClearLine()

func (*MockTerminal) Close

func (t *MockTerminal) Close() error

func (*MockTerminal) CursorDown

func (t *MockTerminal) CursorDown(count int)

func (*MockTerminal) CursorUp

func (t *MockTerminal) CursorUp(count int)

func (*MockTerminal) HideCursor added in v3.50.1

func (t *MockTerminal) HideCursor()

func (*MockTerminal) IsRaw

func (t *MockTerminal) IsRaw() bool

func (*MockTerminal) ReadKey

func (t *MockTerminal) ReadKey() (string, error)

func (*MockTerminal) SendKey

func (t *MockTerminal) SendKey(key string)

func (*MockTerminal) SetSize

func (t *MockTerminal) SetSize(width, height int)

func (*MockTerminal) ShowCursor added in v3.50.1

func (t *MockTerminal) ShowCursor()

func (*MockTerminal) Size

func (t *MockTerminal) Size() (width, height int, err error)

func (*MockTerminal) Write

func (t *MockTerminal) Write(b []byte) (int, error)

type Terminal

type Terminal interface {
	io.WriteCloser

	IsRaw() bool
	Size() (width, height int, err error)

	ClearLine()
	ClearEnd()
	CursorUp(count int)
	CursorDown(count int)
	HideCursor()
	ShowCursor()

	ReadKey() (string, error)
}

func Open

func Open(in io.Reader, out io.Writer, raw bool) (Terminal, error)

Jump to

Keyboard shortcuts

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