Skip to content

wake.ir.yul.if_statement module #

YulIf class #

Bases: YulStatementAbc

Represents an if statement with the following structure:

if <condition> {
    <body>
}

Example

assembly {
    if lt(i, 10) {
        // ...
    }
}

Note

There is no else branch in Yul. It must be implemented using a second if statement when needed.

Source code in wake/ir/yul/if_statement.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
class YulIf(YulStatementAbc):
    """
    Represents an if statement with the following structure:

    ```solidity
    if <condition> {
        <body>
    }
    ```

    !!! example
        ```solidity
        assembly {
            if lt(i, 10) {
                // ...
            }
        }
        ```

    !!! note
        There is no `else` branch in Yul. It must be implemented using a second `if` statement when needed.
    """

    _parent: weakref.ReferenceType[YulBlock]
    _body: YulBlock
    _condition: Union[YulFunctionCall, YulIdentifier, YulLiteral]

    def __init__(self, init: IrInitTuple, if_statement: SolcYulIf, parent: YulAbc):
        super().__init__(init, if_statement, parent)
        self._body = YulBlock(init, if_statement.body, self)
        if isinstance(if_statement.condition, SolcYulFunctionCall):
            self._condition = YulFunctionCall(init, if_statement.condition, self)
        elif isinstance(if_statement.condition, SolcYulIdentifier):
            self._condition = YulIdentifier(init, if_statement.condition, self)
        elif isinstance(if_statement.condition, SolcYulLiteral):
            self._condition = YulLiteral(init, if_statement.condition, self)
        else:
            assert False, f"Unexpected type: {type(if_statement.condition)}"

    def __iter__(self) -> Iterator[YulAbc]:
        yield self
        yield from self._condition
        yield from self._body

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

    @property
    def children(
        self,
    ) -> Iterator[Union[YulBlock, YulFunctionCall, YulIdentifier, YulLiteral]]:
        """
        Yields:
            Direct children of this node.
        """
        yield self._body
        yield self._condition

    @property
    def body(self) -> YulBlock:
        """
        Returns:
            Body of the function executed if the condition is true.
        """
        return self._body

    @property
    def condition(self) -> Union[YulFunctionCall, YulIdentifier, YulLiteral]:
        """
        Returns:
            Condition of the if statement.
        """
        return self._condition

    @property
    def modifies_state(
        self,
    ) -> Set[Tuple[Union[ExpressionAbc, StatementAbc, YulAbc], ModifiesStateFlag]]:
        return self._condition.modifies_state | self._body.modifies_state

body: YulBlock property #

Returns:

Type Description
YulBlock

Body of the function executed if the condition is true.

children: Iterator[Union[YulBlock, YulFunctionCall, YulIdentifier, YulLiteral]] property #

Yields:

Type Description
Union[YulBlock, YulFunctionCall, YulIdentifier, YulLiteral]

Direct children of this node.

condition: Union[YulFunctionCall, YulIdentifier, YulLiteral] property #

Returns:

Type Description
Union[YulFunctionCall, YulIdentifier, YulLiteral]

Condition of the if statement.

parent: YulBlock property #

Returns:

Type Description
YulBlock

Parent IR node.