rat

package

Go to main page

Versions in this module

v0

v0.1.0

Sep 23, 2021

Changes in this version

+ func AddEventHandler(keyStr string, handler func())

+ func ContextEnvironment(ctx Context) []string

+ func KeySequenceFromString(str string) []keyEvent

type Context

+ func NewContextFromAnnotations(annotations []Annotation) Context

+ type EventHandler interface

+ Call func(Context)

+ Specificity func() int

+ Supports func(Context) bool

+ func NewCtxEventHandler(req []string, h func(Context)) EventHandler

+ func NewEventHandler(h func()) EventHandler

+ type HandlerRegistry interface

+ Add func([]keyEvent, EventHandler)

+ Find func([]keyEvent) EventHandler

+ FindCtx func([]keyEvent, Context) EventHandler

+ func NewHandlerRegistry() HandlerRegistry

type Mode

+ AddEventHandlers func(Context) func(Pager)

+ RegisterEventHandler func(func(Context) func(Pager))

type Pager

+ func NewReadPager(rd io.Reader, title string, modeNames string, ctx Context) Pager

+ AddEventHandler func(keyStr string, handler EventHandler)

type PagerStack

+ Last func() Pager

v0.0.2

Oct 12, 2017

Changes in this version

+ var ConfigDir string

+ func SetAnnotatorsDir(dir string)

+ type Annotations interface

+ Add func(Annotation)

+ Intersecting func(Region) []Annotation

+ Len func() int

+ func NewAnnotations() Annotations

type Annotator

+ func NewExternalAnnotator(cmd, class string) Annotator

+ func NewMatchAnnotator(cmd, class string) Annotator

+ func NewRegexAnnotator(regex, class string) Annotator

type Buffer

+ AnnotateWith func(Annotator)

+ StyledLines func(start int, numLines int) [][]StyledRune

+ type Highlight interface

+ type Highlights interface

+ AtPoint func(int) Highlight

+ End func(int)

+ Len func() int

+ Start func(int, TermStyle)

+ func NewHighlights() Highlights

+ type Line interface

+ End func() int

+ SetEnd func(int)

+ Start func() int

+ func NewLine(start, end int) Line

type Mode

+ InitAnnotators func(Context) func() []Annotator

+ type Region interface

+ End func() int

+ Start func() int

+ type ShellCommand interface

+ func NewShellCommand(c string) (ShellCommand, error)

+ type Stream interface

+ Bytes func() []byte

+ NewReader func() StreamReader

+ func NewStream() Stream

+ type StreamReader interface

+ type TermStyle interface

+ Bg func() termbox.Attribute

+ Fg func() termbox.Attribute

+ type TermStyles interface

+ Default func() TermStyle

+ Get func(termbox.Attribute, termbox.Attribute) TermStyle

+ func NewTermStyles() TermStyles

+ type Token interface

+ TermStyle func() TermStyle

+ Type func() TokenType

+ Val func() []byte

+ type TokenReader interface

+ ReadToken func() (Token, error)

+ func NewScanner(rd io.Reader) TokenReader

+ type TokenType uint8

+ const TokNewLine

+ const TokNone

+ const TokTermStyle

+ const TokText

v0.0.1

Feb 11, 2017

Changes in this version

+ func AddChildPager(parent, child Pager, creatingKey string)

+ func AddEventListener(keyStr string, handler func())

+ func Close()

+ func Confirm(message string, callback func())

+ func ConfirmExec(cmd string, ctx Context, callback func())

+ func Exec(cmd string, ctx Context)

+ func Init() error

+ func InterpolateContext(str string, ctx Context) string

+ func KeyEventFromString(str string) keyEvent

+ func KeyEventFromTBEvent(tbev *termbox.Event) keyEvent

+ func LoadConfig(rd io.Reader)

+ func PopPager()

+ func PushPager(p Pager)

+ func Quit()

+ func RegisterMode(name string, mode Mode)

+ func Run()

+ type Annotation interface

+ Class func() string

+ End func() BufferPoint

+ Start func() BufferPoint

+ Val func() string

+ func NewAnnotation(start, end BufferPoint, class string, val string) Annotation

+ type Annotator interface

+ Annotate func(BufferReader) <-chan Annotation

+ func NewMatchParser(cmd, class string) Annotator

+ type Box interface

+ DrawStyledRune func(x, y int, sr StyledRune)

+ DrawStyledRunes func(x, y int, runes []StyledRune)

+ Fill func(sr StyledRune)

+ Height func() int

+ Left func() int

+ Top func() int

+ Width func() int

+ func NewBox(left, top, width, height int) Box

+ type Buffer interface

+ AnnotationsForLine func(line int) []Annotation

+ Destroy func()

+ LineRange func(start int, numLines int) [][]StyledRune

+ Lock func()

+ NextPositionedRune func(bp BufferPoint) (PositionedRune, error)

+ NumAnnotations func() int

+ NumLines func() int

+ Unlock func()

+ func NewBuffer(srr StyledRuneReader, initParsers func() []Annotator) Buffer

+ type BufferPoint interface

+ Col func() int

+ Line func() int

+ func NewBufferPoint(line, col int) BufferPoint

+ type BufferReader interface

+ ReadPositionedRune func() (PositionedRune, error)

+ func NewBufferReader(b Buffer) BufferReader

+ type Configurer interface

+ Process func(rd io.Reader)

+ func NewConfigurer() Configurer

+ type ConfirmPrompt interface

+ Clear func()

+ Confirm func(message string, callback func())

+ func NewConfirmPrompt() ConfirmPrompt

+ type Context map[string]string

+ func MergeContext(orig, extra Context) Context

+ type KeyConst termbox.Key

+ const KeyArrowDown

+ const KeyArrowLeft

+ const KeyArrowRight

+ const KeyArrowUp

+ const KeyBackspace

+ const KeyDelete

+ const KeyEnd

+ const KeyEnter

+ const KeyEsc

+ const KeyF1

+ const KeyF10

+ const KeyF11

+ const KeyF12

+ const KeyF2

+ const KeyF3

+ const KeyF4

+ const KeyF5

+ const KeyF6

+ const KeyF7

+ const KeyF8

+ const KeyF9

+ const KeyHome

+ const KeyInsert

+ const KeyPgdn

+ const KeyPgup

+ const KeySpace

+ const KeyTab

+ type Mode interface

+ AddEventListeners func(Context) func(Pager)

+ InitParsers func(Context) func() []Annotator

+ RegisterAnnotator func(func(Context) Annotator)

+ RegisterEventListener func(func(Context) func(Pager))

+ func NewMode() Mode

+ type Pager interface

+ AddAnnotationEventListener func(keyStr string, annotationTypes []string, handler func(Context))

+ AddEventListener func(keyStr string, handler func())

+ CursorDown func()

+ CursorFirstLine func()

+ CursorLastLine func()

+ CursorUp func()

+ PageDown func()

+ PageUp func()

+ Reload func()

+ ScrollDown func()

+ ScrollUp func()

+ func NewCmdPager(modeName string, cmd string, ctx Context) Pager

+ type PagerStack interface

+ AddChild func(parent Pager, child Pager, creatingKey string)

+ AddEventListener func(string, func())

+ ParentCursorDown func()

+ ParentCursorUp func()

+ Pop func()

+ Push func(p Pager)

+ PushAsChild func(Pager, string)

+ Show func(int)

+ Size func() int

+ func NewPagerStack() PagerStack

+ type PositionedRune interface

+ Pos func() BufferPoint

+ Rune func() rune

+ func NewPositionedRune(ch rune, pos BufferPoint) PositionedRune

+ type StyledRune interface

+ Bg func() termbox.Attribute

+ Fg func() termbox.Attribute

+ Rune func() rune

+ func NewStyledRune(ch rune, fg termbox.Attribute, bg termbox.Attribute) StyledRune

+ func StyledRunesFromString(str string, fg termbox.Attribute, bg termbox.Attribute) []StyledRune

+ type StyledRuneReader interface

+ ReadStyledRune func() (StyledRune, error)

+ func NewStyledRuneReader(reader io.Reader) StyledRuneReader

+ type Widget interface

+ Destroy func()

+ GetBox func() Box

+ HandleEvent func(keyEvent) bool

+ Render func()

+ SetBox func(Box)

+ type WidgetStack interface

+ Pop func() Widget

+ Push func(w Widget)

+ Size func() int

+ func NewWidgetStack() WidgetStack

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL