search

README

search

Package search is a high-performance search algorithm to find matches for a regex pattern on the terminal screen over the course of a recorded terminal session. This is more complicated than it seems: it must track the exact byte at which a match first appeared and calculate how long that match remained intact on the screen.

Documentation

Index

• func NewSearcher() *searcher
• func NormalizePattern(pattern string) string
• type Address
  • func (a Address) After(other Address) bool
  • func (a Address) Before(other Address) bool
  • func (a Address) Equal(other Address) bool
• type Appearance
• type Match
• type SearchResult
  • func Search(events []sessions.Event, pattern string, progress chan<- int) (results []SearchResult, err error)
• type Selection
  • func (s Selection) Within(pos geom.Vec2, size geom.Vec2) bool
  • func (s Selection) WithinRect(rect geom.Rect, size geom.Vec2) bool

Functions

func NewSearcher

func NewSearcher() *searcher

func NormalizePattern

func NormalizePattern(pattern string) string

NormalizePattern returns the given pattern if it's a valid regex, otherwise it escapes all speical regex characters.

Types

type Address

type Address struct {
	// The index of the event
	Index int
	// The byte offset at which (after parsing) the match either appeared
	// or disappeared
	Offset int
}

Address refers to a point inside of a recording.

func (Address) After

func (a Address) After(other Address) bool

func (Address) Before

func (a Address) Before(other Address) bool

func (Address) Equal

func (a Address) Equal(other Address) bool

type Appearance

type Appearance struct {
	Selection
	Begin, End Address
}

type Match

type Match struct {
	Begin, End Address
	// Whether this Match is unbroken by nonprintable characters. If this
	// is true, it is definitely a match.
	Continuous bool
}

type SearchResult

type SearchResult struct {
	// The location of the result in time
	Begin, End Address
	// The location of the result on the screen
	Appearances []Appearance
}

func Search

func Search(events []sessions.Event, pattern string, progress chan<- int) (results []SearchResult, err error)

type Selection

type Selection struct {
	From, To geom.Vec2
}

func (Selection) Within

func (s Selection) Within(pos geom.Vec2, size geom.Vec2) bool

Within returns true if `pos` falls within the Selection.

func (Selection) WithinRect

func (s Selection) WithinRect(rect geom.Rect, size geom.Vec2) bool