Skip to content

variable_assignment

variable_assignment

Macro variable definition token.

MacroVariableAssignment

Bases: MacroStatementToken

4.5.4.3 Definition of New Variable.

New variables can be defined by an assign statement as follows: $4=$1x1.25-$3. The right-hand side is any arithmetic expression as in the previous section.

The variable values are determined as follows:

  • $1, $2, ..., $n take the values of the n parameters of the calling AD command.
  • New variables get their value from their defining expression.
  • The undefined variables are 0.
  • Macro variables cannot be redefined.
Example #1
%AMDONUTCAL*
1,1,$1,$2,$3*
$4=$1x1.25*
1,0,$4,$2,$3*%

The AD command contains four parameters which define the first four macro variables:

$1 = 0.02
$2 = 0
$3 = 0
$4 = 0.06

The variable $5 is defined in the macro body and becomes

$5 = 0.06 x 0.25 = 0.015
Example #2
%AMTEST1*
1,1,$1,$2,$3*
$4=$1x0.75*
$5=($2+100)x1.75*
1,0,$4,$5,$3*%
Example #3
%AMTEST2*
$4=$1x0.75*
$5=100+$3*
1,1,$1,$2,$3*
1,0,$4,$2,$5*
$6=$4x0.5*
1,0,$6,$2,$5*%

See section 4.5.4.3 of The Gerber Layer Format Specification

Source code in src/pygerber/gerberx3/tokenizer/tokens/macro/statements/variable_assignment.py 
 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
class MacroVariableAssignment(MacroStatementToken):
    """## 4.5.4.3 Definition of New Variable.

    New variables can be defined by an assign statement as follows: `$4=$1x1.25-$3`. The
    right-hand side is any arithmetic expression as in the previous section.

    The variable values are determined as follows:

    - `$1`, `$2`, ..., `$n` take the values of the n parameters of the calling AD command.
    - New variables get their value from their defining expression.
    - The undefined variables are 0.
    - Macro variables cannot be redefined.

    ---

    ## Example #1

    ```gerber
    %AMDONUTCAL*
    1,1,$1,$2,$3*
    $4=$1x1.25*
    1,0,$4,$2,$3*%
    ```

    The AD command contains four parameters which define the first four macro variables:

    ```yaml
    $1 = 0.02
    $2 = 0
    $3 = 0
    $4 = 0.06
    ```

    The variable `$5` is defined in the macro body and becomes

    ```yaml
    $5 = 0.06 x 0.25 = 0.015
    ```

    ## Example #2

    ```gerber
    %AMTEST1*
    1,1,$1,$2,$3*
    $4=$1x0.75*
    $5=($2+100)x1.75*
    1,0,$4,$5,$3*%
    ```

    ## Example #3

    ```
    %AMTEST2*
    $4=$1x0.75*
    $5=100+$3*
    1,1,$1,$2,$3*
    1,0,$4,$2,$5*
    $6=$4x0.5*
    1,0,$6,$2,$5*%
    ```

    ---

    See section 4.5.4.3 of [The Gerber Layer Format Specification](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=71)

    """  # noqa: E501

    def __init__(
        self,
        string: str,
        location: int,
        variable: MacroVariableName,
        value: MacroExpressionToken,
    ) -> None:
        super().__init__(string, location)
        self.variable = variable
        self.value = value

    @classmethod
    def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
        """Create instance of this class.

        Created to be used as callback in `ParserElement.set_parse_action()`.
        """
        variable = MacroVariableName.ensure_type(tokens["macro_variable_name"])
        value = MacroExpressionToken.ensure_type(tokens["value"])
        return cls(
            string=string,
            location=location,
            variable=variable,
            value=value,
        )

    def evaluate(
        self,
        macro_context: MacroContext,
        state: State,
        handle: PrivateApertureHandle,
    ) -> None:
        """Evaluate macro expression."""
        name = self.variable.name
        value = self.value.evaluate_numeric(macro_context, state)
        macro_context.variables[name] = value

        return super().evaluate(macro_context, state, handle)

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().macro_variable_assignment.pre_parser_visit_token(
            self,
            context,
        )
        context.get_hooks().macro_variable_assignment.on_parser_visit_token(
            self,
            context,
        )
        context.get_hooks().macro_variable_assignment.post_parser_visit_token(
            self,
            context,
        )

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",
    ) -> str:
        """Get gerber code represented by this token."""
        return (
            f"{indent}{self.variable.get_gerber_code(endline=endline)}="
            f"{self.value.get_gerber_code(endline=endline)}"
        )

    def __str__(self) -> str:
        return f"{super().__str__()}::[{self.variable} = {self.value}]"

new classmethod 

new(
    string: str, location: int, tokens: ParseResults
) -> Self

Create instance of this class.

Created to be used as callback in ParserElement.set_parse_action().

Source code in src/pygerber/gerberx3/tokenizer/tokens/macro/statements/variable_assignment.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@classmethod
def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
    """Create instance of this class.

    Created to be used as callback in `ParserElement.set_parse_action()`.
    """
    variable = MacroVariableName.ensure_type(tokens["macro_variable_name"])
    value = MacroExpressionToken.ensure_type(tokens["value"])
    return cls(
        string=string,
        location=location,
        variable=variable,
        value=value,
    )

evaluate 

evaluate(
    macro_context: MacroContext,
    state: State,
    handle: PrivateApertureHandle,
) -> None

Evaluate macro expression.

Source code in src/pygerber/gerberx3/tokenizer/tokens/macro/statements/variable_assignment.py 
120
121
122
123
124
125
126
127
128
129
130
131
def evaluate(
    self,
    macro_context: MacroContext,
    state: State,
    handle: PrivateApertureHandle,
) -> None:
    """Evaluate macro expression."""
    name = self.variable.name
    value = self.value.evaluate_numeric(macro_context, state)
    macro_context.variables[name] = value

    return super().evaluate(macro_context, state, handle)

parser2_visit_token 

parser2_visit_token(context: Parser2Context) -> None

Perform actions on the context implicated by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/macro/statements/variable_assignment.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().macro_variable_assignment.pre_parser_visit_token(
        self,
        context,
    )
    context.get_hooks().macro_variable_assignment.on_parser_visit_token(
        self,
        context,
    )
    context.get_hooks().macro_variable_assignment.post_parser_visit_token(
        self,
        context,
    )

get_gerber_code 

get_gerber_code(
    indent: str = "", endline: str = "\n"
) -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/macro/statements/variable_assignment.py 
148
149
150
151
152
153
154
155
156
157
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",
) -> str:
    """Get gerber code represented by this token."""
    return (
        f"{indent}{self.variable.get_gerber_code(endline=endline)}="
        f"{self.value.get_gerber_code(endline=endline)}"
    )