twin

package
v1.23.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 29, 2024 License: BSD-2-Clause-Views Imports: 13 Imported by: 1

Documentation

Overview

Package twin provides Terminal Window interaction

Package twin provides Terminal Window interaction

Index

Constants

This section is empty.

Variables

View Source 
var ColorDefault = newColor(ColorTypeDefault, 0)

Reset to default foreground / background color

Functions

func Printable added in v1.12.0 

func Printable(char rune) bool

Types

type AttrMask 

type AttrMask uint
const (
	AttrBold AttrMask = 1 << iota
	AttrBlink
	AttrReverse
	AttrUnderline
	AttrDim
	AttrItalic
	AttrStrikeThrough
	AttrNone AttrMask = 0 // Normal text
)

type Cell 

type Cell struct {
	Rune  rune
	Style Style
}

Cell is a rune with a style to be written to a cell on screen

func NewCell 

func NewCell(rune rune, style Style) Cell

func TrimSpaceLeft added in v1.7.1 

func TrimSpaceLeft(cells []Cell) []Cell

Returns a slice of cells with leading whitespace cells removed

func TrimSpaceRight added in v1.7.1 

func TrimSpaceRight(cells []Cell) []Cell

Returns a slice of cells with trailing whitespace cells removed

func (Cell) String 

func (cell Cell) String() string

type Color 

type Color uint32

Create using NewColor16(), NewColor256 or NewColor24Bit(), or use ColorDefault.

func NewColor16 

func NewColor16(colorNumber0to15 int) Color

Four bit colors as defined here: https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit

func NewColor24Bit 

func NewColor24Bit(red uint8, green uint8, blue uint8) Color

func NewColor256 

func NewColor256(colorNumber uint8) Color

func NewColorHex 

func NewColorHex(rgb uint32) Color

func (Color) BackgroundAnsiString 

func (color Color) BackgroundAnsiString(terminalColorCount ColorType) string

func (Color) ColorType added in v1.20.0 

func (color Color) ColorType() ColorType

func (Color) Distance added in v1.20.0 

func (color Color) Distance(other Color) float64

Wrapper for Chroma's color distance function.

That one says it uses this formula: https://www.compuphase.com/cmetric.htm

The result from this function has been scaled to 0.0-1.0, where 1.0 is the distance between black and white.

func (Color) ForegroundAnsiString 

func (color Color) ForegroundAnsiString(terminalColorCount ColorType) string

func (Color) String 

func (color Color) String() string

type ColorType 

type ColorType uint8
const (
	// Default foreground / background color
	ColorTypeDefault ColorType = iota

	// https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit
	//
	// Note that this type is only used for output, on input we store 3 bit
	// colors as 4 bit colors since they map to the same values.
	ColorType8

	// https://en.wikipedia.org/wiki/ANSI_escape_code#3-bit_and_4-bit
	ColorType16

	// https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
	ColorType256

	// RGB: https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit
	ColorType24bit
)

type Event 

type Event interface {
}

type EventExit added in v1.16.0 

type EventExit struct {
}

If we're unable to continue showing the screen, we'll send this event and drop out.

Ref: https://github.com/walles/moar/issues/126

type EventKeyCode 

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

func (*EventKeyCode) KeyCode 

func (eventKeyCode *EventKeyCode) KeyCode() KeyCode

type EventMouse 

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

func (*EventMouse) Buttons 

func (eventMouse *EventMouse) Buttons() MouseButtonMask

type EventResize 

type EventResize struct {
}

After you get this, query Screen.Size() to get the new size

type EventRune 

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

func (*EventRune) Rune 

func (eventRune *EventRune) Rune() rune

type EventTerminalBackgroundDetected added in v1.23.0 

type EventTerminalBackgroundDetected struct {
	// Terminal background color
	Color Color
}

type FakeScreen 

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

Used for testing.

Try GetRow() after some SetCell() calls to see what you got.

func NewFakeScreen 

func NewFakeScreen(width int, height int) *FakeScreen

func (*FakeScreen) Clear 

func (screen *FakeScreen) Clear()

func (*FakeScreen) Close 

func (screen *FakeScreen) Close()

func (*FakeScreen) Events 

func (screen *FakeScreen) Events() chan Event

func (*FakeScreen) GetRow 

func (screen *FakeScreen) GetRow(row int) []Cell

func (*FakeScreen) RequestTerminalBackgroundColor added in v1.23.3 

func (screen *FakeScreen) RequestTerminalBackgroundColor()

func (*FakeScreen) SetCell 

func (screen *FakeScreen) SetCell(column int, row int, cell Cell)

func (*FakeScreen) Show 

func (screen *FakeScreen) Show()

func (*FakeScreen) ShowCursorAt 

func (screen *FakeScreen) ShowCursorAt(_ int, _ int)

func (*FakeScreen) ShowNLines added in v1.8.4 

func (screen *FakeScreen) ShowNLines(int)

func (*FakeScreen) Size 

func (screen *FakeScreen) Size() (width int, height int)

type KeyCode 

type KeyCode uint16
const (
	KeyEscape KeyCode = iota
	KeyEnter

	KeyBackspace
	KeyDelete

	KeyUp
	KeyDown
	KeyRight
	KeyLeft

	KeyAltUp
	KeyAltDown
	KeyAltRight
	KeyAltLeft

	KeyHome
	KeyEnd
	KeyPgUp
	KeyPgDown
)

type MouseButtonMask 

type MouseButtonMask uint16
const (
	MouseWheelUp MouseButtonMask = 1 << iota
	MouseWheelDown
	MouseWheelLeft
	MouseWheelRight
)

type MouseMode added in v1.19.0 

type MouseMode int
const (
	MouseModeAuto MouseMode = iota

	// Don't capture mouse events. This makes selecting with the mouse work. On
	// some terminals mouse scrolling will work using arrow keys emulation, and
	// on some not.
	MouseModeSelect

	// Capture mouse events. This makes mouse scrolling work. Special gymnastics
	// will be required for marking with the mouse to copy text.
	MouseModeScroll
)

type Screen 

type Screen interface {
	// Close() restores terminal to normal state, must be called after you are
	// done with your screen
	Close()

	Clear()

	SetCell(column int, row int, cell Cell)

	// Render our contents into the terminal window
	Show()

	// Can be called after Close()ing the screen to fake retaining its output.
	// Plain Show() is what you'd call during normal operation.
	ShowNLines(lineCountToShow int)

	// Returns screen width and height.
	//
	// NOTE: Never cache this response! On window resizes you'll get an
	// EventResize on the Screen.Events channel, and this method will start
	// returning the new size instead.
	Size() (width int, height int)

	// ShowCursorAt() moves the cursor to the given screen position and makes
	// sure it is visible.
	//
	// If the position is outside of the screen, the cursor will be hidden.
	ShowCursorAt(column int, row int)

	// RequestTerminalBackgroundColor() asks the terminal to report its
	// background color.
	//
	// If your terminal supports background color queries and it responds, the
	// result will be reported as an EventTerminalBackgroundDetected on the
	// Events() channel.
	RequestTerminalBackgroundColor()

	// This channel is what your main loop should be checking.
	Events() chan Event
}

func NewScreen 

func NewScreen() (Screen, error)

NewScreen() requires Close() to be called after you are done with your new screen, most likely somewhere in your shutdown code.

func NewScreenWithMouseMode added in v1.19.0 

func NewScreenWithMouseMode(mouseMode MouseMode) (Screen, error)

func NewScreenWithMouseModeAndColorType added in v1.20.0 

func NewScreenWithMouseModeAndColorType(mouseMode MouseMode, terminalColorCount ColorType) (Screen, error)

type Style 

type Style struct {
	// contains filtered or unexported fields
}
var StyleDefault Style

func (Style) RenderUpdateFrom 

func (current Style) RenderUpdateFrom(previous Style, terminalColorCount ColorType) string

Emit an ANSI escape sequence switching from a previous style to the current one.

func (Style) String 

func (style Style) String() string

func (Style) WithAttr 

func (style Style) WithAttr(attr AttrMask) Style

func (Style) WithBackground added in v1.20.0 

func (style Style) WithBackground(color Color) Style

func (Style) WithForeground added in v1.20.0 

func (style Style) WithForeground(color Color) Style
func (style Style) WithHyperlink(hyperlinkURL *string) Style

Call with nil to remove the link

func (Style) WithoutAttr 

func (style Style) WithoutAttr(attr AttrMask) Style

type UnixScreen 

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

func (*UnixScreen) Clear 

func (screen *UnixScreen) Clear()

func (*UnixScreen) Close 

func (screen *UnixScreen) Close()

Close() restores terminal to normal state, must be called after you are done with the screen returned by NewScreen()

func (*UnixScreen) Events 

func (screen *UnixScreen) Events() chan Event

func (*UnixScreen) RequestTerminalBackgroundColor added in v1.23.3 

func (screen *UnixScreen) RequestTerminalBackgroundColor()

func (*UnixScreen) SetCell 

func (screen *UnixScreen) SetCell(column int, row int, cell Cell)

func (*UnixScreen) Show 

func (screen *UnixScreen) Show()

func (*UnixScreen) ShowCursorAt 

func (screen *UnixScreen) ShowCursorAt(column int, row int)

ShowCursorAt() moves the cursor to the given screen position and makes sure it is visible.

If the position is outside of the screen, the cursor will be hidden.

func (*UnixScreen) ShowNLines added in v1.8.4 

func (screen *UnixScreen) ShowNLines(height int)

func (*UnixScreen) Size 

func (screen *UnixScreen) Size() (width int, height int)

Returns screen width and height.

NOTE: Never cache this response! On window resizes you'll get an EventResize on the Screen.Events channel, and this method will start returning the new size instead.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.