wake.ir.meta.storage_layout_specifier module

StorageLayoutSpecifier class

Bases: SolidityAbc

Example

layout at (10 + 20) in the following code:

contract C layout at (10 + 20) {}

Source code in wake/ir/meta/storage_layout_specifier.py

class StorageLayoutSpecifier(SolidityAbc):
    """
    !!! example
        `layout at (10 + 20)` in the following code:
        ```solidity
        contract C layout at (10 + 20) {}
        ```
    """

    _ast_node: SolcStorageLayoutSpecifier
    _parent: weakref.ReferenceType[ContractDefinition]

    _base_slot_expression: ExpressionAbc

    def __init__(
        self,
        init: IrInitTuple,
        storage_layout_specifier: SolcStorageLayoutSpecifier,
        parent: ContractDefinition,
    ):
        super().__init__(init, storage_layout_specifier, parent)

        self._base_slot_expression = ExpressionAbc.from_ast(
            init, storage_layout_specifier.base_slot_expression, self
        )

    def __iter__(self) -> Iterator[IrAbc]:
        yield self
        yield self._base_slot_expression

    @property
    def parent(self) -> ContractDefinition:
        """
        Returns:
            Parent IR node.
        """
        return super().parent

    @property
    def children(self) -> Iterator[ExpressionAbc]:
        """
        Yields:
            Direct children of this node.
        """
        yield self._base_slot_expression

    @property
    def base_slot_expression(self) -> ExpressionAbc:
        """
        Returns:
            Expression representing the starting slot of the storage layout.
        """
        return self._base_slot_expression

base_slot_expression: ExpressionAbc property

Returns:

Type	Description
ExpressionAbc	Expression representing the starting slot of the storage layout.

children: Iterator[ExpressionAbc] property

Yields:

Type	Description
ExpressionAbc	Direct children of this node.

parent: ContractDefinition property

Returns:

Type	Description
ContractDefinition	Parent IR node.