start implementing rename support, some code generalization

Author: d-biehl

robotcode/language_server/common/decorators.py

@@ -1,6 +1,6 @@
 from typing import Any, Callable, List, Protocol, TypeVar, runtime_checkable
 
-from robotcode.language_server.common.text_document import TextDocument
+from .text_document import TextDocument
 
 _F = TypeVar("_F", bound=Callable[..., Any])
 

robotcode/language_server/common/lsp_types.py

@@ -965,6 +965,16 @@ class SelectionRangeRegistrationOptions(
     pass
 
 
+@dataclass(repr=False)
+class RenameOptions(WorkDoneProgressOptions):
+    prepare_provider: Optional[bool] = None
+
+
+@dataclass(repr=False)
+class RenameRegistrationOptions(TextDocumentRegistrationOptions, RenameOptions, StaticRegistrationOptions):
+    pass
+
+
 @dataclass(repr=False)
 class ServerCapabilities(Model):
     text_document_sync: Union[TextDocumentSyncOptions, TextDocumentSyncKind, None] = None
@@ -984,7 +994,7 @@ class ServerCapabilities(Model):
     document_formatting_provider: Union[bool, DocumentFormattingOptions, None] = None
     document_range_formatting_provider: Union[bool, DocumentRangeFormattingOptions, None] = None
     # TODO document_on_type_formatting_provider: Optional[DocumentOnTypeFormattingOptions] = None
-    # TODO rename_provider: Union[bool, RenameOptions, None] = None
+    rename_provider: Union[bool, RenameOptions, None] = None
     folding_range_provider: Union[bool, FoldingRangeOptions, FoldingRangeRegistrationOptions, None] = None
     execute_command_provider: Optional[ExecuteCommandOptions] = None
     selection_range_provider: Union[bool, SelectionRangeOptions, SelectionRangeRegistrationOptions, None] = None
@@ -1139,7 +1149,7 @@ class TextDocumentIdentifier(Model):
 
 @dataclass(repr=False)
 class OptionalVersionedTextDocumentIdentifier(TextDocumentIdentifier):
-    version: Optional[int] = None
+    version: Optional[int]
 
 
 @dataclass(repr=False)
@@ -1429,7 +1439,7 @@ class AnnotatedTextEdit(TextEdit):
 @dataclass(repr=False)
 class TextDocumentEdit(Model):
     text_document: OptionalVersionedTextDocumentIdentifier
-    edits: Union[TextEdit, AnnotatedTextEdit]
+    edits: List[Union[TextEdit, AnnotatedTextEdit]]
 
 
 @dataclass(repr=False)
@@ -1442,7 +1452,7 @@ class ChangeAnnotation(Model):
 @dataclass(repr=False)
 class WorkspaceEdit(Model):
     changes: Optional[Dict[DocumentUri, List[TextEdit]]] = None
-    document_changes: Union[List[TextDocumentEdit], TextDocumentEdit, CreateFile, RenameFile, DeleteFile, None] = None
+    document_changes: Optional[List[Union[TextDocumentEdit, CreateFile, RenameFile, DeleteFile]]] = None
     change_annotations: Optional[Dict[ChangeAnnotationIdentifier, ChangeAnnotation]] = None
 
 
@@ -1978,3 +1988,32 @@ class _WorkDoneProgressEnd(Model):
 @dataclass(repr=False)
 class WorkDoneProgressEnd(WorkDoneProgressBase, _WorkDoneProgressEnd):
     kind: Literal["end"] = "end"
+
+
+@dataclass(repr=False)
+class _RenameParams(Model):
+    new_name: str
+
+
+@dataclass(repr=False)
+class RenameParams(WorkDoneProgressParams, TextDocumentPositionParams, _RenameParams):
+    pass
+
+
+@dataclass(repr=False)
+class PrepareRenameParams(TextDocumentPositionParams):
+    pass
+
+
+@dataclass(repr=False)
+class PrepareRenameResultWithPlaceHolder(Model):
+    range: Range
+    placeholder: str
+
+
+@dataclass(repr=False)
+class PrepareRenameResultWithDefaultBehavior(Model):
+    default_behavior: bool
+
+
+PrepareRenameResult = Union[Range, PrepareRenameResultWithPlaceHolder, PrepareRenameResultWithDefaultBehavior]

robotcode/language_server/common/parts/rename.py

@@ -0,0 +1,130 @@
+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 (
+    Position,
+    PrepareRenameParams,
+    PrepareRenameResult,
+    RenameOptions,
+    RenameParams,
+    ServerCapabilities,
+    TextDocumentIdentifier,
+    WorkspaceEdit,
+)
+from ..text_document import TextDocument
+
+if TYPE_CHECKING:
+    from ..protocol import LanguageServerProtocol
+
+from .protocol_part import LanguageServerProtocolPart
+
+
+class RenameProtocolPart(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.rename_provider = RenameOptions(
+                prepare_provider=len(self.collect_prepare) > 0, work_done_progress=True
+            )
+
+    @async_tasking_event
+    async def collect(
+        sender, document: TextDocument, position: Position, new_name: str  # NOSONAR
+    ) -> Optional[WorkspaceEdit]:
+        ...
+
+    @async_tasking_event
+    async def collect_prepare(
+        sender, document: TextDocument, position: Position  # NOSONAR
+    ) -> Optional[PrepareRenameResult]:
+        ...
+
+    @rpc_method(name="textDocument/rename", param_type=RenameParams)
+    async def _text_document_rename(
+        self,
+        text_document: TextDocumentIdentifier,
+        position: Position,
+        new_name: str,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Optional[WorkspaceEdit]:
+
+        edits: List[WorkspaceEdit] = []
+
+        document = await self.parent.documents.get(text_document.uri)
+        if document is None:
+            return None
+
+        for result in await self.collect(
+            self, document, position, new_name, 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:
+                    edits.append(result)
+
+        if len(edits) == 0:
+            return None
+
+        result = WorkspaceEdit()
+        for we in edits:
+            if we.changes:
+                if result.changes is None:
+                    result.changes = {}
+                result.changes.update(we.changes)
+
+            if we.document_changes:
+                if result.document_changes is None:
+                    result.document_changes = []
+                result.document_changes.extend(we.document_changes)
+
+            if we.change_annotations:
+                if result.change_annotations is None:
+                    result.change_annotations = {}
+                result.change_annotations.update(we.change_annotations)
+
+        return result
+
+    @rpc_method(name="textDocument/prepareRename", param_type=PrepareRenameParams)
+    async def _text_document_prepare_rename(
+        self,
+        text_document: TextDocumentIdentifier,
+        position: Position,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Optional[PrepareRenameResult]:
+
+        results: List[PrepareRenameResult] = []
+
+        document = await self.parent.documents.get(text_document.uri)
+        if document is None:
+            return None
+
+        for result in await self.collect_prepare(
+            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:
+                    results.append(result)
+
+        if len(results) == 0:
+            return None
+
+        return results[-1]

robotcode/language_server/common/protocol.py

@@ -51,6 +51,7 @@
 from .parts.implementation import ImplementationProtocolPart
 from .parts.linked_editing_ranges import LinkedEditingRangeProtocolPart
 from .parts.references import ReferencesProtocolPart
+from .parts.rename import RenameProtocolPart
 from .parts.selection_range import SelectionRangeProtocolPart
 from .parts.semantic_tokens import SemanticTokensProtocolPart
 from .parts.signature_help import SignatureHelpProtocolPart
@@ -86,6 +87,7 @@ class LanguageServerProtocol(JsonRPCProtocol):
     document_highlight = ProtocolPartDescriptor(DocumentHighlightProtocolPart)
     linked_editing_range = ProtocolPartDescriptor(LinkedEditingRangeProtocolPart)
     selection_range = ProtocolPartDescriptor(SelectionRangeProtocolPart)
+    rename = ProtocolPartDescriptor(RenameProtocolPart)
 
     name: Optional[str] = None
     version: Optional[str] = None

robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -229,7 +229,7 @@ class ArgumentSpec:
     defaults: Any
     types: Any
 
-    __robot_arguments: Optional[Any] = None
+    __robot_arguments: Optional[Any] = field(default=None, compare=False)
 
     @staticmethod
     def from_robot_argument_spec(spec: Any) -> ArgumentSpec:
@@ -470,6 +470,9 @@ def get(self, key: str, default: Optional[KeywordDoc] = None) -> Optional[Keywor
         except KeyError:
             return default
 
+    def get_all(self, key: str) -> List[KeywordDoc]:
+        return [v for k, v in self._matchers.items() if k == key]
+
 
 @dataclass
 class ModuleSpec:

robotcode/language_server/robotframework/parts/document_highlight.py

@@ -194,17 +194,8 @@ async def highlight_KeywordCall(  # noqa: N802
                 and keyword_doc.source
             ):
                 return [
-                    *(
-                        [DocumentHighlight(keyword_doc.range, DocumentHighlightKind.TEXT)]
-                        if keyword_doc.source == str(document.uri.to_path())
-                        else []
-                    ),
-                    *(
-                        DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
-                        for e in await self.parent.robot_references.find_keyword_references_in_file(
-                            document, keyword_doc
-                        )
-                    ),
+                    DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
+                    for e in await self.parent.robot_references.find_keyword_references_in_file(document, keyword_doc)
                 ]
 
         return None
@@ -228,18 +219,12 @@ async def highlight_KeywordName(  # noqa: N802
 
         doc = await namespace.get_library_doc()
         if doc is not None:
-            keyword = next(
-                (v for v in doc.keywords.keywords if v.name == name_token.value and v.line_no == kw_node.lineno),
-                None,
-            )
+            keyword = await self.get_keyword_definition_at_token(namespace, name_token)
 
             if keyword is not None and keyword.source and not keyword.is_error_handler:
                 return [
-                    DocumentHighlight(keyword.range, DocumentHighlightKind.TEXT),
-                    *(
-                        DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
-                        for e in await self.parent.robot_references.find_keyword_references_in_file(document, keyword)
-                    ),
+                    DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
+                    for e in await self.parent.robot_references.find_keyword_references_in_file(document, keyword)
                 ]
 
         return None
@@ -287,17 +272,8 @@ async def highlight_Fixture(  # noqa: N802
 
             if position in kw_range and keyword_doc is not None and not keyword_doc.is_error_handler:
                 return [
-                    *(
-                        [DocumentHighlight(keyword_doc.range, DocumentHighlightKind.TEXT)]
-                        if keyword_doc.source == str(document.uri.to_path())
-                        else []
-                    ),
-                    *(
-                        DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
-                        for e in await self.parent.robot_references.find_keyword_references_in_file(
-                            document, keyword_doc
-                        )
-                    ),
+                    DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
+                    for e in await self.parent.robot_references.find_keyword_references_in_file(document, keyword_doc)
                 ]
 
         return None
@@ -340,17 +316,10 @@ async def _highlight_Template_or_TestTemplate(  # noqa: N802
 
                     if not keyword_doc.is_error_handler:
                         return [
-                            *(
-                                [DocumentHighlight(keyword_doc.range, DocumentHighlightKind.TEXT)]
-                                if keyword_doc.source == str(document.uri.to_path())
-                                else []
-                            ),
-                            *(
-                                DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
-                                for e in await self.parent.robot_references.find_keyword_references_in_file(
-                                    document, keyword_doc
-                                )
-                            ),
+                            DocumentHighlight(e.range, DocumentHighlightKind.TEXT)
+                            for e in await self.parent.robot_references.find_keyword_references_in_file(
+                                document, keyword_doc
+                            )
                         ]
         return None
 

robotcode/language_server/robotframework/parts/goto.py

@@ -254,7 +254,7 @@ async def definition_KeywordName(  # noqa: N802
         if not name_token:
             return None
 
-        result = await namespace.find_keyword(name_token.value)
+        result = await self.get_keyword_definition_at_token(namespace, name_token)
 
         if result is not None and not result.is_error_handler and result.source:
             token_range = range_from_token(name_token)

robotcode/language_server/robotframework/parts/hover.py

@@ -537,11 +537,11 @@ async def hover_KeywordName(  # noqa: N802
             return None
 
         kw_node = cast(KeywordName, node)
-        name_token = kw_node.get_token(RobotToken.KEYWORD_NAME)
+        name_token = cast(RobotToken, kw_node.get_token(RobotToken.KEYWORD_NAME))
         if not name_token:
             return None
 
-        result = (await namespace.get_library_doc()).keywords.get(name_token.value, None)
+        result = await self.get_keyword_definition_at_token(namespace, name_token)
 
         if result is not None and not result.is_error_handler:
             return Hover(

robotcode/language_server/robotframework/parts/model_helper.py

@@ -514,3 +514,10 @@ def strip_bdd_prefix(cls, token: Token) -> Token:
     def is_bdd_token(cls, token: Token) -> bool:
         bdd_match = cls.BDD_TOKEN.match(token.value)
         return bool(bdd_match)
+
+    @classmethod
+    async def get_keyword_definition_at_token(cls, namespace: Namespace, token: Token) -> Optional[KeywordDoc]:
+        return next(
+            (k for k in (await namespace.get_library_doc()).keywords.get_all(token.value) if k.line_no == token.lineno),
+            None,
+        )