[lldb][dap] always add column field in StackFrame body

[xujuntwt95329]

The column field is mandatory in StackTraceResponse, otherwise the debugger client may raise error (e.g. VSCode can't correctly open an editor without the column field)

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Xu Jun (xujuntwt95329)

Changes

The column field is mandatory in StackTraceResponse, otherwise the debugger client may raise error (e.g. VSCode can't correctly open an editor without the column field)

---

Full diff: https://github.com/llvm/llvm-project/pull/73393.diff

1 Files Affected:

• (modified) lldb/tools/lldb-dap/JSONUtils.cpp (+1-2)

diff --git a/lldb/tools/lldb-dap/JSONUtils.cpp b/lldb/tools/lldb-dap/JSONUtils.cpp
index 03a43f9da87f241..e65b05243df7066 100644
--- a/lldb/tools/lldb-dap/JSONUtils.cpp
+++ b/lldb/tools/lldb-dap/JSONUtils.cpp
@@ -817,8 +817,7 @@ llvm::json::Value CreateStackFrame(lldb::SBFrame &frame) {
     if (line && line != LLDB_INVALID_LINE_NUMBER)
       object.try_emplace("line", line);
     auto column = line_entry.GetColumn();
-    if (column && column != LLDB_INVALID_COLUMN_NUMBER)
-      object.try_emplace("column", column);
+    object.try_emplace("column", column);
   } else {
     object.try_emplace("line", 0);
     object.try_emplace("column", 0);

[bulbazord]

Lgtm thanks!

[walter-erquinigo]

Thanks!

[semensanyok]

Bug confirmed. Its causing exception for nvim-dap plugin which expects column required in specification, but not sent by server.
pr contains log message, showing missing column case. closed by maintainer:

Thanks for the PR, but I'm not going to merge this. column is a required property of a StackFrame according to the specification:

https://microsoft.github.io/debug-adapter-protocol/specification#Types_StackFrame

This needs to be fixed in the debug adapter.

mfussenegger/nvim-dap#1195

[walter-erquinigo]

@semensanyok, I've just merged this PR because it's very straightforward. If it breaks the buildbots, I'll just revert it and let the original author fix it.

[CheapMeow]

It still has bug in VSCode: The editor could not be opened due to an unexpected error: Invalid arguments

My llvm version is

lldb version 18.1.8
clang version 18.1.8
Target: x86_64-pc-windows-msvc
Thread model: posix
InstalledDir: E:\software\LLVM\bin
Found HIP installation: E:\software\AMD\ROCm\6.1\, version 6.1.40252

platform is

microsoft windows 11 professional

[clayborg]

I wonder if this needs to default to column 1? We might end up adding column zero.

  /**
   * Start position of the range covered by the stack frame. It is measured in
   * UTF-16 code units and the client capability `columnsStartAt1` determines
   * whether it is 0- or 1-based. If attribute `source` is missing or doesn't
   * exist, `column` is 0 and should be ignored by the client.
   */
  column: number;

So if we return zero, it might cause a problem as the InitializeRequestArguments contains:

  /**
   * If true all column numbers are 1-based (default).
   */
  columnsStartAt1?: boolean;

1 is the default, and if we return zero, this could cause a problem?