rat

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2017 License: MIT Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ConfigDir string
)

Functions

func AddChildPager 

func AddChildPager(parent, child Pager, creatingKey string)

func AddEventListener 

func AddEventListener(keyStr string, handler func())

func Close 

func Close()

func Confirm 

func Confirm(message string, callback func())

func ConfirmExec 

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

func Exec 

func Exec(cmd string, ctx Context)

func Init 

func Init() error

func InterpolateContext 

func InterpolateContext(str string, ctx Context) string

func KeyEventFromString 

func KeyEventFromString(str string) keyEvent

func KeyEventFromTBEvent 

func KeyEventFromTBEvent(tbev *termbox.Event) keyEvent

func LoadConfig 

func LoadConfig(rd io.Reader)

func PopPager 

func PopPager()

func PushPager 

func PushPager(p Pager)

func Quit 

func Quit()

func RegisterMode 

func RegisterMode(name string, mode Mode)

func Run 

func Run()

func SetAnnotatorsDir added in v0.0.2 

func SetAnnotatorsDir(dir string)

Types

type Annotation 

type Annotation interface {
	Start() int
	End() int
	Class() string
	Val() string
}

func NewAnnotation 

func NewAnnotation(start, end int, class string, val string) Annotation

type Annotations added in v0.0.2 

type Annotations interface {
	Add(Annotation)
	Intersecting(Region) []Annotation
	Len() int
}

func NewAnnotations added in v0.0.2 

func NewAnnotations() Annotations

type Annotator 

type Annotator interface {
	Annotate(io.Reader) <-chan Annotation
}

func NewExternalAnnotator added in v0.0.2 

func NewExternalAnnotator(cmd, class string) Annotator

func NewMatchAnnotator added in v0.0.2 

func NewMatchAnnotator(cmd, class string) Annotator

func NewRegexAnnotator added in v0.0.2 

func NewRegexAnnotator(regex, class string) Annotator

type Box 

type Box interface {
	Left() int
	Top() int
	Width() int
	Height() int
	DrawStyledRune(x, y int, sr StyledRune)
	DrawStyledRunes(x, y int, runes []StyledRune)
	Fill(sr StyledRune)
}

func NewBox 

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

type Buffer 

type Buffer interface {
	sync.Locker
	AnnotateWith(Annotator)
	AnnotationsForLine(line int) []Annotation
	NumAnnotations() int
	NumLines() int
	StyledLines(start int, numLines int) [][]StyledRune
	io.Closer
}

func NewBuffer 

func NewBuffer(rd io.Reader) Buffer

type Configurer 

type Configurer interface {
	Process(rd io.Reader)
}

func NewConfigurer 

func NewConfigurer() Configurer

type ConfirmPrompt 

type ConfirmPrompt interface {
	Widget
	Confirm(message string, callback func())
	Clear()
}

func NewConfirmPrompt 

func NewConfirmPrompt() ConfirmPrompt

type Context 

type Context map[string]string

func MergeContext 

func MergeContext(orig, extra Context) Context

type Highlight added in v0.0.2 

type Highlight interface {
	TermStyle
}

type Highlights added in v0.0.2 

type Highlights interface {
	Start(int, TermStyle)
	End(int)
	AtPoint(int) Highlight
	Len() int
}

func NewHighlights added in v0.0.2 

func NewHighlights() Highlights

type KeyConst 

type KeyConst termbox.Key
const (
	KeyF1         KeyConst = KeyConst(termbox.KeyF1)
	KeyF2         KeyConst = KeyConst(termbox.KeyF2)
	KeyF3         KeyConst = KeyConst(termbox.KeyF3)
	KeyF4         KeyConst = KeyConst(termbox.KeyF4)
	KeyF5         KeyConst = KeyConst(termbox.KeyF5)
	KeyF6         KeyConst = KeyConst(termbox.KeyF6)
	KeyF7         KeyConst = KeyConst(termbox.KeyF7)
	KeyF8         KeyConst = KeyConst(termbox.KeyF8)
	KeyF9         KeyConst = KeyConst(termbox.KeyF9)
	KeyF10        KeyConst = KeyConst(termbox.KeyF10)
	KeyF11        KeyConst = KeyConst(termbox.KeyF11)
	KeyF12        KeyConst = KeyConst(termbox.KeyF12)
	KeyInsert     KeyConst = KeyConst(termbox.KeyInsert)
	KeyDelete     KeyConst = KeyConst(termbox.KeyDelete)
	KeyHome       KeyConst = KeyConst(termbox.KeyHome)
	KeyEnd        KeyConst = KeyConst(termbox.KeyEnd)
	KeyPgup       KeyConst = KeyConst(termbox.KeyPgup)
	KeyPgdn       KeyConst = KeyConst(termbox.KeyPgdn)
	KeyArrowUp    KeyConst = KeyConst(termbox.KeyArrowUp)
	KeyArrowDown  KeyConst = KeyConst(termbox.KeyArrowDown)
	KeyArrowLeft  KeyConst = KeyConst(termbox.KeyArrowLeft)
	KeyArrowRight KeyConst = KeyConst(termbox.KeyArrowRight)
	KeyTab        KeyConst = KeyConst(termbox.KeyTab)
	KeyBackspace  KeyConst = KeyConst(termbox.KeyBackspace)
	KeyEnter      KeyConst = KeyConst(termbox.KeyEnter)
	KeyEsc        KeyConst = KeyConst(termbox.KeyEsc)
	KeySpace      KeyConst = KeyConst(termbox.KeySpace)
)

type Line added in v0.0.2 

type Line interface {
	Start() int
	End() int
	SetEnd(int)
}

func NewLine added in v0.0.2 

func NewLine(start, end int) Line

type Mode 

type Mode interface {
	RegisterAnnotator(func(Context) Annotator)
	RegisterEventListener(func(Context) func(Pager))
	InitAnnotators(Context) func() []Annotator
	AddEventListeners(Context) func(Pager)
}

func NewMode 

func NewMode() Mode

type Pager 

type Pager interface {
	Widget
	AddEventListener(keyStr string, handler func())
	AddAnnotationEventListener(keyStr string, annotationTypes []string, handler func(Context))
	Reload()
	CursorUp()
	CursorDown()
	CursorFirstLine()
	CursorLastLine()
	ScrollUp()
	ScrollDown()
	PageUp()
	PageDown()
}

func NewCmdPager 

func NewCmdPager(modeNames string, cmd string, ctx Context) Pager

type PagerStack 

type PagerStack interface {
	Widget
	AddEventListener(string, func())
	Show(int)
	Push(p Pager)
	Pop()
	Size() int
	AddChild(parent Pager, child Pager, creatingKey string)
	PushAsChild(Pager, string)
	ParentCursorUp()
	ParentCursorDown()
}

func NewPagerStack 

func NewPagerStack() PagerStack

type Region added in v0.0.2 

type Region interface {
	Start() int
	End() int
}

type ShellCommand added in v0.0.2 

type ShellCommand interface {
	io.ReadCloser
}

func NewShellCommand added in v0.0.2 

func NewShellCommand(c string) (ShellCommand, error)

type Stream added in v0.0.2 

type Stream interface {
	io.WriteCloser
	Bytes() []byte
	NewReader() StreamReader
}

func NewStream added in v0.0.2 

func NewStream() Stream

type StreamReader added in v0.0.2 

type StreamReader interface {
	io.Reader
}

type StyledRune 

type StyledRune interface {
	Rune() rune
	TermStyle
}

func NewStyledRune 

func NewStyledRune(ch rune, ts TermStyle) StyledRune

func StyledRunesFromString 

func StyledRunesFromString(str string, ts TermStyle) []StyledRune

type TermStyle added in v0.0.2 

type TermStyle interface {
	Fg() termbox.Attribute
	Bg() termbox.Attribute
}

type TermStyles added in v0.0.2 

type TermStyles interface {
	Get(termbox.Attribute, termbox.Attribute) TermStyle
	Default() TermStyle
}

func NewTermStyles added in v0.0.2 

func NewTermStyles() TermStyles

type Token added in v0.0.2 

type Token interface {
	Type() TokenType
	Val() []byte
	TermStyle() TermStyle
}

type TokenReader added in v0.0.2 

type TokenReader interface {
	ReadToken() (Token, error)
}

func NewScanner added in v0.0.2 

func NewScanner(rd io.Reader) TokenReader

type TokenType added in v0.0.2 

type TokenType uint8
const (
	TokNone TokenType = iota
	TokText
	TokTermStyle
	TokNewLine
)

type Widget 

type Widget interface {
	SetBox(Box)
	GetBox() Box
	Render()
	HandleEvent(keyEvent) bool
	Destroy()
}

type WidgetStack 

type WidgetStack interface {
	Widget
	Push(w Widget)
	Pop() Widget
	Size() int
}

func NewWidgetStack 

func NewWidgetStack() WidgetStack

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.