vkdoom_m/src/common/scripting/dap/Utilities.h
Nikita 45ac7c1d9e
ZScript DAP Debug server (#3009)
* Add STL-standard type traits and functions to TMap to enable for loop iteration

* add third-party range-map library

I have e-mailed the author for clarifcation on the license, will update this when they respond

* vcpkg: Add cppdap and eventpp libraries, update baseline

* DAP implementation

* Add `FileSystem::FileHash()` to get the CRC32 hash

* add `starting_offset` param to `VMDisasm()` for debugger disassembly view

Defaults to `0`, should not change output if it's not set

* Add `VMFrameStack::HasFrames()` to prevent assertions when inspecting in the debugger

* Add `PC` field to VMFrame, ensure that it is updated whenever vm increments/decrements the pc

Does not change alignment, the offsets used in VMFrame still work
We need this for the debugger because we otherwise have no way to get the pc; it was a local in `ExecScriptFunc()`

* `ZCCCompiler::CreateClassTypes()`: ensure SourceLumpName is set for classes derived from non-native classes

* start debug server in d_main, add `vm_debug` cvars and `-debug` CLI arg

* Add documentation for `vm_debug` cvars

* vm_exec: Add debugger hooks for instruction execution events

* c_console: Add debugger hooks for logging events in `PrintString`

* add `.cache/` to gitignore

* vendor cppdap on main @ 6464cd7

Patches:
removed .gitmodules (submodules were thirdparty/json, thirdparty/googletest)
removed thirdparty/googletest, not needed
removed thirdparty/json/docs, thirdparty/json/test, thirdparty/json/benchmarks to prevent massive bloat

* vendor eventpp on master @ 1224dd6

* build: use internal cppdap and eventpp by default

* dap: fix Binary::GetFunctionLineRange()

* fix bug in range_map::find_ranges

* make Binary dap::Source dynamic

* cache source code upon retrieval

* refactor Binary into a class, cleanup PexCache

* fix ending session gracefully

* d_main: Stop debug server in D_Cleanup()

* Fix connecting to debugger when session already started

* cleanup unused stuff in ZScriptDebugger

* always send TerminateEvents on disconnect if initialized

* tweak color display

* Don't cache disassembly lines when scanning scripts

* Cache nodes when getting runtime state

* WIP display locals

* Fix display of static arrays

* Ensure names display in proper order

* dap: Fix struct locals display, add args display

* Support `start` parameter

* Support `filter` parameter

* remove struct unbound native data display

Practically useless for debugging zscript and didn't work properly anyway

* d_main: fix vm_jit and vm_jit not being disabled soon enough

* support breaking on abort exceptions

* dap: refactor game event emitter functions into seperate header

* dap: show native functions on stack

* dap: Remove "Native" from exception handling, simplify exception event emit

* dap: add instruction breakpoints

* dap: fix display of locals not in scope yet

* dap: Make disassembly view display invalid instructions for non-code addresses

* dap: remove dot initializers

* dap: fix local structs in scope

* dap: don't parse the non-used options in the launch/attach requests

* dap: fix local struct view

* dap: Fix displaying objects that aren't their actual types

* dap: Fix action and state handling

* dap: stack display view

* dap: fix object display view

* d_dehacked: set qualified name in addition to the printable name

* dap: fix displaying breakpoint errors when script isn't loaded

* dap: remove debug print

* dap: Display parameter names

* dap: Turn down verbosity of logging

* dap: fix disassembly view

* dap: fix performance problems with arrays

* c_console: emit event only if not PRINT_NODAPEVENT

* dap: improve logging

* dap: update upstream cppdap library to fix deadlocks on no bind

* dap: Fix ending session on client socket closed

* dap: prevent DebugServer.h from pulling in `dap` and `ZScriptDebugger.h`

* dap: fix pause event not being emitted on pause

* dap: remove eventpp emitters, way too slow

* Remove eventpp dependency

* dap: Display correct register names

* dap: Show special inits in registers

* dap: Add stack offset to VMLocalVariable

* dap: fix display of static arrays and local variables on stack vs. registers

* dap: fix displaying function pointers

* dap: tweak color display

* dap: fix scalar display < 4

* dap: add Globals display to debugger

* dap: unify methods to get vmvalue

* dap: rename free method to freeValue to avoid running afoul of macro defs

* fix windows builds

* fix compile on linux

* cleanup

* Fix display of function breakpoints

* dap: Don't send back binary files

* dap: include sbarinfo in script types (no debug support for anything but zscript yet, this is just for returning source info)

* dap: don't show ending session message unless initialized

* fix erroneous commit

* dap: handle evaluate requests

* Fix getting bitfield values

* Add CVars Scope and evaluation

* add running console commands from repl

* dap: disable commands via repl for now

* fix loading functions DECORATE scripts

* Add source information to Dehacked VM functions, add debugging support

* dap: cleanup

* fix resolving archive paths

* don't send source back on native stack frames

* handle `modules` request

* cleanup

* allow evaluating cvars on hover

* fix oob bpinfos

* fix restarting the game blowing out the debug server

* dap: process input events while paused to prevent deadlocks

* fix getting local state

* dap: fix LocalState alignment

* dap: fix DumpStateHelper

* update cppdap protocol version to 1.68.0

* remove cppdap from vcpkg deps

We can't use the upstream version anyway because the maintainers are not merging our patches

* dap: make named variable nodes derive from the same class

* dap: make cvar scope available in native stack frames

* handle local variables with conflicting names

* add I_GetWindowEvent() to win32 to only process window events when debugging is paused

* dap: fix evaluate

* dap: fix display of `out` variables
2025-07-18 00:01:18 -03:00

275 lines
6.4 KiB
C++

#pragma once
#include <string>
#include <sstream>
#include <regex>
#include <dap/protocol.h>
#include <common/engine/printf.h>
#include <map>
#include <set>
namespace DebugServer
{
// Caseless comparison, required for script identifiers (ZScript/ACS/DECORATE are all case-insensitive)
struct ci_less
{
// case-independent (ci) compare_less binary function
struct nocase_compare
{
bool operator()(const unsigned char &c1, const unsigned char &c2) const { return tolower(c1) < tolower(c2); }
};
template <
typename T,
typename U,
typename = std::enable_if_t<
(std::is_same_v<T, std::string> || std::is_same_v<T, std::string_view>) && (std::is_same_v<U, std::string> || std::is_same_v<U, std::string_view>)>>
bool operator()(T const &s1, U const &s2) const
{
return std::lexicographical_compare(
s1.begin(),
s1.end(), // source range
s2.begin(),
s2.end(), // dest range
nocase_compare()); // comparison
}
};
template <typename V> using caseless_path_map = typename std::map<std::string, V, ci_less>;
using caseless_path_set = typename std::set<std::string, ci_less>;
inline bool CaseInsensitiveEquals(const std::string &s1, const std::string &s2)
{
return s1.size() == s2.size()
&& std::equal(
s1.begin(), s1.end(), // source range
s2.begin(), s2.end(), // dest range
[](const unsigned char &c1, const unsigned char &c2) { return tolower(c1) == tolower(c2); }); // comparison
}
inline size_t CaseInsensitiveFind(const std::string &s1, const std::string &s2)
{
auto pos = std::search(s1.begin(), s1.end(), s2.begin(), s2.end(), [](char c1, char c2) { return tolower(c1) == tolower(c2); });
if (pos == s1.end()){
return std::string::npos;
}
return std::distance(s1.begin(), pos);
}
template <typename... Args> std::string StringFormat(const char *fmt, Args... args)
{
const size_t size = snprintf(nullptr, 0, fmt, args...);
std::string buf;
buf.reserve(size + 1);
buf.resize(size);
snprintf(&buf[0], size + 1, fmt, args...);
return buf;
}
static inline std::string StripColorCodes(const std::string &str)
{
TArray<char> copy(str.size() + 1);
const char *srcp = str.c_str();
char *dstp = copy.Data();
while (*srcp != 0)
{
if (*srcp != TEXTCOLOR_ESCAPE)
{
*dstp++ = *srcp++;
}
else if (srcp[1] == '[')
{
srcp += 2;
while (*srcp != ']' && *srcp != 0)
srcp++;
if (*srcp == ']') srcp++;
}
else
{
if (srcp[1] != 0) srcp += 2;
else
break;
}
}
*dstp = 0;
return copy.Data();
}
template <typename... Args> void LogInternal(const char *fmt, Args... args)
{
Printf(PRINT_HIGH | PRINT_NODAPEVENT | PRINT_NONOTIFY, "%s\n", StringFormat(fmt, args...).c_str());
}
template <typename... Args> void LogInternalError(const char *fmt, Args... args)
{
Printf(PRINT_HIGH | PRINT_NODAPEVENT | PRINT_NONOTIFY, TEXTCOLOR_RED "%s\n", StringFormat(fmt, args...).c_str());
}
template <typename... Args> void Log(const char *fmt, Args... args)
{
Printf(PRINT_HIGH | PRINT_NONOTIFY, "%s\n", StringFormat(fmt, args...).c_str());
}
template <typename... Args> void LogError(const char *fmt, Args... args)
{
Printf(PRINT_HIGH | PRINT_NONOTIFY, TEXTCOLOR_RED "%s\n", StringFormat(fmt, args...).c_str());
}
#define RETURN_DAP_ERROR(message) \
LogError("%s", message); \
return dap::Error(message);
#define RETURN_DAP_ERROR_NO_NOTIFY(message) \
return dap::Error(message);
#define RETURN_COND_DAP_ERROR(cond, message) \
if (cond) { \
RETURN_DAP_ERROR(message); \
}
template <typename T> T ByteSwap(T val)
{
T retVal;
const auto pVal = reinterpret_cast<char *>(&val);
const auto pRetVal = reinterpret_cast<char *>(&retVal);
const int size = sizeof(T);
for (auto i = 0; i < size; i++)
{
pRetVal[size - 1 - i] = pVal[i];
}
return retVal;
}
inline std::vector<std::string> Split(const std::string &s, const std::string &delimiter)
{
size_t posStart = 0, posEnd;
const auto delimLen = delimiter.length();
std::vector<std::string> res;
while ((posEnd = s.find(delimiter, posStart)) != std::string::npos)
{
auto token = s.substr(posStart, posEnd - posStart);
posStart = posEnd + delimLen;
res.push_back(token);
}
res.push_back(s.substr(posStart));
return res;
}
inline std::string Join(const std::vector<std::string> &elements, const char *const separator)
{
switch (elements.size())
{
case 0:
return "";
case 1:
return elements[0];
default:
std::ostringstream os;
std::copy(elements.begin(), elements.end() - 1, std::ostream_iterator<std::string>(os, separator));
os << *elements.rbegin();
return os.str();
}
}
inline bool ParseInt(const std::string &str, int *value, std::size_t *pos = nullptr, const int base = 10)
{
try
{
*value = std::stoi(str, pos, base);
}
catch (void *)
{
return false;
}
return true;
}
inline void ToLower(std::string &p_str)
{
for (size_t i = 0; i < p_str.size(); i++)
{
p_str[i] = tolower(p_str[i]);
}
}
inline std::string ToLowerCopy(const std::string &p_str)
{
std::string r_str = p_str;
ToLower(r_str);
return r_str;
}
inline std::string DemangleName(std::string name)
{
if (name.front() == ':')
{
return name.substr(2, name.length() - 6);
}
return name;
}
inline int GetScriptReference(const std::string &scriptName)
{
constexpr std::hash<std::string> hasher {};
std::string name = scriptName;
std::transform(name.begin(), name.end(), name.begin(), ::tolower);
return std::abs(static_cast<int>(hasher(name))) + 1;
}
inline int GetSourceReference(const dap::Source &src)
{
// If the source reference <= 0, it's invalid
if (src.sourceReference.value(0) > 0)
{
return static_cast<int>(src.sourceReference.value());
}
if (!src.path.has_value())
{
return -1;
}
std::string path = src.path.value();
if (src.origin.has_value())
{
path = src.origin.value() + ":" + path;
}
return GetScriptReference(path);
}
inline std::string GetSourceModfiedTime(const dap::Source &src)
{
if (!src.checksums.has_value())
{
return "";
}
for (auto &checksum : src.checksums.value())
{
if (checksum.algorithm == "timestamp")
{
return checksum.checksum;
}
}
return "";
}
inline bool CompareSourceModifiedTime(const dap::Source &src1, const dap::Source &src2)
{
if (GetSourceModfiedTime(src1) != GetSourceModfiedTime(src2))
{
return false;
}
return true;
}
inline std::string StringJoin(const std::vector<std::string> &strings, const char *delim)
{
std::ostringstream imploded;
std::copy(strings.begin(), strings.end(), std::ostream_iterator<std::string>(imploded, delim));
return imploded.str().substr(0, imploded.str().size() - strlen(delim));
}
}