Improved global assert

ChangeLog.md

@@ -5,6 +5,7 @@
     [ 20140806 ]
     * Improved Script reader and its Unit Test
     * Successfully parsing the TR2 Script strings!
+    * Now using assertEqual globally
 
     [ 20140804 ]
     * Added preliminary Tomb Raider Script parser

include/global.h

@@ -107,16 +107,62 @@ KeyboardButton stringToKeyboardButton(const char *key);
 
 // If available, use our own assert that prints the call stack
 #if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE) && defined(HAVE_BACKTRACE_SYMBOLS)
+
 #ifndef NDEBUG
-[[noreturn]] void assertImplementation(const char *exp, const char *file, int line);
-#define assert(x) (void)((x) || (assertImplementation(#x, __FILE__, __LINE__),0))
-#else
+
+#include <iostream>
+#include <execinfo.h>
+
+template<typename T, typename U>
+[[noreturn]] void assertEqualImplementation(const char *exp, T a, U b, const char *file, int line, bool print) {
+    const unsigned int maxSize = 128;
+    void *callstack[maxSize];
+    int frames = backtrace(callstack, maxSize);
+    char **strs = backtrace_symbols(callstack, frames);
+
+    std::cout << std::endl << "assertion failed:" << std::endl;
+    std::cout << "\t" << exp << std::endl;
+    if (print)
+        std::cout << "\t (" << a << " != " << b << ")" << std::endl;
+    std::cout << "in " << file << ":" << line << std::endl << std::endl;
+
+    for (int i = 0; i < frames; i++)
+        std::cout << strs[i] << std::endl;
+
+    delete [] strs;
+    abort();
+}
+
+// Evaluating x or y could have side-effects
+// So we only do it once!
+
+#define assert(x) { \
+    auto assertEvalTemp = x; \
+    if (!assertEvalTemp) \
+        assertEqualImplementation(#x, assertEvalTemp, true, __FILE__, __LINE__, false); \
+}
+
+#define assertEqual(x, y) { \
+    auto assertEvalTemp = x; \
+    auto assertEvalTemp2 = y; \
+    if (assertEvalTemp != assertEvalTemp2) \
+        assertEqualImplementation(#x " == " #y, assertEvalTemp, assertEvalTemp2, __FILE__, __LINE__, true); \
+}
+
+#else // NDEBUG
+
 #define assert(x)
-#endif
-#else
+#define assertEqual(x, y)
+
+#endif // NDEBUG
+
+#else // EXECINFO
+
 // Fall back to the default C assert
 #include <cassert>
-#endif
+#define assertEqual(x, y) assert((x) == (y))
 
-#endif
+#endif // EXECINFO
+
+#endif // _GLOBAL_H_
 

src/main.cpp

@@ -23,8 +23,6 @@
 #include "utils/strings.h"
 #include "utils/time.h"
 
-#ifndef UNIT_TEST
-
 #ifdef USING_AL
 #include "SoundAL.h"
 #else
@@ -364,28 +362,3 @@ KeyboardButton stringToKeyboardButton(const char *key) {
     return unknownKey;
 }
 
-#endif // UNIT_TEST
-
-#if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE) && defined(HAVE_BACKTRACE_SYMBOLS) && (!defined(NDEBUG))
-
-#include <execinfo.h>
-
-void assertImplementation(const char *exp, const char *file, int line) {
-    const unsigned int maxSize = 128;
-    void *callstack[maxSize];
-    int frames = backtrace(callstack, maxSize);
-    char **strs = backtrace_symbols(callstack, frames);
-
-    std::cout << std::endl << "assertion failed:" << std::endl;
-    std::cout << "\t" << exp << std::endl;
-    std::cout << "in " << file << ":" << line << std::endl << std::endl;
-
-    for (int i = 0; i < frames; i++)
-        std::cout << strs[i] << std::endl;
-
-    delete [] strs;
-    abort();
-}
-
-#endif
-

test/CMakeLists.txt

@@ -7,7 +7,7 @@ add_custom_target (check COMMAND ${CMAKE_CTEST_COMMAND} --output-on-failure)
 #################################################################
 
 add_executable (tester_binary EXCLUDE_FROM_ALL
-    "binary.cpp" "../src/utils/binary.cpp" "../src/main.cpp"
+    "binary.cpp" "../src/utils/binary.cpp"
 )
 add_dependencies (check tester_binary)
 add_test (NAME test_binary COMMAND tester_binary)
@@ -15,7 +15,7 @@ add_test (NAME test_binary COMMAND tester_binary)
 #################################################################
 
 add_executable (tester_script EXCLUDE_FROM_ALL
-    "Script.cpp" "../src/Script.cpp" "../src/main.cpp"
+    "Script.cpp" "../src/Script.cpp"
     "../src/utils/binary.cpp" "../src/utils/strings.cpp"
 )
 

test/Script.cpp

@@ -8,7 +8,6 @@
 #include <iostream>
 
 #include "global.h"
-#include "test.h"
 #include "utils/strings.h"
 #include "Script.h"
 

test/binary.cpp

@@ -10,7 +10,6 @@
 #include <fstream>
 
 #include "global.h"
-#include "test.h"
 #include "utils/binary.h"
 
 
@@ -57,7 +56,7 @@ namespace {
         assertEqual(file.readFloat(), f1);
         assertEqual(file.readFloat(), f2);
 
-        assert(file.tell() == 38);
+        assertEqual(file.tell(), 38);
 
         return 0;
     }

test/test.h

@@ -1,20 +0,0 @@
-/*!
- * \file test/test.h
- * \brief Common Unit Test helpers
- *
- * \author xythobuz
- */
-
-#ifndef _TEST_H
-#define _TEST_H
-
-#include <iostream>
-
-#define assertEqual(x, y) if (x != y) { \
-    std::cout << "Assertion failed:" << std::endl; \
-    std::cout << #x << " == " << #y << " (" << x << ", " << y << ")" << std::endl; \
-    return 1; \
-}
-
-#endif
-