Class SourceUnit

Hierarchy (view full)

ASTNodeWithChildren<ASTNode>
- SourceUnit

Constructors

constructor

new SourceUnit(id, src, sourceEntryKey, sourceListIndex, absolutePath, exportedSymbols, children?, license?, raw?): SourceUnit
Parameters
- id: number
- src: string
- sourceEntryKey: string
- sourceListIndex: number
- absolutePath: string
- exportedSymbols: Map<string, number>
- Optional children: Iterable<ASTNode>
- Optional license: string
- Optional raw: any
Returns SourceUnit
Overrides ASTNodeWithChildren.constructor
- Defined in src/ast/implementation/meta/source_unit.ts:52

Properties

absolutePath

absolutePath: string

File path to the source file

`Optional` context

context?: ASTContext

Current tree context of the node

exportedSymbols

exportedSymbols: Map<string, number>

Exported symbols dictionary, e.g. { "A": 74, "B": 34, ... }

id

id: number

Unique identifier number for the node in the tree context

`Optional` license

license?: string

SPDX license identifier (if provided)

`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.

sourceEntryKey

sourceEntryKey: string

Original "sources" key, that corresponds to current AST entry.

sourceListIndex

sourceListIndex: number

Index of the source unit in the "sourceList".

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

abiEncoderVersion

get abiEncoderVersion(): undefined | ABIEncoderVersion
Returns user-defined ABI encoder version for the source unit. If there is no encoder version defined in the pragma directives, then returns undefined.

Returns undefined | ABIEncoderVersion
- Defined in src/ast/implementation/meta/source_unit.ts:197

children

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

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

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 ASTNodeWithChildren.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 ASTNodeWithChildren.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 ASTNodeWithChildren.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 ASTNodeWithChildren.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 ASTNodeWithChildren.requiredContext
- Defined in src/ast/ast_node.ts:86

root

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

Returns ASTNode
Inherited from ASTNodeWithChildren.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 ASTNodeWithChildren.sourceInfo
- Defined in src/ast/ast_node.ts:169

type

get type(): string
Type of the AST node

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

vContracts

get vContracts(): readonly ContractDefinition[]
References to contract definitions

Returns readonly ContractDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:99

vEnums

get vEnums(): readonly EnumDefinition[]
References to file-level enum definitions

Returns readonly EnumDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:108

vErrors

get vErrors(): readonly ErrorDefinition[]
References to file-level error definitions

Returns readonly ErrorDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:117

vEvents

get vEvents(): readonly EventDefinition[]
References to file-level event definitions

Returns readonly EventDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:144

vExportedSymbols

get vExportedSymbols(): ReadonlyMap<string, ExportedSymbol>
Referenced exported symbols

Returns ReadonlyMap<string, ExportedSymbol>
- Defined in src/ast/implementation/meta/source_unit.ts:181

vFunctions

get vFunctions(): readonly FunctionDefinition[]
References to file-level function definitions (free functions)

Returns readonly FunctionDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:135

vImportDirectives

get vImportDirectives(): readonly ImportDirective[]
References to import directives

Returns readonly ImportDirective[]
- Defined in src/ast/implementation/meta/source_unit.ts:90

vPragmaDirectives

get vPragmaDirectives(): readonly PragmaDirective[]
References to pragma directives

Returns readonly PragmaDirective[]
- Defined in src/ast/implementation/meta/source_unit.ts:81

vStructs

get vStructs(): readonly StructDefinition[]
References to file-level struct definitions

Returns readonly StructDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:126

vUserDefinedValueTypes

get vUserDefinedValueTypes(): readonly UserDefinedValueTypeDefinition[]
References to file-level user-defined value type definitions

Returns readonly UserDefinedValueTypeDefinition[]
- Defined in src/ast/implementation/meta/source_unit.ts:162

vUsingForDirectives

get vUsingForDirectives(): readonly UsingForDirective[]
References to file-level using-for directives

Returns readonly UsingForDirective[]
- Defined in src/ast/implementation/meta/source_unit.ts:172

vVariables

get vVariables(): readonly VariableDeclaration[]
References to file-level constant variable definitions

Returns readonly VariableDeclaration[]
- Defined in src/ast/implementation/meta/source_unit.ts:153

Methods

acceptChildren

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

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

appendChild

appendChild(node): ASTNode
Parameters
- node: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.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 ASTNodeWithChildren.extractSourceFragment
- Defined in src/ast/ast_node.ts:331

getChildren

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

getFieldValues

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

getGettersValues

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

getParents

getParents(): ASTNode[]
Returns ASTNode[]
Inherited from ASTNodeWithChildren.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 ASTNodeWithChildren.getParentsBySelector
- Defined in src/ast/ast_node.ts:269

insertAfter

insertAfter(node, referenceNode): ASTNode
Parameters
- node: ASTNode
- referenceNode: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.insertAfter
- Defined in src/ast/ast_node.ts:393

insertAtBeginning

insertAtBeginning(node): ASTNode
Parameters
- node: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.insertAtBeginning
- Defined in src/ast/ast_node.ts:403

insertBefore

insertBefore(node, referenceNode): ASTNode
Parameters
- node: ASTNode
- referenceNode: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.insertBefore
- Defined in src/ast/ast_node.ts:379

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 ASTNodeWithChildren.print
- Defined in src/ast/ast_node.ts:287

removeChild

removeChild(node): ASTNode
Parameters
- node: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.removeChild
- Defined in src/ast/ast_node.ts:357

replaceChild

replaceChild(newNode, oldNode): ASTNode
Parameters
- newNode: ASTNode
- oldNode: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.replaceChild
- Defined in src/ast/ast_node.ts:409

walk

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

walkChildren

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

walkParents

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

Class SourceUnit

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SourceUnit

Properties

absolutePath

Optional context

exportedSymbols

id

Optional license

Optional parent

Optional raw

sourceEntryKey

sourceListIndex

src

Accessors

abiEncoderVersion

Returns undefined | ABIEncoderVersion

children

Returns readonly T[]

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

vContracts

Returns readonly ContractDefinition[]

vEnums

Returns readonly EnumDefinition[]

vErrors

Returns readonly ErrorDefinition[]

vEvents

Returns readonly EventDefinition[]

vExportedSymbols

Returns ReadonlyMap<string, ExportedSymbol>

vFunctions

Returns readonly FunctionDefinition[]

vImportDirectives

Returns readonly ImportDirective[]

vPragmaDirectives

Returns readonly PragmaDirective[]

vStructs

Returns readonly StructDefinition[]

vUserDefinedValueTypes

Returns readonly UserDefinedValueTypeDefinition[]

vUsingForDirectives

Returns readonly UsingForDirective[]

vVariables

Returns readonly VariableDeclaration[]

Methods

acceptChildren

Returns void

appendChild

Parameters

Returns ASTNode

extractSourceFragment

Parameters

Returns Uint8Array

getChildren

Parameters

Returns ASTNode[]

getChildrenBySelector

`Optional` context

`Optional` license

`Optional` parent

`Optional` raw