vt10x

type ChangeFlag uint32

type Color uint32

type Cursor struct {
	Attr  Glyph
	X, Y  int
	State uint8
}

type Glyph struct {
	Char   rune
	Mode   int16
	FG, BG Color
}

type ModeFlag uint32

type State struct {
	DebugLogger *log.Logger
	// contains filtered or unexported fields
}

type Terminal interface {
	// View displays the virtual terminal.
	View

	// Write parses input and writes terminal changes to state.
	io.Writer

	// Parse blocks on read on pty or io.Reader, then parses sequences until
	// buffer empties. State is locked as soon as first rune is read, and unlocked
	// when buffer is empty.
	Parse(bf *bufio.Reader) error
}

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

type TerminalOption func(*TerminalInfo)

type View interface {
	// String dumps the virtual terminal contents.
	fmt.Stringer

	// Size returns the size of the virtual terminal.
	Size() (cols, rows int)

	// Resize changes the size of the virtual terminal.
	Resize(cols, rows int)

	// Mode returns the current terminal mode.//
	Mode() ModeFlag

	// Title represents the title of the console window.
	Title() string

	// Cell returns the glyph containing the character code, foreground color, and
	// background color at position (x, y) relative to the top left of the terminal.
	Cell(x, y int) Glyph

	// Cursor returns the current position of the cursor.
	Cursor() Cursor

	// CursorVisible returns the visible state of the cursor.
	CursorVisible() bool

	// Lock locks the state object's mutex.
	Lock()

	// Unlock resets change flags and unlocks the state object's mutex.
	Unlock()

	// SetScrollbackMax sets the maximum number of scrolled-off main-screen
	// lines retained for scrollback. <= 0 disables and clears capture.
	SetScrollbackMax(n int)

	// ScrollbackLen returns the number of retained scrollback lines. Caller
	// must serialize access (Lock/Unlock).
	ScrollbackLen() int

	// Scrollback returns a copy of the scrollback history, oldest first.
	// Caller must serialize access (Lock/Unlock).
	Scrollback() [][]Glyph

	// ScrollbackEvictedTotal returns the monotonic count of lines ever captured
	// into scrollback (keeps growing past ring trimming). Serialize access.
	ScrollbackEvictedTotal() int64

	// ScrollbackTail returns copies of the last n scrollback lines, oldest of
	// the returned set first. Serialize access.
	ScrollbackTail(n int) [][]Glyph

	// ClearScrollback discards all retained scrollback lines.
	ClearScrollback()
}