implemented thread-local activity tracking

includes support for on-demand formatting of scope in error messages

1 files changed, 83 insertions, 0 deletions

diff --git a/src/zencore/include/zencore/logging.h b/src/zencore/include/zencore/logging.h
index 5cbe034cf..92db1b35b 100644
--- a/src/zencore/include/zencore/logging.h
+++ b/src/zencore/include/zencore/logging.h
@@ -134,3 +134,86 @@ LogIsErrorLevel(int level)
 		using namespace std::literals;                \
 		ConsoleLog().info(fmtstr##sv, ##__VA_ARGS__); \
 	} while (false)
+
+//////////////////////////////////////////////////////////////////////////
+
+namespace zen {
+
+class StringBuilderBase;
+
+/** Thread-local diagnostics scope stack
+
+	Intended to be used in logging and such to provide context on demand.
+	A subclass should do as little work as possible at construction time
+	and ideally only do something when the Emit function is called.
+  */
+class ScopedActivityBase
+{
+public:
+	ScopedActivityBase();
+	virtual ~ScopedActivityBase();
+	virtual void Emit(StringBuilderBase& Target) = 0;
+
+	inline ScopedActivityBase* GetNext() { return m_NextScope; }
+
+private:
+	ScopedActivityBase* m_NextScope;
+};
+
+class ScopedActivityString : public ScopedActivityBase
+{
+public:
+	inline ScopedActivityString(const std::string_view& Text) : m_Text{Text} {}
+	virtual ~ScopedActivityString();
+	virtual void Emit(StringBuilderBase& Target) override;
+
+private:
+	const std::string_view m_Text;
+};
+
+template<typename Lambda>
+class ScopedLazyActivity : public ScopedActivityBase
+{
+public:
+	ScopedLazyActivity(Lambda&& InFunc) : m_CapturedFunc(std::move(InFunc)) {}
+	~ScopedLazyActivity() = default;
+
+	virtual void Emit(StringBuilderBase& Target) override { m_CapturedFunc(Target); }
+
+private:
+	const Lambda m_CapturedFunc;
+};
+
+std::string_view EmitScopesForLogging(StringBuilderBase& OutString);
+
+#define ZEN_LOG_SCOPE(...) ScopedLazyActivity Activity$##__LINE__([&](StringBuilderBase& Out) { Out << fmt::format(__VA_ARGS__); })
+
+#define ZEN_SCOPED_ERROR(fmtstr, ...)                                                  \
+	do                                                                                 \
+	{                                                                                  \
+		ExtendableStringBuilder<256> ScopeString;                                      \
+		const std::string_view		 Scopes = EmitScopesForLogging(ScopeString);       \
+		ZEN_LOG_WITH_LOCATION(Log(),                                                   \
+							  spdlog::source_loc(__FILE__, __LINE__, SPDLOG_FUNCTION), \
+							  spdlog::level::err,                                      \
+							  fmtstr "{}"sv,                                           \
+							  ##__VA_ARGS__,                                           \
+							  Scopes);                                                 \
+	} while (false)
+
+#define ZEN_SCOPED_CRITICAL(fmtstr, ...)                                               \
+	do                                                                                 \
+	{                                                                                  \
+		ExtendableStringBuilder<256> ScopeString;                                      \
+		const std::string_view		 Scopes = EmitScopesForLogging(ScopeString);       \
+		ZEN_LOG_WITH_LOCATION(Log(),                                                   \
+							  spdlog::source_loc(__FILE__, __LINE__, SPDLOG_FUNCTION), \
+							  spdlog::level::critical,                                 \
+							  fmtstr "{}"sv,                                           \
+							  ##__VA_ARGS__,                                           \
+							  Scopes);                                                 \
+	} while (false)
+
+ScopedActivityBase* GetThreadActivity();
+
+}  // namespace zen