From 28fb58f0ea11f0b30b8aaf79d7bb148491ed8775 Mon Sep 17 00:00:00 2001
From: Murlocohol <B_svendsen@aol.com>
Date: Wed, 11 Oct 2023 06:15:40 -0400
Subject: [PATCH] [rtext] TextFormat() warn user if buffer overflow occured.
 (#3399)

* [rtext] TextFormat now alerts user to truncation.

* Update rtext.c

* Update rcore.c

* Update rtext.c
---
 src/rcore.c | 12 +++++++++++-
 src/rtext.c | 11 ++++++++++-
 2 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/src/rcore.c b/src/rcore.c
index 18d2e2929..c1c9980b2 100644
--- a/src/rcore.c
+++ b/src/rcore.c
@@ -2922,6 +2922,7 @@ static void PlayAutomationEvent(unsigned int frame)
 #if !defined(SUPPORT_MODULE_RTEXT)
 // Formatting of text with variables to 'embed'
 // WARNING: String returned will expire after this function is called MAX_TEXTFORMAT_BUFFERS times
+
 const char *TextFormat(const char *text, ...)
 {
 #ifndef MAX_TEXTFORMAT_BUFFERS
@@ -2940,12 +2941,21 @@ const char *TextFormat(const char *text, ...)
 
     va_list args;
     va_start(args, text);
-    vsnprintf(currentBuffer, MAX_TEXT_BUFFER_LENGTH, text, args);
+    int charCountRequired = vsnprintf(currentBuffer, MAX_TEXT_BUFFER_LENGTH, text, args);
     va_end(args);
 
+    // If charCountRequired is larger than the MAX_TEXT_BUFFER_LENGTH, then overflow occured
+    if(charCountRequired > MAX_TEXT_BUFFER_LENGTH)
+    {
+        // We are going to insert [TRUN] at the end of the string so the user knows what happened
+        char *truncBuffer = buffers[index] + MAX_TEXT_BUFFER_LENGTH - 7; // 7 = six letters + '\0'
+        sprintf(truncBuffer, "[TRUN]");
+    }
+
     index += 1;     // Move to next buffer for next function call
     if (index >= MAX_TEXTFORMAT_BUFFERS) index = 0;
 
     return currentBuffer;
 }
+
 #endif // !SUPPORT_MODULE_RTEXT
diff --git a/src/rtext.c b/src/rtext.c
index fb8440131..16b65507b 100644
--- a/src/rtext.c
+++ b/src/rtext.c
@@ -1371,15 +1371,24 @@ const char *TextFormat(const char *text, ...)
 
     va_list args;
     va_start(args, text);
-    vsnprintf(currentBuffer, MAX_TEXT_BUFFER_LENGTH, text, args);
+    int charCountRequired = vsnprintf(currentBuffer, MAX_TEXT_BUFFER_LENGTH, text, args);
     va_end(args);
 
+    // If charCountRequired is larger than the MAX_TEXT_BUFFER_LENGTH, then overflow occured
+    if(charCountRequired > MAX_TEXT_BUFFER_LENGTH)
+    {
+        // We are going to insert [TRUN] at the end of the string so the user knows what happened
+        char *truncBuffer = buffers[index] + MAX_TEXT_BUFFER_LENGTH - 7; // 7 = six letters + '\0'
+        sprintf(truncBuffer, "[TRUN]");
+    }
+
     index += 1;     // Move to next buffer for next function call
     if (index >= MAX_TEXTFORMAT_BUFFERS) index = 0;
 
     return currentBuffer;
 }
 
+
 // Get integer value from text
 // NOTE: This function replaces atoi() [stdlib.h]
 int TextToInteger(const char *text)