Class Block

Block is a compound statement and it can hold other statements

Hierarchy (view full)

StatementWithChildren<Statement | StatementWithChildren<ASTNode> | StructuredDocumentation>
- Block

Constructors

constructor

new Block(id, src, statements, documentation?, raw?): Block
Parameters
- id: number
- src: string
- statements: Iterable<Statement>
- Optional documentation: string | StructuredDocumentation
- Optional raw: any
Returns Block
Overrides StatementWithChildren.constructor
- Defined in src/ast/implementation/statement/block.ts:11

Properties

`Optional` context

context?: ASTContext

Current tree context of the node

`Optional` danglingDocString

danglingDocString?: string

This field is used as a storage field for string, if string is set as value for danglingDocumentation.

`Optional` docString

docString?: string

This field is used as a storage field for string, if string is set as value for documentation.

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 T[]
Returns children nodes of the current node

Returns readonly T[]
Inherited from StatementWithChildren.children
- Defined in src/ast/ast_node.ts:353

danglingDocumentation

get danglingDocumentation(): undefined | string | StructuredDocumentation
Optional documentation that is dangling in the source fragment, that is after end of last child and before the end of the current node.

It is:
- Is undefined when not detected.
- Is type of string for compatibility reasons.
Returns undefined | string | StructuredDocumentation
Inherited from StatementWithChildren.danglingDocumentation
- Defined in src/ast/implementation/statement/statement.ts:76
set danglingDocumentation(value): void
Parameters
- value: undefined | string | StructuredDocumentation
Returns void
Inherited from StatementWithChildren.danglingDocumentation
- Defined in src/ast/implementation/statement/statement.ts:80

documentation

get documentation(): undefined | string | StructuredDocumentation
Optional documentation appearing above the contract definition:
- Is undefined when not specified.
- Is type of string when specified and compiler version is older than 0.6.3.
- Is instance of StructuredDocumentation when specified and compiler version is 0.6.3 or newer.
Returns undefined | string | StructuredDocumentation
Inherited from StatementWithChildren.documentation
- Defined in src/ast/implementation/statement/statement.ts:60
set documentation(value): void
Parameters
- value: undefined | string | StructuredDocumentation
Returns void
Inherited from StatementWithChildren.documentation
- Defined in src/ast/implementation/statement/statement.ts:64

firstChild

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

Returns undefined | ASTNode
Inherited from StatementWithChildren.firstChild
- 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
Inherited from StatementWithChildren.lastChild
- 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
Inherited from StatementWithChildren.nextSibling
- 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
Inherited from StatementWithChildren.previousSibling
- 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
Inherited from StatementWithChildren.requiredContext
- Defined in src/ast/ast_node.ts:86

root

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

Returns ASTNode
Inherited from StatementWithChildren.root
- Defined in src/ast/ast_node.ts:156

sourceInfo

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

Returns SourceLocation
Inherited from StatementWithChildren.sourceInfo
- Defined in src/ast/ast_node.ts:169

type

get type(): string
Type of the AST node

Returns string
Inherited from StatementWithChildren.type
- Defined in src/ast/ast_node.ts:79

vStatements

get vStatements(): (Statement | StatementWithChildren<ASTNode>)[]
An array of the member statements

Returns (Statement | StatementWithChildren<ASTNode>)[]
- Defined in src/ast/implementation/statement/block.ts:28

Methods

acceptChildren

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

Returns void
Inherited from StatementWithChildren.acceptChildren
- Defined in src/ast/ast_node.ts:70

appendChild

appendChild(node): StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Parameters
- node: StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Returns StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Inherited from StatementWithChildren.appendChild
- Defined in src/ast/ast_node.ts:371

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
Inherited from StatementWithChildren.extractSourceFragment
- Defined in src/ast/ast_node.ts:331

getChildren

getChildren(inclusive?): ASTNode[]
Parameters
- inclusive: boolean = false
Returns ASTNode[]
Inherited from StatementWithChildren.getChildren
- 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[]
Inherited from StatementWithChildren.getChildrenBySelector
- 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[]
Inherited from StatementWithChildren.getChildrenByType
- 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[]
Inherited from StatementWithChildren.getChildrenByTypeString
- 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
Inherited from StatementWithChildren.getClosestParentBySelector
- 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
Inherited from StatementWithChildren.getClosestParentByType
- 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
Inherited from StatementWithChildren.getClosestParentByTypeString
- Defined in src/ast/ast_node.ts:265

getFieldValues

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

getGettersValues

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

getParents

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

getParentsBySelector

getParentsBySelector<T>(selector): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns T[]
Inherited from StatementWithChildren.getParentsBySelector
- 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
Inherited from StatementWithChildren.print
- Defined in src/ast/ast_node.ts:287

removeChild

removeChild(node): StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Parameters
- node: StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Returns StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Inherited from StatementWithChildren.removeChild
- Defined in src/ast/ast_node.ts:357

replaceChild

replaceChild(newNode, oldNode): StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Parameters
- newNode: StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
- oldNode: StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Returns StructuredDocumentation | Statement | StatementWithChildren<ASTNode>
Inherited from StatementWithChildren.replaceChild
- Defined in src/ast/ast_node.ts:409

walk

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

walkChildren

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

walkParents

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

Class Block

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Block

Properties

Optional context

Optional danglingDocString

Optional docString

id

Optional parent

Optional raw

src

Accessors

children

Returns readonly T[]

danglingDocumentation

Returns undefined | string | StructuredDocumentation

Parameters

Returns void

documentation

Returns undefined | string | StructuredDocumentation

Parameters

Returns void

firstChild

Returns undefined | ASTNode

lastChild

Returns undefined | ASTNode

nextSibling

Returns undefined | ASTNode

previousSibling

Returns undefined | ASTNode

requiredContext

Returns ASTContext

root

Returns ASTNode

sourceInfo

Returns SourceLocation

type

Returns string

vStatements

Returns (Statement | StatementWithChildren<ASTNode>)[]

Methods

acceptChildren

Returns void

appendChild

Parameters

Returns StructuredDocumentation | Statement | StatementWithChildren<ASTNode>

extractSourceFragment

Parameters

Returns Uint8Array

getChildren

Parameters

Returns ASTNode[]

getChildrenBySelector

Type Parameters

Parameters

Returns T[]

getChildrenByType

Type Parameters

Parameters

Returns T[]

getChildrenByTypeString

Type Parameters

Parameters

Returns T[]

getClosestParentBySelector

Type Parameters

Parameters

Returns undefined | T

getClosestParentByType

Type Parameters

Parameters

Returns undefined | T

`Optional` context

`Optional` danglingDocString

`Optional` docString

`Optional` parent

`Optional` raw