Class CompilationUnit

Represents a Compilation Unit, encapsulating the information necessary for analyzing a single Tact project.

Index

Constructors

Properties

ast contracts functions projectName

Methods

findCFGByIdx findFunctionCFGByName findMethodCFGByName forEachBasicBlock forEachCFG

Constructors

constructor

new CompilationUnit(projectName, ast, functions, contracts): CompilationUnit
Creates an instance of CompilationUnit.
Parameters
- projectName: string
  The name of the project this Compilation Unit belongs to.
- ast: TactASTStore
  The AST of the project.
- functions: Map<number, CFG>
  A mapping from unique IDs of free functions to their CFGs.
- contracts: Map<number, Contract>
  A mapping from unique IDs of contract entries to contracts.
Returns CompilationUnit
- Defined in internals/ir/ir.ts:25

Properties

ast

ast: TactASTStore

The AST of the project.

contracts

contracts: Map<number, Contract>

A mapping from unique IDs of contract entries to contracts.

functions

functions: Map<number, CFG>

A mapping from unique IDs of free functions to their CFGs.

projectName

projectName: string

The name of the project this Compilation Unit belongs to.

Methods

findCFGByIdx

findCFGByIdx(idx): undefined | CFG
Looks for a CFG with a specific index.
Parameters
- idx: number
Returns undefined | CFG
Found CFG or undefined if not found.
- Defined in internals/ir/ir.ts:36

findFunctionCFGByName

findFunctionCFGByName(name): undefined | CFG
Looks for a CFG for a function node with a specific name.
Parameters
- name: string
Returns undefined | CFG
Found CFG or undefined if not found.
- Defined in internals/ir/ir.ts:48

findMethodCFGByName

findMethodCFGByName(contractName, methodName): undefined | CFG
Looks for a CFG for a method node with a specific name.
Parameters
- contractName: string
- methodName: string
Returns undefined | CFG
Found CFG or undefined if not found.
- Defined in internals/ir/ir.ts:56

forEachBasicBlock

forEachBasicBlock(astStore, callback): void
Iterates over all CFGs in a Compilation Unit, and applies a callback to each basic block in every CFG.
Parameters
- astStore: TactASTStore
  The store containing the AST nodes.
- callback: ((cfg: CFG, node: BasicBlock, stmt: AstStatement) => void)
  The function to apply to each BB within each CFG.
  - - (cfg, node, stmt): void
    - Parameters
      cfg: CFG
      node: BasicBlock
      stmt: AstStatement
      Returns void
Returns void
- Defined in internals/ir/ir.ts:96

forEachCFG

forEachCFG(astStore, callback): void
Iterates over all CFGs in a Compilation Unit, and applies a callback to CFG.
Parameters
- astStore: TactASTStore
  The store containing the AST nodes.
- callback: ((cfg: CFG) => void)
  The function to apply to each CFG.
  - - (cfg): void
    - Parameters
      cfg: CFG
      Returns void
Returns void
- Defined in internals/ir/ir.ts:78