Class TranslationUnitAST

TranslationUnitAST node.

Hierarchy (View Summary)

UnitAST
- TranslationUnitAST

Index

Constructors

Properties

Methods

accept getDeclarationList getEndLocation getHandle getKind getStartLocation is isNot walk from

Constructors

constructor

new TranslationUnitAST(
    handle: number,
    kind: ASTKind,
    parser: TranslationUnitLike,
): TranslationUnitAST
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 TranslationUnitAST
Inherited from UnitAST.constructor
- Defined in AST.ts:49

Properties

`Protected` `Readonly`parser

parser: TranslationUnitLike

the parser that owns the AST node.

Methods

accept

accept<Context, Result>(
visitor: ASTVisitor<Context, Result>,
context: Context,
): Result
Traverse this node using the given visitor.
Type Parameters
- Context
- Result
Parameters
- visitor: ASTVisitor<Context, Result>
  the visitor.
- context: Context
  the context.
Returns Result
the result of the visit.
Overrides UnitAST.accept
- Defined in AST.ts:182

getDeclarationList

getDeclarationList(): Iterable<undefined | DeclarationAST>
Returns the declarationList of this node

Returns Iterable<undefined | DeclarationAST>
- Defined in AST.ts:192

getEndLocation

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

Returns undefined | SourceLocation
the source location of the AST node.
Inherited from UnitAST.getEndLocation
- Defined in AST.ts:118

getHandle

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

Returns number
the handle of the AST node.
Inherited from UnitAST.getHandle
- Defined in AST.ts:100

getKind

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

Returns ASTKind
the kind of the AST node.
Inherited from UnitAST.getKind
- Defined in AST.ts:71

getStartLocation

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

Returns undefined | SourceLocation
the source location of the AST node.
Inherited from UnitAST.getStartLocation
- Defined in AST.ts:109

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.
Inherited from UnitAST.is
- Defined in AST.ts:81

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.
Inherited from UnitAST.isNot
- Defined in AST.ts:91

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.
Inherited from UnitAST.walk
- Defined in AST.ts:62

`Static`from

from<T extends AST = AST>(
handle: number,
parser: TranslationUnitLike,
): undefined | T
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 undefined | T
the AST node.
Inherited from UnitAST.from
- Defined in AST.ts:137