terminal

package
v3.199.0 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2025 License: Apache-2.0 Imports: 10 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 {
	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)
}

Info provides methods to print ANSI escape codes to a writer.

func OpenInfo 

func OpenInfo(terminal string) Info

OpenInfo returns a new Info instance for the given terminal, ensuring that the correct ANSI escape codes are used. If the terminal is not found in the terminfo database, a fallback implementation is used.

type MockTerminal 

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

func NewMockTerminal 

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

MockTerminal is a mock terminal implementation that writes its output to a buffer. Terminal codes are printed as explicit strings for identification in test outputs.

func (*MockTerminal) CarriageReturn added in v3.132.0 

func (t *MockTerminal) CarriageReturn()

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 SimpleTerminal added in v3.132.0 

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

SimpleTerminal is a terminal which ignores terminal codes and writes its output to a buffer.

func NewSimpleTerminal added in v3.132.0 

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

func (*SimpleTerminal) CarriageReturn added in v3.132.0 

func (t *SimpleTerminal) CarriageReturn()

func (*SimpleTerminal) ClearEnd added in v3.132.0 

func (t *SimpleTerminal) ClearEnd()

func (*SimpleTerminal) ClearLine added in v3.132.0 

func (t *SimpleTerminal) ClearLine()

func (*SimpleTerminal) Close added in v3.132.0 

func (t *SimpleTerminal) Close() error

func (*SimpleTerminal) CursorDown added in v3.132.0 

func (t *SimpleTerminal) CursorDown(count int)

func (*SimpleTerminal) CursorUp added in v3.132.0 

func (t *SimpleTerminal) CursorUp(count int)

func (*SimpleTerminal) HideCursor added in v3.132.0 

func (t *SimpleTerminal) HideCursor()

func (*SimpleTerminal) IsRaw added in v3.132.0 

func (t *SimpleTerminal) IsRaw() bool

func (*SimpleTerminal) ReadKey added in v3.132.0 

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

func (*SimpleTerminal) SendKey added in v3.132.0 

func (t *SimpleTerminal) SendKey(key string)

func (*SimpleTerminal) SetSize added in v3.132.0 

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

func (*SimpleTerminal) ShowCursor added in v3.132.0 

func (t *SimpleTerminal) ShowCursor()

func (*SimpleTerminal) Size added in v3.132.0 

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

func (*SimpleTerminal) Write added in v3.132.0 

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.