Skip to content

Parameter list

woke.ast.ir.meta.parameter_list module #

ParameterList class #

Bases: SolidityAbc

Example

A parameter list can be used:

  • in an ErrorDefinition:
    • (uint requested, uint available) in line 2,
  • in an EventDefinition:
    • (address indexed previousOwner, address indexed newOwner) in line 3,
  • in a FunctionDefinition:
    • (uint a, uint b) in line 12 as function parameters,
    • (uint256) in line 12 as function return parameters,
  • in a FunctionTypeName:
    • (string memory, uint) in line 5 as function type name parameters,
    • (bool) in line 5 as function type name return parameters,
  • in a ModifierDefinition:
    • (uint x) in line 7,
  • in a TryCatchClause:
    • (bool success) in line 17 as try clause parameters,
    • (string memory reason) in line 19 as catch clause parameters.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
contract C {
    error InsufficientBalance(uint requested, uint available);
    event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

    function (string memory, uint) external returns (bool) externalFunction;

    modifier onlyPositive(uint x) {
        require(x > 0, "x must be positive");
        _;
    }

    function add(uint a, uint b) onlyPositive(a) public pure returns (uint256) {
        return a + b;
    }

    function callExternalFunction() public {
        try externalFunction("abc", 123) returns (bool success) {
            // ...
        } catch Error(string memory reason) {
            // ...
        }
    }
}
Source code in woke/ast/ir/meta/parameter_list.py 
 22
 23
 24
 25
 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
110
111
112
113
114
115
116
117
118
119
120
class ParameterList(SolidityAbc):
    """
    !!! example
        A parameter list can be used:

        - in an [ErrorDefinition][woke.ast.ir.declaration.error_definition.ErrorDefinition]:
            - `:::solidity (uint requested, uint available)` in line 2,
        - in an [EventDefinition][woke.ast.ir.declaration.event_definition.EventDefinition]:
            - `:::solidity (address indexed previousOwner, address indexed newOwner)` in line 3,
        - in a [FunctionDefinition][woke.ast.ir.declaration.function_definition.FunctionDefinition]:
            - `:::solidity (uint a, uint b)` in line 12 as function parameters,
            - `:::solidity (uint256)` in line 12 as function return parameters,
        - in a [FunctionTypeName][woke.ast.ir.type_name.function_type_name.FunctionTypeName]:
            - `:::solidity (string memory, uint)` in line 5 as function type name parameters,
            - `:::solidity (bool)` in line 5 as function type name return parameters,
        - in a [ModifierDefinition][woke.ast.ir.declaration.modifier_definition.ModifierDefinition]:
            - `:::solidity (uint x)` in line 7,
        - in a [TryCatchClause][woke.ast.ir.meta.try_catch_clause.TryCatchClause]:
            - `:::solidity (bool success)` in line 17 as try clause parameters,
            - `:::solidity (string memory reason)` in line 19 as catch clause parameters.

        ```solidity linenums="1"
        contract C {
            error InsufficientBalance(uint requested, uint available);
            event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

            function (string memory, uint) external returns (bool) externalFunction;

            modifier onlyPositive(uint x) {
                require(x > 0, "x must be positive");
                _;
            }

            function add(uint a, uint b) onlyPositive(a) public pure returns (uint256) {
                return a + b;
            }

            function callExternalFunction() public {
                try externalFunction("abc", 123) returns (bool success) {
                    // ...
                } catch Error(string memory reason) {
                    // ...
                }
            }
        }
        ```
    """

    _ast_node: SolcParameterList
    _parent: Union[
        ErrorDefinition,
        EventDefinition,
        FunctionDefinition,
        FunctionTypeName,
        ModifierDefinition,
        TryCatchClause,
    ]

    _parameters: List[VariableDeclaration]

    def __init__(
        self, init: IrInitTuple, parameter_list: SolcParameterList, parent: SolidityAbc
    ):
        super().__init__(init, parameter_list, parent)

        self._parameters = []
        for parameter in parameter_list.parameters:
            self._parameters.append(VariableDeclaration(init, parameter, self))

    def __iter__(self) -> Iterator[IrAbc]:
        yield self
        for parameter in self._parameters:
            yield from parameter

    @property
    def parent(
        self,
    ) -> Union[
        ErrorDefinition,
        EventDefinition,
        FunctionDefinition,
        FunctionTypeName,
        ModifierDefinition,
        TryCatchClause,
    ]:
        """
        Returns:
            Parent IR node.
        """
        return self._parent

    @property
    def parameters(self) -> Tuple[VariableDeclaration, ...]:
        """
        Can be empty.
        Returns:
            Variable declarations of the parameter list.
        """
        return tuple(self._parameters)

parameters: Tuple[VariableDeclaration, ...] property #

Can be empty.

Returns:

Type Description
Tuple[VariableDeclaration, ...]

Variable declarations of the parameter list.

parent: Union[ErrorDefinition, EventDefinition, FunctionDefinition, FunctionTypeName, ModifierDefinition, TryCatchClause] property #

Returns:

Type Description
Union[ErrorDefinition, EventDefinition, FunctionDefinition, FunctionTypeName, ModifierDefinition, TryCatchClause]

Parent IR node.