implement common linked editing ranges support

Author: d-biehl

robotcode/language_server/common/lsp_types.py

@@ -941,6 +941,18 @@ class DocumentHighlightRegistrationOptions(TextDocumentRegistrationOptions, Docu
     pass
 
 
+@dataclass(repr=False)
+class LinkedEditingRangeOptions(WorkDoneProgressOptions):
+    pass
+
+
+@dataclass(repr=False)
+class LinkedEditingRangeRegistrationOptions(
+    TextDocumentRegistrationOptions, LinkedEditingRangeOptions, StaticRegistrationOptions
+):
+    pass
+
+
 @dataclass(repr=False)
 class ServerCapabilities(Model):
     text_document_sync: Union[TextDocumentSyncOptions, TextDocumentSyncKind, None] = None
@@ -964,9 +976,9 @@ class ServerCapabilities(Model):
     folding_range_provider: Union[bool, FoldingRangeOptions, FoldingRangeRegistrationOptions, None] = None
     execute_command_provider: Optional[ExecuteCommandOptions] = None
     # TODO selection_range_provider: Union[bool, SelectionRangeOptions, SelectionRangeRegistrationOptions, None] = None
-    # TODO linked_editing_range_provider: Union[
-    #     boolean, LinkedEditingRangeOptions, LinkedEditingRangeRegistrationOptions, None
-    # ] = None
+    linked_editing_range_provider: Union[
+        bool, LinkedEditingRangeOptions, LinkedEditingRangeRegistrationOptions, None
+    ] = None
     # TODO call_hierarchy_provider: Union[boolean, CallHierarchyOptions, CallHierarchyRegistrationOptions, None] = None
     semantic_tokens_provider: Union[SemanticTokensOptions, SemanticTokensRegistrationOptions, None] = None
     # TODO moniker_provider: Union[bool, MonikerOptions, MonikerRegistrationOptions, None] = None
@@ -1877,3 +1889,14 @@ class DocumentHighlightKind(Enum):
 class DocumentHighlight(Model):
     range: Range
     kind: Optional[DocumentHighlightKind] = None
+
+
+@dataclass(repr=False)
+class LinkedEditingRangeParams(WorkDoneProgressParams, TextDocumentPositionParams):
+    pass
+
+
+@dataclass(repr=False)
+class LinkedEditingRanges(Model):
+    ranges: List[Range]
+    word_pattern: Optional[str] = None

robotcode/language_server/common/parts/linked_editing_ranges.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from asyncio import CancelledError
+from typing import TYPE_CHECKING, Any, List, Optional
+
+from ....jsonrpc2.protocol import rpc_method
+from ....utils.async_tools import async_tasking_event
+from ....utils.logging import LoggingDescriptor
+from ..decorators import language_id_filter
+from ..has_extend_capabilities import HasExtendCapabilities
+from ..lsp_types import (
+    LinkedEditingRangeOptions,
+    LinkedEditingRangeParams,
+    LinkedEditingRanges,
+    Position,
+    Range,
+    ServerCapabilities,
+    TextDocumentIdentifier,
+)
+from ..text_document import TextDocument
+
+if TYPE_CHECKING:
+    from ..protocol import LanguageServerProtocol
+
+from .protocol_part import LanguageServerProtocolPart
+
+
+class LinkedEditingRangeProtocolPart(LanguageServerProtocolPart, HasExtendCapabilities):
+
+    _logger = LoggingDescriptor()
+
+    def __init__(self, parent: LanguageServerProtocol) -> None:
+        super().__init__(parent)
+
+    def extend_capabilities(self, capabilities: ServerCapabilities) -> None:
+        if len(self.collect):
+            capabilities.linked_editing_range_provider = LinkedEditingRangeOptions(work_done_progress=True)
+
+    @async_tasking_event
+    async def collect(sender, document: TextDocument, position: Position) -> Optional[LinkedEditingRanges]:  # NOSONAR
+        ...
+
+    @rpc_method(name="textDocument/linkedEditingRange", param_type=LinkedEditingRangeParams)
+    async def _text_document_linked_editing_range(
+        self,
+        text_document: TextDocumentIdentifier,
+        position: Position,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Optional[LinkedEditingRanges]:
+
+        linked_ranges: List[Range] = []
+        word_pattern: Optional[str] = None
+
+        document = await self.parent.documents.get(text_document.uri)
+        if document is None:
+            return None
+
+        for result in await self.collect(self, document, position, callback_filter=language_id_filter(document)):
+            if isinstance(result, BaseException):
+                if not isinstance(result, CancelledError):
+                    self._logger.exception(result, exc_info=result)
+            else:
+                if result is not None:
+                    linked_ranges.extend(result.ranges)
+                    if result.word_pattern is not None:
+                        word_pattern = result.word_pattern
+
+        return LinkedEditingRanges(linked_ranges, word_pattern)

robotcode/language_server/common/protocol.py

@@ -48,6 +48,7 @@
 from .parts.formatting import FormattingProtocolPart
 from .parts.hover import HoverProtocolPart
 from .parts.implementation import ImplementationProtocolPart
+from .parts.linked_editing_ranges import LinkedEditingRangeProtocolPart
 from .parts.references import ReferencesProtocolPart
 from .parts.semantic_tokens import SemanticTokensProtocolPart
 from .parts.signature_help import SignatureHelpProtocolPart
@@ -81,6 +82,7 @@ class LanguageServerProtocol(JsonRPCProtocol):
     semantic_tokens = ProtocolPartDescriptor(SemanticTokensProtocolPart)
     references = ProtocolPartDescriptor(ReferencesProtocolPart)
     document_highlight = ProtocolPartDescriptor(DocumentHighlightProtocolPart)
+    linked_editing_range = ProtocolPartDescriptor(LinkedEditingRangeProtocolPart)
 
     name: Optional[str] = None
     version: Optional[str] = None

robotcode/language_server/robotframework/protocol.py

@@ -87,7 +87,7 @@ class RobotLanguageServerProtocol(LanguageServerProtocol):
     robot_workspace = ProtocolPartDescriptor(RobotWorkspaceProtocolPart)
 
     robot_discovering = ProtocolPartDescriptor(DiscoveringProtocolPart)
-    robot_debuggin_utils = ProtocolPartDescriptor(RobotDebuggingUtilsProtocolPart)
+    robot_debugging_utils = ProtocolPartDescriptor(RobotDebuggingUtilsProtocolPart)
 
     name = "RobotCode"
     version = __version__