feat(langserver): highlight namespace references

Author: d-biehl

packages/core/src/robotcode/core/lsp/types.py

@@ -3985,6 +3985,9 @@ def extend(
             ),
         )
 
+    def __bool__(self) -> bool:
+        return self.start != self.end
+
     def __contains__(self, x: object) -> bool:
         if isinstance(x, (Position, Range)):
             return x.is_in_range(self)

packages/language_server/src/robotcode/language_server/robotframework/diagnostics/entities.py

@@ -71,6 +71,20 @@ def range(self) -> Range:
 class LibraryImport(Import):
     args: Tuple[str, ...] = ()
     alias: Optional[str] = None
+    alias_token: Optional[Token] = None
+
+    @property
+    def alias_range(self) -> Range:
+        return Range(
+            start=Position(
+                line=self.alias_token.lineno - 1 if self.alias_token is not None else -1,
+                character=self.alias_token.col_offset if self.alias_token is not None else -1,
+            ),
+            end=Position(
+                line=self.alias_token.lineno - 1 if self.alias_token is not None else -1,
+                character=self.alias_token.end_col_offset if self.alias_token is not None else -1,
+            ),
+        )
 
     @single_call
     def __hash__(self) -> int:
@@ -301,6 +315,7 @@ class LibraryEntry:
     alias: Optional[str] = None
     import_range: Range = field(default_factory=lambda: Range.zero())
     import_source: Optional[str] = None
+    alias_range: Range = field(default_factory=lambda: Range.zero())
 
     def __str__(self) -> str:
         result = self.import_name

packages/language_server/src/robotcode/language_server/robotframework/diagnostics/namespace.py

@@ -417,6 +417,9 @@ def visit_LibraryImport(self, node: ast.AST) -> None:  # noqa: N802
         n = cast(RobotLibraryImport, node)
         name = cast(RobotToken, n.get_token(RobotToken.NAME))
 
+        separator = n.get_token(RobotToken.WITH_NAME)
+        alias_token = n.get_tokens(RobotToken.NAME)[-1] if separator else None
+
         last_data_token = cast(
             RobotToken, next(v for v in reversed(n.tokens) if v.type not in RobotToken.NON_DATA_TOKENS)
         )
@@ -427,6 +430,7 @@ def visit_LibraryImport(self, node: ast.AST) -> None:  # noqa: N802
                     name_token=name if name is not None else None,
                     args=n.args,
                     alias=n.alias,
+                    alias_token=alias_token,
                     line_no=node.lineno,
                     col_offset=node.col_offset,
                     end_line_no=last_data_token.lineno
@@ -1025,6 +1029,7 @@ async def _import(
                     )
                     result.import_range = value.range
                     result.import_source = value.source
+                    result.alias_range = value.alias_range
 
                     self._import_entries[value] = result
 

packages/language_server/src/robotcode/language_server/robotframework/parts/document_highlight.py

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, List, Optional
+from typing import TYPE_CHECKING, Any, List, Optional, cast
 
 from robotcode.core.logging import LoggingDescriptor
-from robotcode.core.lsp.types import DocumentHighlight, DocumentHighlightKind, Position
+from robotcode.core.lsp.types import DocumentHighlight, DocumentHighlightKind, Position, Range
 from robotcode.language_server.common.decorators import language_id
 from robotcode.language_server.common.text_document import TextDocument
 
@@ -60,4 +60,40 @@ async def collect(
                             *(DocumentHighlight(e.range, DocumentHighlightKind.TEXT) for e in kw_refs),
                         ]
 
+        all_namespace_refs = await namespace.get_namespace_references()
+        if all_namespace_refs:
+            for ns, ns_refs in all_namespace_refs.items():
+                found_range = (
+                    ns.import_range
+                    if ns.import_source == namespace.source
+                    and (position.is_in_range(ns.alias_range, False) or position.is_in_range(ns.import_range, False))
+                    else cast(
+                        Optional[Range], next((r.range for r in ns_refs if position.is_in_range(r.range, False)), None)
+                    )
+                )
+
+                if found_range is not None:
+                    return [
+                        *(
+                            [
+                                DocumentHighlight(
+                                    ns.import_range,
+                                    DocumentHighlightKind.TEXT,
+                                )
+                            ]
+                            if ns.import_source == namespace.source and ns.import_range and not ns.alias_range
+                            else []
+                        ),
+                        *(
+                            [
+                                DocumentHighlight(
+                                    ns.alias_range,
+                                    DocumentHighlightKind.TEXT,
+                                )
+                            ]
+                            if ns.import_source == namespace.source and ns.alias_range
+                            else []
+                        ),
+                        *(DocumentHighlight(e.range, DocumentHighlightKind.TEXT) for e in ns_refs),
+                    ]
         return None

packages/language_server/src/robotcode/language_server/robotframework/parts/hover.py

@@ -140,7 +140,7 @@ async def _hover_default(self, nodes: List[ast.AST], document: TextDocument, pos
             for ns, ns_refs in all_namespace_refs.items():
                 found_range = (
                     ns.import_range
-                    if kw.source == namespace.source and position.is_in_range(ns.import_range, False)
+                    if ns.import_source == namespace.source and position.is_in_range(ns.import_range, False)
                     else cast(
                         Optional[Range], next((r.range for r in ns_refs if position.is_in_range(r.range, False)), None)
                     )

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_highlight.test[document_highlight.robot-006-029-namespace_reference_with_resource].out

@@ -0,0 +1,23 @@
+data: !GeneratedTestData
+  character: 29
+  line: 6
+  name: namespace reference with resource
+result:
+- !DocumentHighlight
+  kind: !DocumentHighlightKind 'TEXT'
+  range:
+    end:
+      character: 61
+      line: 6
+    start:
+      character: 16
+      line: 6
+- !DocumentHighlight
+  kind: !DocumentHighlightKind 'TEXT'
+  range:
+    end:
+      character: 17
+      line: 70
+    start:
+      character: 4
+      line: 70

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_highlight.test[document_highlight.robot-006-040-namespace_reference_with_resource].out

@@ -0,0 +1,23 @@
+data: !GeneratedTestData
+  character: 40
+  line: 6
+  name: namespace reference with resource
+result:
+- !DocumentHighlight
+  kind: !DocumentHighlightKind 'TEXT'
+  range:
+    end:
+      character: 61
+      line: 6
+    start:
+      character: 16
+      line: 6
+- !DocumentHighlight
+  kind: !DocumentHighlightKind 'TEXT'
+  range:
+    end:
+      character: 17
+      line: 70
+    start:
+      character: 4
+      line: 70

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_document_highlight.test[document_highlight.robot-006-051-namespace_reference_with_resource].out

@@ -0,0 +1,23 @@
+data: !GeneratedTestData
+  character: 51
+  line: 6
+  name: namespace reference with resource
+result:
+- !DocumentHighlight
+  kind: !DocumentHighlightKind 'TEXT'
+  range:
+    end:
+      character: 61
+      line: 6
+    start:
+      character: 16
+      line: 6
+- !DocumentHighlight
+  kind: !DocumentHighlightKind 'TEXT'
+  range:
+    end:
+      character: 17
+      line: 70
+    start:
+      character: 4
+      line: 70