Adds SnitchLogGetString()

JujuAdams · May 2, 2023 · 3715d2f · 3715d2f
1 parent 7c4ce57
commit 3715d2f
Show file tree

Hide file tree

Showing 10 changed files with 67 additions and 3 deletions.
diff --git a/Snitch.yyp b/Snitch.yyp
@@ -3,10 +3,12 @@
   "resourceVersion": "1.6",
   "name": "Snitch",
   "resources": [
+    {"id":{"name":"__SnitchShowDebugMessage","path":"scripts/__SnitchShowDebugMessage/__SnitchShowDebugMessage.yy",},"order":15,},
     {"id":{"name":"SnitchServiceSet","path":"scripts/SnitchServiceSet/SnitchServiceSet.yy",},"order":6,},
     {"id":{"name":"SnitchLogSet","path":"scripts/SnitchLogSet/SnitchLogSet.yy",},"order":0,},
     {"id":{"name":"SnitchSoftError","path":"scripts/SnitchSoftError/SnitchSoftError.yy",},"order":2,},
     {"id":{"name":"__SnitchInitialize","path":"scripts/__SnitchInitialize/__SnitchInitialize.yy",},"order":0,},
+    {"id":{"name":"SnitchLogGetString","path":"scripts/SnitchLogGetString/SnitchLogGetString.yy",},"order":4,},
     {"id":{"name":"SnitchNetworkSet","path":"scripts/SnitchNetworkSet/SnitchNetworkSet.yy",},"order":2,},
     {"id":{"name":"oInvalidObject","path":"objects/oInvalidObject/oInvalidObject.yy",},"order":2,},
     {"id":{"name":"SnitchSendStringToNetwork","path":"scripts/SnitchSendStringToNetwork/SnitchSendStringToNetwork.yy",},"order":3,},

diff --git a/scripts/Snitch/Snitch.gml b/scripts/Snitch/Snitch.gml
@@ -19,7 +19,7 @@ function Snitch()
         ++_i;
     }
 
-    show_debug_message(_string);
+    __SnitchShowDebugMessage(_string);
     SnitchSendStringToLogFile(_string);
     SnitchSendStringToNetwork(_string); //TODO - Format this string for consumption (LogCat?)
 }
diff --git a/scripts/SnitchLogGetString/SnitchLogGetString.gml b/scripts/SnitchLogGetString/SnitchLogGetString.gml
@@ -0,0 +1,24 @@
+/// @param index
+
+function SnitchLogGetString(_index)
+{
+    static _logArray = __SnitchState().__logArray;
+
+    if (_index == all)
+    {
+        var _string = "";
+
+        var _i = 0;
+        repeat(SNITCH_IN_GAME_LOG_SIZE)
+        {
+            _string += _logArray[_i] + "\n";
+            ++_i;
+        }
+
+        _string = string_delete(_string, string_length(_string), 1);
+
+        return _string;
+    }
+
+    return ((_index < 0) || (_index >= SNITCH_IN_GAME_LOG_SIZE))? "" : _logArray[_index];
+}
diff --git a/scripts/SnitchLogGetString/SnitchLogGetString.yy b/scripts/SnitchLogGetString/SnitchLogGetString.yy
@@ -0,0 +1,11 @@
+{
+  "resourceType": "GMScript",
+  "resourceVersion": "1.0",
+  "name": "SnitchLogGetString",
+  "isDnD": false,
+  "isCompatibility": false,
+  "parent": {
+    "name": "Advanced",
+    "path": "folders/Snitch/Advanced.yy",
+  },
+}
diff --git a/scripts/__SnitchClassError/__SnitchClassError.gml b/scripts/__SnitchClassError/__SnitchClassError.gml
@@ -112,7 +112,7 @@ function __SnitchClassError() constructor
         var _string = "[" + (__fatal? "fatal" : "error") + " " + __uuid + "] " + __message;
         if (is_array(__rawCallstackArray)) _string += " " + string(__GuaranteeSimpleCallstack());
 
-        show_debug_message(_string);
+        __SnitchShowDebugMessage(_string);
         SnitchSendStringToLogFile(_string);
         SnitchSendStringToNetwork(_string);
     }

diff --git a/scripts/__SnitchConfigLog/__SnitchConfigLog.gml b/scripts/__SnitchConfigLog/__SnitchConfigLog.gml
@@ -1,3 +1,7 @@
+//How many strings to store in the in-game copy of the log
+//You can fetch strings using SnitchLogGetString()
+#macro SNITCH_IN_GAME_LOG_SIZE  20
+
 //Controls whether logging to file should be allowed at all
 #macro SNITCH_LOG_PERMITTED  true
 

diff --git a/scripts/__SnitchInitialize/__SnitchInitialize.gml b/scripts/__SnitchInitialize/__SnitchInitialize.gml
@@ -36,6 +36,7 @@ function __SnitchInitialize()
         __CrashCapture   = __RunningFromIDE? SNITCH_CRASH_CAPTURE_FROM_IDE : SNITCH_CRASH_CAPTURE_COMPILED;
 
         //Log files
+        __logArray           = array_create(SNITCH_IN_GAME_LOG_SIZE, "");
         __WroteLogFileHeader = false;
         __ZerothLogFile      = string_replace(SNITCH_LOG_FILENAME, "#", "0");
         __LogFileBuffer      = buffer_create(SNITCH_LOG_BUFFER_START_SIZE, buffer_grow, 1);

diff --git a/scripts/__SnitchShowDebugMessage/__SnitchShowDebugMessage.gml b/scripts/__SnitchShowDebugMessage/__SnitchShowDebugMessage.gml
@@ -0,0 +1,11 @@
+/// @param string
+
+function __SnitchShowDebugMessage(_string)
+{
+    static _logArray = __SnitchState().__logArray;
+
+    array_insert(_logArray, 0, _string);
+    array_delete(_logArray, SNITCH_IN_GAME_LOG_SIZE-1, 1);
+
+    show_debug_message(_string);
+}
diff --git a/scripts/__SnitchShowDebugMessage/__SnitchShowDebugMessage.yy b/scripts/__SnitchShowDebugMessage/__SnitchShowDebugMessage.yy
@@ -0,0 +1,11 @@
+{
+  "resourceType": "GMScript",
+  "resourceVersion": "1.0",
+  "name": "__SnitchShowDebugMessage",
+  "isDnD": false,
+  "isCompatibility": false,
+  "parent": {
+    "name": "THE SNITCH SEES ALL",
+    "path": "folders/Snitch/(System)/THE SNITCH SEES ALL.yy",
+  },
+}
diff --git a/scripts/__SnitchTrace/__SnitchTrace.gml b/scripts/__SnitchTrace/__SnitchTrace.gml
@@ -10,5 +10,5 @@ function __SnitchTrace()
 
     SnitchSendStringToLogFile(_string);
     SnitchSendStringToNetwork(_string);
-    show_debug_message(_string);
+    __SnitchShowDebugMessage(_string);
 }