text

Documentation

Overview

Package text defines a text input reader and basic terminal parsers.

Index

• func LeftTrim(p parsley.Parser, wsMode WsMode) parser.Func
• func RightTrim(p parsley.Parser, wsMode WsMode) parser.Func
• func Trim(p parsley.Parser) parser.Func
• type File
  • func NewFile(filename string, data []byte) *File
  • func ReadFile(filename string) (*File, error)
  • func (f *File) Len() int
  • func (f *File) Pos(pos int) parsley.Pos
  • func (f *File) Position(pos int) parsley.Position
  • func (f *File) SetOffset(offset int)
• type Position
  • func NewPosition(filename string, line int, column int) *Position
  • func (pos Position) String() string
• type Reader
  • func NewReader(file *File) *Reader
  • func (r *Reader) IsEOF(pos parsley.Pos) bool
  • func (r *Reader) MatchString(pos parsley.Pos, str string) (parsley.Pos, bool)
  • func (r *Reader) MatchWord(pos parsley.Pos, word string) (parsley.Pos, bool)
  • func (r *Reader) Pos(cur int) parsley.Pos
  • func (r *Reader) ReadRegexp(pos parsley.Pos, expr string) (parsley.Pos, []byte)
  • func (r *Reader) ReadRegexpSubmatch(pos parsley.Pos, expr string) (parsley.Pos, [][]byte)
  • func (r *Reader) ReadRune(pos parsley.Pos, ch rune) (parsley.Pos, bool)
  • func (r *Reader) Readf(pos parsley.Pos, f func(b []byte) ([]byte, int)) (parsley.Pos, []byte)
  • func (r *Reader) Remaining(pos parsley.Pos) int
  • func (r *Reader) SkipWhitespaces(pos parsley.Pos, wsMode WsMode) (parsley.Pos, parsley.Error)
• type WsMode

Functions

func LeftTrim

func LeftTrim(p parsley.Parser, wsMode WsMode) parser.Func

LeftTrim skips the whitespaces before it tries to match the given parser

func RightTrim

func RightTrim(p parsley.Parser, wsMode WsMode) parser.Func

RightTrim reads and skips the whitespaces after any parser matches and updates the reader position

func Trim

func Trim(p parsley.Parser) parser.Func

Trim removes all whitespaces before and after the result token

Types

type File

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

File contains the contents of a file and the line offsets for quick line+column lookup

func NewFile

func NewFile(filename string, data []byte) *File

NewFile creates a new file object

func ReadFile

func ReadFile(filename string) (*File, error)

ReadFile reads a file and creates a File object

func (*File) Len

func (f *File) Len() int

Len returns with the length of the file in bytes

func (*File) Pos

func (f *File) Pos(pos int) parsley.Pos

Pos returns with a global offset in a file set

func (*File) Position

func (f *File) Position(pos int) parsley.Position

Position returns with a Position object for the given offset

func (*File) SetOffset

func (f *File) SetOffset(offset int)

SetOffset set the offset of this file related to a file set

type Position

type Position struct {
	Filename string
	Line     int
	Column   int
}

Position is a text file position

func NewPosition

func NewPosition(filename string, line int, column int) *Position

NewPosition creates a new text position

func (Position) String

func (pos Position) String() string

type Reader

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

Reader defines a text input reader For more efficient reading it provides methods for regexp matching.

func NewReader

func NewReader(file *File) *Reader

NewReader creates a new reader instance The Windows-style line endings (\r\n) are automatically replaced with Unix-style line endings (\n).

func (*Reader) IsEOF

func (r *Reader) IsEOF(pos parsley.Pos) bool

IsEOF returns true if we reached the end of the buffer

func (*Reader) MatchString

func (r *Reader) MatchString(pos parsley.Pos, str string) (parsley.Pos, bool)

MatchString matches the given string

func (*Reader) MatchWord

func (r *Reader) MatchWord(pos parsley.Pos, word string) (parsley.Pos, bool)

MatchWord matches the given word It's different from MatchString() as it checks that the next character is not a word character

func (*Reader) Pos

func (r *Reader) Pos(cur int) parsley.Pos

Pos returns with the global position for the given cursor

func (*Reader) ReadRegexp

func (r *Reader) ReadRegexp(pos parsley.Pos, expr string) (parsley.Pos, []byte)

ReadRegexp matches part of the input based on the given regular expression and returns with the full match

func (*Reader) ReadRegexpSubmatch

func (r *Reader) ReadRegexpSubmatch(pos parsley.Pos, expr string) (parsley.Pos, [][]byte)

ReadRegexpSubmatch matches part of the input based on the given regular expression and returns with all capturing groups

func (*Reader) ReadRune

func (r *Reader) ReadRune(pos parsley.Pos, ch rune) (parsley.Pos, bool)

ReadRune matches the given rune

func (*Reader) Readf

func (r *Reader) Readf(pos parsley.Pos, f func(b []byte) ([]byte, int)) (parsley.Pos, []byte)

Readf uses the given function to match the next token

func (*Reader) Remaining

func (r *Reader) Remaining(pos parsley.Pos) int

Remaining returns with the remaining character count

func (*Reader) SkipWhitespaces

func (r *Reader) SkipWhitespaces(pos parsley.Pos, wsMode WsMode) (parsley.Pos, parsley.Error)

SkipWhitespaces skips all the whitespaces and returns true if it only encountered the required whitespace characters

type WsMode

type WsMode uint8

WsMode is a type for definining how to handle whitespaces after the tokens

const (
	WsNone WsMode = iota
	WsSpaces
	WsSpacesNl
	WsSpacesForceNl
)

Whitespace modes WsNone means no whitespaces will read and skipped after a token WsSpaces means spaces and tabs will be read and skipped automatically after a match WsSpacesNl means spaces, tabs and new lines will be read and skipped automatically after a match