feat(langserver): better support for indexed assignments

Author: d-biehl

package.json

@@ -548,6 +548,12 @@
           "variableEnd": [
             "punctuation.definition.variable.end.robotframework"
           ],
+          "expressionBegin": [
+            "punctuation.definition.expression.begin.robotframework"
+          ],
+          "expressionEnd": [
+            "punctuation.definition.expression.end.robotframework"
+          ],
           "escape": [
             "constant.character.escape.robotframework"
           ],

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

@@ -70,7 +70,7 @@
     iter_over_keyword_names_and_owners,
     token_in_range,
 )
-from robotcode.robot.utils.variables import is_variable, split_from_equals
+from robotcode.robot.utils.variables import split_from_equals
 
 from .protocol_part import RobotLanguageServerProtocolPart
 
@@ -116,6 +116,8 @@ class RobotSemTokenTypes(Enum):
     FOR_SEPARATOR = "forSeparator"
     VARIABLE_BEGIN = "variableBegin"
     VARIABLE_END = "variableEnd"
+    EXPRESSION_BEGIN = "expressionBegin"
+    EXPRESSION_END = "expressionEnd"
     VARIABLE_EXPRESSION = "variableExpression"
     ESCAPE = "escape"
     NAMESPACE = "namespace"
@@ -362,46 +364,8 @@ def generate_sem_sub_tokens(
                 sem_mod = {SemanticTokenModifiers.DOCUMENTATION}
 
             if token.type in [Token.VARIABLE, Token.ASSIGN]:
-                if is_variable(token.value, "$@&%"):
-                    if col_offset is None:
-                        col_offset = token.col_offset
-                    if length is None:
-                        length = token.end_col_offset - token.col_offset
-
-                    last_index = token.value.rfind("}")
-
-                    is_expr = token.value[1:2] == "{" and token.value[last_index - 1 : last_index] == "}"
-
-                    if last_index >= 0:
-                        yield SemTokenInfo(
-                            token.lineno,
-                            col_offset,
-                            3 if is_expr else 2,
-                            RobotSemTokenTypes.VARIABLE_BEGIN,
-                            sem_mod,
-                        )
-
-                        yield SemTokenInfo(
-                            token.lineno,
-                            col_offset + ((last_index - 1) if is_expr else last_index),
-                            2 if is_expr else 1,
-                            RobotSemTokenTypes.VARIABLE_END,
-                            sem_mod,
-                        )
-
-                        if length - last_index - 1 > 0:
-                            yield SemTokenInfo.from_token(
-                                token,
-                                sem_type,
-                                sem_mod,
-                                col_offset + last_index + 1,
-                                length - last_index - 1,
-                            )
-                    else:
-                        yield SemTokenInfo.from_token(token, sem_type, sem_mod)
-
-                else:
-                    yield SemTokenInfo.from_token(token, sem_type, sem_mod)
+                # TODO: maybe we can distinguish between local and global variables, by default all variables are global
+                pass
 
             elif token.type in [Token.KEYWORD, ROBOT_KEYWORD_INNER] or (
                 token.type == Token.NAME and cached_isinstance(node, Fixture, Template, TestTemplate)

packages/robot/src/robotcode/robot/config/model.py

@@ -2371,11 +2371,11 @@ class RobotConfig(RobotExtendBaseProfile):
 
             Examples:
             ```toml
-            default_profiles = "default"
+            default-profiles = "default"
             ```
 
             ```toml
-            default_profiles = ["default", "Firefox"]
+            default-profiles = ["default", "Firefox"]
             ```
             """
     )

packages/robot/src/robotcode/robot/diagnostics/entities.py

@@ -17,10 +17,9 @@
 
 from robot.parsing.lexer.tokens import Token
 from robotcode.core.lsp.types import Position, Range
-from robotcode.robot.utils.match import normalize
 
 from ..utils.ast import range_from_token
-from ..utils.variables import search_variable
+from ..utils.variables import VariableMatcher
 
 if TYPE_CHECKING:
     from robotcode.robot.diagnostics.library_doc import KeywordDoc, LibraryDoc
@@ -164,48 +163,6 @@ def __hash__(self) -> int:
         return hash((type(self), self.name, self.args))
 
 
-class InvalidVariableError(Exception):
-    pass
-
-
-class VariableMatcher:
-    def __init__(self, name: str) -> None:
-        self.name = name
-
-        match = search_variable(name, "$@&%", ignore_errors=True)
-
-        if match.base is None:
-            raise InvalidVariableError(f"Invalid variable '{name}'")
-
-        self.base = match.base
-
-        self.normalized_name = normalize(self.base)
-
-    def __eq__(self, o: object) -> bool:
-        if type(o) is VariableMatcher:
-            return o.normalized_name == self.normalized_name
-
-        if type(o) is str:
-            match = search_variable(o, "$@&%", ignore_errors=True)
-            base = match.base
-            if base is None:
-                return False
-
-            normalized = normalize(base)
-            return self.normalized_name == normalized
-
-        return False
-
-    def __hash__(self) -> int:
-        return hash(self.normalized_name)
-
-    def __str__(self) -> str:
-        return self.name
-
-    def __repr__(self) -> str:
-        return f"{type(self).__name__}(name={self.name!r})"
-
-
 class VariableDefinitionType(Enum):
     VARIABLE = "suite variable"
     LOCAL_VARIABLE = "local variable"

packages/robot/src/robotcode/robot/diagnostics/errors.py

@@ -43,3 +43,4 @@ class Error:
     VARIABLE_OVERRIDDEN = "VariableOverridden"
     MODEL_ERROR = "ModelError"
     TOKEN_ERROR = "TokenError"
+    ASSIGN_MARK_ALLOWED_ONLY_ON_LAST_VAR = "AssignmentMarkAllowedOnlyOnLastVariable"

packages/robot/src/robotcode/robot/diagnostics/model_helper.py

@@ -253,7 +253,7 @@ def get_namespace_info_from_keyword_token(
 
         return lib_entry, kw_namespace
 
-    match_extended = re.compile(
+    MATCH_EXTENDED = re.compile(
         r"""
     (.+?)          # base name (group 1)
     ([^\s\w].+)    # extended part (group 2)
@@ -500,9 +500,9 @@ def iter_token(
                     and sub_token.value[1:2] == "{"
                     and sub_token.value[-1:] == "}"
                 ):
-                    match = cls.match_extended.match(name[2:-1])
-                    if match is not None:
-                        base_name, _ = match.groups()
+                    extended_match = cls.MATCH_EXTENDED.match(name[2:-1])
+                    if extended_match is not None:
+                        base_name, _ = extended_match.groups()
                         name = f"{name[0]}{{{base_name.strip()}}}"
                         var = namespace.find_variable(
                             name,

packages/robot/src/robotcode/robot/diagnostics/namespace.py

@@ -55,6 +55,8 @@
 from ..utils.stubs import Languages
 from ..utils.variables import (
     BUILTIN_VARIABLES,
+    InvalidVariableError,
+    VariableMatcher,
     is_scalar_assign,
     is_variable,
     search_variable,
@@ -66,7 +68,6 @@
     EnvironmentVariableDefinition,
     GlobalVariableDefinition,
     Import,
-    InvalidVariableError,
     LibraryEntry,
     LibraryImport,
     LocalVariableDefinition,
@@ -76,7 +77,6 @@
     TestCaseDefinition,
     TestVariableDefinition,
     VariableDefinition,
-    VariableMatcher,
     VariablesEntry,
     VariablesImport,
 )