terminal

package

v3.0.0-...-a5432f4 Latest Latest Go to latest Published: Jan 13, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/khulnasoft/codeinfra

Documentation ¶

Index ¶

Constants
Variables
type Info
- func OpenInfo(terminal string) Info
type MockTerminal
- func NewMockTerminal(dest io.Writer, width, height int, raw bool) *MockTerminal
type SimpleTerminal
- func NewSimpleTerminal(dest io.Writer, width, height int) *SimpleTerminal
type Terminal
- func Open(in io.Reader, out io.Writer, raw bool) (Terminal, error)

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)
	CarriageReturn(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) CarriageReturn ¶

func (t *MockTerminal) CarriageReturn()

func (*MockTerminal) ClearEnd ¶

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 ¶

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 ¶

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 SimpleTerminal ¶

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

func NewSimpleTerminal ¶

func NewSimpleTerminal(dest io.Writer, width, height int) *SimpleTerminal

func (*SimpleTerminal) CarriageReturn ¶

func (t *SimpleTerminal) CarriageReturn()

func (*SimpleTerminal) ClearEnd ¶

func (t *SimpleTerminal) ClearEnd()

func (*SimpleTerminal) ClearLine ¶

func (t *SimpleTerminal) ClearLine()

func (*SimpleTerminal) Close ¶

func (t *SimpleTerminal) Close() error

func (*SimpleTerminal) CursorDown ¶

func (t *SimpleTerminal) CursorDown(count int)

func (*SimpleTerminal) CursorUp ¶

func (t *SimpleTerminal) CursorUp(count int)

func (*SimpleTerminal) HideCursor ¶

func (t *SimpleTerminal) HideCursor()

func (*SimpleTerminal) IsRaw ¶

func (t *SimpleTerminal) IsRaw() bool

func (*SimpleTerminal) ReadKey ¶

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

func (*SimpleTerminal) SendKey ¶

func (t *SimpleTerminal) SendKey(key string)

func (*SimpleTerminal) SetSize ¶

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

func (*SimpleTerminal) ShowCursor ¶

func (t *SimpleTerminal) ShowCursor()

func (*SimpleTerminal) Size ¶

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

func (*SimpleTerminal) Write ¶

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

type Terminal ¶

type Terminal interface {
	io.WriteCloser

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

	ClearLine()
	ClearEnd()
	CarriageReturn()
	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)

Source Files ¶

View all Source files

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