[V2] gdb/dap - Add CompletionsRequest
Checks
Commit Message
Use GDB/MI command "-complete" to implement.
Co-authored-by: Simon Farre <simon.farre.cx@gmail.com>
Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=31140
---
gdb/data-directory/Makefile.in | 1 +
gdb/python/lib/gdb/dap/__init__.py | 1 +
gdb/python/lib/gdb/dap/completions.py | 50 +++++++++++++++++++++++++++
gdb/python/lib/gdb/dap/server.py | 21 +++++++++--
4 files changed, 71 insertions(+), 2 deletions(-)
create mode 100644 gdb/python/lib/gdb/dap/completions.py
Comments
>>>>> oltolm <oleg.tolmatcev@gmail.com> writes:
> Use GDB/MI command "-complete" to implement.
> Co-authored-by: Simon Farre <simon.farre.cx@gmail.com>
> Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=31140
Thanks. This looks pretty good. I had a couple of minor comments.
> +def completions(
> + *,
> + frameId: Optional[int] = None,
frameId isn't used. I suspect it would be enough to add this:
if frameId is not None:
select_frame(frameId)
> + mi_result = exec_mi_and_log("-complete", text)
This does command completion, which seems fine. But I wonder if this
should be documented in the "Debugger Adapter Protocol" node?
Either way, I think a new DAP request should get a NEWS entry.
Finally, I ran pre-commit on the patch and isort changed the imports.
Tom
@@ -97,6 +97,7 @@ PYTHON_FILE_LIST = \
gdb/command/xmethods.py \
gdb/dap/breakpoint.py \
gdb/dap/bt.py \
+ gdb/dap/completions.py \
gdb/dap/disassemble.py \
gdb/dap/evaluate.py \
gdb/dap/events.py \
@@ -27,6 +27,7 @@ from . import startup
# server object. "F401" is the flake8 "imported but unused" code.
from . import breakpoint # noqa: F401
from . import bt # noqa: F401
+from . import completions # noqa: F401
from . import disassemble # noqa: F401
from . import evaluate # noqa: F401
from . import launch # noqa: F401
new file mode 100644
@@ -0,0 +1,50 @@
+# Copyright 2024 Free Software Foundation, Inc.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from .server import request, capability, import_line, import_column
+from .startup import exec_mi_and_log
+
+from typing import Optional
+
+
+@request("completions")
+@capability("supportsCompletionsRequest")
+@capability("completionTriggerCharacters", [" ", "."])
+def completions(
+ *,
+ frameId: Optional[int] = None,
+ text: str,
+ column: int,
+ line: Optional[int] = None,
+ **extra
+):
+ column = import_column(column)
+ if line is None:
+ line = 1
+ else:
+ line = import_line(line)
+ for i, l in enumerate(text.splitlines()):
+ if i + 1 == line:
+ text = l
+ break
+ text = text[: column - 1]
+ mi_result = exec_mi_and_log("-complete", text)
+ result = []
+ if "completion" in mi_result:
+ completion = mi_result["completion"]
+ result.append({"label": completion, "length": len(completion)})
+ for match in mi_result["matches"]:
+ result.append({"label": match, "length": len(match)})
+ return {"targets": result}
@@ -49,6 +49,7 @@ _server = None
# These are set by the initialize request and are used when rewriting
# line or column numbers.
_lines_start_at_1 = False
+_columns_start_at_1 = False
class DeferredRequest:
@@ -593,6 +594,8 @@ def initialize(**args):
_server.send_event_later("initialized")
global _lines_start_at_1
_lines_start_at_1 = client_bool_capability("linesStartAt1", True)
+ global _columns_start_at_1
+ _columns_start_at_1 = client_bool_capability("columnsStartAt1", True)
return _capabilities.copy()
@@ -698,7 +701,7 @@ def send_gdb_with_response(fn):
return val
-def export_line(line):
+def export_line(line: int) -> int:
"""Rewrite LINE according to client capability.
This applies the linesStartAt1 capability as needed,
when sending a line number from gdb to the client."""
@@ -710,7 +713,7 @@ def export_line(line):
return line
-def import_line(line):
+def import_line(line: int) -> int:
"""Rewrite LINE according to client capability.
This applies the linesStartAt1 capability as needed,
when the client sends a line number to gdb."""
@@ -720,3 +723,17 @@ def import_line(line):
# the client starts at 0.
line = line + 1
return line
+
+
+def export_column(column: int) -> int:
+ """Rewrite COLUMN according to client capability.
+ This applies the columnsStartAt1 capability as needed,
+ when sending a column number from gdb to the client."""
+ return column if _columns_start_at_1 else column - 1
+
+
+def import_column(column: int) -> int:
+ """Rewrite COLUMN according to client capability.
+ This applies the columnsStartAt1 capability as needed,
+ when the client sends a column number to gdb."""
+ return column if _columns_start_at_1 else column + 1