terminal

type ActOn ¶

type ActOn interface {
	Handle(emu *Emulator)
}

type Cell ¶

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

contents saved in strings.Builder * Don't set the fields directly * * Cell is comparable

func (c *Cell) Append(r rune)

func (c *Cell) Clear()

func (c *Cell) ContentsMatch(x Cell) bool

func (c *Cell) Empty() bool

func (c *Cell) GetContents() string

func (c Cell) GetRenditions() Renditions

func (c *Cell) GetWidth() int

func (c Cell) IsBlank() bool

func (c *Cell) IsDoubleWidth() bool

func (c *Cell) IsDoubleWidthCont() bool

func (c Cell) IsEarlyWrap() bool

func (c *Cell) Reset2(attrs Cell)

func (c *Cell) SetContents(chs []rune)

func (c *Cell) SetDoubleWidth(value bool)

func (c *Cell) SetDoubleWidthCont(value bool)

func (c *Cell) SetEarlyWrap(v bool)

func (c *Cell) SetRenditions(r Renditions)

func (c *Cell) SetUnderline(underline bool)

func (c Cell) String() string

type CharsetState ¶

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

only in vtMode, charset is enabled, otherwise UTF-8 is choosed.

func (cs *CharsetState) Equal(x *CharsetState) bool

type ColMode ¶

type ColMode uint8

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

const (
	ColMode_C80 ColMode = iota
	ColMode_C132
)

type Color ¶

type Color uint64

https://github.com/gdamore/tcell/blob/master/color.go https://www.ditig.com/256-colors-cheat-sheet

Color represents a color. The low numeric values are the same as used by ECMA-48, and beyond that XTerm. A 24-bit RGB value may be used by adding in the ColorIsRGB flag. For Color names we use the W3C approved color names.

We use a 64-bit integer to allow future expansion if we want to add an 8-bit alpha, while still leaving us some room for extra options.

Note that on various terminals colors may be approximated however, or not supported at all. If no suitable representation for a color is known, the library will simply not set any color, deferring to whatever default attributes the terminal uses.

const (
	// ColorDefault is used to leave the Color unchanged from whatever
	// system or terminal default may exist.  It's also the zero value.
	ColorDefault Color = 0

	// ColorValid is used to indicate the color value is actually
	// valid (initialized).  This is useful to permit the zero value
	// to be treated as the default.
	ColorValid Color = 1 << 32

	// ColorIsRGB is used to indicate that the numeric value is not
	// a known color constant, but rather an RGB value.  The lower
	// order 3 bytes are RGB.
	ColorIsRGB Color = 1 << 33

	// ColorSpecial is a flag used to indicate that the values have
	// special meaning, and live outside of the color space(s).
	ColorSpecial Color = 1 << 34
)

func GetColor(name string) Color

func NewHexColor(v int32) Color

func NewRGBColor(r, g, b int32) Color

func PaletteColor(index int) Color

func (c Color) Hex() int32

func (c Color) Index() int

func (c Color) IsRGB() bool

func (c Color) Name() []string

func (c Color) RGB() (int32, int32, int32)

func (c Color) String() (name string)

func (c Color) TrueColor() Color

func (c Color) Valid() bool

type CompatibilityLevel ¶

type CompatibilityLevel uint8

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

const (
	CompatLevel_Unused CompatibilityLevel = iota
	CompatLevel_VT52
	CompatLevel_VT100
	CompatLevel_VT400
)

type Cursor ¶

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

type CursorKeyMode ¶

type CursorKeyMode uint8

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

const (
	CursorKeyMode_ANSI CursorKeyMode = iota
	CursorKeyMode_Application
)

type CursorStyle ¶

type CursorStyle uint

const (
	CursorStyle_Hidden CursorStyle = iota
	CursorStyle_FillBlock
	CursorStyle_HollowBlock
)

const (
	CursorStyle_BlinkBlock CursorStyle = iota
	CursorStyle_SteadyBlock
	CursorStyle_BlinkUnderline
	CursorStyle_SteadyUnderline
	CursorStyle_BlinkBar
	CursorStyle_SteadyBar
	CursorStyle_Invalid
)

Ps = 0  ⇒  blinking block.
Ps = 1  ⇒  blinking block (default).
Ps = 2  ⇒  steady block.
Ps = 3  ⇒  blinking underline.
Ps = 4  ⇒  steady underline.
Ps = 5  ⇒  blinking bar, xterm.
Ps = 6  ⇒  steady bar, xterm.

type Damage ¶

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

type Display ¶

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

* The following are some interesting questions I asked several month ago. As I know terminfo * and terminal better, the answter is more clear and confident than before. * * do we need to package the the terminfo DB into application? * - yes, mosh-server depends on ncurses-terminfo-base and ncurses-libs * how to read terminfo DB? through ncurses lib or directly? * - yes the answer is read through tcell. * how to operate terminal? through direct escape sequence or through terminfo DB? * how to replace the following functions? setupterm(), tigetnum(), tigetstr(), tigetflag()

func NewDisplay(useEnvironment bool) (d *Display, e error)

func (d *Display) Clone() *Display

func (d *Display) Close() string

func (d *Display) NewFrame(initialized bool, oldE, newE *Emulator) string

func (d *Display) Open() string

type Emulator ¶

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

func NewEmulator3(nCols, nRows, saveLines int) *Emulator

func (emu *Emulator) Clone() *Emulator

func (emu *Emulator) Equal(x *Emulator) bool

func (emu *Emulator) EqualTrace(x *Emulator) bool

func (emu *Emulator) GetCell(posY, posX int) Cell

func (emu *Emulator) GetCellPtr(posY, posX int) *Cell

func (emu *Emulator) GetCursorCol() int

func (emu *Emulator) GetCursorRow() int

func (emu *Emulator) GetFramebuffer() *Framebuffer

func (emu *Emulator) GetHeight() int

func (emu *Emulator) GetIconLabel() string

func (emu *Emulator) GetParser() *Parser

func (emu *Emulator) GetRenditions() (rnd Renditions)

func (emu *Emulator) GetSaveLines() int

func (emu *Emulator) GetWidth() int

func (emu *Emulator) GetWindowTitle() string

func (emu *Emulator) HandleLargeStream(seq string) (diff, remains string)

func (emu *Emulator) HandleStream(seq string) (hds []*Handler, diff string)

func (emu *Emulator) MoveCursor(posY, posX int)

func (emu *Emulator) PrefixWindowTitle(prefix string)

func (emu *Emulator) ReadOctetsToHost() string

func (emu *Emulator) SetCursorVisible(visible bool)

func (emu *Emulator) SetLastRows(x int)

type FrameState ¶

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

type Framebuffer ¶

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

support both (scrollable) normal screen buffer and alternate screen buffer

func NewFramebuffer2(nCols, nRows int) Framebuffer

func NewFramebuffer3(nCols, nRows, saveLines int) (fb Framebuffer, marginTop int, marginBottom int)

func (fb *Framebuffer) Equal(x *Framebuffer) bool

type Handler ¶

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

Handler is the outcome of parsering input, it can be used to perform control sequence on emulator.

func (h *Handler) GetCh() rune

func (h *Handler) GetId() int

type KeypadMode ¶

type KeypadMode uint8

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

const (
	KeypadMode_Normal KeypadMode = iota
	KeypadMode_Application
)

type MouseTrackingEnc ¶

type MouseTrackingEnc uint16

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

type MouseTrackingMode ¶

type MouseTrackingMode uint16

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

type MouseTrackingState ¶

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

check resetScreen() for default value

type OriginMode ¶

type OriginMode uint8

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

const (
	OriginMode_Absolute OriginMode = iota
	OriginMode_ScrollingRegion
)

type Parser ¶

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

func NewParser() *Parser

func (p *Parser) ProcessInput(chs ...rune) (hd *Handler)

func (p *Parser) ResetInput()

type Point ¶

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

func (p Point) String() string

type Rect ¶

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

func NewRect() (rect *Rect)

func NewRect4(x1, y1, x2, y2 int) (rect *Rect)

func (rect *Rect) String() string

type Renditions ¶

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

Renditions determines the foreground and background color and character attribute. it is comparable. default background/foreground is ColorDefault

func NewRenditions(attribute int) (rend Renditions)

func (rend *Renditions) ClearAttributes()

func (r *Renditions) GetAttributes(attr charAttribute) (value, ok bool)

func (rend *Renditions) SGR() string

func (r *Renditions) SetAttributes(attr charAttribute, value bool)

func (rend *Renditions) SetBackgroundColor(index int)

func (rend *Renditions) SetBgColor(r, g, b int)

func (rend *Renditions) SetFgColor(r, g, b int)

func (rend *Renditions) SetForegroundColor(index int)

type Resize ¶

type Resize struct {
	Width  int
	Height int
}

func (r Resize) Handle(emu *Emulator)

type SavedCursor_DEC ¶

type SavedCursor_DEC struct {
	SavedCursor_SCO
	// contains filtered or unexported fields
}

type SavedCursor_SCO ¶

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

type SelectSnapTo ¶

type SelectSnapTo uint8

type DrawState struct {
	width            int
	height           int
	cursorCol        int
	cursorRow        int
	cursorColor      Color
	combiningCharCol int
	combiningCharRow int

	defaultTabs bool
	tabs        []bool

	scrollingRegionTopRow    int
	scrollingRegionBottomRow int
	renditions               Renditions
	save                     SavedCursor

	// public fields
	NextPrintWillWrap bool

	// DEC private mode
	OriginMode                bool // two possiible value: ScrollingRegion(true), Absolute(false)
	AutoWrapMode              bool // true/false
	CursorVisible             bool // true/false
	ReverseVideo              bool // two possible value: Reverse(true), Normal(false)
	BracketedPaste            bool // true/false
	MouseReportingMode        int  // replace it with MouseTrackingMode
	MouseFocusEvent           bool // replace it with MouseTrackingState.focusEventMode
	MouseAlternateScroll      bool // rename to altScrollMode
	MouseEncodingMode         int  // replace it with MouseTrackingEnc
	ApplicationModeCursorKeys bool // =cursorKeyMode two possible value : Application(true), ANSI(false)
	mouseTrk                  MouseTrackingState
	altSendsEscape            bool

	// ANSI mode
	keyboardLocked  bool
	InsertMode      bool // true/false
	localEcho       bool
	autoNewlineMode bool

	// added for vt400 compatibility
	compatLevel         CompatibilityLevel // VT52, VT100, VT400
	altScreenBufferMode bool               // Alternate Screen Buffer support: default false
	columnMode          ColMode            // column mode 80 or 132, just for compatibility
	horizMarginMode     bool               // left and right margins support
	hMargin             int                // left margins
	nColsEff            int                // right margins
	bkspSendsDel        bool               // backspace send delete

	savedCursorSCO SavedCursorSCO // SCO console cursor state
}

const (
	SelectSnapTo_Char SelectSnapTo = iota
	SelectSnapTo_Word
	SelectSnapTo_Line
	SelectSnapTo_COUNT
)

type UserByte ¶

type UserByte struct {
	Chs []rune
}

func (u UserByte) Handle(emu *Emulator)

type UserInput ¶

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

the default state is USER_INPUT_GROUND = 0