Skip to content

server

server

PyGerber's Gerber language server implementation.

get_language_server 

get_language_server() -> LanguageServer

Get instance of Gerber language server.

Source code in src\pygerber\gerberx3\language_server\_internals\server.py 
 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
 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
def get_language_server() -> LanguageServer:  # noqa: C901
    """Get instance of Gerber language server."""
    if not IS_LANGUAGE_SERVER_FEATURE_AVAILABLE:  # pragma: no cover
        raise LanguageServerNotAvailableError

    import lsprotocol.types as lspt
    from pygls.server import LanguageServer

    from pygerber.gerberx3.language_server._internals.document import Document

    if TYPE_CHECKING:
        from pygls import workspace

    server = LanguageServer(
        "pygerber.gerberx3.language_server",
        pygerber.__version__,
        max_workers=1,
    )

    @server.feature(lspt.INITIALIZE)
    def _initialize(params: lspt.InitializeParams) -> None:
        client_name = getattr(params.client_info, "name", "Unknown")
        client_version = getattr(params.client_info, "version", "Unknown")
        server.show_message_log(
            "Started PyGerber's Gerber Language Server version "
            f"{pygerber.__version__} for {client_name} {client_version}.",
            lspt.MessageType.Info,
        )

    @server.feature(lspt.TEXT_DOCUMENT_DID_OPEN)
    def _text_document_open(params: lspt.DidOpenTextDocumentParams) -> None:
        document = get_document(params.text_document.uri)
        document.publish_diagnostics()

    @server.feature(lspt.TEXT_DOCUMENT_DID_CHANGE)
    def _text_document_change(params: lspt.DidOpenTextDocumentParams) -> None:
        document = get_document(params.text_document.uri)
        document.publish_diagnostics()

    cached_documents_map: dict[bytes, Document] = {}

    def get_document(uri: str) -> Document:
        text_document: workspace.TextDocument = server.workspace.get_text_document(
            uri,
        )
        digest_text_document = sha256(text_document.source.encode("utf-8")).digest()
        digest_uri = sha256(text_document.uri.encode("utf-8")).digest()

        document_id = digest_text_document + digest_uri
        document = cached_documents_map.get(document_id)

        if document is None:
            if len(cached_documents_map) > MAX_CACHE_SIZE:
                cached_documents_map.popitem()

            cached_documents_map[document_id] = Document(
                server,
                text_document.source,
                uri,
            )

        return cached_documents_map[document_id]

    @server.feature(lspt.TEXT_DOCUMENT_HOVER)
    def _text_document_hover(params: lspt.HoverParams) -> Optional[lspt.Hover]:
        document = get_document(params.text_document.uri)
        return document.text_document_hover(params)

    @server.feature(
        lspt.TEXT_DOCUMENT_COMPLETION,
        lspt.CompletionOptions(trigger_characters=["G"]),
    )
    def _text_document_completion(
        _params: lspt.CompletionParams,
    ) -> lspt.CompletionList:
        return lspt.CompletionList(
            is_incomplete=False,
            items=[
                lspt.CompletionItem(
                    label=f"G{code}*",
                    kind=lspt.CompletionItemKind.Keyword,
                )
                for code in [
                    "01",
                    "02",
                    "03",
                    "36",
                    "37",
                    "54",
                    "55",
                    "70",
                    "71",
                    "74",
                    "75",
                    "90",
                    "91",
                ]
            ],
        )

    return server