Skip to content

extended_command

extended_command

Base class for all extended commands.

Token

Bases: GerberCode

Base class for creating Gerber token classes.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
 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
121
122
123
124
125
126
127
128
129
130
131
132
class Token(GerberCode):
    """Base class for creating Gerber token classes."""

    @classmethod
    def wrap(cls, expr: ParserElement) -> ParserElement:
        """Set parse result to be instance of this class."""
        return expr.set_parse_action(cls.new)

    @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()`.
        """
        return cls(string, location)

    def __init__(self, string: str, location: int) -> None:
        """Initialize token instance."""
        self.string = string
        self.location = location

    def __str__(self) -> str:
        return f"GerberCode::Token::{self.__class__.__qualname__}"

    def __repr__(self) -> str:
        """Return pretty representation of comment token."""
        return self.__str__()

    def get_debug_format(self) -> str:
        """Return debug formatted token object."""
        return super().__repr__()

    @classmethod
    def ensure_type(cls, thing: Any) -> Self:
        """Ensure that <thing> is a instance of this class.

        Raise TypeError otherwise.
        """
        if not isinstance(thing, cls):
            raise TypeError(thing)

        return thing

    def update_drawing_state(
        self,
        state: State,
        _backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Update drawing state."""
        return state, ()

    def get_token_position(self) -> Position:
        """Get position of token."""
        return self._token_position

    @cached_property
    def _token_position(self) -> Position:
        return Position(
            lineno(self.location, self.string),
            col(self.location, self.string),
        )

    def get_hover_message(self, state: LanguageServerState) -> str:
        """Return language server hover message."""
        ref_doc = "\n".join(s.strip() for s in str(self.__doc__).split("\n"))
        op_specific_extra = self.get_operation_specific_info(state)
        return (
            "```gerber\n"
            f"{self.get_gerber_code_one_line_pretty_display()}"
            "\n"
            "```"
            "\n"
            "---"
            "\n"
            f"{op_specific_extra}\n"
            "\n"
            "---"
            "\n"
            f"{ref_doc}"
        )

    def get_operation_specific_info(
        self,
        state: LanguageServerState,  # noqa: ARG002
    ) -> str:
        """Return operation specific extra information about token."""
        return ""

    def find_closest_token(
        self,
        pos: Position,  # noqa: ARG002
        parent: Optional[TokenAccessor] = None,
    ) -> TokenAccessor:
        """Find token closest to specified position."""
        return TokenAccessor(self, parent)

    def get_gerber_code_one_line_pretty_display(self) -> str:
        """Get gerber code represented by this token."""
        return self.get_gerber_code()

    def __iter__(self) -> Iterator[Token]:
        yield self

    def __hash__(self) -> int:
        return id(self)

    def __eq__(self, __value: object) -> bool:
        if not isinstance(__value, Token):
            return NotImplemented
        return id(__value) == id(self)

wrap classmethod 

wrap(expr: ParserElement) -> ParserElement

Set parse result to be instance of this class.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
26
27
28
29
@classmethod
def wrap(cls, expr: ParserElement) -> ParserElement:
    """Set parse result to be instance of this class."""
    return expr.set_parse_action(cls.new)

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/bases/token.py 
31
32
33
34
35
36
37
@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()`.
    """
    return cls(string, location)

__init__ 

__init__(string: str, location: int) -> None

Initialize token instance.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
39
40
41
42
def __init__(self, string: str, location: int) -> None:
    """Initialize token instance."""
    self.string = string
    self.location = location

__repr__ 

__repr__() -> str

Return pretty representation of comment token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
47
48
49
def __repr__(self) -> str:
    """Return pretty representation of comment token."""
    return self.__str__()

get_debug_format 

get_debug_format() -> str

Return debug formatted token object.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
51
52
53
def get_debug_format(self) -> str:
    """Return debug formatted token object."""
    return super().__repr__()

ensure_type classmethod 

ensure_type(thing: Any) -> Self

Ensure that is a instance of this class.

Raise TypeError otherwise.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
55
56
57
58
59
60
61
62
63
64
@classmethod
def ensure_type(cls, thing: Any) -> Self:
    """Ensure that <thing> is a instance of this class.

    Raise TypeError otherwise.
    """
    if not isinstance(thing, cls):
        raise TypeError(thing)

    return thing

update_drawing_state 

update_drawing_state(
    state: State, _backend: Backend
) -> Tuple[State, Iterable[DrawCommand]]

Update drawing state.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
66
67
68
69
70
71
72
def update_drawing_state(
    self,
    state: State,
    _backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Update drawing state."""
    return state, ()

get_token_position 

get_token_position() -> Position

Get position of token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
74
75
76
def get_token_position(self) -> Position:
    """Get position of token."""
    return self._token_position

get_hover_message 

get_hover_message(state: LanguageServerState) -> str

Return language server hover message.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get_hover_message(self, state: LanguageServerState) -> str:
    """Return language server hover message."""
    ref_doc = "\n".join(s.strip() for s in str(self.__doc__).split("\n"))
    op_specific_extra = self.get_operation_specific_info(state)
    return (
        "```gerber\n"
        f"{self.get_gerber_code_one_line_pretty_display()}"
        "\n"
        "```"
        "\n"
        "---"
        "\n"
        f"{op_specific_extra}\n"
        "\n"
        "---"
        "\n"
        f"{ref_doc}"
    )

get_operation_specific_info 

get_operation_specific_info(
    state: LanguageServerState,
) -> str

Return operation specific extra information about token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
104
105
106
107
108
109
def get_operation_specific_info(
    self,
    state: LanguageServerState,  # noqa: ARG002
) -> str:
    """Return operation specific extra information about token."""
    return ""

find_closest_token 

find_closest_token(
    pos: Position, parent: Optional[TokenAccessor] = None
) -> TokenAccessor

Find token closest to specified position.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
111
112
113
114
115
116
117
def find_closest_token(
    self,
    pos: Position,  # noqa: ARG002
    parent: Optional[TokenAccessor] = None,
) -> TokenAccessor:
    """Find token closest to specified position."""
    return TokenAccessor(self, parent)

get_gerber_code_one_line_pretty_display 

get_gerber_code_one_line_pretty_display() -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/token.py 
119
120
121
def get_gerber_code_one_line_pretty_display(self) -> str:
    """Get gerber code represented by this token."""
    return self.get_gerber_code()

ExtendedCommandToken

Bases: Token

3.3 Commands.

Commands are the core syntactic element of the Gerber format. A Gerber file is a stream of commands. Commands define the graphics state, create graphical objects, defines apertures, manage attributes and so on.

Commands are built with words, the basic syntactic building block of a Gerber file. A word is a non-empty character string, excluding the reserved characters '' and '%', terminated with an ''

free_character = /[^%*]/; # All characters but * and %
word = {free_character}+ '*';

For historic reasons, there are two command syntax styles: word commands and extended commands.

command =
| extended_command
| word_command
;
word_command = word;
extended_command = '%' {word}+ '%';

Word commands are identified by a command code, the letter G, D or M followed by a positive integer, e.g. G02. Most word commands only consist of the command code, some also contain coordinates.

Extended commands are identified by a two-character command code that is followed by parameters specific to the code. An extended command is enclosed by a pair of "%" delimiters

An overview of all commands is in section 2.8, a full description in chapters 3.5 and 5.

Example 1

The example below shows a stream of Gerber commands.

G04 Different command styles*
G75*
G02*
D10*
X0Y0D02*
X2000000Y0I1000000J0D01*
D11*
X0Y2000000D03*
M02*
Example 2

The example below shows a stream of Gerber extended commands.

%FSLAX26Y26*%
%MOMM*%
%AMDonut*
1,1,$1,$2,$3*
$4=$1x0.75*
1,0,$4,$2,$3*
%
%ADD11Donut,0.30X0X0*%
%ADD10C,0.1*%

See section 3.3 of The Gerber Layer Format Specification

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/extended_command.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
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
class ExtendedCommandToken(Token):
    """## 3.3 Commands.

    Commands are the core syntactic element of the Gerber format. A Gerber file is a stream of
    commands. Commands define the graphics state, create graphical objects, defines apertures,
    manage attributes and so on.

    Commands are built with words, the basic syntactic building block of a Gerber file. A word is a
    non-empty character string, excluding the reserved characters '*' and '%', terminated with an '*'

    ```ebnf
    free_character = /[^%*]/; # All characters but * and %
    word = {free_character}+ '*';
    ```

    For historic reasons, there are two command syntax styles: word commands and extended
    commands.

    ```ebnf
    command =
    | extended_command
    | word_command
    ;
    word_command = word;
    extended_command = '%' {word}+ '%';
    ```


    Word commands are identified by a command code, the letter G, D or M followed by a positive
    integer, e.g. `G02`. Most word commands only consist of the command code, some also contain
    coordinates.

    Extended commands are identified by a two-character command code that is followed by
    parameters specific to the code. An extended command is enclosed by a pair of "%" delimiters

    An overview of all commands is in section 2.8, a full description in chapters 3.5 and 5.


    ---

    ## Example 1

    The example below shows a stream of Gerber commands.

    ```gerber
    G04 Different command styles*
    G75*
    G02*
    D10*
    X0Y0D02*
    X2000000Y0I1000000J0D01*
    D11*
    X0Y2000000D03*
    M02*
    ```


    ---

    ## Example 2

    The example below shows a stream of Gerber extended commands.

    ```gerber
    %FSLAX26Y26*%
    %MOMM*%
    %AMDonut*
    1,1,$1,$2,$3*
    $4=$1x0.75*
    1,0,$4,$2,$3*
    %
    %ADD11Donut,0.30X0X0*%
    %ADD10C,0.1*%
    ```

    ---

    See section 3.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=33)

    """  # noqa: E501

    def get_gerber_code_one_line_pretty_display(self) -> str:
        """Get gerber code represented by this token."""
        return f"%{self.get_gerber_code()}*%"

get_gerber_code_one_line_pretty_display 

get_gerber_code_one_line_pretty_display() -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/bases/extended_command.py 
90
91
92
def get_gerber_code_one_line_pretty_display(self) -> str:
    """Get gerber code represented by this token."""
    return f"%{self.get_gerber_code()}*%"