html

Documentation

Index

• func WalkFunc(n *Node, f NodeVisitorFunc)
• type NodeVisitor
• type NodeVisitorFunc
  • func (f NodeVisitorFunc) Visit(node *Node, entering bool) WalkStatus
• type WalkStatus
  • func Walk(n *Node, visitor NodeVisitor) WalkStatus

Functions

func WalkFunc

func WalkFunc(n *Node, f NodeVisitorFunc)

WalkFunc is like Walk but accepts just a callback function

Types

type NodeVisitor

type NodeVisitor interface {
	Visit(node *Node, entering bool) WalkStatus
}

NodeVisitor is a callback to be called when traversing the syntax tree. Called twice for every node: once with entering=true when the branch is first visited, then with entering=false after all the children are done.

type NodeVisitorFunc

type NodeVisitorFunc func(node *Node, entering bool) WalkStatus

NodeVisitorFunc casts a function to match NodeVisitor interface

func (NodeVisitorFunc) Visit

func (f NodeVisitorFunc) Visit(node *Node, entering bool) WalkStatus

Visit calls visitor function

type WalkStatus

type WalkStatus int

WalkStatus allows NodeVisitor to have some control over the tree traversal. It is returned from NodeVisitor and different values allow Node.Walk to decide which node to go to next.

const (
	// GoToNext is the default traversal of every node.
	GoToNext WalkStatus = iota
	// SkipChildren tells walker to skip all children of current node.
	SkipChildren
	// Terminate tells walker to terminate the traversal.
	Terminate
)

func Walk

func Walk(n *Node, visitor NodeVisitor) WalkStatus