cursorutil

Documentation

Overview

Package cursorutil provides utility functions for working with inspector.Cursor.

It should create no additional dependencies beyond those of Cursor itself, so that functions can be promoted to the public API of Cursor in due course.

Index

• func FirstEnclosing[N ast.Node](cur inspector.Cursor) (N, inspector.Cursor)
• func Path(cur inspector.Cursor) (path []ast.Node)

Functions

func FirstEnclosing

func FirstEnclosing[N ast.Node](cur inspector.Cursor) (N, inspector.Cursor)

FirstEnclosing returns the first value from [cursor.Enclosing] as both a designated type and a inspector.Cursor pointing to it.

It returns the zero value if it is not found.

A common usage is:

call, callCur := cursorutil.FirstEnclosing[*ast.CallExpr](cur)
if call == nil {
	// Not Found
}

func Path

func Path(cur inspector.Cursor) (path []ast.Node)

Path returns the specified node followed by all its ancestors up to the file. Use it as an adaptor between cursors and code that works with PathEnclosingInterval. Ultimately all such code should be eliminated.