m

README

Oviewer

Feature rich terminal pager

Documentation

Index

• Variables
• func Page(reader *Reader) error
• func SetManPageFormatFromEnv()
• type Line
  • func NewLine(raw string) *Line
  • func (line *Line) Plain() string
  • func (line *Line) Tokens() []Token
• type Lines
• type MatchRanges
  • func (mr *MatchRanges) InRange(index int) bool
• type Pager
  • func NewPager(r *Reader) *Pager
  • func (p *Pager) Quit()
  • func (p *Pager) StartPaging(screen tcell.Screen)
• type Reader
  • func NewReaderFromFilename(filename string) (*Reader, error)
  • func NewReaderFromStream(name string, reader io.Reader) *Reader
  • func NewReaderFromText(name string, text string) *Reader
  • func (r *Reader) GetLine(lineNumberOneBased int) *Line
  • func (r *Reader) GetLineCount() int
  • func (r *Reader) GetLines(firstLineOneBased int, wantedLineCount int) *Lines
• type Token

Variables

var DeInit = true

If true, the Page function will clear the screen on return. If false, the Page function will clear the last line, and show the cursor.

Functions

func Page

func Page(reader *Reader) error

Page displays text in a pager.

The reader parameter can be constructed using one of: * NewReaderFromFilename() * NewReaderFromText() * NewReaderFromStream()

Or your could roll your own Reader based on the source code for any of those constructors.

func SetManPageFormatFromEnv

func SetManPageFormatFromEnv()

SetManPageFormatFromEnv parses LESS_TERMCAP_xx environment variables and adapts the moar output accordingly.

Types

type Line

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

A Line represents a line of text that can / will be paged

func NewLine

func NewLine(raw string) *Line

NewLine creates a new Line from a (potentially ANSI / man page formatted) string

func (*Line) Plain

func (line *Line) Plain() string

Plain returns a plain text representation of the initial string

func (*Line) Tokens

func (line *Line) Tokens() []Token

Tokens returns a representation of the string split into styled tokens

type Lines

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

Lines contains a number of lines from the reader, plus metadata

type MatchRanges

type MatchRanges struct {
	Matches [][2]int
}

MatchRanges collects match indices

func (*MatchRanges) InRange

func (mr *MatchRanges) InRange(index int) bool

InRange says true if the index is part of a regexp match

type Pager

type Pager struct {

	// NewPager shows lines by default, this field can hide them
	ShowLineNumbers bool
	// contains filtered or unexported fields
}

Pager is the main on-screen pager

func NewPager

func NewPager(r *Reader) *Pager

NewPager creates a new Pager

func (*Pager) Quit

func (p *Pager) Quit()

Quit leaves the help screen or quits the pager

func (*Pager) StartPaging

func (p *Pager) StartPaging(screen tcell.Screen)

StartPaging brings up the pager on screen

type Reader

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

Reader reads a file into an array of strings.

It does the reading in the background, and it returns parts of the read data upon request.

This package provides query methods for the struct, no peeking!!

func NewReaderFromFilename

func NewReaderFromFilename(filename string) (*Reader, error)

NewReaderFromFilename creates a new file reader.

The Reader will try to uncompress various compressed file format, and also apply highlighting to the file using Chroma: https://github.com/alecthomas/chroma

func NewReaderFromStream

func NewReaderFromStream(name string, reader io.Reader) *Reader

NewReaderFromStream creates a new stream reader

The name can be an empty string ("").

If non-empty, the name will be displayed by the pager in the bottom left corner to help the user keep track of what is being paged.

func NewReaderFromText

func NewReaderFromText(name string, text string) *Reader

NewReaderFromText creates a Reader from a block of text.

First parameter is the name of this Reader. This name will be displayed by Moar in the bottom left corner of the screen.

func (*Reader) GetLine

func (r *Reader) GetLine(lineNumberOneBased int) *Line

GetLine gets a line. If the requested line number is out of bounds, nil is returned.

func (*Reader) GetLineCount

func (r *Reader) GetLineCount() int

GetLineCount returns the number of lines available for viewing

func (*Reader) GetLines

func (r *Reader) GetLines(firstLineOneBased int, wantedLineCount int) *Lines

GetLines gets the indicated lines from the input

type Token

type Token struct {
	Rune  rune
	Style tcell.Style
}

Token is a rune with a style to be written to a cell on screen