tsm

README

go-tsm

Terminal-emulator State Machine library for Go.

Note: libvterm is a better alternative.

License

MIT

Documentation

Index

• type Screen
  • func NewScreen() *Screen
  • func (s *Screen) ClearScrollback()
  • func (s *Screen) CursorX() uint
  • func (s *Screen) CursorY() uint
  • func (s *Screen) DeleteChars(num uint)
  • func (s *Screen) DeleteLines(num uint)
  • func (s *Screen) Draw(f ScreenDrawFunc) uint32
  • func (s *Screen) EraseChars(num uint)
  • func (s *Screen) EraseCurrentLine(protect bool)
  • func (s *Screen) EraseCursor()
  • func (s *Screen) EraseCursorToEnd(protect bool)
  • func (s *Screen) EraseCursorToScreen(protect bool)
  • func (s *Screen) EraseHomeToCursor(protect bool)
  • func (s *Screen) EraseScreen(protect bool)
  • func (s *Screen) EraseScreenToCursor(protect bool)
  • func (s *Screen) Flags() ScreenFlags
  • func (s *Screen) Height() uint
  • func (s *Screen) InsertChars(num uint)
  • func (s *Screen) InsertLines(num uint)
  • func (s *Screen) MoveDown(num uint, scroll bool)
  • func (s *Screen) MoveLeft(num uint)
  • func (s *Screen) MoveLineEnd()
  • func (s *Screen) MoveLineHome()
  • func (s *Screen) MoveRight(num uint)
  • func (s *Screen) MoveTo(x, y uint)
  • func (s *Screen) MoveUp(num uint, scroll bool)
  • func (s *Screen) Newline()
  • func (s *Screen) Reset()
  • func (s *Screen) ResetAllTabstops()
  • func (s *Screen) ResetFlags(flags ScreenFlags)
  • func (s *Screen) ResetTabstop()
  • func (s *Screen) Resize(w, h uint)
  • func (s *Screen) ScrollDown(num uint)
  • func (s *Screen) ScrollUp(num uint)
  • func (s *Screen) ScrollbackDown(num uint)
  • func (s *Screen) ScrollbackPageDown(num uint)
  • func (s *Screen) ScrollbackPageUp(num uint)
  • func (s *Screen) ScrollbackReset()
  • func (s *Screen) ScrollbackUp(num uint)
  • func (s *Screen) SelectionCopy() string
  • func (s *Screen) SelectionReset()
  • func (s *Screen) SelectionStart(posx, posy uint)
  • func (s *Screen) SelectionTarget(posx, posy uint)
  • func (s *Screen) SetDefAttr(attr *ScreenAttr)
  • func (s *Screen) SetFlags(flags ScreenFlags)
  • func (s *Screen) SetMargins(top, bottom uint)
  • func (s *Screen) SetMaxScrollback(max uint)
  • func (s *Screen) SetTabstop()
  • func (s *Screen) TabLeft(num uint)
  • func (s *Screen) TabRight(num uint)
  • func (s *Screen) Width() uint
  • func (s *Screen) Write(r rune, attr *ScreenAttr)
• type ScreenAttr
• type ScreenDrawFunc
• type ScreenFlags
• type VTE
  • func NewVTE(s *Screen, f VTEWriteFunc) *VTE
  • func (vte *VTE) HandleKeyboard(keysym, ascii uint32, mods VTEModifiers, unicode rune) bool
  • func (vte *VTE) HardReset()
  • func (vte *VTE) Input(b []byte)
  • func (vte *VTE) Reset()
  • func (vte *VTE) SetPalette(palette string)
• type VTEModifiers
• type VTEWriteFunc

Types

type Screen

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

func NewScreen

func NewScreen() *Screen

func (*Screen) ClearScrollback

func (s *Screen) ClearScrollback()

func (*Screen) CursorX

func (s *Screen) CursorX() uint

func (*Screen) CursorY

func (s *Screen) CursorY() uint

func (*Screen) DeleteChars

func (s *Screen) DeleteChars(num uint)

func (*Screen) DeleteLines

func (s *Screen) DeleteLines(num uint)

func (*Screen) Draw

func (s *Screen) Draw(f ScreenDrawFunc) uint32

func (*Screen) EraseChars

func (s *Screen) EraseChars(num uint)

func (*Screen) EraseCurrentLine

func (s *Screen) EraseCurrentLine(protect bool)

func (*Screen) EraseCursor

func (s *Screen) EraseCursor()

func (*Screen) EraseCursorToEnd

func (s *Screen) EraseCursorToEnd(protect bool)

func (*Screen) EraseCursorToScreen

func (s *Screen) EraseCursorToScreen(protect bool)

func (*Screen) EraseHomeToCursor

func (s *Screen) EraseHomeToCursor(protect bool)

func (*Screen) EraseScreen

func (s *Screen) EraseScreen(protect bool)

func (*Screen) EraseScreenToCursor

func (s *Screen) EraseScreenToCursor(protect bool)

func (*Screen) Flags

func (s *Screen) Flags() ScreenFlags

func (*Screen) Height

func (s *Screen) Height() uint

func (*Screen) InsertChars

func (s *Screen) InsertChars(num uint)

func (*Screen) InsertLines

func (s *Screen) InsertLines(num uint)

func (*Screen) MoveDown

func (s *Screen) MoveDown(num uint, scroll bool)

func (*Screen) MoveLeft

func (s *Screen) MoveLeft(num uint)

func (*Screen) MoveLineEnd

func (s *Screen) MoveLineEnd()

func (*Screen) MoveLineHome

func (s *Screen) MoveLineHome()

func (*Screen) MoveRight

func (s *Screen) MoveRight(num uint)

func (*Screen) MoveTo

func (s *Screen) MoveTo(x, y uint)

func (*Screen) MoveUp

func (s *Screen) MoveUp(num uint, scroll bool)

func (*Screen) Newline

func (s *Screen) Newline()

func (*Screen) Reset

func (s *Screen) Reset()

func (*Screen) ResetAllTabstops

func (s *Screen) ResetAllTabstops()

func (*Screen) ResetFlags

func (s *Screen) ResetFlags(flags ScreenFlags)

func (*Screen) ResetTabstop

func (s *Screen) ResetTabstop()

func (*Screen) Resize

func (s *Screen) Resize(w, h uint)

func (*Screen) ScrollDown

func (s *Screen) ScrollDown(num uint)

func (*Screen) ScrollUp

func (s *Screen) ScrollUp(num uint)

func (*Screen) ScrollbackDown

func (s *Screen) ScrollbackDown(num uint)

func (*Screen) ScrollbackPageDown

func (s *Screen) ScrollbackPageDown(num uint)

func (*Screen) ScrollbackPageUp

func (s *Screen) ScrollbackPageUp(num uint)

func (*Screen) ScrollbackReset

func (s *Screen) ScrollbackReset()

func (*Screen) ScrollbackUp

func (s *Screen) ScrollbackUp(num uint)

func (*Screen) SelectionCopy

func (s *Screen) SelectionCopy() string

func (*Screen) SelectionReset

func (s *Screen) SelectionReset()

func (*Screen) SelectionStart

func (s *Screen) SelectionStart(posx, posy uint)

func (*Screen) SelectionTarget

func (s *Screen) SelectionTarget(posx, posy uint)

func (*Screen) SetDefAttr

func (s *Screen) SetDefAttr(attr *ScreenAttr)

func (*Screen) SetFlags

func (s *Screen) SetFlags(flags ScreenFlags)

func (*Screen) SetMargins

func (s *Screen) SetMargins(top, bottom uint)

func (*Screen) SetMaxScrollback

func (s *Screen) SetMaxScrollback(max uint)

func (*Screen) SetTabstop

func (s *Screen) SetTabstop()

func (*Screen) TabLeft

func (s *Screen) TabLeft(num uint)

func (*Screen) TabRight

func (s *Screen) TabRight(num uint)

func (*Screen) Width

func (s *Screen) Width() uint

func (*Screen) Write

func (s *Screen) Write(r rune, attr *ScreenAttr)

type ScreenAttr

type ScreenAttr struct {
	FCCode, BCCode                           int8  // foreground, background color codes (<0 for rgb)
	FR, FG, FB, BR, BG, BB                   uint8 // foreground/background red/green/blue
	Bold, Underline, Inverse, Protect, Blink bool
}

type ScreenDrawFunc

type ScreenDrawFunc func(id uint32, s string, width, posx, posy uint, attr *ScreenAttr, age uint32) bool

type ScreenFlags

type ScreenFlags uint

const (
	ScreenInsertMode ScreenFlags = 1 << iota
	ScreenAutoWrap
	ScreenRelOrigin
	ScreenInverse
	ScreenHideCursor
	ScreenFixedPos
	ScreenAlternate
)

type VTE

type VTE struct {
	Screen *Screen
	// contains filtered or unexported fields
}

func NewVTE

func NewVTE(s *Screen, f VTEWriteFunc) *VTE

func (*VTE) HandleKeyboard

func (vte *VTE) HandleKeyboard(keysym, ascii uint32, mods VTEModifiers, unicode rune) bool

func (*VTE) HardReset

func (vte *VTE) HardReset()

func (*VTE) Input

func (vte *VTE) Input(b []byte)

func (*VTE) Reset

func (vte *VTE) Reset()

func (*VTE) SetPalette

func (vte *VTE) SetPalette(palette string)

type VTEModifiers

type VTEModifiers uint

const (
	VTEModifierShift VTEModifiers = 1 << iota
	VTEModifierLock
	VTEModifierControl
	VTEModifierAlt
	VTEModifierLogo
)

type VTEWriteFunc

type VTEWriteFunc func(b []byte)