dst: github.com/dave/dst/dstutil Index | Files

package dstutil

import "github.com/dave/dst/dstutil"


Package Files

decorations-generated.go decorations.go rewrite.go util.go

func Apply Uses

func Apply(root dst.Node, pre, post ApplyFunc) (result dst.Node)

Apply traverses a syntax tree recursively, starting with root, and calling pre and post for each node as described below. Apply returns the syntax tree, possibly modified.

If pre is not nil, it is called for each node before the node's children are traversed (pre-order). If pre returns false, no children are traversed, and post is not called for that node.

If post is not nil, and a prior call of pre didn't return false, post is called for each node after its children are traversed (post-order). If post returns false, traversal is terminated and Apply returns immediately.

Only fields that refer to AST nodes are considered children; i.e., token.Pos, Scopes, Objects, and fields of basic types (strings, etc.) are ignored.

Children are traversed in the order in which they appear in the respective node's struct definition. A package's files are traversed in the filenames' alphabetical order.

func Unparen Uses

func Unparen(e dst.Expr) dst.Expr

Unparen returns e with any enclosing parentheses stripped.

type ApplyFunc Uses

type ApplyFunc func(*Cursor) bool

An ApplyFunc is invoked by Apply for each node n, even if n is nil, before and/or after the node's children, using a Cursor describing the current node and providing operations on it.

The return value of ApplyFunc controls the syntax tree traversal. See Apply for details.

type Cursor Uses

type Cursor struct {
    // contains filtered or unexported fields

A Cursor describes a node encountered during Apply. Information about the node and its parent is available from the Node, Parent, Name, and Index methods.

If p is a variable of type and value of the current parent node c.Parent(), and f is the field identifier with name c.Name(), the following invariants hold:

p.f            == c.Node()  if c.Index() <  0
p.f[c.Index()] == c.Node()  if c.Index() >= 0

The methods Replace, Delete, InsertBefore, and InsertAfter can be used to change the AST without disrupting Apply.

func (*Cursor) Delete Uses

func (c *Cursor) Delete()

Delete deletes the current Node from its containing slice. If the current Node is not part of a slice, Delete panics. As a special case, if the current node is a package file, Delete removes it from the package's Files map.

func (*Cursor) Index Uses

func (c *Cursor) Index() int

Index reports the index >= 0 of the current Node in the slice of Nodes that contains it, or a value < 0 if the current Node is not part of a slice. The index of the current node changes if InsertBefore is called while processing the current node.

func (*Cursor) InsertAfter Uses

func (c *Cursor) InsertAfter(n dst.Node)

InsertAfter inserts n after the current Node in its containing slice. If the current Node is not part of a slice, InsertAfter panics. Apply does not walk n.

func (*Cursor) InsertBefore Uses

func (c *Cursor) InsertBefore(n dst.Node)

InsertBefore inserts n before the current Node in its containing slice. If the current Node is not part of a slice, InsertBefore panics. Apply will not walk n.

func (*Cursor) Name Uses

func (c *Cursor) Name() string

Name returns the name of the parent Node field that contains the current Node. If the parent is a *dst.Package and the current Node is a *dst.File, Name returns the filename for the current Node.

func (*Cursor) Node Uses

func (c *Cursor) Node() dst.Node

Node returns the current Node.

func (*Cursor) Parent Uses

func (c *Cursor) Parent() dst.Node

Parent returns the parent of the current Node.

func (*Cursor) Replace Uses

func (c *Cursor) Replace(n dst.Node)

Replace replaces the current Node with n. The replacement node is not walked by Apply.

type DecorationPoint Uses

type DecorationPoint struct {
    Name string
    Decs []string

DecorationPoint contains the name of the decoration attachment point and a list of decorations attached there

func Decorations Uses

func Decorations(n dst.Node) (before, after dst.SpaceType, info []DecorationPoint)

Decorations returns information about all the decoration attachment points associated with a node

Package dstutil imports 4 packages (graph) and is imported by 12 packages. Updated 2020-07-28. Refresh now. Tools for package owners.