feat(*): add initial function call tracing

GothicKit · Dec 24, 2023 · 9ce7ad7 · 9ce7ad7
1 parent 8c9340a
commit 9ce7ad7
Show file tree

Hide file tree

Showing 12 changed files with 189 additions and 1 deletion.
diff --git a/include/zenkit-capi/Library.h b/include/zenkit-capi/Library.h
@@ -33,6 +33,7 @@
 	#include <zenkit/Logger.hh>
 
 	#define ZKC_WRAP_NEW(x) new (decltype(x))(std::move(x))
+	#define ZKC_LOG_TRACE(...) zenkit::Logger::log(zenkit::LogLevel::TRACE, "<Native>", __VA_ARGS__)
 	#define ZKC_LOG_ERROR(...) zenkit::Logger::log(zenkit::LogLevel::ERROR, "<Native>", __VA_ARGS__)
 	#define ZKC_LOG_WARN(...) zenkit::Logger::log(zenkit::LogLevel::WARNING, "<Native>", __VA_ARGS__)
 	#define ZKC_LOG_WARN_NULL(fn)                                                                                      \

diff --git a/src/Boxes.cc b/src/Boxes.cc
@@ -2,7 +2,10 @@
 // SPDX-License-Identifier: MIT
 #include "zenkit-capi/Boxes.h"
 
+#include "Internal.hh"
+
 ZkVec3f ZkOrientedBoundingBox_getCenter(ZkOrientedBoundingBox const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_getCenter");
 		return {};
@@ -12,6 +15,7 @@ ZkVec3f ZkOrientedBoundingBox_getCenter(ZkOrientedBoundingBox const* slf) {
 }
 
 ZkVec3f ZkOrientedBoundingBox_getAxis(ZkOrientedBoundingBox const* slf, ZkSize i) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_getAxis");
 		return {};
@@ -26,6 +30,7 @@ ZkVec3f ZkOrientedBoundingBox_getAxis(ZkOrientedBoundingBox const* slf, ZkSize i
 }
 
 ZkVec3f ZkOrientedBoundingBox_getHalfWidth(ZkOrientedBoundingBox const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_getHalfWidth");
 		return {};
@@ -35,6 +40,7 @@ ZkVec3f ZkOrientedBoundingBox_getHalfWidth(ZkOrientedBoundingBox const* slf) {
 }
 
 ZkSize ZkOrientedBoundingBox_getChildCount(ZkOrientedBoundingBox const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_getChildCount");
 		return {};
@@ -44,6 +50,7 @@ ZkSize ZkOrientedBoundingBox_getChildCount(ZkOrientedBoundingBox const* slf) {
 }
 
 ZkOrientedBoundingBox const* ZkOrientedBoundingBox_getChild(ZkOrientedBoundingBox const* slf, ZkSize i) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_getChildCount");
 		return {};
@@ -60,6 +67,7 @@ ZkOrientedBoundingBox const* ZkOrientedBoundingBox_getChild(ZkOrientedBoundingBo
 void ZkOrientedBoundingBox_enumerateChildren(ZkOrientedBoundingBox const* slf,
                                              ZkOrientedBoundingBoxEnumerator cb,
                                              void* ctx) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr || cb == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_enumerateChildren");
 		return;
@@ -71,6 +79,7 @@ void ZkOrientedBoundingBox_enumerateChildren(ZkOrientedBoundingBox const* slf,
 }
 
 ZkAxisAlignedBoundingBox ZkOrientedBoundingBox_toAabb(ZkOrientedBoundingBox const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkOrientedBoundingBox_toAabb");
 		return {};

diff --git a/src/CutsceneLibrary.cc b/src/CutsceneLibrary.cc
@@ -2,7 +2,10 @@
 // SPDX-License-Identifier: MIT
 #include "zenkit-capi/CutsceneLibrary.h"
 
+#include "Internal.hh"
+
 ZkCutsceneLibrary* ZkCutsceneLibrary_load(ZkRead* buf) {
+	ZKC_TRACE_FN();
 	if (buf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneLibrary_load");
 		return nullptr;
@@ -19,6 +22,7 @@ ZkCutsceneLibrary* ZkCutsceneLibrary_load(ZkRead* buf) {
 }
 
 ZkCutsceneLibrary* ZkCutsceneLibrary_loadPath(ZkString path) {
+	ZKC_TRACE_FN();
 	if (path == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneLibrary_loadPath");
 		return nullptr;
@@ -37,6 +41,7 @@ ZkCutsceneLibrary* ZkCutsceneLibrary_loadPath(ZkString path) {
 }
 
 ZkCutsceneLibrary* ZkCutsceneLibrary_loadVfs(ZkVfs const* vfs, ZkString name) {
+	ZKC_TRACE_FN();
 	if (vfs == nullptr || name == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneLibrary_loadVfs");
 		return nullptr;
@@ -50,10 +55,12 @@ ZkCutsceneLibrary* ZkCutsceneLibrary_loadVfs(ZkVfs const* vfs, ZkString name) {
 }
 
 void ZkCutsceneLibrary_del(ZkCutsceneLibrary* slf) {
+	ZKC_TRACE_FN();
 	delete slf;
 }
 
 ZkCutsceneBlock const* ZkCutsceneLibrary_getBlock(ZkCutsceneLibrary const* slf, ZkString name) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr || name == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneLibrary_getBlock");
 		return nullptr;
@@ -63,6 +70,7 @@ ZkCutsceneBlock const* ZkCutsceneLibrary_getBlock(ZkCutsceneLibrary const* slf,
 }
 
 void ZkCutsceneLibrary_enumerateBlocks(ZkCutsceneLibrary const* slf, ZkCutsceneBlockEnumerator cb, void* ctx) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr || cb == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneLibrary_enumerateBlocks");
 		return;
@@ -74,6 +82,7 @@ void ZkCutsceneLibrary_enumerateBlocks(ZkCutsceneLibrary const* slf, ZkCutsceneB
 }
 
 ZkString ZkCutsceneBlock_getName(ZkCutsceneBlock const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneBlock_getName");
 		return nullptr;
@@ -83,6 +92,7 @@ ZkString ZkCutsceneBlock_getName(ZkCutsceneBlock const* slf) {
 }
 
 ZkCutsceneMessage const* ZkCutsceneBlock_getMessage(ZkCutsceneBlock const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneBlock_getMessage");
 		return nullptr;
@@ -92,6 +102,7 @@ ZkCutsceneMessage const* ZkCutsceneBlock_getMessage(ZkCutsceneBlock const* slf)
 }
 
 uint32_t ZkCutsceneMessage_getType(ZkCutsceneMessage const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneMessage_getType");
 		return 0;
@@ -101,6 +112,7 @@ uint32_t ZkCutsceneMessage_getType(ZkCutsceneMessage const* slf) {
 }
 
 ZkString ZkCutsceneMessage_getText(ZkCutsceneMessage const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneMessage_getText");
 		return nullptr;
@@ -110,6 +122,7 @@ ZkString ZkCutsceneMessage_getText(ZkCutsceneMessage const* slf) {
 }
 
 ZkString ZkCutsceneMessage_getName(ZkCutsceneMessage const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkCutsceneMessage_getName");
 		return nullptr;

diff --git a/src/Internal.hh b/src/Internal.hh
@@ -174,4 +174,6 @@ inline bool zk_any_nullptr(T*... args) {
 			ZKC_LOG_ERROR("%s() failed: index out of range", __func__);                                                \
 			return;                                                                                                    \
 		}                                                                                                              \
-	} while (false)
+	} while (false)
+
+#define ZKC_TRACE_FN() ZKC_LOG_TRACE("%s()", __func__)\
diff --git a/src/Material.cc b/src/Material.cc
@@ -2,9 +2,12 @@
 // SPDX-License-Identifier: MIT
 #include "zenkit-capi/Material.h"
 
+#include "Internal.hh"
+
 #include <zenkit/Archive.hh>
 
 ZkMaterial* ZkMaterial_load(ZkRead* buf) {
+	ZKC_TRACE_FN();
 	if (buf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_load");
 		return nullptr;
@@ -24,6 +27,7 @@ ZkMaterial* ZkMaterial_load(ZkRead* buf) {
 }
 
 ZkMaterial* ZkMaterial_loadPath(ZkString path) {
+	ZKC_TRACE_FN();
 	if (path == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_loadPath");
 		return nullptr;
@@ -44,10 +48,12 @@ ZkMaterial* ZkMaterial_loadPath(ZkString path) {
 }
 
 void ZkMaterial_del(ZkMaterial* slf) {
+	ZKC_TRACE_FN();
 	delete slf;
 }
 
 ZkString ZkMaterial_getName(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getName");
 		return nullptr;
@@ -57,6 +63,7 @@ ZkString ZkMaterial_getName(ZkMaterial const* slf) {
 }
 
 ZkMaterialGroup ZkMaterial_getGroup(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getGroup");
 		return ZkMaterialGroup_UNDEFINED;
@@ -66,6 +73,7 @@ ZkMaterialGroup ZkMaterial_getGroup(ZkMaterial const* slf) {
 }
 
 ZkColor ZkMaterial_getColor(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getColor");
 		return {};
@@ -75,6 +83,7 @@ ZkColor ZkMaterial_getColor(ZkMaterial const* slf) {
 }
 
 float ZkMaterial_getSmoothAngle(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getSmoothAngle");
 		return 0;
@@ -84,6 +93,7 @@ float ZkMaterial_getSmoothAngle(ZkMaterial const* slf) {
 }
 
 ZkString ZkMaterial_getTexture(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getTexture");
 		return nullptr;
@@ -93,6 +103,7 @@ ZkString ZkMaterial_getTexture(ZkMaterial const* slf) {
 }
 
 ZkVec2f ZkMaterial_getTextureScale(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getTextureScale");
 		return {};
@@ -102,6 +113,7 @@ ZkVec2f ZkMaterial_getTextureScale(ZkMaterial const* slf) {
 }
 
 float ZkMaterial_getTextureAnimationFps(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getTextureAnimationFps");
 		return 0;
@@ -111,6 +123,7 @@ float ZkMaterial_getTextureAnimationFps(ZkMaterial const* slf) {
 }
 
 ZkAnimationMapping ZkMaterial_getTextureAnimationMapping(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getTextureAnimationMapping");
 		return ZkAnimationMapping_NONE;
@@ -120,6 +133,7 @@ ZkAnimationMapping ZkMaterial_getTextureAnimationMapping(ZkMaterial const* slf)
 }
 
 ZkVec2f ZkMaterial_getTextureAnimationMappingDirection(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getTextureAnimationMappingDirection");
 		return {};
@@ -129,6 +143,7 @@ ZkVec2f ZkMaterial_getTextureAnimationMappingDirection(ZkMaterial const* slf) {
 }
 
 ZkBool ZkMaterial_getDisableCollision(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getDisableCollision");
 		return false;
@@ -138,6 +153,7 @@ ZkBool ZkMaterial_getDisableCollision(ZkMaterial const* slf) {
 }
 
 ZkBool ZkMaterial_getDisableLightmap(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getDisableLightmap");
 		return false;
@@ -147,6 +163,7 @@ ZkBool ZkMaterial_getDisableLightmap(ZkMaterial const* slf) {
 }
 
 ZkBool ZkMaterial_getDontCollapse(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getDontCollapse");
 		return false;
@@ -156,6 +173,7 @@ ZkBool ZkMaterial_getDontCollapse(ZkMaterial const* slf) {
 }
 
 ZkString ZkMaterial_getDetailObject(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getDetailObject");
 		return nullptr;
@@ -165,6 +183,7 @@ ZkString ZkMaterial_getDetailObject(ZkMaterial const* slf) {
 }
 
 float ZkMaterial_getDetailObjectScale(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getDetailObjectScale");
 		return 1;
@@ -174,6 +193,7 @@ float ZkMaterial_getDetailObjectScale(ZkMaterial const* slf) {
 }
 
 ZkBool ZkMaterial_getForceOccluder(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getForceOccluder");
 		return false;
@@ -183,6 +203,7 @@ ZkBool ZkMaterial_getForceOccluder(ZkMaterial const* slf) {
 }
 
 ZkBool ZkMaterial_getEnvironmentMapping(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getEnvironmentMapping");
 		return false;
@@ -192,6 +213,7 @@ ZkBool ZkMaterial_getEnvironmentMapping(ZkMaterial const* slf) {
 }
 
 float ZkMaterial_getEnvironmentMappingStrength(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getEnvironmentMappingStrength");
 		return 0;
@@ -201,6 +223,7 @@ float ZkMaterial_getEnvironmentMappingStrength(ZkMaterial const* slf) {
 }
 
 ZkWaveMode ZkMaterial_getWaveMode(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getWaveMode");
 		return ZkWaveMode_NONE;
@@ -210,6 +233,7 @@ ZkWaveMode ZkMaterial_getWaveMode(ZkMaterial const* slf) {
 }
 
 ZkWaveSpeed ZkMaterial_getWaveSpeed(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getWaveSpeed");
 		return ZkWaveSpeed_NORMAL;
@@ -219,6 +243,7 @@ ZkWaveSpeed ZkMaterial_getWaveSpeed(ZkMaterial const* slf) {
 }
 
 float ZkMaterial_getWaveAmplitude(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getWaveAmplitude");
 		return 0;
@@ -228,6 +253,7 @@ float ZkMaterial_getWaveAmplitude(ZkMaterial const* slf) {
 }
 
 float ZkMaterial_getWaveGridSize(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getWaveGridSize");
 		return 1;
@@ -237,6 +263,7 @@ float ZkMaterial_getWaveGridSize(ZkMaterial const* slf) {
 }
 
 ZkBool ZkMaterial_getIgnoreSun(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getIgnoreSun");
 		return false;
@@ -246,6 +273,7 @@ ZkBool ZkMaterial_getIgnoreSun(ZkMaterial const* slf) {
 }
 
 ZkAlphaFunction ZkMaterial_getAlphaFunction(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getAlphaFunction");
 		return ZkAlphaFunction_DEFAULT;
@@ -255,6 +283,7 @@ ZkAlphaFunction ZkMaterial_getAlphaFunction(ZkMaterial const* slf) {
 }
 
 ZkVec2f ZkMaterial_getDefaultMapping(ZkMaterial const* slf) {
+	ZKC_TRACE_FN();
 	if (slf == nullptr) {
 		ZKC_LOG_WARN_NULL("ZkMaterial_getDefaultMapping");
 		return {};