Greatest has colors. Documented TombRaider1.h

include/System.h

@@ -66,7 +66,7 @@ public:
     virtual ~System();
 
     /*!
-     * \brief Generates a buufered string for the printf call
+     * \brief Generates a buffered string for the printf call
      * \param string Format string like for printf
      * \returns string in a buffer
      */

include/TombRaider1.h

@@ -16,7 +16,9 @@
 class TombRaider1 {
 public:
 
-    // Associated with Item 7
+    /*!
+     * \brief States of a Wolf (Item 7)
+     */
     enum WolfStates {
         WolfState_Walking       = 1,
         WolfState_Running       = 2,
@@ -31,7 +33,9 @@ public:
         WolfState_Biting        = 12
     };
 
-    // Associated with Item 8
+    /*!
+     * \brief States of a Bear (Item 8)
+     */
     enum BearStates {
         BearState_Walking       = 0, //!< Walking on all fours
         BearState_Getting       = 1, //!< Getting back to all fours
@@ -45,7 +49,9 @@ public:
         BearState_Dying         = 9
     };
 
-    // Associated with Item 9
+    /*!
+     * \brief States of a Bat (Item 9)
+     */
     enum BatStates {
         BatState_Starting = 1, //!< Starting to fly
         BatState_Flying   = 2, //!< Flying straight
@@ -54,7 +60,9 @@ public:
         BatState_Dying    = 5
     };
 
-    // Associated with Item 10
+    /*!
+     * \brief States of a Crocodile on land (Item 10)
+     */
     enum CrocodileLandStates {
         CrocodileLandState_Stationary = 1,
         CrocodileLandState_Walking1   = 2,
@@ -64,14 +72,18 @@ public:
         CrocodileLandState_Dying      = 7
     };
 
-    // Associated with Item 11
+    /*!
+     * \brief States of a Crocodile in water (Item 11)
+     */
     enum CrocodileWaterStates {
         CrocodileWaterState_Swimming = 1,
         CrocodileWaterState_Biting   = 2,
         CrocodileWaterState_Dying    = 3
     };
 
-    // Associated with Items 12, 13 and 14
+    /*!
+     * \brief States of a Lion (Male & Female) and a Panther (Items 12, 13, 14)
+     */
     enum LionStates {
         LionState_Standing = 1,
         LionState_Walking  = 2,
@@ -82,7 +94,9 @@ public:
         LionState_Biting2  = 7
     };
 
-    // Associated with Item 15
+    /*!
+     * \brief States of a Gorilla (Item 15)
+     */
     enum GorillaStates {
         GorillaState_Standing = 1,  //!< Standing on all fours
         GorillaState_Running  = 3,  //!< Running on all fours
@@ -96,7 +110,9 @@ public:
         GorillaState_Climbing = 11
     };
 
-    // Associated with Item 16
+    /*!
+     * \brief States of a Giant Rat on land (Item 16)
+     */
     enum GiantRatLandStates {
         GiantRatLandState_Standing  = 1,
         GiantRatLandState_JumpBite  = 2,
@@ -106,14 +122,18 @@ public:
         GiantRatLandState_RearingUp = 6
     };
 
-    // Associated with Item 17
+    /*!
+     * \brief States of a Giant Rat in the water (Item 17)
+     */
     enum GiantRatWaterStates {
         GiantRatWaterState_Swimming = 1,
         GiantRatWaterState_Biting   = 2,
         GiantRatWaterState_Dying    = 3
     };
 
-    // Associated with Item 18
+    /*!
+     * \brief States of a Tyrannosaur (Item 18)
+     */
     enum TyrannosaurStates {
         TyrannosaurState_Standing  = 1,
         TyrannosaurState_Walking   = 2,
@@ -124,7 +144,9 @@ public:
         TyrannosaurState_Shaking   = 8  //!< Shaking Head and Spitting Out
     };
 
-    // Associated with Item 19
+    /*!
+     * \brief States of a Raptor (Item 19)
+     */
     enum RaptorStates {
         RaptorState_Dying     = 0,
         RaptorState_Standing  = 1,
@@ -136,7 +158,9 @@ public:
         RaptorState_Biting    = 8,
     };
 
-    // Associated with Item 20
+    /*!
+     * \brief States of a Winged Mutant (Item 20)
+     */
     enum WingedMutantStates {
         WingedMutantState_Crouching = 1,
         WingedMutantState_Walking   = 2,
@@ -145,14 +169,16 @@ public:
         WingedMutantState_Looking   = 6,
         WingedMutantState_Jumping   = 7,
         WingedMutantState_Clawing   = 8,
-        WingedMutantState_Aiming    = 9, //!< Aiming Right-Hand Gun
+        WingedMutantState_Aiming    = 9,  //!< Aiming Right-Hand Gun
         WingedMutantState_AimFire   = 10, //!< Aiming and Firing Left-Hand Gun
         WingedMutantState_Firing    = 11, //!< Firing Right-Hand Gun
         WingedMutantState_Standing  = 12,
         WingedMutantState_Flying    = 13
     };
 
-    // Associated with Item 23
+    /*!
+     * \brief States of a Centaur Mutant (Item 23)
+     */
     enum CentaurMutantStates {
         CentaurMutantState_Standing  = 1,
         CentaurMutantState_Firing    = 2,
@@ -162,13 +188,17 @@ public:
         CentaurMutantState_Rearing   = 6  //!<  Rearing up
     };
 
-    // Associated with Item 24
+    /*!
+     * \brief States of a Mummy (Item 24)
+     */
     enum MummyStates {
         MummyState_Standing = 1,
         MummyState_Falling  = 2  //!< Falling forward
     };
 
-    // Associated with Item 27
+    /*!
+     * \brief States of Larson (Item 27)
+     */
     enum LarsonStates {
         LarsonState_Walking1    = 0,
         LarsonState_StandingGun = 1,
@@ -180,7 +210,9 @@ public:
         LarsonState_Firing      = 7
     };
 
-    // Associated with Item 28
+    /*!
+     * \brief States of Pierre (Item 28)
+     */
     enum PierreStates {
         PierreState_Standing   = 1,
         PierreState_Walking    = 2,
@@ -191,7 +223,9 @@ public:
         PierreState_Firing     = 7
     };
 
-    // Associated with Item 29
+    /*!
+     * \brief States of the Skateboard (Item 29)
+     */
     enum SkateboardStates {
         SkateboardState_BeingTurned = 0,
         SkateboardState_Stationary1 = 1,
@@ -200,7 +234,9 @@ public:
         SkateboardState_Stationary4 = 4
     };
 
-    // Associated with Item 30
+    /*!
+     * \brief States of the Skateboard Kid (Item 30)
+     */
     enum SkateboardKidStates {
         SkateboardKidState_Turning = 0, //!< Turning and Aiming?
         SkateboardKidState_Firing1 = 1,
@@ -210,7 +246,9 @@ public:
         SkateboardKidState_Dying   = 5
     };
 
-    // Associated with Item 31
+    /*!
+     * \brief States of the Cowboy (Item 31)
+     */
     enum CowboyStates {
         CowboyState_Aiming1 = 1,
         CowboyState_Walking = 2,
@@ -220,7 +258,9 @@ public:
         CowboyState_Firing  = 6
     };
 
-    // Associated with Item 32
+    /*!
+     * \brief States of Mr. T (Item 32)
+     */
     enum MrTStates {
         MrTState_Dying    = 0,
         MrTState_Standing = 1,
@@ -230,7 +270,9 @@ public:
         MrTState_Firing   = 6
     };
 
-    // Associated with Item 33
+    /*!
+     * \brief States of Winged Natla (Item 33)
+     */
     enum WingedNatlaStates {
         WingedNatlaState_Standing1 = 1,
         WingedNatlaState_Flying    = 2,
@@ -242,7 +284,9 @@ public:
         WingedNatlaState_Dying2    = 9, //!< Dying for real
     };
 
-    // Associated with Item 34
+    /*!
+     * \brief States of the Giant Mutant (Item 34)
+     */
     enum GiantMutantStates {
         GiantMutantState_Dying         = 0,
         GiantMutantState_Sitting       = 1, //!< Sitting on floor
@@ -255,7 +299,9 @@ public:
         GiantMutantState_Shaking       = 11 //!< Shaking victim with right hand
     };
 
-    // Associated with Item 35
+    /*!
+     * \brief States of a piece of Collapsible Floor (Item 35)
+     */
     enum CollapsibleFloorStates {
         CollapsibleFloorState_Stationary = 0,
         CollapsibleFloorState_Shaking    = 1,
@@ -263,37 +309,49 @@ public:
         CollapsibleFloorState_Settling   = 3  //!< Settling down
     };
 
-    // Associated with Item 36
+    /*!
+     * \brief States of a Swinging Blade (Item 36)
+     */
     enum SwingingBladeStates {
         SwingingBladeState_Stationary = 0,
         SwingingBladeState_Swinging   = 2
     };
 
-    // Associated with Item 38
+    /*!
+     * \brief States of a Boulder (Item 38)
+     */
     enum BoulderStates {
         BoulderState_Stationary = 0,
         BoulderState_Rolling    = 1
     };
 
-    // Associated with Item 40
+    /*!
+     * \brief States of a Dart Gun (Item 40)
+     */
     enum DartGunStates {
         DartGunState_Idle   = 0, //!< ?
         DartGunState_Firing = 1  //!< ?
     };
 
-    // Associated with Item 41
+    /*!
+     * \brief States of a Door opening upwards (Item 41)
+     */
     enum DoorUpwardStates {
         DoorUpwardState_Upward = 0,
         DoorUpwardState_OnSide = 1
     };
 
-    // Associated with Item 42
+    /*!
+     * \brief States of a Slamming Door (Item 42)
+     */
     enum SlammingDoorStates {
         SlammingDoorState_Open   = 0,
         SlammingDoorState_Closed = 1
     };
 
-    // Associated with Item 44
+    /*!
+     * \brief States of the Handle of Thors Hammer (Item 44)
+     */
     enum ThorHammerHandleStates {
         ThorHammerHandleState_Stationary = 0, //!< Stationary in up position
         ThorHammerHandleState_Moving1    = 1, //!< Moving down a little and returning
@@ -301,59 +359,77 @@ public:
         ThorHammerHandleState_Stopped    = 3  //!< Stopped at down position
     };
 
-    // Associated with Item 45
+    /*!
+     * \brief States of the Block of Thors Hammer (Item 45)
+     */
     enum ThorHammerBlockStates {
         ThorHammerBlockState_Stationary = 0,
         ThorHammerBlockState_Moving1    = 1, //!< Moving down a little and returning
         ThorHammerBlockState_Moving2    = 2  //!< Moving down all the way
     };
 
-    // Associated with Item 47
+    /*!
+     * \brief States of a Metal Rod (Item 47)
+     */
     enum MetalRodStates {
         MetalRodState_Stationary = 0,
         MetalRodState_Moving     = 1
     };
 
-    // Associated with Items 48 - 51
+    /*!
+     * \brief States of a Pushable Cubical (Item 48 - 51)
+     */
     enum PushableStates {
         PushableState_Stationary = 0,
         PushableState_Pulled     = 1, //!< ?
         PushableState_Pushed     = 2  //!< ?
     };
 
-    // Associated with Item 52
+    /*!
+     * \brief States of a Movable Tall Block (Item 52)
+     */
     enum MovableTallBlockStates {
         MovableTallBlockState_Stationary     = 0,
         MovableTallBlockState_MovingForward  = 1, //!< ?
         MovableTallBlockState_MovingBackward = 2  //!< ?
     };
 
-    // Associated with Item 53
+    /*!
+     * \brief States of Falling Pieces (Item 53)
+     */
     enum FallingPiecesStates {
         FallingPiecesState_Stationary = 0,
         FallingPiecesState_Falling    = 1,
         FallingPiecesState_Settling   = 2  //!< Settling down
     };
 
-    // Associated with Items 55, 56
+    /*!
+     * \brief States of a Switch (Item 55, 56)
+     */
     enum SwitchStates {
         SwitchState_Off = 0,
         SwitchState_On  = 1  //!< States may be reversed
     };
 
-    // Associated with Items 57 - 66
+    /*!
+     * \brief States of a Door (Item 57 - 66)
+     */
     enum DoorStates {
         DoorState_Closed = 0,
         DoorState_Open   = 1
     };
 
-    // Associated with Items 74 - 76
+    /*!
+     * \brief States of a Cog (Item 74 - 76)
+     */
     enum CogStates {
         CogState_Stationary = 0,
         CogState_Turning    = 1
     };
 
-    // Associated with Item 162
+    /*!
+     * \brief States of a Shack (Item 162)
+     */
     enum ShackStates {
         ShackState_StartingPosition = 0,
         ShackState_DroppingFirst    = 1, //!< Dropping after first fuse
@@ -362,19 +438,26 @@ public:
         ShackState_OnGround         = 4
     };
 
-    // Associated with Items 163 and 181
+    /*!
+     * \brief States of a Mutant Egg & Holder (Item 163 & 181)
+     */
     enum MutantEggStates {
         MutantEggState_Starting = 0,
         MutantEggState_Hatching = 1  //!< Is the fragmenting hardcoded?
     };
 
-    // Associated with Item 182
+    /*!
+     * \brief States of a Motorboat (Item 182)
+     */
     enum MotorboatStates {
         MotorboatState_StationaryInitial = 1,
         MotorboatState_Moving            = 2,
         MotorboatState_StationaryFinal   = 3,
     };
 
+    /*!
+     * \brief Items & IDs in Tomb Raider 1
+     */
     enum Items {
         Lara             = 0,
         PistolAnimation  = 1,

test/greatest.h

@@ -3,6 +3,8 @@
  *
  * Modified 2014 by Thomas Buck <xythobuz@xythobuz.de>
  * --> C++ support
+ * --> Included janoskk color output patch
+ * --> Modified it so a tty output is detected at runtime (now unix only)
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -21,7 +23,6 @@
 #define GREATEST_H
 
 #ifdef __cplusplus
-#define __STDC_VERSION__ 19901L // C++11 compilers support var args
 extern "C"
 {
 #endif
@@ -81,6 +82,7 @@ int main(int argc, char **argv) {
 #include <stdio.h>
 #include <string.h>
 #include <time.h>
+#include <unistd.h>
 
 
 /***********
@@ -102,6 +104,15 @@ int main(int argc, char **argv) {
 #define GREATEST_USE_ABBREVS 1
 #endif
 
+/* Colorize the passed/failed results */
+#ifndef COLOR_FAIL
+#define COLOR_FAIL  "\033[22;31;1m"
+#endif
+#ifndef COLOR_PASS
+#define COLOR_PASS  "\033[22;32m"
+#endif
+#define COLOR_RESET "\033[22;0m"
+
 
 /*********
  * Types *
@@ -229,7 +240,7 @@ void GREATEST_SET_TEARDOWN_CB(greatest_teardown_cb *cb, void *udata);
 
 /* If __VA_ARGS__ (C99) is supported, allow parametric testing
  * without needing to manually manage the argument struct. */
-#if __STDC_VERSION__ >= 19901L
+#if defined __cplusplus || (__STDC_VERSION__ >= 19901L)
 #define GREATEST_RUN_TESTp(TEST, ...)                                   \
     do {                                                                \
         if (greatest_pre_test(#TEST) == 1) {                            \
@@ -421,10 +432,18 @@ static void greatest_run_suite(greatest_suite_cb *suite_cb,             \
     GREATEST_SET_TIME(greatest_info.suite.post_suite);                  \
     if (greatest_info.suite.tests_run > 0) {                            \
         fprintf(GREATEST_STDOUT,                                        \
-            "\n%u tests - %u pass, %u fail, %u skipped",                \
+            "\n%u tests - %u %spass%s, %u %sfail%s, %u skipped",        \
             greatest_info.suite.tests_run,                              \
             greatest_info.suite.passed,                                 \
+            (isatty(fileno(GREATEST_STDOUT))) ? (                       \
+            (!greatest_info.suite.failed) ? COLOR_PASS : COLOR_RESET    \
+            ) : "",                                                     \
+            (isatty(fileno(GREATEST_STDOUT))) ? COLOR_RESET : "",       \
             greatest_info.suite.failed,                                 \
+            (isatty(fileno(GREATEST_STDOUT))) ? (                       \
+            (greatest_info.suite.failed) ? COLOR_FAIL : COLOR_RESET     \
+            ) : "",                                                     \
+            (isatty(fileno(GREATEST_STDOUT))) ? COLOR_RESET : "",       \
             greatest_info.suite.skipped);                               \
         GREATEST_CLOCK_DIFF(greatest_info.suite.pre_suite,              \
             greatest_info.suite.post_suite);                            \
@@ -442,8 +461,11 @@ static void greatest_run_suite(greatest_suite_cb *suite_cb,             \
                                                                         \
 void greatest_do_pass(const char *name) {                               \
     if (GREATEST_IS_VERBOSE()) {                                        \
-        fprintf(GREATEST_STDOUT, "PASS %s: %s",                         \
-            name, greatest_info.msg ? greatest_info.msg : "");          \
+        fprintf(GREATEST_STDOUT,                                        \
+                (isatty(fileno(GREATEST_STDOUT))) ?                     \
+                COLOR_PASS "PASS" COLOR_RESET " %s: %s" :               \
+                "PASS %s: %s",                                          \
+                name, greatest_info.msg ? greatest_info.msg : "");      \
     } else {                                                            \
         fprintf(GREATEST_STDOUT, ".");                                  \
     }                                                                   \
@@ -453,6 +475,8 @@ void greatest_do_pass(const char *name) {                               \
 void greatest_do_fail(const char *name) {                               \
     if (GREATEST_IS_VERBOSE()) {                                        \
         fprintf(GREATEST_STDOUT,                                        \
+            (isatty(fileno(GREATEST_STDOUT))) ?                         \
+            COLOR_FAIL "FAIL" COLOR_RESET " %s: %s (%s:%u)" :           \
             "FAIL %s: %s (%s:%u)",                                      \
             name, greatest_info.msg ? greatest_info.msg : "",           \
             greatest_info.fail_file, greatest_info.fail_line);          \
@@ -462,7 +486,10 @@ void greatest_do_fail(const char *name) {                               \
         if (greatest_info.col % greatest_info.width != 0)               \
             fprintf(GREATEST_STDOUT, "\n");                             \
         greatest_info.col = 0;                                          \
-        fprintf(GREATEST_STDOUT, "FAIL %s: %s (%s:%u)\n",               \
+        fprintf(GREATEST_STDOUT,                                        \
+            (isatty(fileno(GREATEST_STDOUT))) ?                         \
+            COLOR_FAIL "FAIL" COLOR_RESET " %s: %s (%s:%u)\n" :         \
+            "FAIL %s: %s (%s:%u)\n",                                    \
             name,                                                       \
             greatest_info.msg ? greatest_info.msg : "",                 \
             greatest_info.fail_file, greatest_info.fail_line);          \
@@ -510,38 +537,38 @@ greatest_run_info greatest_info
 /* Handle command-line arguments, etc. */
 #define GREATEST_MAIN_BEGIN()                                           \
     do {                                                                \
-        int _i = 0;                                                      \
+        int _i = 0;                                                     \
         memset(&greatest_info, 0, sizeof(greatest_info));               \
         if (greatest_info.width == 0) {                                 \
             greatest_info.width = GREATEST_DEFAULT_WIDTH;               \
         }                                                               \
-        for (_i = 1; _i < argc; _i++) {                                    \
-            if (0 == strcmp("-t", argv[_i])) {                           \
-                if (argc <= _i + 1) {                                    \
+        for (_i = 1; _i < argc; _i++) {                                 \
+            if (0 == strcmp("-t", argv[_i])) {                          \
+                if (argc <= _i + 1) {                                   \
                     greatest_usage(argv[0]);                            \
                     exit(EXIT_FAILURE);                                 \
                 }                                                       \
-                greatest_info.test_filter = argv[_i+1];                  \
-                _i++;                                                    \
-            } else if (0 == strcmp("-s", argv[_i])) {                    \
-                if (argc <= _i + 1) {                                    \
+                greatest_info.test_filter = argv[_i+1];                 \
+                _i++;                                                   \
+            } else if (0 == strcmp("-s", argv[_i])) {                   \
+                if (argc <= _i + 1) {                                   \
                     greatest_usage(argv[0]);                            \
                     exit(EXIT_FAILURE);                                 \
                 }                                                       \
-                greatest_info.suite_filter = argv[_i+1];                 \
-                _i++;                                                    \
-            } else if (0 == strcmp("-f", argv[_i])) {                    \
+                greatest_info.suite_filter = argv[_i+1];                \
+                _i++;                                                   \
+            } else if (0 == strcmp("-f", argv[_i])) {                   \
                 greatest_info.flags |= GREATEST_FLAG_FIRST_FAIL;        \
-            } else if (0 == strcmp("-v", argv[_i])) {                    \
+            } else if (0 == strcmp("-v", argv[_i])) {                   \
                 greatest_info.flags |= GREATEST_FLAG_VERBOSE;           \
-            } else if (0 == strcmp("-l", argv[_i])) {                    \
+            } else if (0 == strcmp("-l", argv[_i])) {                   \
                 greatest_info.flags |= GREATEST_FLAG_LIST_ONLY;         \
-            } else if (0 == strcmp("-h", argv[_i])) {                    \
+            } else if (0 == strcmp("-h", argv[_i])) {                   \
                 greatest_usage(argv[0]);                                \
                 exit(EXIT_SUCCESS);                                     \
             } else {                                                    \
                 fprintf(GREATEST_STDOUT,                                \
-                    "Unknown argument '%s'\n", argv[_i]);                \
+                    "Unknown argument '%s'\n", argv[_i]);               \
                 greatest_usage(argv[0]);                                \
                 exit(EXIT_FAILURE);                                     \
             }                                                           \
@@ -559,9 +586,14 @@ greatest_run_info greatest_info
                 greatest_info.end);                                     \
             fprintf(GREATEST_STDOUT, "\n");                             \
             fprintf(GREATEST_STDOUT,                                    \
-                "Pass: %u, fail: %u, skip: %u.\n",                      \
-                greatest_info.passed,                                   \
-                greatest_info.failed, greatest_info.skipped);           \
+                "%sPass: %u, fail: %u, "                                \
+                "skip: %u.%s\n",                                        \
+                (isatty(fileno(GREATEST_STDOUT))) ?                     \
+                ((greatest_info.failed) ? COLOR_FAIL : COLOR_PASS) :    \
+                "", greatest_info.passed,                               \
+                greatest_info.failed,                                   \
+                greatest_info.skipped,                                  \
+                (isatty(fileno(GREATEST_STDOUT))) ? COLOR_RESET : "");  \
         }                                                               \
         return (greatest_info.failed > 0                                \
             ? EXIT_FAILURE : EXIT_SUCCESS);                             \
@@ -592,9 +624,9 @@ greatest_run_info greatest_info
 #define SET_SETUP      GREATEST_SET_SETUP_CB
 #define SET_TEARDOWN   GREATEST_SET_TEARDOWN_CB
 
-#if __STDC_VERSION__ >= 19901L
-#endif /* C99 */
+#if defined __cplusplus || (__STDC_VERSION__ >= 19901L)
 #define RUN_TESTp      GREATEST_RUN_TESTp
+#endif
 #endif /* USE_ABBREVS */
 
 #ifdef __cplusplus