terminal

package

v0.0.0-...-ad3cfc1 Latest Latest Go to latest Published: Dec 16, 2019 License: LGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package terminal abstract the terminal by providing two main interfaces: Input Events and a framebuffer output

This section is empty.

This section is empty.

This section is empty.

type Fder interface {
	Fd() uintptr
}

Fder is the interface that wraps a Fd() filedescriptor. It is require to properly use the terminal

type Terminal struct {
	Input       io.Reader
	Output      io.Writer
	DefaultChar ansi.Char
	// contains filtered or unexported fields
}

Terminal holds the state of the current terminal

func (t *Terminal) Close() error

Close resets the terminal to the previous state

func (t *Terminal) NextEvent() events.Event

NextEvent return the nextevent in the pipe

func (t *Terminal) Open() error

Open opens a terminal. If output

func (t *Terminal) Send(cmd string, args ...interface{})

Send send a command to the output

func (t *Terminal) Set(row, col int, ch area.Char)

Set changes the character display in the given row/col.

func (t *Terminal) Size() (Rows, Cols int)

Size returns the terminal size

func (t *Terminal) Sync()

Sync dump all the changes in the buffer.

func (t *Terminal) Write(data []byte) (n int, err error)

Path	Synopsis
ansi Package ansi converts a given area into a stream of ansi sequences to be dump into a terminal	Package ansi converts a given area into a stream of ansi sequences to be dump into a terminal
area
eachchange Package eachchange will compare two areas	Package eachchange will compare two areas
events Package events contains the basic primitives of the input and output events	Package events contains the basic primitives of the input and output events
framebuffer Package framebuffer stores the current terminal state and return the ansi sequences require to transform the current state to the new one	Package framebuffer stores the current terminal state and return the ansi sequences require to transform the current state to the new one
input Package input converts a io.Reader (normally a tty) into a sequence of events.	Package input converts a io.Reader (normally a tty) into a sequence of events.
test
tty Package tty implements the os part of the terminal	Package tty implements the os part of the terminal