Error percolation with nice error messages in debug mode

SamuelMarks · SamuelMarks · commit fc74436fd798 · 2026-04-15T19:40:53.000+12:00
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
+*.exe
 .idea
 *build*
 *_export.h
-
-test_amalg.c
+
+test_amalg.c
 cmake/scripts/
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -57,12 +57,18 @@ add_subdirectory("${PROJECT_NAME}")
 
 include(CTest)
 option(BUILD_TESTING "Build the tests" ON)
-if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
-    option(C89STRINGUTILS_BUILD_TESTING "Build the tests" ON)
-else()
-    option(C89STRINGUTILS_BUILD_TESTING "Build the tests" OFF)
+if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
+    option(C89STRINGUTILS_BUILD_TESTING "Build the tests" ON)
+else()
+    option(C89STRINGUTILS_BUILD_TESTING "Build the tests" OFF)
 endif()
 
+set(CDD_CHARSET "Unicode" CACHE STRING "Charset to use: Unicode or ANSI")
+set(CDD_THREADING "Multi-threaded" CACHE STRING "Threading: Multi-threaded or Single-threaded")
+set(CDD_MSVC_RTC "" CACHE STRING "MSVC Runtime Checks: RTC1, RTCs, RTCu, or empty")
+set(CDD_LTO OFF CACHE BOOL "Enable Link-Time Optimization (LTO)")
+set(CDD_DEPS "System" CACHE STRING "Dependency resolution strategy")
+
 if (CDD_CHARSET STREQUAL "Unicode")
     add_compile_definitions(UNICODE _UNICODE)
 endif()
diff --git a/c89stringutils/CMakeLists.txt b/c89stringutils/CMakeLists.txt
@@ -1,6 +1,6 @@
 get_filename_component(LIBRARY_NAME "${CMAKE_CURRENT_SOURCE_DIR}" NAME)
 
-set(Header_Files "c89stringutils_string_extras.h")
+set(Header_Files "c89stringutils_string_extras.h" "c89stringutils_log.h")
 source_group("Header Files" FILES "${Header_Files}")
 
 set(Source_Files "c89stringutils_string_extras.c")
@@ -61,19 +61,23 @@ if (C89STRINGUTILS_BUILD_AMALGAMATION)
     set(amalg_file "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_amalgamation.h")
     set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS
         "c89stringutils_export_pregen.h"
+        "c89stringutils_log.h"
         "c89stringutils_string_extras.h"
         "c89stringutils_string_extras.c")
 
     file(READ "${CMAKE_CURRENT_SOURCE_DIR}/c89stringutils_export_pregen.h" amalg_export)
+    file(READ "${CMAKE_CURRENT_SOURCE_DIR}/c89stringutils_log.h" amalg_log)
     file(READ "${CMAKE_CURRENT_SOURCE_DIR}/c89stringutils_string_extras.h" amalg_header)
     file(READ "${CMAKE_CURRENT_SOURCE_DIR}/c89stringutils_string_extras.c" amalg_source)
 
     string(REPLACE "#include \"c89stringutils_export.h\"" "" amalg_header "${amalg_header}")
     string(REPLACE "#include \"c89stringutils_string_extras.h\"" "" amalg_source "${amalg_source}")
+    string(REPLACE "#include \"c89stringutils_log.h\"" "" amalg_source "${amalg_source}")
 
     set(amalgamation "/* c89stringutils Amalgamation STB-style */\n\n")
     string(APPEND amalgamation "#ifndef C89STRINGUTILS_AMALGAMATION_H\n#define C89STRINGUTILS_AMALGAMATION_H\n\n")
     string(APPEND amalgamation "${amalg_export}\n\n")
+    string(APPEND amalgamation "${amalg_log}\n\n")
     string(APPEND amalgamation "${amalg_header}\n\n")
     string(APPEND amalgamation "#ifdef C89STRINGUTILS_IMPLEMENTATION\n\n")
     string(APPEND amalgamation "${amalg_source}\n\n")
diff --git a/c89stringutils/c89stringutils_log.h b/c89stringutils/c89stringutils_log.h
@@ -0,0 +1,43 @@
+#ifndef C89STRINGUTILS_LOG_H
+#define C89STRINGUTILS_LOG_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/* clang-format off */
+#include <stdio.h>
+/* clang-format on */
+
+#ifndef LOG_DEBUG
+#ifdef DEBUG
+#if defined(_MSC_VER) && _MSC_VER < 1400
+/* MSVC older than 2005 doesn't support variadic macros well */
+#define LOG_DEBUG(fmt, ...)
+#else
+#if defined(__GNUC__) || defined(__clang__)
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wvariadic-macros"
+#endif /* defined(__GNUC__) || defined(__clang__) */
+#define LOG_DEBUG(fmt, ...) fprintf(stderr, "[DEBUG] " fmt, ##__VA_ARGS__)
+#if defined(__GNUC__) || defined(__clang__)
+#pragma GCC diagnostic pop
+#endif /* defined(__GNUC__) || defined(__clang__) */
+#endif
+#else
+#if defined(__GNUC__) || defined(__clang__)
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wvariadic-macros"
+#endif /* defined(__GNUC__) || defined(__clang__) */
+#define LOG_DEBUG(fmt, ...)
+#if defined(__GNUC__) || defined(__clang__)
+#pragma GCC diagnostic pop
+#endif /* defined(__GNUC__) || defined(__clang__) */
+#endif /* DEBUG */
+#endif /* !LOG_DEBUG */
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* !C89STRINGUTILS_LOG_H */
diff --git a/c89stringutils/c89stringutils_string_extras.c b/c89stringutils/c89stringutils_string_extras.c
@@ -5,6 +5,7 @@
 
 /* clang-format off */
 #include "c89stringutils_string_extras.h"
+#include "c89stringutils_log.h"
 
 #include <stdarg.h>
 #include <stdio.h>
@@ -31,35 +32,35 @@
 #endif /* ANY_BSD */
 
 static int wtf_snprintf(char *buffer, size_t count, const char *format, ...) {
-  int result;
+  int rc;
   va_list args;
   va_start(args, format);
 #if defined(_MSC_VER)
-  result = _vsnprintf_s(buffer, count, _TRUNCATE, format, args);
+  rc = _vsnprintf_s(buffer, count, _TRUNCATE, format, args);
 #else
-  result = _vsnprintf(buffer, count, format, args);
+  rc = _vsnprintf(buffer, count, format, args);
 #endif
   va_end(args);
   /* In the case where the string entirely filled the buffer, _vsnprintf will
      not null-terminate it, but snprintf must. */
   if (count > 0)
     buffer[count - 1] = '\0';
-  return result;
+  return rc;
 }
 
 static int wtf_vsnprintf(char *buffer, size_t count, const char *format,
                          va_list args) {
-  int result;
+  int rc;
 #if defined(_MSC_VER)
-  result = _vsnprintf_s(buffer, count, _TRUNCATE, format, args);
+  rc = _vsnprintf_s(buffer, count, _TRUNCATE, format, args);
 #else
-  result = _vsnprintf(buffer, count, format, args);
+  rc = _vsnprintf(buffer, count, format, args);
 #endif
   /* In the case where the string entirely filled the buffer, _vsnprintf will
      not null-terminate it, but vsnprintf must. */
   if (count > 0)
     buffer[count - 1] = '\0';
-  return result;
+  return rc;
 }
 
 #define vsnprintf(buffer, count, format, args)                                 \
@@ -72,8 +73,11 @@ static int wtf_vsnprintf(char *buffer, size_t count, const char *format,
 
 #define HAVE_STRNCASECMP_H
 
-#define strncasecmp _strnicmp
-#define strcasecmp _stricmp
+int strncasecmp(const char *s1, const char *s2, size_t n) {
+  return _strnicmp(s1, s2, n);
+}
+
+int strcasecmp(const char *s1, const char *s2) { return _stricmp(s1, s2); }
 
 #endif /* !HAVE_STRNCASECMP_H */
 
@@ -199,55 +203,79 @@ size_t strerrorlen_s(errno_t errnum) {
 #define INIT_SZ 128
 
 extern int vasprintf(char **str, const char *fmt, va_list ap) {
-  int ret;
+  int rc;
   va_list ap2;
   char *string, *newstr;
   size_t len;
 
-  if ((string = (char *)malloc(INIT_SZ)) == NULL)
+  if ((string = (char *)malloc(INIT_SZ)) == NULL) {
+    rc = -1;
     goto fail;
+  }
 
   VA_COPY(ap2, ap);
-  ret = vsnprintf(string, INIT_SZ, fmt, ap2);
+  rc = vsnprintf(string, INIT_SZ, fmt, ap2);
   va_end(ap2);
-  if (ret >= 0 && ret < INIT_SZ) { /* succeeded with initial alloc */
+  if (rc >= 0 && rc < INIT_SZ) { /* succeeded with initial alloc */
     *str = string;
-  } else if (ret == INT_MAX || ret < 0) { /* Bad length */
+  } else if (rc == INT_MAX || rc < 0) { /* Bad length */
     free(string);
+    rc = -1;
     goto fail;
   } else { /* bigger than initial, realloc allowing for nul */
-    len = (size_t)ret + 1;
+    len = (size_t)rc + 1;
     if ((newstr = (char *)realloc(string, len)) == NULL) {
       free(string);
+      rc = -1;
       goto fail;
     }
     VA_COPY(ap2, ap);
-    ret = vsnprintf(newstr, len, fmt, ap2);
+    rc = vsnprintf(newstr, len, fmt, ap2);
     va_end(ap2);
-    if (ret < 0 || (size_t)ret >= len) { /* failed with realloc'ed string */
+    if (rc < 0 || (size_t)rc >= len) { /* failed with realloc'ed string */
       free(newstr);
+      rc = -1;
       goto fail;
     }
     *str = newstr;
   }
-  return ret;
+  return rc;
 
 fail:
+  if (rc != 0) {
+#ifdef _MSC_VER
+    char errbuf[256];
+    strerror_s(errbuf, sizeof(errbuf), errno);
+    LOG_DEBUG("vasprintf failed with rc=%d, error=%s\n", rc, errbuf);
+#else
+    LOG_DEBUG("vasprintf failed with rc=%d, error=%s\n", rc, strerror(errno));
+#endif
+  }
   *str = NULL;
   errno = ENOMEM;
-  return -1;
+  return rc;
 }
 
 extern int asprintf(char **str, const char *fmt, ...) {
   va_list ap;
-  int ret;
+  int rc;
 
   *str = NULL;
   va_start(ap, fmt);
-  ret = vasprintf(str, fmt, ap);
+  rc = vasprintf(str, fmt, ap);
   va_end(ap);
 
-  return ret;
+  if (rc < 0) {
+#ifdef _MSC_VER
+    char errbuf[256];
+    strerror_s(errbuf, sizeof(errbuf), errno);
+    LOG_DEBUG("asprintf failed with rc=%d, error=%s\n", rc, errbuf);
+#else
+    LOG_DEBUG("asprintf failed with rc=%d, error=%s\n", rc, strerror(errno));
+#endif
+  }
+
+  return rc;
 }
 
 #endif /* !HAVE_ASPRINTF */
diff --git a/c89stringutils/tests/test_string_extras.h b/c89stringutils/tests/test_string_extras.h
@@ -10,6 +10,7 @@ extern "C" {
 
 #include <c89stringutils_string_extras.h>
 #include <stdlib.h>
+#include <errno.h>
 /* clang-format on */
 
 static const char *buffer = "hello world";
@@ -27,7 +28,8 @@ TEST x_strnstr_should_fail(void) {
 
 TEST x_asprintf_should_succeed(void) {
   char *s = NULL;
-  asprintf(&s, "foo%s", "bar");
+  int rc = asprintf(&s, "foo%s", "bar");
+  ASSERT_EQ(6, rc);
   ASSERT_STR_EQ("foobar", s);
   free(s);
   PASS();
@@ -42,12 +44,63 @@ TEST x_jasprintf_should_succeed(void) {
   PASS();
 }
 
+TEST x_strcasecmp_should_succeed(void) {
+  ASSERT_EQ(0, strcasecmp("HeLlO", "hElLo"));
+  ASSERT(strcasecmp("apple", "banana") < 0);
+  ASSERT(strcasecmp("banana", "apple") > 0);
+  PASS();
+}
+
+TEST x_strncasecmp_should_succeed(void) {
+  ASSERT_EQ(0, strncasecmp("HeLlO World", "hElLo Earth", 5));
+  ASSERT(strncasecmp("apple pie", "apple tart", 9) < 0);
+  PASS();
+}
+
+TEST x_strcasestr_should_succeed(void) {
+  const char *haystack = "The Quick Brown Fox";
+  ASSERT_STR_EQ("Brown Fox", strcasestr(haystack, "bRoWn"));
+  ASSERT_EQ((char *)NULL, strcasestr(haystack, "red"));
+  PASS();
+}
+
+TEST x_strerrorlen_s_should_succeed(void) {
+  ASSERT(strerrorlen_s(ENOMEM) > 0);
+  ASSERT(strerrorlen_s(400) == 8); /* ESNULLP */
+  PASS();
+}
+
+/* vasprintf can be tested implicitly via asprintf, but let's test it directly
+ * just in case */
+static int test_vasprintf_wrapper(char **str, const char *fmt, ...) {
+  int rc;
+  va_list ap;
+  va_start(ap, fmt);
+  rc = vasprintf(str, fmt, ap);
+  va_end(ap);
+  return rc;
+}
+
+TEST x_vasprintf_should_succeed(void) {
+  char *s = NULL;
+  int rc = test_vasprintf_wrapper(&s, "test %d", 123);
+  ASSERT_EQ(8, rc);
+  ASSERT_STR_EQ("test 123", s);
+  free(s);
+  PASS();
+}
+
 /* Suites can group multiple tests with common setup. */
 SUITE(strnstr_suite) {
   RUN_TEST(x_strnstr_should_succeed);
   RUN_TEST(x_strnstr_should_fail);
   RUN_TEST(x_asprintf_should_succeed);
   RUN_TEST(x_jasprintf_should_succeed);
+  RUN_TEST(x_strcasecmp_should_succeed);
+  RUN_TEST(x_strncasecmp_should_succeed);
+  RUN_TEST(x_strcasestr_should_succeed);
+  RUN_TEST(x_strerrorlen_s_should_succeed);
+  RUN_TEST(x_vasprintf_should_succeed);
 }
 
 #ifdef __cplusplus
