ebnf

README

ebnf

Go module that parses EBNF grammars.

Documentation

Overview

Package ebnf parses extended Backus-Naur Form (EBNF) grammars.

Index

• type Expr
• type Factor
• type Grammar
  • func Parse(s string) (*Grammar, error)
• type ParserError
  • func (e ParserError) Error() string
• type Prod
• type Term

Types

type Expr

type Expr struct {
	Terms []*Term
}

Expr is the right side of a production.

type Factor

type Factor struct {
	Ident   string
	Literal string
	Paren   *Expr
	Brak    *Expr
	Brace   *Expr
}

Factor is a concrete form that can be sequenced.

type Grammar

type Grammar struct {
	Prods []*Prod
}

Grammar is an abstract syntax tree for a grammar.

func Parse

func Parse(s string) (*Grammar, error)

Parse returns a Grammar for a valid grammar, or an error otherwise.

type ParserError

type ParserError struct {
	Errs []error
}

ParserError has all the parse errors.

func (ParserError) Error

func (e ParserError) Error() string

Error returns all the error strings joined by a newline.

type Prod

type Prod struct {
	Ident string
	Expr  *Expr
}

Prod is a production.

type Term

type Term struct {
	Factors []*Factor
}

Term is an alternative.