references for arguments also finds named arguments

Author: d-biehl

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to the "robotcode" extension will be documented in this file
 
 - Information about possible circular imports
   - if one resource file imports another resource file and vice versa an information message is shown in source code and problems list
+- References for arguments also finds named arguments
 
 ##  0.11.16
 

robotcode/language_server/robotframework/diagnostics/entities.py

@@ -1,10 +1,13 @@
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Any, Optional, Tuple
+from typing import TYPE_CHECKING, Any, Optional, Tuple
 
 from ...common.lsp_types import Position, Range
 from ..utils.ast_utils import Token
 
+if TYPE_CHECKING:
+    from .library_doc import KeywordDoc
+
 
 @dataclass
 class SourceEntity:
@@ -195,6 +198,7 @@ def __hash__(self) -> int:
 @dataclass
 class ArgumentDefinition(VariableDefinition):
     type: VariableDefinitionType = VariableDefinitionType.ARGUMENT
+    keyword_doc: Optional["KeywordDoc"] = None
 
     def __hash__(self) -> int:
         return hash((type(self), self.name, self.type))

robotcode/language_server/robotframework/diagnostics/namespace.py

@@ -143,14 +143,17 @@ async def visit_Variable(self, node: ast.AST) -> None:  # noqa: N802
 
 
 class BlockVariableVisitor(AsyncVisitor):
-    def __init__(self, source: str, position: Optional[Position] = None, in_args: bool = True) -> None:
+    def __init__(
+        self, namespace: Namespace, source: str, position: Optional[Position] = None, in_args: bool = True
+    ) -> None:
         super().__init__()
-
+        self.namespace = namespace
         self.source = source
         self.position = position
         self.in_args = in_args
 
         self._results: Dict[str, VariableDefinition] = {}
+        self.current_kw_doc: Optional[KeywordDoc] = None
 
     async def get(self, model: ast.AST) -> List[VariableDefinition]:
 
@@ -164,15 +167,26 @@ async def visit(self, node: ast.AST) -> None:
         if self.position is None or self.position >= range_from_node(node).start:
             return await super().visit(node)
 
+    async def visit_Keyword(self, node: ast.AST) -> None:  # noqa: N802
+        try:
+            await self.generic_visit(node)
+        finally:
+            self.current_kw_doc = None
+
     async def visit_KeywordName(self, node: ast.AST) -> None:  # noqa: N802
         from robot.parsing.lexer.tokens import Token as RobotToken
         from robot.parsing.model.statements import KeywordName
         from robot.variables.search import VariableSearcher
 
+        from ..parts.model_helper import ModelHelperMixin
+
         n = cast(KeywordName, node)
         name_token = cast(Token, n.get_token(RobotToken.KEYWORD_NAME))
 
         if name_token is not None and name_token.value:
+            keyword = await ModelHelperMixin.get_keyword_definition_at_token(self.namespace, name_token)
+            self.current_kw_doc = keyword
+
             for variable_token in filter(
                 lambda e: e.type == RobotToken.VARIABLE,
                 tokenize_variables(name_token, identifiers="$", ignore_errors=True),
@@ -192,6 +206,7 @@ async def visit_KeywordName(self, node: ast.AST) -> None:  # noqa: N802
                         end_line_no=variable_token.lineno,
                         end_col_offset=variable_token.end_col_offset,
                         source=self.source,
+                        keyword_doc=self.current_kw_doc,
                     )
 
     def get_variable_token(self, token: Token) -> Optional[Token]:
@@ -240,6 +255,7 @@ async def visit_Arguments(self, node: ast.AST) -> None:  # noqa: N802
                             end_line_no=argument.lineno,
                             end_col_offset=argument.end_col_offset,
                             source=self.source,
+                            keyword_doc=self.current_kw_doc,
                         )
 
             except VariableError:
@@ -816,7 +832,10 @@ async def yield_variables(
             *[
                 (
                     await BlockVariableVisitor(
-                        self.source, position, isinstance(test_or_keyword_nodes[-1], Arguments) if nodes else False
+                        self,
+                        self.source,
+                        position,
+                        isinstance(test_or_keyword_nodes[-1], Arguments) if nodes else False,
                     ).get(test_or_keyword)
                 )
                 if test_or_keyword is not None

robotcode/language_server/robotframework/parts/references.py

@@ -225,7 +225,7 @@ async def find_variable_references(
     ) -> List[Location]:
         return (
             await create_sub_task(self.find_variable_references_in_file(document, variable, include_declaration))
-            if isinstance(variable, (ArgumentDefinition, LocalVariableDefinition))
+            if isinstance(variable, (LocalVariableDefinition))
             else await self._find_references_in_workspace(
                 document, self.find_variable_references_in_file, variable, include_declaration
             )
@@ -266,6 +266,8 @@ async def find_variable_references_in_file(
     ) -> List[Location]:
         from robot.parsing.lexer.tokens import Token as RobotToken
         from robot.parsing.model.blocks import Block, Keyword, Section, TestCase
+        from robot.parsing.model.statements import Fixture, KeywordCall
+        from robot.utils.escaping import split_from_equals
 
         namespace = await self.parent.documents_cache.get_namespace(doc)
         model = await self.parent.documents_cache.get_model(doc)
@@ -334,6 +336,26 @@ async def find_variable_references_in_file(
                     if found_variable == variable:
                         result.append(Location(str(doc.uri), range_from_token(sub_token)))
 
+            if (
+                isinstance(variable, ArgumentDefinition)
+                and isinstance(node, (KeywordCall, Fixture))
+                and variable.name_token
+            ):
+                kw_token = cast(
+                    Token,
+                    node.get_token(RobotToken.KEYWORD)
+                    if isinstance(node, KeywordCall)
+                    else node.get_token(RobotToken.NAME),
+                )
+                if kw_token and kw_token.value:
+                    kw = await namespace.find_keyword(kw_token.value)
+                    if kw is not None and kw == variable.keyword_doc:
+                        for arg in node.get_tokens(RobotToken.ARGUMENT):
+                            name, value = split_from_equals(arg.value)
+                            if value is not None and name == variable.name_token.value:
+                                name_token = RobotToken(RobotToken.ARGUMENT, name, arg.lineno, arg.col_offset)
+                                result.append(Location(str(doc.uri), range_from_token(name_token)))
+
         return result
 
     async def references_KeywordName(  # noqa: N802

tests/robotcode/language_server/robotframework/parts/data/.vscode/settings.json

@@ -13,7 +13,7 @@
         }
     },
     "robotcode.languageServer.args": [
-        // "--debugpy",
+        "--debugpy",
         // "--log",
         // "--log-level",
         // "TRACE",
@@ -30,5 +30,5 @@
     // "robotcode.debug.outputMessages": true
     //"python.analysis.diagnosticMode": "workspace"
     //"robotcode.robot.paths": ["./tests", "./tests1"]
-    "robotcode.analysis.diagnosticMode": "workspace"
+    "robotcode.analysis.diagnosticMode": "openFilesOnly"
 }

tests/robotcode/language_server/robotframework/parts/data/resources/firstresource.resource

@@ -13,3 +13,8 @@ some failing keyword
     Log    hello from failing
     Fail    ho
     Log    end failing
+
+
+a keyword with args
+    [Arguments]    ${a}    ${a long name}=    ${a_short_name}=default
+    No Operation

tests/robotcode/language_server/robotframework/parts/data/tests/document_highlight.robot

@@ -63,6 +63,7 @@ fifth
     a keyword with params
     another keyword with params    1
     again a keyword with params    1
+    a keyword with args    a=2    a long name=99    a_short_name=342
 
 *** Keywords ***
 a keyword with params

tests/robotcode/language_server/robotframework/parts/data/tests/variables.robot

@@ -152,6 +152,10 @@ templated with embedded not defined
 environmentvars
     log  ${%{TESTENV}.server.ip}  port=${%{TESTENV}.server.port}  # TODO
 
+named arguments
+    a keyword with loop    aaa=hello
+
+
 *** Keywords ***
 do something
     Log    hello from do something

tests/robotcode/language_server/robotframework/parts/test_document_highlight/test_document_highlight_robot_018_002_simple_variable_.yml

@@ -62,16 +62,16 @@ result:
   range:
     end:
       character: 35
-      line: 68
+      line: 69
     start:
       character: 30
-      line: 68
+      line: 69
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 44
-      line: 77
+      line: 78
     start:
       character: 39
-      line: 77
+      line: 78

tests/robotcode/language_server/robotframework/parts/test_document_highlight/test_document_highlight_robot_018_004_simple_variable_.yml

@@ -62,16 +62,16 @@ result:
   range:
     end:
       character: 35
-      line: 68
+      line: 69
     start:
       character: 30
-      line: 68
+      line: 69
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 44
-      line: 77
+      line: 78
     start:
       character: 39
-      line: 77
+      line: 78

tests/robotcode/language_server/robotframework/parts/test_document_highlight/test_document_highlight_robot_018_006_simple_variable_.yml

@@ -62,16 +62,16 @@ result:
   range:
     end:
       character: 35
-      line: 68
+      line: 69
     start:
       character: 30
-      line: 68
+      line: 69
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 44
-      line: 77
+      line: 78
     start:
       character: 39
-      line: 77
+      line: 78

tests/robotcode/language_server/robotframework/parts/test_document_highlight/test_document_highlight_robot_030_004_simple_keyword_call_.yml

@@ -26,61 +26,61 @@ result:
   range:
     end:
       character: 7
-      line: 71
+      line: 72
     start:
       character: 4
-      line: 71
+      line: 72
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 7
-      line: 73
+      line: 74
     start:
       character: 4
-      line: 73
+      line: 74
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 7
-      line: 81
+      line: 82
     start:
       character: 4
-      line: 81
+      line: 82
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 7
-      line: 83
+      line: 84
     start:
       character: 4
-      line: 83
+      line: 84
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 7
-      line: 91
+      line: 92
     start:
       character: 4
-      line: 91
+      line: 92
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 7
-      line: 93
+      line: 94
     start:
       character: 4
-      line: 93
+      line: 94
 - !DocumentHighlight
   kind: !DocumentHighlightKind 'TEXT'
   range:
     end:
       character: 7
-      line: 95
+      line: 96
     start:
       character: 4
-      line: 95
+      line: 96