feat: format the stack frame' labels in a nicer way

VM/include/RigCVM/DevServer/Utils.hpp

@@ -0,0 +1,10 @@
+#pragma once
+
+#include RIGCVM_PCH
+
+namespace rigc::vm
+{
+
+auto formatStackFrameLabel(ParserNode const&) -> std::string;
+
+}

VM/src/DevServer/Utils.cpp

@@ -0,0 +1,72 @@
+#include RIGCVM_PCH
+
+#include <RigCVM/VM.hpp>
+#include <RigCVM/DevServer/Utils.hpp>
+
+#include <numeric>
+#include <functional>
+
+namespace {
+
+auto formatFunctionSignature(rigc::ParserNode const& node) {
+	using namespace rigc;
+	using namespace rigc::vm;
+
+	auto const* const name = findElem<rigc::Name>(node);
+	auto const* const params = findElem<rigc::FunctionParams>(node);
+	auto const* const returnType = findElem<rigc::ExplicitReturnType>(node);
+
+	// name(arg1: type, arg2: type): return_type
+	return name->string()
+		+ (params ? params->string() : "()")
+		+ (returnType ? ": " : "")
+		+ (returnType ? returnType->string() : "");
+}
+
+auto stripWhitespace(std::string& str) {
+	auto const prefixIt = rg::find_if(str, [](char c) { return std::isalpha(c); });
+
+	auto const begin = rg::begin(str);
+	auto const end = begin + (prefixIt - begin);
+
+	str.erase(begin, end);
+}
+
+auto formatCodeBlock(rigc::ParserNode const& node) {
+	using namespace std::string_view_literals;
+
+	auto static constexpr maxLabelNameLen = 20;
+	auto static constexpr overflowIndicator = "..."sv;
+	auto static constexpr overflowIndicatorLen = overflowIndicator.length();
+	auto static constexpr maxAllowedLen = maxLabelNameLen - overflowIndicatorLen;
+
+	auto nodeString = node.string();
+
+	if (node.is_type<rigc::CodeBlock>()) {
+		stripWhitespace(nodeString);
+	}
+
+	if(nodeString.length() > maxLabelNameLen) {
+		return
+			nodeString.substr(0, maxAllowedLen)
+				+ std::string(overflowIndicator);
+	} else {
+		return nodeString;
+	}
+}
+
+}
+
+namespace rigc::vm {
+
+auto formatStackFrameLabel(ParserNode const& node) -> std::string {
+	auto const isFunctionDefinition = node.is_type<rigc::FunctionDefinition>();
+
+	if(isFunctionDefinition) {
+		return formatFunctionSignature(node);
+	} else {
+		return formatCodeBlock(node);
+	}
+}
+
+}

VM/src/StackFrame.cpp

@@ -2,6 +2,7 @@
 
 #include <RigCVM/StackFrame.hpp>
 #include <RigCVM/VM.hpp>
+#include <RigCVM/DevServer/Utils.hpp>
 
 namespace rigc::vm
 {
@@ -11,7 +12,7 @@ StackFramePusher::StackFramePusher(Instance& vm_, ParserNode const& stmt_)
 	: vm(vm_)
 {
 #if DEBUG
-	vm.pushStackFrameOf(&stmt_, fmt::format("{} -> {}", stmt_.type, stmt_.string()));
+	vm.pushStackFrameOf(&stmt_, formatStackFrameLabel(stmt_));
 #else
 	vm.pushStackFrameOf(&stmt_);
 #endif

VM/src/VM.cpp

@@ -12,6 +12,7 @@
 #include <RigCVM/TypeSystem/ArrayType.hpp>
 #include <RigCVM/TypeSystem/FuncType.hpp>
 #include <RigCVM/DevServer/Messaging.hpp>
+#include <RigCVM/DevServer/Utils.hpp>
 
 #include <RigCVM/ErrorHandling/Exceptions.hpp>
 
@@ -289,7 +290,7 @@ R"msg(
 
 
 #if DEBUG
-		auto& fnScope			= this->pushStackFrameOf(func_.addr(), func_.runtimeImpl().node->string());
+		auto& fnScope			= this->pushStackFrameOf(func_.addr(), formatStackFrameLabel(*func_.runtimeImpl().node));
 #else
 		auto& fnScope			= this->pushStackFrameOf(func_.addr());
 #endif