irutil

Documentation

Overview

Code generated by the `ir/codegen` package. DO NOT EDIT.

Code generated by the `ir/codegen` package. DO NOT EDIT.

Index

• func FindClassMethodNode(n ir.Node, name string) *ir.ClassMethodStmt
• func FindPHPDoc(n ir.Node, withSuspicious bool) (doc string, found bool)
• func FindWithPredicate(what ir.Node, where ir.Node, pred findPredicate) bool
• func FmtNode(n ir.Node) string
• func InLoop(path NodePath) bool
• func Inspect(root ir.Node, visit func(ir.Node) bool)
• func IsAssign(n ir.Node) bool
• func IsBoolAnd(n ir.Node) bool
• func IsBoolOr(n ir.Node) bool
• func IsLoop(n ir.Node) bool
• func Keywords(n ir.Node) []*token.Token
• func NodeClone(x ir.Node) ir.Node
• func NodeEqual(x, y ir.Node) bool
• func NodeSliceClone(xs []ir.Node) []ir.Node
• func NodeSliceEqual(xs, ys []ir.Node) bool
• func Unparen(e ir.Node) ir.Node
• type NodePath
  • func NewNodePath() NodePath
  • func (p NodePath) Conditional() bool
  • func (p NodePath) ConditionalUntil(end ir.Node) bool
  • func (p NodePath) Current() ir.Node
  • func (p NodePath) NthParent(n int) ir.Node
  • func (p NodePath) Parent() ir.Node
  • func (p *NodePath) Pop()
  • func (p *NodePath) Push(n ir.Node)
  • func (p NodePath) String() string
• type NodeSet
  • func NewNodeSet() NodeSet
  • func (set *NodeSet) Add(x ir.Node) bool
  • func (set *NodeSet) Len() int
  • func (set *NodeSet) Reset()

Functions

func FindClassMethodNode

func FindClassMethodNode(n ir.Node, name string) *ir.ClassMethodStmt

func FindPHPDoc

func FindPHPDoc(n ir.Node, withSuspicious bool) (doc string, found bool)

FindPHPDoc searches for phpdoc by traversing all subtree and all tokens.

func FindWithPredicate

func FindWithPredicate(what ir.Node, where ir.Node, pred findPredicate) bool

FindWithPredicate searches for a node in the passed subtree using a predicate.

If the predicate returns true, the search ends.

func FmtNode

func FmtNode(n ir.Node) string

FmtNode returns string representation of n.

func InLoop

func InLoop(path NodePath) bool

func Inspect

func Inspect(root ir.Node, visit func(ir.Node) bool)

func IsAssign

func IsAssign(n ir.Node) bool

func IsBoolAnd

func IsBoolAnd(n ir.Node) bool

func IsBoolOr

func IsBoolOr(n ir.Node) bool

func IsLoop

func IsLoop(n ir.Node) bool

func Keywords

func Keywords(n ir.Node) []*token.Token

Keywords returns one or two tokens that contain the keywords for the passed node.

func NodeClone

func NodeClone(x ir.Node) ir.Node

func NodeEqual

func NodeEqual(x, y ir.Node) bool

func NodeSliceClone

func NodeSliceClone(xs []ir.Node) []ir.Node

func NodeSliceEqual

func NodeSliceEqual(xs, ys []ir.Node) bool

func Unparen

func Unparen(e ir.Node) ir.Node

Unparen returns n with all parenthesis removed.

Types

type NodePath

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

func NewNodePath

func NewNodePath() NodePath

func (NodePath) Conditional

func (p NodePath) Conditional() bool

func (NodePath) ConditionalUntil

func (p NodePath) ConditionalUntil(end ir.Node) bool

func (NodePath) Current

func (p NodePath) Current() ir.Node

func (NodePath) NthParent

func (p NodePath) NthParent(n int) ir.Node

func (NodePath) Parent

func (p NodePath) Parent() ir.Node

func (*NodePath) Pop

func (p *NodePath) Pop()

func (*NodePath) Push

func (p *NodePath) Push(n ir.Node)

func (NodePath) String

func (p NodePath) String() string

type NodeSet

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

NodeSet is a set of unique AST nodes.

It's possible to avoid allocations in most cases if node set is reused with Reset(). If this is not possible, use NewNodeSet() to create a set that can do fewer allocations than a zero value set.

NodeSet is not thread-safe, but since Root/Block walkers always operate in isolation, we can share on per RootWalker level.

func NewNodeSet

func NewNodeSet() NodeSet

NewNodeSet returns a node set with preallocated storage.

Intended to be used in places where reusing root node set is tricky or impossible (function is reentrant).

func (*NodeSet) Add

func (set *NodeSet) Add(x ir.Node) bool

Add attempts to insert x into the node set.

Returns true if element was inserted. If x is already in the set, false is returned and no insertion is performed.

func (*NodeSet) Len

func (set *NodeSet) Len() int

Len returns the number of unique node elements present in the set.

func (*NodeSet) Reset

func (set *NodeSet) Reset()

Reset clears the set state and prepares it for another round.