parser

Documentation

Overview

Package parser contains the main structs for parsing

Index

• Constants
• type EndNode
  • func (e EndNode) Pos() parsley.Pos
  • func (e EndNode) ReaderPos() parsley.Pos
  • func (e EndNode) Schema() interface{}
  • func (e EndNode) SetReaderPos(func(parsley.Pos) parsley.Pos)
  • func (e EndNode) String() string
  • func (e EndNode) Token() string
  • func (e EndNode) Value(userCtx interface{}) (interface{}, parsley.Error)
• type Func
  • func Empty() Func
  • func End() Func
  • func ReturnError(p parsley.Parser, customErr error) Func
  • func (f Func) Name(name string) Func
  • func (f Func) Parse(ctx *parsley.Context, leftRecCtx data.IntMap, pos parsley.Pos) (parsley.Node, data.IntSet, parsley.Error)
• type FuncWrapper
  • func (f FuncWrapper) Parse(ctx *parsley.Context, leftRecCtx data.IntMap, pos parsley.Pos) (parsley.Node, data.IntSet, parsley.Error)

Constants

const EOF = "EOF"

EOF is the end-of-file token

Types

type EndNode

type EndNode parsley.Pos

EndNode represents an eof node

func (EndNode) Pos

func (e EndNode) Pos() parsley.Pos

Pos returns with the position

func (EndNode) ReaderPos

func (e EndNode) ReaderPos() parsley.Pos

ReaderPos returns the reader position

func (EndNode) Schema

func (e EndNode) Schema() interface{}

Schema returns with nil

func (EndNode) SetReaderPos

func (e EndNode) SetReaderPos(func(parsley.Pos) parsley.Pos)

SetReaderPos changes the reader position

func (EndNode) String

func (e EndNode) String() string

String returns with a string representation of the node

func (EndNode) Token

func (e EndNode) Token() string

Token returns with EOF

func (EndNode) Value

func (e EndNode) Value(userCtx interface{}) (interface{}, parsley.Error)

Value returns with nil

type Func

type Func func(ctx *parsley.Context, leftRecCtx data.IntMap, pos parsley.Pos) (parsley.Node, data.IntSet, parsley.Error)

Func defines a helper to implement the Parser interface with functions

func Empty

func Empty() Func

Empty always matches and returns with an empty node result

func End

func End() Func

End matches the end of the input

func ReturnError

func ReturnError(p parsley.Parser, customErr error) Func

ReturnError will override the returned error by the parser if its position is the same as the reader's position

func (Func) Name

func (f Func) Name(name string) Func

Name returns with a new parser function which overrides the returned error if its position is the same as the reader's position The error will be: "was expecting <name>"

func (Func) Parse

func (f Func) Parse(ctx *parsley.Context, leftRecCtx data.IntMap, pos parsley.Pos) (parsley.Node, data.IntSet, parsley.Error)

Parse parses the input using the function

type FuncWrapper

type FuncWrapper struct {
	F Func
}

FuncWrapper is a parser which wraps a parser function as a struct It's useful when you have to use a parser recursively as that's not possible with functions

func (FuncWrapper) Parse

func (f FuncWrapper) Parse(ctx *parsley.Context, leftRecCtx data.IntMap, pos parsley.Pos) (parsley.Node, data.IntSet, parsley.Error)

Parse parses the input using the function