terminal

package module

v0.0.1 Latest Latest Go to latest Published: Dec 17, 2019 License: MIT Imports: 9 Imported by: 0

Details

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) 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
cmd
sequencegenerator command
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
example
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.
tty Package tty implements the os part of the terminal	Package tty implements the os part of the terminal