ast

Documentation

Index

• Constants
• func BuildTreeView(rootname string, root Node, skipAtNodes bool) string
• func Choice(n Node) int
• func NewExtRefTreeElement(g parser.Grammar, node parser.TreeElement) parser.TreeElement
• func ToParserNode(g parser.Grammar, branch Branch) parser.TreeElement
• type Branch
  • func FromParserNode(g parser.Grammar, e parser.TreeElement) Branch
  • func (b Branch) ContentEquals(other Node) bool
  • func (Branch) IsExtra()
  • func (b Branch) Many(name string) []Node
  • func (b Branch) One(name string) Node
  • func (b Branch) Scanner() parser.Scanner
  • func (b Branch) String() string
• type Children
  • func Which(b Branch, names ...string) (string, Children)
• type Extra
  • func (e Extra) ContentEquals(other Node) bool
  • func (Extra) Many(_ string) []Node
  • func (Extra) One(_ string) Node
  • func (Extra) Scanner() parser.Scanner
  • func (e Extra) String() string
• type Leaf
  • func (l Leaf) ContentEquals(other Node) bool
  • func (Leaf) Many(_ string) []Node
  • func (Leaf) One(_ string) Node
  • func (l Leaf) Scanner() parser.Scanner
  • func (l Leaf) String() string
• type Many
  • func (c Many) Scanner() parser.Scanner
  • func (c Many) String() string
• type Node
  • func All(n Node, name string) []Node
  • func First(n Node, name string) Node
• type One
  • func (c One) Scanner() parser.Scanner
  • func (c One) String() string

Constants

const (
	RuleTag   = "@rule"
	ChoiceTag = "@choice"
	SkipTag   = "@skip"
)

Functions

func BuildTreeView

func BuildTreeView(rootname string, root Node, skipAtNodes bool) string

func Choice

func Choice(n Node) int

Choice attempts to check for the @choice tag, and if found returns the value The return is the 0-based index of the chosen option. -1 means there was no @choice tag

func NewExtRefTreeElement

func NewExtRefTreeElement(g parser.Grammar, node parser.TreeElement) parser.TreeElement

func ToParserNode

func ToParserNode(g parser.Grammar, branch Branch) parser.TreeElement

Types

type Branch

type Branch map[string]Children

func FromParserNode

func FromParserNode(g parser.Grammar, e parser.TreeElement) Branch

func (Branch) ContentEquals

func (b Branch) ContentEquals(other Node) bool

func (Branch) IsExtra

func (Branch) IsExtra()

func (Branch) Many

func (b Branch) Many(name string) []Node

func (Branch) One

func (b Branch) One(name string) Node

func (Branch) Scanner

func (b Branch) Scanner() parser.Scanner

func (Branch) String

func (b Branch) String() string

type Children

type Children interface {
	fmt.Stringer
	Scanner() parser.Scanner
	// contains filtered or unexported methods
}

func Which

func Which(b Branch, names ...string) (string, Children)

Which returns the first child of the branch from the list of names supplied

type Extra

type Extra struct {
	Data any
}

func (Extra) ContentEquals

func (e Extra) ContentEquals(other Node) bool

func (Extra) Many

func (Extra) Many(_ string) []Node

func (Extra) One

func (Extra) One(_ string) Node

func (Extra) Scanner

func (Extra) Scanner() parser.Scanner

func (Extra) String

func (e Extra) String() string

type Leaf

type Leaf parser.Scanner

func (Leaf) ContentEquals

func (l Leaf) ContentEquals(other Node) bool

func (Leaf) Many

func (Leaf) Many(_ string) []Node

func (Leaf) One

func (Leaf) One(_ string) Node

func (Leaf) Scanner

func (l Leaf) Scanner() parser.Scanner

func (Leaf) String

func (l Leaf) String() string

type Many

type Many []Node

func (Many) Scanner

func (c Many) Scanner() parser.Scanner

func (Many) String

func (c Many) String() string

type Node

type Node interface {
	fmt.Stringer
	One(name string) Node
	Many(name string) []Node
	Scanner() parser.Scanner
	ContentEquals(n Node) bool // true if scanner and extra data contents are equivalent
	// contains filtered or unexported methods
}

func All

func All(n Node, name string) []Node

All returns a list of Nodes for the given name even if only a single Node is found

func First

func First(n Node, name string) Node

First finds the first child of the given node with the named tag. nil if the named node does not exist

type One

type One struct {
	Node Node
}

func (One) Scanner

func (c One) Scanner() parser.Scanner

func (One) String

func (c One) String() string