Changeset 8858 for code/trunk/src/libraries/util/OrxAssert.h

Timestamp:

Aug 23, 2011, 12:45:53 AM (13 years ago)

Author:

landauf

Message:

merged output branch back to trunk.

Changes:

• you have to include util/Output.h instead of util/Debug.h
• COUT(x) is now called orxout(level)
• output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
• it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
• you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

• instead of COUT(0) use orxout()
• instead of COUT(1) use orxout(user_error) or orxout(internal_error)
• instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
• instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
• instead of COUT(4) use orxout(verbose)
• instead of COUT(5) use orxout(verbose_more)
• instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

• user_* levels are for the user, visible in the console and the log-file
• internal_* levels are for developers, visible in the log-file
• verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

• orxout() << "message" << endl;
• orxout(level) << "message" << endl;
• orxout(level, context) << "message" << endl;

Usage in Lua:

• orxout("message")
• orxout(orxonox.level.levelname, "message")
• orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

• orxout levelname message
• orxout_context levelname context message
• shortcuts: log message, error message, warning message, status message, info message, debug message

Location:

code/trunk

Files:

• . (modified) (2 props)
• src/libraries/util/OrxAssert.h (modified) (6 diffs)

code/trunk

@@ -1 +1 @@
 build
 codeblocks
+vs
 dependencies

@@ -1 +1 @@
 build
 codeblocks
+vs
 dependencies

code/trunk/src/libraries/util/OrxAssert.h

@@ -40 +40 @@
 
 #include <cassert>
-#include "Debug.h"
+#include "Output.h"
 
 #ifndef NDEBUG
@@ -46 +46 @@
 /** Run time assertion like assert(), but with an embedded message.
 @details
-    The message will be printed as error with COUT(1). <br>
+    The message will be printed as error with orxout(user_error). <br>
     You can use the same magic here as you can with \ref ThrowException
     @code
@@ -57 +57 @@
         if (!(condition)) \
         { \
-            COUT(1) << __FILE__ << "(" << __LINE__ << "): "; \
-            COUT(1) << "Assertion failed in " << __FUNCTIONNAME__ << std::endl; \
-            COUT(1) << "Expression: " << #condition << std::endl; \
-            COUT(1) << "Message   : " << errorMessage << std::endl; \
+            orxout(user_error) << __FILE__ << "(" << __LINE__ << "): "; \
+            orxout(user_error) << "Assertion failed in " << __FUNCTIONNAME__ << endl; \
+            orxout(user_error) << "Expression: " << #condition << endl; \
+            orxout(user_error) << "Message   : " << errorMessage << endl; \
             /* Don't use the condition again to avoid double evaluation */ \
             /* Instead, stringify the expression and negate it */ \
@@ -70 +70 @@
     mode (no abort() triggered then).
 @details
-    The message will be printed as error with COUT(1). <br>
+    The message will be printed as error with orxout(user_error). <br>
     You can use the same magic here as you can with \ref ThrowException
     @code
@@ -81 +81 @@
         if (!(condition)) \
         { \
-            COUT(1) << __FILE__ << "(" << __LINE__ << "): "; \
-            COUT(1) << "Verification failed in " << __FUNCTIONNAME__ << std::endl; \
-            COUT(1) << "Expression: " << #condition << std::endl; \
-            COUT(1) << "Message   : " << errorMessage << std::endl; \
+            orxout(user_error) << __FILE__ << "(" << __LINE__ << "): "; \
+            orxout(user_error) << "Verification failed in " << __FUNCTIONNAME__ << endl; \
+            orxout(user_error) << "Expression: " << #condition << endl; \
+            orxout(user_error) << "Message   : " << errorMessage << endl; \
             /* Don't use the condition again to avoid double evaluation */ \
             /* Instead, stringify the expression and negate it */ \
@@ -100 +100 @@
         if (!(condition)) \
         { \
-            COUT(1) << __FILE__ << "(" << __LINE__ << "): "; \
-            COUT(1) << "Verification failed in " << __FUNCTIONNAME__ << std::endl; \
-            COUT(1) << "Expression: " << #condition << std::endl; \
-            COUT(1) << "Message   : " << errorMessage << std::endl; \
+            orxout(user_error) << __FILE__ << "(" << __LINE__ << "): "; \
+            orxout(user_error) << "Verification failed in " << __FUNCTIONNAME__ << endl; \
+            orxout(user_error) << "Expression: " << #condition << endl; \
+            orxout(user_error) << "Message   : " << errorMessage << endl; \
             /* No assert() in release configuration */ \
         } \

@@ -1 +1 @@
 build
 codeblocks
+vs
 dependencies