Class AST`Abstract`

The base class of all the AST nodes.

Hierarchy (View Summary)

AST

Index

Constructors

Properties

Methods

accept getEndLocation getHandle getKind getStartLocation is isNot stream walk from

Constructors

constructor

new AST(handle: number, kind: ASTKind, parser: TranslationUnitLike): AST
Constructs an AST node.
Parameters
- handle: number
  the handle of the AST node.
- kind: ASTKind
  the kind of the AST node.
- parser: TranslationUnitLike
  the parser that owns the AST node.
Returns AST
- Defined in packages/cxx-frontend/src/AST.ts:50

Properties

`Protected` `Readonly`parser

parser: TranslationUnitLike

the parser that owns the AST node.

Methods

`Abstract`accept

accept<Context, Result>(
visitor: ASTVisitor<Context, Result>,
context: Context,
): Result
Accepts the given visitor.
Type Parameters
- Context
- Result
Parameters
- visitor: ASTVisitor<Context, Result>
- context: Context
Returns Result
- Defined in packages/cxx-frontend/src/AST.ts:138

getEndLocation

getEndLocation(): SourceLocation | undefined
Returns the source location of the AST node.

Returns SourceLocation | undefined
the source location of the AST node.
- Defined in packages/cxx-frontend/src/AST.ts:131

getHandle

getHandle(): number
Returns the handle of the AST node.

Returns number
the handle of the AST node.
- Defined in packages/cxx-frontend/src/AST.ts:113

getKind

getKind(): ASTKind
Returns the kind of the AST node.

Returns ASTKind
the kind of the AST node.
- Defined in packages/cxx-frontend/src/AST.ts:84

getStartLocation

getStartLocation(): SourceLocation | undefined
Returns the source location of the AST node.

Returns SourceLocation | undefined
the source location of the AST node.
- Defined in packages/cxx-frontend/src/AST.ts:122

is

is(kind: ASTKind): boolean
Returns true if the AST node is of the given kind.
Parameters
- kind: ASTKind
  the kind to check.
Returns boolean
true if the AST node is of the given kind.
- Defined in packages/cxx-frontend/src/AST.ts:94

isNot

isNot(kind: ASTKind): boolean
Returns true if the AST node is not of the given kind.
Parameters
- kind: ASTKind
  the kind to check.
Returns boolean
true if the AST node is not of the given kind.
- Defined in packages/cxx-frontend/src/AST.ts:104

stream

stream(): ReadableStream<ASTVisit>
Returns a readable stream of the AST nodes in pre-order.

The stream must be consumed, or cancelled, before the parser that owns the AST is disposed.

Returns ReadableStream<ASTVisit>
a stream of the nodes of this subtree in pre-order.
- Defined in packages/cxx-frontend/src/AST.ts:75

walk

walk(): ASTCursor
Returns the cursor of the AST node.

The cursor is used to traverse the AST.

Returns ASTCursor
the cursor of the AST node.
- Defined in packages/cxx-frontend/src/AST.ts:63

`Static`from

from<T extends AST = AST>(
handle: number,
parser: TranslationUnitLike,
): T | undefined
Constructs an AST node from the given handle.
Type Parameters
- T extends AST = AST
Parameters
- handle: number
  the handle of the AST node.
- parser: TranslationUnitLike
  the parser that owns the AST node.
Returns T | undefined
the AST node.
- Defined in packages/cxx-frontend/src/AST.ts:150