feat(ui): improve FrameXML debug routines

src/gameui/GameScriptFunctions.hpp

@@ -6,9 +6,11 @@
 
 struct lua_State;
 
+#define NUM_SCRIPT_FUNCTIONS_GAME 310
 #define NUM_SCRIPT_FUNCTIONS_CAMERA 22
 
 namespace GameScript {
+    extern FrameScript_Method s_ScriptFunctions_Game[NUM_SCRIPT_FUNCTIONS_GAME];
     extern FrameScript_Method s_ScriptFunctions_Camera[NUM_SCRIPT_FUNCTIONS_CAMERA];
 }
 

src/ui/FrameScript.cpp

@@ -156,7 +156,12 @@ void FrameScript_CreateEvents(const char* names[], uint32_t count) {
 }
 
 void FrameScript_Destroy() {
-    // TODO
+    lua_close(FrameScript::s_context);
+    FrameScript::s_context = nullptr;
+    luaM_freePool(FrameScript::s_mempool);
+    FrameScript::s_mempool = nullptr;
+    FrameScript::s_scriptEventsHash.Clear();
+    FrameScript::s_scriptEvents.Clear();
 }
 
 void FrameScript_Execute(const char* source, const char* filename, const char* a3) {

src/ui/FrameXML.cpp

@@ -272,9 +272,10 @@ int32_t FrameXML_CreateFrames(const char* tocPath, const char* a2, MD5_CTX* md5,
         tocData = tocData + 3;
     }
 
-    CStatus v21;
+    CStatus frameStatus;
     char tocLine[1024];
     char tocEntryPath[260];
+    int32_t v25 = 0;
 
     do {
         SStrTokenize(&tocData, tocLine, 1024, "\r\n", 0);
@@ -307,7 +308,7 @@ int32_t FrameXML_CreateFrames(const char* tocPath, const char* a2, MD5_CTX* md5,
 
         *v12 = 0;
 
-        FrameXML_ProcessFile(tocEntryPath, a2, md5, &v21);
+        FrameXML_ProcessFile(tocEntryPath, a2, md5, &frameStatus);
 
         // TODO
         // if (s_progressCallback && s_progressFiles < s_progressTotal) {
@@ -324,13 +325,11 @@ int32_t FrameXML_CreateFrames(const char* tocPath, const char* a2, MD5_CTX* md5,
 
     SFile::Unload(tocBuffer);
 
-    // TODO
-    // if (s_debugLevel > 0 || v25 > 0) {
-    //     v21.Prepend(STATUS_INFO, "** Loading table of contents %s", v5);
-    // }
+    if (FrameXML::s_debugLevel > 0 || v25 > 0) {
+        frameStatus.Prepend(STATUS_INFO, "** Loading table of contents %s", v5);
+    }
 
-    // TODO
-    // status->Add(v21);
+    status->Add(frameStatus);
 
     return 1;
 }
@@ -417,7 +416,7 @@ int32_t FrameXML_ProcessFile(const char* filePath, const char* a2, MD5_CTX* md5,
         return 0;
     }
 
-    CStatus unkStatus;
+    CStatus fileStatus;
 
     XMLNode* node = XMLTree_GetRoot(tree)->m_child;
 
@@ -428,6 +427,8 @@ int32_t FrameXML_ProcessFile(const char* filePath, const char* a2, MD5_CTX* md5,
     // Should come from some kind of Lua headers
     const char* lua_tainted = nullptr;
 
+    int32_t v34 = 0;
+
     while (node) {
         // <Include>
         if (!SStrCmpI(node->GetName(), "Include", 0x7FFFFFFFu)) {
@@ -448,9 +449,9 @@ int32_t FrameXML_ProcessFile(const char* filePath, const char* a2, MD5_CTX* md5,
                     SStrCopy(v27, v14, 260);
                 }
 
-                FrameXML_ProcessFile(v27, a2, md5, &unkStatus);
+                FrameXML_ProcessFile(v27, a2, md5, &fileStatus);
             } else {
-                unkStatus.Add(STATUS_ERROR, "Element 'Include' without file attribute");
+                fileStatus.Add(STATUS_ERROR, "Element 'Include' without file attribute");
             }
         // <Script>
         } else if (!SStrCmpI(node->GetName(), "Script", 0x7FFFFFFFu)) {
@@ -473,7 +474,7 @@ int32_t FrameXML_ProcessFile(const char* filePath, const char* a2, MD5_CTX* md5,
                     SStrCopy(v27, v16, 260);
                 }
 
-                FrameScript_ExecuteFile(v27, a2, md5, &unkStatus);
+                FrameScript_ExecuteFile(v27, a2, md5, &fileStatus);
             }
 
             char* v19 = node->m_body;
@@ -490,22 +491,22 @@ int32_t FrameXML_ProcessFile(const char* filePath, const char* a2, MD5_CTX* md5,
                 CSimpleFont* font = CSimpleFont::GetFont(fontName, 1);
                 font->LoadXML(node, status);
             } else {
-                unkStatus.Add(STATUS_WARNING, "Unnamed font node at top level");
+                fileStatus.Add(STATUS_WARNING, "Unnamed font node at top level");
             }
         // Everything else (frame nodes)
         } else {
             const char* v22 = node->GetAttributeByName("virtual");
 
             if (!v22 || SStrCmpI(v22, "true", 0x7FFFFFFFu)) {
-                FrameXML_CreateFrame(node, nullptr, &unkStatus);
+                FrameXML_CreateFrame(node, nullptr, &fileStatus);
                 CLayoutFrame::ResizePending();
             } else {
                 const char* v23 = node->GetAttributeByName("name");
 
                 if (v23 && *v23) {
-                    FrameXML_StoreHashNode(node, v23, lua_tainted, &unkStatus);
+                    FrameXML_StoreHashNode(node, v23, lua_tainted, &fileStatus);
                 } else {
-                    unkStatus.Add(STATUS_WARNING, "Unnamed virtual node at top level");
+                    fileStatus.Add(STATUS_WARNING, "Unnamed virtual node at top level");
                 }
             }
         }
@@ -515,13 +516,11 @@ int32_t FrameXML_ProcessFile(const char* filePath, const char* a2, MD5_CTX* md5,
 
     XMLTree_Free(tree);
 
-    // TODO
-    // if (s_debugLevel > 0 || v34 > 0) {
-    //     unkStatus.Prepend(STATUS_INFO, "++ Loading file %s", v5);
-    // }
+    if (FrameXML::s_debugLevel > 0 || v34 > 0) {
+        fileStatus.Prepend(STATUS_INFO, "++ Loading file %s", v5);
+    }
 
-    // TODO
-    // status->Unk8(unkStatus);
+    status->Add(fileStatus);
 
     return 1;
 }
@@ -613,3 +612,11 @@ int32_t FrameXML_GuessNumFiles(const char* data) {
     }
     return result;
 }
+
+int32_t FrameXML_GetDebugLevel() {
+    return FrameXML::s_debugLevel;
+}
+
+void FrameXML_SetDebugLevel(int32_t level) {
+    FrameXML::s_debugLevel = level;
+}

src/ui/FrameXML.hpp

@@ -54,4 +54,8 @@ void FrameXML_StoreHashNode(XMLNode* node, const char* name, const char* a3, CSt
 
 int32_t FrameXML_GuessNumFiles(const char* data);
 
+int32_t FrameXML_GetDebugLevel();
+
+void FrameXML_SetDebugLevel(int32_t level);
+
 #endif

src/ui/LuaMemory.cpp

@@ -30,6 +30,25 @@ void* luaM_initPool() {
     return pools;
 }
 
+void luaM_freePool(void* ptr) {
+    if (!ptr) {
+        return;
+    }
+
+    MemPool** pools = reinterpret_cast<MemPool**>(ptr);
+
+    for (uint32_t i = 0; i < 9; ++i) {
+        MemPool* pool = pools[i];
+        if (pool) {
+            // Is the sub_8556E0(pool) a desturctor?
+            pool->~MemPool();
+            SMemFree(pool, __FILE__, __LINE__, 0);
+        }
+    }
+
+    SMemFree(pools, __FILE__, __LINE__, 0);
+}
+
 void* luaM_reallocPool(void* ud, void* ptr, size_t osize, size_t nsize) {
     void* result; // eax
     signed int v5; // esi

src/ui/LuaMemory.hpp

@@ -4,6 +4,7 @@
 #include <cstdlib>
 
 void* luaM_initPool();
+void luaM_freePool(void* ptr);
 void* luaM_reallocPool(void* ud, void* ptr, size_t osize, size_t nsize);
 
 #endif

src/util/CStatus.cpp

@@ -24,6 +24,16 @@ void CStatus::Add(STATUS_TYPE severity, const char* format, ...) {
     va_end(args);
 }
 
+void CStatus::Prepend(STATUS_TYPE severity, const char* format, ...) {
+    // TODO
+    // Remove temporary console debug logging
+    va_list args;
+    va_start(args, format);
+    vprintf(format, args);
+    printf("\n");
+    va_end(args);
+}
+
 CStatus& GetGlobalStatusObj() {
     return CStatus::s_errorList;
 }

src/util/CStatus.hpp

@@ -27,6 +27,7 @@ class CStatus {
         // Member functions
         void Add(const CStatus&);
         void Add(STATUS_TYPE, const char*, ...);
+        void Prepend(STATUS_TYPE, const char*, ...);
 
     public:
         STORM_EXPLICIT_LIST(CStatus::STATUSENTRY, link) statusList;