buffer

Documentation

Index

• type Buffer
  • func NewBuffer(viewCols uint16, viewLines uint16, attr CellAttributes) *Buffer
  • func (buffer *Buffer) Backspace()
  • func (buffer *Buffer) BottomMargin() uint
  • func (buffer *Buffer) CarriageReturn()
  • func (buffer *Buffer) Clear()
  • func (buffer *Buffer) CursorAttr() *CellAttributes
  • func (buffer *Buffer) CursorColumn() uint16
  • func (buffer *Buffer) CursorLine() uint16
  • func (buffer *Buffer) DeleteChars(n int)
  • func (buffer *Buffer) DeleteLines(count int)
  • func (buffer *Buffer) EndSelection(col uint16, row uint16, complete bool)
  • func (buffer *Buffer) EraseCharacters(n int)
  • func (buffer *Buffer) EraseDisplay()
  • func (buffer *Buffer) EraseDisplayFromCursor()
  • func (buffer *Buffer) EraseDisplayToCursor()
  • func (buffer *Buffer) EraseLine()
  • func (buffer *Buffer) EraseLineFromCursor()
  • func (buffer *Buffer) EraseLineToCursor()
  • func (buffer *Buffer) GetCell(viewCol uint16, viewRow uint16) *Cell
  • func (buffer *Buffer) GetHintAtPosition(col uint16, row uint16) *hints.Hint
  • func (buffer *Buffer) GetScrollOffset() uint
  • func (buffer *Buffer) GetSelectedText() string
  • func (buffer *Buffer) GetURLAtPosition(col uint16, row uint16) string
  • func (buffer *Buffer) GetVisibleLines() []Line
  • func (buffer *Buffer) HasScrollableRegion() bool
  • func (buffer *Buffer) Height() int
  • func (buffer *Buffer) InScrollableRegion() bool
  • func (buffer *Buffer) InSelection(col uint16, row uint16) bool
  • func (buffer *Buffer) Index()
  • func (buffer *Buffer) InsertBlankCharacters(count int)
  • func (buffer *Buffer) InsertLines(count int)
  • func (buffer *Buffer) IsDirty() bool
  • func (buffer *Buffer) MovePosition(x int16, y int16)
  • func (buffer *Buffer) NewLine()
  • func (buffer *Buffer) RawLine() uint64
  • func (buffer *Buffer) ResizeView(width uint16, height uint16)
  • func (buffer *Buffer) RestoreCursor()
  • func (buffer *Buffer) ReverseIndex()
  • func (buffer *Buffer) SaveCursor()
  • func (buffer *Buffer) ScrollDown(lines uint16)
  • func (buffer *Buffer) ScrollPageDown()
  • func (buffer *Buffer) ScrollPageUp()
  • func (buffer *Buffer) ScrollToEnd()
  • func (buffer *Buffer) ScrollUp(lines uint16)
  • func (buffer *Buffer) SelectWordAtPosition(col uint16, row uint16)
  • func (buffer *Buffer) SetAutoWrap(enabled bool)
  • func (buffer *Buffer) SetInsertMode()
  • func (buffer *Buffer) SetPosition(col uint16, line uint16)
  • func (buffer *Buffer) SetReplaceMode()
  • func (buffer *Buffer) SetVerticalMargins(top uint, bottom uint)
  • func (buffer *Buffer) StartSelection(col uint16, row uint16)
  • func (buffer *Buffer) Tab()
  • func (buffer *Buffer) TopMargin() uint
  • func (buffer *Buffer) ViewHeight() uint16
  • func (buffer *Buffer) ViewWidth() uint16
  • func (buffer *Buffer) Width() uint16
  • func (buffer *Buffer) Write(runes ...rune)
• type Cell
  • func NewBackgroundCell(colour [3]float32) Cell
  • func (cell *Cell) Attr() CellAttributes
  • func (cell *Cell) Bg() [3]float32
  • func (cell *Cell) Fg() [3]float32
  • func (cell *Cell) Image() *image.RGBA
  • func (cell *Cell) Rune() rune
  • func (cell *Cell) SetImage(img *image.RGBA)
• type CellAttributes
• type Line
  • func (line *Line) Cells() []Cell
  • func (line *Line) Cleanse()
  • func (line *Line) CutCellsAfter(n int) []Cell
  • func (line *Line) CutCellsFromBeginning(n int) []Cell
  • func (line *Line) CutCellsFromEnd(n int) []Cell
  • func (line *Line) String() string
• type Position

Types

type Buffer

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

func NewBuffer

func NewBuffer(viewCols uint16, viewLines uint16, attr CellAttributes) *Buffer

NewBuffer creates a new terminal buffer

func (*Buffer) Backspace

func (buffer *Buffer) Backspace()

func (*Buffer) BottomMargin

func (buffer *Buffer) BottomMargin() uint

func (*Buffer) CarriageReturn

func (buffer *Buffer) CarriageReturn()

func (*Buffer) Clear

func (buffer *Buffer) Clear()

func (*Buffer) CursorAttr

func (buffer *Buffer) CursorAttr() *CellAttributes

func (*Buffer) CursorColumn

func (buffer *Buffer) CursorColumn() uint16

Column returns cursor column

func (*Buffer) CursorLine

func (buffer *Buffer) CursorLine() uint16

Line returns cursor line

func (*Buffer) DeleteChars

func (buffer *Buffer) DeleteChars(n int)

func (*Buffer) DeleteLines

func (buffer *Buffer) DeleteLines(count int)

func (*Buffer) EndSelection

func (buffer *Buffer) EndSelection(col uint16, row uint16, complete bool)

func (*Buffer) EraseCharacters

func (buffer *Buffer) EraseCharacters(n int)

func (*Buffer) EraseDisplay

func (buffer *Buffer) EraseDisplay()

func (*Buffer) EraseDisplayFromCursor

func (buffer *Buffer) EraseDisplayFromCursor()

func (*Buffer) EraseDisplayToCursor

func (buffer *Buffer) EraseDisplayToCursor()

func (*Buffer) EraseLine

func (buffer *Buffer) EraseLine()

func (*Buffer) EraseLineFromCursor

func (buffer *Buffer) EraseLineFromCursor()

func (*Buffer) EraseLineToCursor

func (buffer *Buffer) EraseLineToCursor()

func (*Buffer) GetCell

func (buffer *Buffer) GetCell(viewCol uint16, viewRow uint16) *Cell

func (*Buffer) GetHintAtPosition

func (buffer *Buffer) GetHintAtPosition(col uint16, row uint16) *hints.Hint

func (*Buffer) GetScrollOffset

func (buffer *Buffer) GetScrollOffset() uint

func (*Buffer) GetSelectedText

func (buffer *Buffer) GetSelectedText() string

func (*Buffer) GetURLAtPosition

func (buffer *Buffer) GetURLAtPosition(col uint16, row uint16) string

func (*Buffer) GetVisibleLines

func (buffer *Buffer) GetVisibleLines() []Line

func (*Buffer) HasScrollableRegion

func (buffer *Buffer) HasScrollableRegion() bool

func (*Buffer) Height

func (buffer *Buffer) Height() int

func (*Buffer) InScrollableRegion

func (buffer *Buffer) InScrollableRegion() bool

func (*Buffer) InSelection

func (buffer *Buffer) InSelection(col uint16, row uint16) bool

func (*Buffer) Index

func (buffer *Buffer) Index()

func (*Buffer) InsertBlankCharacters

func (buffer *Buffer) InsertBlankCharacters(count int)

func (*Buffer) InsertLines

func (buffer *Buffer) InsertLines(count int)

func (*Buffer) IsDirty

func (buffer *Buffer) IsDirty() bool

func (*Buffer) MovePosition

func (buffer *Buffer) MovePosition(x int16, y int16)

func (*Buffer) NewLine

func (buffer *Buffer) NewLine()

func (*Buffer) RawLine

func (buffer *Buffer) RawLine() uint64

translates the cursor line to the raw buffer line

func (*Buffer) ResizeView

func (buffer *Buffer) ResizeView(width uint16, height uint16)

func (*Buffer) RestoreCursor

func (buffer *Buffer) RestoreCursor()

func (*Buffer) ReverseIndex

func (buffer *Buffer) ReverseIndex()

func (*Buffer) SaveCursor

func (buffer *Buffer) SaveCursor()

func (*Buffer) ScrollDown

func (buffer *Buffer) ScrollDown(lines uint16)

func (*Buffer) ScrollPageDown

func (buffer *Buffer) ScrollPageDown()

func (*Buffer) ScrollPageUp

func (buffer *Buffer) ScrollPageUp()

func (*Buffer) ScrollToEnd

func (buffer *Buffer) ScrollToEnd()

func (*Buffer) ScrollUp

func (buffer *Buffer) ScrollUp(lines uint16)

func (*Buffer) SelectWordAtPosition

func (buffer *Buffer) SelectWordAtPosition(col uint16, row uint16)

func (*Buffer) SetAutoWrap

func (buffer *Buffer) SetAutoWrap(enabled bool)

func (*Buffer) SetInsertMode

func (buffer *Buffer) SetInsertMode()

func (*Buffer) SetPosition

func (buffer *Buffer) SetPosition(col uint16, line uint16)

func (*Buffer) SetReplaceMode

func (buffer *Buffer) SetReplaceMode()

func (*Buffer) SetVerticalMargins

func (buffer *Buffer) SetVerticalMargins(top uint, bottom uint)

func (*Buffer) StartSelection

func (buffer *Buffer) StartSelection(col uint16, row uint16)

func (*Buffer) Tab

func (buffer *Buffer) Tab()

func (*Buffer) TopMargin

func (buffer *Buffer) TopMargin() uint

func (*Buffer) ViewHeight

func (buffer *Buffer) ViewHeight() uint16

func (*Buffer) ViewWidth

func (buffer *Buffer) ViewWidth() uint16

func (*Buffer) Width

func (buffer *Buffer) Width() uint16

Width returns the width of the buffer in columns

func (*Buffer) Write

func (buffer *Buffer) Write(runes ...rune)

Write will write a rune to the terminal at the position of the cursor, and increment the cursor position

type Cell

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

func NewBackgroundCell

func NewBackgroundCell(colour [3]float32) Cell

func (*Cell) Attr

func (cell *Cell) Attr() CellAttributes

func (*Cell) Bg

func (cell *Cell) Bg() [3]float32

func (*Cell) Fg

func (cell *Cell) Fg() [3]float32

func (*Cell) Image

func (cell *Cell) Image() *image.RGBA

func (*Cell) Rune

func (cell *Cell) Rune() rune

func (*Cell) SetImage

func (cell *Cell) SetImage(img *image.RGBA)

type CellAttributes

type CellAttributes struct {
	FgColour  [3]float32
	BgColour  [3]float32
	Bold      bool
	Dim       bool
	Underline bool
	Blink     bool
	Reverse   bool
	Hidden    bool
}

type Line

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

func (*Line) Cells

func (line *Line) Cells() []Cell

func (*Line) Cleanse

func (line *Line) Cleanse()

Cleanse removes null bytes from the end of the row

func (*Line) CutCellsAfter

func (line *Line) CutCellsAfter(n int) []Cell

@todo test these (ported from legacy) ------------------

func (*Line) CutCellsFromBeginning

func (line *Line) CutCellsFromBeginning(n int) []Cell

func (*Line) CutCellsFromEnd

func (line *Line) CutCellsFromEnd(n int) []Cell

func (*Line) String

func (line *Line) String() string

type Position

type Position struct {
	Line int
	Col  int
}