Class ASTNode

Hierarchy (view full)

ASTNode

Constructors

constructor

new ASTNode(id, src, raw?): ASTNode
Parameters
- id: number
- src: string
- Optional raw: any
Returns ASTNode
- Defined in src/ast/ast_node.ts:45

Properties

`Optional` context

context?: ASTContext

Current tree context of the node

id

id: number

Unique identifier number for the node in the tree context

`Optional` parent

parent?: ASTNode

The AST node that is containing current node

`Optional` raw

raw?: any

Raw original Solc AST node that was used to create current node.

src

src: string

Source mapping data corresponting to the AST node.

The value has format start:length:sourceIndex:

start is the starting index of the corresponding code fragment substring in the source string;
length is the length of corresponding code fragment substring;
sourceIndex is the index number of the source unit (file), that contains the AST node.

To get parsed values, use sourceInfo accessor.

Accessors

children

get children(): readonly ASTNode[]
Returns children nodes of the current node

Returns readonly ASTNode[]
- Defined in src/ast/ast_node.ts:97

firstChild

get firstChild(): undefined | ASTNode
Returns the first immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
- Defined in src/ast/ast_node.ts:105

lastChild

get lastChild(): undefined | ASTNode
Returns the last immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
- Defined in src/ast/ast_node.ts:113

nextSibling

get nextSibling(): undefined | ASTNode
Returns the node immediately following the current one in its parent's children.

Returns undefined if the current node is the last child in its parent's children.

Returns undefined | ASTNode
- Defined in src/ast/ast_node.ts:142

previousSibling

get previousSibling(): undefined | ASTNode
Returns the node immediately preceding the current one in its parent's children.

Returns undefined if the current node is the first child in its parent's children.

Returns undefined | ASTNode
- Defined in src/ast/ast_node.ts:124

requiredContext

get requiredContext(): ASTContext
Returns current node AST context. Throws an error if no context is set.

Returns ASTContext
- Defined in src/ast/ast_node.ts:86

root

get root(): ASTNode
Returns most parent node in tree hierarchy

Returns ASTNode
- Defined in src/ast/ast_node.ts:156

sourceInfo

get sourceInfo(): SourceLocation
Returns parsed parts of the src property value

Returns SourceLocation
- Defined in src/ast/ast_node.ts:169

type

get type(): string
Type of the AST node

Returns string
- Defined in src/ast/ast_node.ts:79

Methods

acceptChildren

acceptChildren(): void
Sets parent to the current node for each of the accessible children node.

Returns void
- Defined in src/ast/ast_node.ts:70

extractSourceFragment

extractSourceFragment(source): Uint8Array
Extracts and returns substring from source, that corresponds to src property value of the current node.

In other words, returns corresponding code fragment substring.
Parameters
- source: Uint8Array
Returns Uint8Array
- Defined in src/ast/ast_node.ts:331

getChildren

getChildren(inclusive?): ASTNode[]
Parameters
- inclusive: boolean = false
Returns ASTNode[]
- Defined in src/ast/ast_node.ts:197

getChildrenBySelector

getChildrenBySelector<T>(selector, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
- inclusive: boolean = true
Returns T[]
- Defined in src/ast/ast_node.ts:212

getChildrenByType

getChildrenByType<T>(type, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
- inclusive: boolean = false
Returns T[]
- Defined in src/ast/ast_node.ts:229

getChildrenByTypeString

getChildrenByTypeString<T>(typeString, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
- inclusive: boolean = false
Returns T[]
- Defined in src/ast/ast_node.ts:233

getClosestParentBySelector

getClosestParentBySelector<T>(selector): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns undefined | T
- Defined in src/ast/ast_node.ts:247

getClosestParentByType

getClosestParentByType<T>(type): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
Returns undefined | T
- Defined in src/ast/ast_node.ts:261

getClosestParentByTypeString

getClosestParentByTypeString<T>(typeString): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
Returns undefined | T
- Defined in src/ast/ast_node.ts:265

getFieldValues

getFieldValues(): Map<string, any>
Returns Map<string, any>
- Defined in src/ast/ast_node.ts:291

getGettersValues

getGettersValues(): Map<string, any>
Returns Map<string, any>
- Defined in src/ast/ast_node.ts:295

getParents

getParents(): ASTNode[]
Returns ASTNode[]
- Defined in src/ast/ast_node.ts:237

getParentsBySelector

getParentsBySelector<T>(selector): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns T[]
- Defined in src/ast/ast_node.ts:269

print

print(depth?): string
Returns string representation of the node properties.
Parameters
- depth: number = 0
  The number of children node levels to output
Returns string
- Defined in src/ast/ast_node.ts:287

walk

walk(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
- Defined in src/ast/ast_node.ts:173

walkChildren

walkChildren(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
- Defined in src/ast/ast_node.ts:179

walkParents

walkParents(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
- Defined in src/ast/ast_node.ts:187

Generated using TypeDoc