process

Documentation

Index

• Constants
• Variables
• func CropView(atablelist *ANSITableList, lines []*SubLine, x, y, width, height int) string
• func IsEndOfSGR(data []byte) bool
• func IsEscEnd(c rune) bool
• func IsSGR(data []byte) bool
• func ProcessContent(s string) (*ANSITableList, []*SubLine)
• func Search(list []BoundsStruct, pos int) []int
• func SliceFrom[S ~[]E, E comparable](src S, start, end int) S
• type ANSIQueueItem
• type ANSITable
  • func (a *ANSITable) AddStyle(data []byte, boundLeft int)
  • func (a *ANSITable) Split(index int) (*ANSITable, *ANSITable)
• type ANSITableList
  • func GetANSIs(s string) (*ANSITableList, string)
  • func (a *ANSITableList) GetSlice(startIndex, endIndex int) []BoundsStruct
  • func (a *ANSITableList) SetStyle(style []byte, startIndex, endIndex int)
• type BoundsStruct
• type RuneData
• type RuneDataList
  • func (r *RuneDataList) Init(s []rune) *RuneDataList
• type SubLine

Constants

const (
	ESCAPE_SEQUENCE     = '\x1b'
	SGR_FUNC            = byte('\x6d')
	ESCAPE_SEQUENCE_END = string(ESCAPE_SEQUENCE) + "[0" + string(SGR_FUNC)
)

const LINE_SPLIT = "\n"

const TAB_RUNE = '\t'

NOTE: Planning to make these rune process function available to be set from outside

Variables

var (
	SPACE_HODLER   = []byte(" ")
	SPACE_RUNEDATA = &RuneData{
		Byte: SPACE_HODLER,
	}
)

var EMPTY_ANSITABLELIST = make([]BoundsStruct, 0)

var TAB_BYTES = []byte{32, 32, 32, 32}

Functions

func CropView

func CropView(atablelist *ANSITableList, lines []*SubLine, x, y, width, height int) string

extract certain area of the given lines, and render ansi sequence

func IsEndOfSGR

func IsEndOfSGR(data []byte) bool

func IsEscEnd

func IsEscEnd(c rune) bool

func IsSGR

func IsSGR(data []byte) bool

func ProcessContent

func ProcessContent(s string) (*ANSITableList, []*SubLine)

separate ansi and normal string, separate lines into RuneData list

func Search

func Search(list []BoundsStruct, pos int) []int

func SliceFrom

func SliceFrom[S ~[]E, E comparable](src S, start, end int) S

if endIndex bigger than length, return copy of rest. mainly for cut slice easier

Types

type ANSIQueueItem

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

type ANSITable

type ANSITable struct {
	Sub   *ANSITable
	Data  []byte
	Bound [2]int // rune index
}

func (*ANSITable) AddStyle

func (a *ANSITable) AddStyle(data []byte, boundLeft int)

func (*ANSITable) Split

func (a *ANSITable) Split(index int) (*ANSITable, *ANSITable)

split ansi table given index(bounds), left: [:index] right: [index:]

type ANSITableList

type ANSITableList struct {
	L []BoundsStruct
}

func GetANSIs

func GetANSIs(s string) (*ANSITableList, string)

split `string with ansi` into `ansi sequences` and `raw string`

func (*ANSITableList) GetSlice

func (a *ANSITableList) GetSlice(startIndex, endIndex int) []BoundsStruct

get a slice of ansi table, it will find all tables between `startIndex` and `endIndex`

func (*ANSITableList) SetStyle

func (a *ANSITableList) SetStyle(style []byte, startIndex, endIndex int)

type BoundsStruct

type BoundsStruct interface {
	// contains filtered or unexported methods
}

type RuneData

type RuneData struct {
	Byte  []byte
	Bound [2]int // refers to the visible width
}

type RuneDataList

type RuneDataList struct {
	L          []BoundsStruct
	TotalWidth int
}

func (*RuneDataList) Init

func (r *RuneDataList) Init(s []rune) *RuneDataList

init RuneData list given runes

RuneDataList can only be set with this function, no more process allowed afterwards

type SubLine

type SubLine struct {
	Data  *RuneDataList
	Bound [2]int
}