virtualterm

package

v0.0.0-...-e081c89 Latest Latest Go to latest Published: Feb 17, 2024 License: GPL-2.0 Imports: 3 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 virtualterm provides a virtual terminal and some terminal emulation functions

This section is empty.

This section is empty.

This section is empty.

type PtyState struct {
	LfIncCr bool // if false, \n acts as a \r\n
}

PtyState defines some basic emulation states for the virtual TTY

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

Term is the display state of the virtual term

func NewTerminal(x, y int) *Term

NewTerminal creates a new virtual term

func (t *Term) Export() string

Export returns a character map of the virtual terminal

func (t *Term) ExportHtml() string

ExportHTML returns a HTML reder of the virtual terminal

func (term *Term) GetSize() (int, int, error)

GetSize outputs mirror those from terminal and readline packages

func (term *Term) MakeRaw() PtyState

MakeRaw sets the virtual TTY to a raw state

func (term *Term) Restore(state PtyState)

Restore returns the virtual TTY to a previous state

func (term *Term) Write(text []rune)

Write multiple characters to the virtual terminal