llvm-project/lldb/tools/lldb-dap/Protocol/ProtocolRequests.cpp
John Harrison 2d30a60e9f
[lldb-dap] Adding support for cancelling a request. (#130169)
Adding support for cancelling requests.

There are two forms of request cancellation.

* Preemptively cancelling a request that is in the queue.
* Actively cancelling the in progress request as a best effort attempt
using `SBDebugger.RequestInterrupt()`.
2025-04-14 08:29:02 -07:00

108 lines
3.7 KiB
C++

//===-- ProtocolRequests.cpp ----------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "Protocol/ProtocolRequests.h"
#include "DAP.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/JSON.h"
#include <utility>
using namespace llvm;
namespace lldb_dap::protocol {
bool fromJSON(const llvm::json::Value &Params, CancelArguments &CA,
llvm::json::Path P) {
llvm::json::ObjectMapper O(Params, P);
return O && O.mapOptional("requestId", CA.requestId) &&
O.mapOptional("progressId", CA.progressId);
}
bool fromJSON(const json::Value &Params, DisconnectArguments &DA,
json::Path P) {
json::ObjectMapper O(Params, P);
return O && O.mapOptional("restart", DA.restart) &&
O.mapOptional("terminateDebuggee", DA.terminateDebuggee) &&
O.mapOptional("suspendDebuggee", DA.suspendDebuggee);
}
bool fromJSON(const llvm::json::Value &Params, PathFormat &PF,
llvm::json::Path P) {
auto rawPathFormat = Params.getAsString();
if (!rawPathFormat) {
P.report("expected a string");
return false;
}
std::optional<PathFormat> pathFormat =
StringSwitch<std::optional<PathFormat>>(*rawPathFormat)
.Case("path", ePatFormatPath)
.Case("uri", ePathFormatURI)
.Default(std::nullopt);
if (!pathFormat) {
P.report("unexpected value, expected 'path' or 'uri'");
return false;
}
PF = *pathFormat;
return true;
}
static const llvm::StringMap<ClientFeature> ClientFeatureByKey{
{"supportsVariableType", eClientFeatureVariableType},
{"supportsVariablePaging", eClientFeatureVariablePaging},
{"supportsRunInTerminalRequest", eClientFeatureRunInTerminalRequest},
{"supportsMemoryReferences", eClientFeatureMemoryReferences},
{"supportsProgressReporting", eClientFeatureProgressReporting},
{"supportsInvalidatedEvent", eClientFeatureInvalidatedEvent},
{"supportsMemoryEvent", eClientFeatureMemoryEvent},
{"supportsArgsCanBeInterpretedByShell",
eClientFeatureArgsCanBeInterpretedByShell},
{"supportsStartDebuggingRequest", eClientFeatureStartDebuggingRequest},
{"supportsANSIStyling", eClientFeatureANSIStyling}};
bool fromJSON(const llvm::json::Value &Params, InitializeRequestArguments &IRA,
llvm::json::Path P) {
json::ObjectMapper OM(Params, P);
if (!OM)
return false;
const json::Object *O = Params.getAsObject();
for (auto &kv : ClientFeatureByKey)
if (std::optional<bool> v = O->getBoolean(kv.first()); v && *v)
IRA.supportedFeatures.insert(kv.second);
return OM.mapOptional("adatperID", IRA.adatperID) &&
OM.mapOptional("clientID", IRA.clientID) &&
OM.mapOptional("clientName", IRA.clientName) &&
OM.mapOptional("locale", IRA.locale) &&
OM.mapOptional("linesStartAt1", IRA.linesStartAt1) &&
OM.mapOptional("columnsStartAt1", IRA.columnsStartAt1) &&
OM.mapOptional("pathFormat", IRA.pathFormat) &&
OM.mapOptional("$__lldb_sourceInitFile", IRA.lldbExtSourceInitFile);
}
bool fromJSON(const json::Value &Params, SourceArguments &SA, json::Path P) {
json::ObjectMapper O(Params, P);
return O && O.mapOptional("source", SA.source) &&
O.map("sourceReference", SA.sourceReference);
}
json::Value toJSON(const SourceResponseBody &SA) {
json::Object Result{{"content", SA.content}};
if (SA.mimeType)
Result.insert({"mimeType", SA.mimeType});
return std::move(Result);
}
} // namespace lldb_dap::protocol