[lldb-dap] Migrating DAP 'initialize' to new typed RequestHandler.

This adds new types and helpers to support the 'initialize' request with the new typed RequestHandler. While working on this I found there were a few cases where we incorrectly treated initialize arguments as capabilities. The new `lldb_dap::protocol::InitializeRequestArguments` and `lldb_dap::protocol::Capabilities` uncovered the inconsistencies.

Author: ashgti

lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py

@@ -776,7 +776,8 @@ def request_initialize(self, sourceInitFile):
                 "supportsVariablePaging": True,
                 "supportsVariableType": True,
                 "supportsStartDebuggingRequest": True,
-                "sourceInitFile": sourceInitFile,
+                "supportsProgressReporting": True,
+                "$__lldb_sourceInitFile": sourceInitFile,
             },
         }
         response = self.send_recv(command_dict)
@@ -1261,7 +1262,7 @@ def launch(cls, /, executable, env=None, log_file=None, connection=None):
         expected_prefix = "Listening for: "
         out = process.stdout.readline().decode()
         if not out.startswith(expected_prefix):
-            self.process.kill()
+            process.kill()
             raise ValueError(
                 "lldb-dap failed to print listening address, expected '{}', got '{}'".format(
                     expected_prefix, out

lldb/test/API/tools/lldb-dap/launch/TestDAP_launch.py

@@ -524,8 +524,7 @@ def test_version(self):
 
         # The first line is the prompt line like "(lldb) version", so we skip it.
         version_eval_output_without_prompt_line = version_eval_output.splitlines()[1:]
-        lldb_json = self.dap_server.get_initialize_value("__lldb")
-        version_string = lldb_json["version"]
+        version_string = self.dap_server.get_initialize_value("$__lldb_version")
         self.assertEqual(
             version_eval_output_without_prompt_line,
             version_string.splitlines(),

lldb/tools/lldb-dap/DAP.cpp

@@ -14,6 +14,7 @@
 #include "LLDBUtils.h"
 #include "OutputRedirector.h"
 #include "Protocol/ProtocolBase.h"
+#include "Protocol/ProtocolTypes.h"
 #include "Transport.h"
 #include "lldb/API/SBBreakpoint.h"
 #include "lldb/API/SBCommandInterpreter.h"
@@ -1144,31 +1145,137 @@ lldb::SBValue Variables::FindVariable(uint64_t variablesReference,
   return variable;
 }
 
-llvm::StringMap<bool> DAP::GetCapabilities() {
-  llvm::StringMap<bool> capabilities;
+static void mergeCapabilities(protocol::Capabilities &into,
+                              const protocol::Capabilities &from) {
+  if (from.supportsConfigurationDoneRequest)
+    into.supportsConfigurationDoneRequest =
+        *from.supportsConfigurationDoneRequest;
+  if (from.supportsFunctionBreakpoints)
+    into.supportsFunctionBreakpoints = *from.supportsFunctionBreakpoints;
+  if (from.supportsConditionalBreakpoints)
+    into.supportsConditionalBreakpoints = *from.supportsConditionalBreakpoints;
+  if (from.supportsHitConditionalBreakpoints)
+    into.supportsHitConditionalBreakpoints =
+        *from.supportsHitConditionalBreakpoints;
+  if (from.supportsEvaluateForHovers)
+    into.supportsEvaluateForHovers = *from.supportsEvaluateForHovers;
+  if (from.exceptionBreakpointFilters)
+    into.exceptionBreakpointFilters = *from.exceptionBreakpointFilters;
+  if (from.supportsStepBack)
+    into.supportsStepBack = *from.supportsStepBack;
+  if (from.supportsSetVariable)
+    into.supportsSetVariable = *from.supportsSetVariable;
+  if (from.supportsRestartFrame)
+    into.supportsRestartFrame = *from.supportsRestartFrame;
+  if (from.supportsGotoTargetsRequest)
+    into.supportsGotoTargetsRequest = *from.supportsGotoTargetsRequest;
+  if (from.supportsStepInTargetsRequest)
+    into.supportsStepInTargetsRequest = *from.supportsStepInTargetsRequest;
+  if (from.supportsCompletionsRequest)
+    into.supportsCompletionsRequest = *from.supportsCompletionsRequest;
+  if (from.completionTriggerCharacters)
+    into.completionTriggerCharacters = *from.completionTriggerCharacters;
+  if (from.supportsModulesRequest)
+    into.supportsModulesRequest = *from.supportsModulesRequest;
+  if (from.additionalModuleColumns)
+    into.additionalModuleColumns = *from.additionalModuleColumns;
+  if (from.supportedChecksumAlgorithms)
+    into.supportedChecksumAlgorithms = *from.supportedChecksumAlgorithms;
+  if (from.supportsRestartRequest)
+    into.supportsRestartRequest = *from.supportsRestartRequest;
+  if (from.supportsExceptionOptions)
+    into.supportsExceptionOptions = *from.supportsExceptionOptions;
+  if (from.supportsValueFormattingOptions)
+    into.supportsValueFormattingOptions = *from.supportsValueFormattingOptions;
+  if (from.supportsExceptionInfoRequest)
+    into.supportsExceptionInfoRequest = *from.supportsExceptionInfoRequest;
+  if (from.supportTerminateDebuggee)
+    into.supportTerminateDebuggee = *from.supportTerminateDebuggee;
+  if (from.supportSuspendDebuggee)
+    into.supportSuspendDebuggee = *from.supportSuspendDebuggee;
+  if (from.supportsDelayedStackTraceLoading)
+    into.supportsDelayedStackTraceLoading =
+        *from.supportsDelayedStackTraceLoading;
+  if (from.supportsLoadedSourcesRequest)
+    into.supportsLoadedSourcesRequest = *from.supportsLoadedSourcesRequest;
+  if (from.supportsLogPoints)
+    into.supportsLogPoints = *from.supportsLogPoints;
+  if (from.supportsTerminateThreadsRequest)
+    into.supportsTerminateThreadsRequest =
+        *from.supportsTerminateThreadsRequest;
+  if (from.supportsSetExpression)
+    into.supportsSetExpression = *from.supportsSetExpression;
+  if (from.supportsTerminateRequest)
+    into.supportsTerminateRequest = *from.supportsTerminateRequest;
+  if (from.supportsDataBreakpoints)
+    into.supportsDataBreakpoints = *from.supportsDataBreakpoints;
+  if (from.supportsReadMemoryRequest)
+    into.supportsReadMemoryRequest = *from.supportsReadMemoryRequest;
+  if (from.supportsWriteMemoryRequest)
+    into.supportsWriteMemoryRequest = *from.supportsWriteMemoryRequest;
+  if (from.supportsDisassembleRequest)
+    into.supportsDisassembleRequest = *from.supportsDisassembleRequest;
+  if (from.supportsCancelRequest)
+    into.supportsCancelRequest = *from.supportsCancelRequest;
+  if (from.supportsBreakpointLocationsRequest)
+    into.supportsBreakpointLocationsRequest =
+        *from.supportsBreakpointLocationsRequest;
+  if (from.supportsClipboardContext)
+    into.supportsClipboardContext = *from.supportsClipboardContext;
+  if (from.supportsSteppingGranularity)
+    into.supportsSteppingGranularity = *from.supportsSteppingGranularity;
+  if (from.supportsInstructionBreakpoints)
+    into.supportsInstructionBreakpoints = *from.supportsInstructionBreakpoints;
+  if (from.supportsExceptionFilterOptions)
+    into.supportsExceptionFilterOptions = *from.supportsExceptionFilterOptions;
+  if (from.supportsSingleThreadExecutionRequests)
+    into.supportsSingleThreadExecutionRequests =
+        *from.supportsSingleThreadExecutionRequests;
+  if (from.supportsDataBreakpointBytes)
+    into.supportsDataBreakpointBytes = *from.supportsDataBreakpointBytes;
+  if (from.breakpointModes)
+    into.breakpointModes = *from.breakpointModes;
+  if (from.supportsANSIStyling)
+    into.supportsANSIStyling = *from.supportsANSIStyling;
+}
+
+protocol::Capabilities DAP::GetCapabilities() {
+  protocol::Capabilities capabilities;
 
   // Supported capabilities.
-  capabilities["supportTerminateDebuggee"] = true;
-  capabilities["supportsDataBreakpoints"] = true;
-  capabilities["supportsDelayedStackTraceLoading"] = true;
-  capabilities["supportsEvaluateForHovers"] = true;
-  capabilities["supportsExceptionOptions"] = true;
-  capabilities["supportsLogPoints"] = true;
-  capabilities["supportsProgressReporting"] = true;
-  capabilities["supportsSteppingGranularity"] = true;
-  capabilities["supportsValueFormattingOptions"] = true;
+  capabilities.supportTerminateDebuggee = true;
+  capabilities.supportsDataBreakpoints = true;
+  capabilities.supportsDelayedStackTraceLoading = true;
+  capabilities.supportsEvaluateForHovers = true;
+  capabilities.supportsExceptionOptions = true;
+  capabilities.supportsLogPoints = true;
+  capabilities.supportsSteppingGranularity = true;
+  capabilities.supportsValueFormattingOptions = true;
 
   // Unsupported capabilities.
-  capabilities["supportsGotoTargetsRequest"] = false;
-  capabilities["supportsLoadedSourcesRequest"] = false;
-  capabilities["supportsRestartFrame"] = false;
-  capabilities["supportsStepBack"] = false;
+  capabilities.supportsGotoTargetsRequest = false;
+  capabilities.supportsLoadedSourcesRequest = false;
+  capabilities.supportsRestartFrame = false;
+  capabilities.supportsStepBack = false;
 
   // Capabilities associated with specific requests.
-  for (auto &kv : request_handlers) {
-    for (auto &request_kv : kv.second->GetCapabilities())
-      capabilities[request_kv.getKey()] = request_kv.getValue();
-  }
+  for (auto &kv : request_handlers)
+    mergeCapabilities(capabilities, kv.second->GetCapabilities());
+
+  // Available filters or options for the setExceptionBreakpoints request.
+  std::vector<protocol::ExceptionBreakpointsFilter> filters;
+  for (const auto &exc_bp : *exception_breakpoints)
+    filters.emplace_back(CreateExceptionBreakpointFilter(exc_bp));
+  capabilities.exceptionBreakpointFilters = std::move(filters);
+
+  std::vector<std::string> completion_characters;
+  completion_characters.emplace_back(".");
+  completion_characters.emplace_back(" ");
+  completion_characters.emplace_back("\t");
+  capabilities.completionTriggerCharacters = std::move(completion_characters);
+
+  // Put in non-DAP specification lldb specific information.
+  capabilities.lldbVersion = debugger.GetVersionString();
 
   return capabilities;
 }

lldb/tools/lldb-dap/DAP.h

@@ -16,6 +16,7 @@
 #include "OutputRedirector.h"
 #include "ProgressEvent.h"
 #include "Protocol/ProtocolBase.h"
+#include "Protocol/ProtocolTypes.h"
 #include "SourceBreakpoint.h"
 #include "Transport.h"
 #include "lldb/API/SBBroadcaster.h"
@@ -180,6 +181,7 @@ struct DAP {
   bool enable_auto_variable_summaries;
   bool enable_synthetic_child_debugging;
   bool display_extended_backtrace;
+  bool supports_run_in_terminal_request;
   // The process event thread normally responds to process exited events by
   // shutting down the entire adapter. When we're restarting, we keep the id of
   // the old process here so we can detect this case and keep running.
@@ -363,8 +365,8 @@ struct DAP {
     request_handlers[Handler::GetCommand()] = std::make_unique<Handler>(*this);
   }
 
-  /// Return a key-value list of capabilities.
-  llvm::StringMap<bool> GetCapabilities();
+  /// The set of capablities supported by this adapter.
+  protocol::Capabilities GetCapabilities();
 
   /// Debuggee will continue from stopped state.
   void WillContinue() { variables.Clear(); }