feat(debugger): simple keyword completion in debugger

Author: d-biehl

packages/debugger/src/robotcode/debugger/dap_types.py

@@ -1092,3 +1092,67 @@ class SetExceptionBreakpointsResponseBody(Model):
 @dataclass
 class SetExceptionBreakpointsResponse(Response):
     body: Optional[SetExceptionBreakpointsResponseBody] = None
+
+
+@dataclass
+class _CompletionsRequest:
+    arguments: CompletionsArguments
+
+
+@dataclass
+class CompletionsRequest(Request, _CompletionsRequest):
+    arguments: CompletionsArguments = field()
+    command: str = "completions"
+
+
+@dataclass
+class CompletionsArguments(Model):
+    text: str
+    column: int
+    line: Optional[int] = None
+    frame_id: Optional[int] = None
+
+
+class CompletionItemType(Enum):
+    METHOD = "method"
+    FUNCTION = "function"
+    CONSTRUCTOR = "constructor"
+    FIELD = "field"
+    VARIABLE = "variable"
+    CLASS = "class"
+    INTERFACE = "interface"
+    MODULE = "module"
+    PROPERTY = "property"
+    UNIT = "unit"
+    VALUE = "value"
+    ENUM = "enum"
+    KEYWORD = "keyword"
+    SNIPPET = "snippet"
+    TEXT = "text"
+    COLOR = "color"
+    FILE = "file"
+    REFERENCE = "reference"
+    CUSTOMCOLOR = "customcolor"
+
+
+@dataclass
+class CompletionItem(Model):
+    label: str
+    text: Optional[str] = None
+    sort_text: Optional[str] = None
+    detail: Optional[str] = None
+    type: Optional[CompletionItemType] = None
+    start: Optional[int] = None
+    length: Optional[int] = None
+    selection_start: Optional[int] = None
+    selection_length: Optional[int] = None
+
+
+@dataclass
+class CompletionsResponseBody(Model):
+    targets: List[CompletionItem]
+
+
+@dataclass
+class CompletionsResponse(Response):
+    body: Optional[CompletionsResponseBody] = None

packages/debugger/src/robotcode/debugger/debugger.py

@@ -40,6 +40,8 @@
 
 from .dap_types import (
     Breakpoint,
+    CompletionItem,
+    CompletionItemType,
     ContinuedEvent,
     ContinuedEventBody,
     EvaluateArgumentContext,
@@ -289,9 +291,8 @@ def state(self) -> State:
 
     @state.setter
     def state(self, value: State) -> None:
-        if self._state == value:
-            # if state is not changed, do nothing and wait a little bit to avoid busy loop
-            time.sleep(0.01)
+        # if state is changed, do nothing and wait a little bit to avoid busy loop
+        time.sleep(0.01)
 
         self._state = value
 
@@ -1516,3 +1517,63 @@ def set_exception_breakpoints(
                     result.append(Breakpoint(verified=False))
 
         return result or None
+
+    def completions(
+        self, text: str, column: int, line: Optional[int] = None, frame_id: Optional[int] = None
+    ) -> List[CompletionItem]:
+        if self.expression_mode:
+            return []
+
+        stack_frame = next((v for v in self.full_stack_frames if v.id == frame_id), None)
+
+        evaluate_context = stack_frame.context() if stack_frame else None
+
+        if evaluate_context is None:
+            evaluate_context = EXECUTION_CONTEXTS.current
+
+        if evaluate_context is None:
+            return []
+
+        result = []
+
+        for library in evaluate_context.namespace._kw_store.libraries.values():
+            result.append(
+                CompletionItem(
+                    label=library.name,
+                    text=library.name,
+                    sort_text=f"010_{library.name}",
+                    type=CompletionItemType.MODULE,
+                )
+            )
+            for kw in library.handlers:
+                result.append(
+                    CompletionItem(
+                        label=kw.name,
+                        text=kw.name,
+                        sort_text=f"001_{kw.name}",
+                        type=CompletionItemType.FUNCTION,
+                        detail=kw.shortdoc,
+                    )
+                )
+
+        for resource in evaluate_context.namespace._kw_store.resources.values():
+            result.append(
+                CompletionItem(
+                    label=resource.name,
+                    text=resource.name,
+                    sort_text=f"010_{resource.name}",
+                    type=CompletionItemType.MODULE,
+                )
+            )
+            for kw in resource.handlers:
+                result.append(
+                    CompletionItem(
+                        label=kw.name,
+                        text=kw.name,
+                        sort_text=f"001_{kw.name}",
+                        type=CompletionItemType.FUNCTION,
+                        detail=kw.shortdoc,
+                    )
+                )
+
+        return result

packages/debugger/src/robotcode/debugger/launcher/server.py

@@ -131,6 +131,7 @@ async def _initialize(self, arguments: InitializeRequestArguments, *args: Any, *
             ],
             supports_exception_options=True,
             supports_exception_filter_options=True,
+            supports_completions_request=True,
         )
 
     @rpc_method(name="launch", param_type=LaunchRequestArguments)

packages/debugger/src/robotcode/debugger/server.py

@@ -11,6 +11,8 @@
 from .dap_types import (
     AttachRequestArguments,
     Capabilities,
+    CompletionsArguments,
+    CompletionsResponseBody,
     ConfigurationDoneArguments,
     ContinueArguments,
     ContinueResponseBody,
@@ -178,6 +180,7 @@ async def _initialize(self, arguments: InitializeRequestArguments, *args: Any, *
             ],
             supports_exception_options=True,
             supports_exception_filter_options=True,
+            supports_completions_request=True,
         )
 
     @rpc_method(name="attach", param_type=AttachRequestArguments)
@@ -376,6 +379,20 @@ async def _set_exception_breakpoints(
         )
         return SetExceptionBreakpointsResponseBody(breakpoints=result) if result else None
 
+    @rpc_method(name="completions", param_type=CompletionsArguments)
+    async def _completions(
+        self,
+        arguments: CompletionsArguments,
+        text: str,
+        column: int,
+        line: Optional[int] = None,
+        frame_id: Optional[int] = None,
+        *args: Any,
+        **kwargs: Any,
+    ) -> CompletionsResponseBody:
+        result = Debugger.instance().completions(text, column, line, frame_id)
+        return CompletionsResponseBody(targets=result)
+
 
 class DebugAdapterServer(JsonRPCServer[DebugAdapterServerProtocol]):
     def __init__(