Class ASTCursor

constructor

• new ASTCursor(root: AST, parser: TranslationUnitLike): ASTCursor

  Constructs a new AST cursor.

  Parameters

  • root: AST

    The root node.
  • parser: TranslationUnitLike

    The parser that owns the AST.

  Returns ASTCursor

Readonlyroot

node

• get node(): Token | AST

  Returns the current AST node or Token.

  Returns Token | AST

slot

• get slot(): undefined | ASTSlot

  Returns the current AST slot.

  Returns undefined | ASTSlot

gotoFirstChild

• gotoFirstChild(): boolean

  Move the cursor to the first child of the current node.

  Returns boolean

gotoNextSibling

• gotoNextSibling(): boolean

  Move the cursor to the next sibling of the current node.

  Returns boolean

gotoParent

• gotoParent(): boolean

  Move the cursor to the parent of the current node.

  Returns boolean

preVisit

• preVisit(): Generator<
      { depth: number; node: Token
      | AST; slot: undefined | ASTSlot },
      void,
      unknown,
  >

  Pre-order traversal of the AST.

  Returns Generator<
      { depth: number; node: Token
      | AST; slot: undefined | ASTSlot },
      void,
      unknown,
  >

  A generator that yields the nodes in pre-order.