Changeset 8858 for code/trunk/src/libraries/core/command/TclBind.cc

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/core/command/TclBind.cc (modified) (9 diffs)

code/trunk

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

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

code/trunk/src/libraries/core/command/TclBind.cc

@@ -34 +34 @@
 
 #include "SpecialConfig.h"
-#include "util/Debug.h"
+#include "util/Output.h"
 #include "util/Exception.h"
 #include "util/StringUtils.h"
@@ -106 +106 @@
             }
             catch (Tcl::tcl_error const &e)
-            {   COUT(1) << "Tcl error while creating Tcl-interpreter: " << e.what() << std::endl;   }
+            {   orxout(internal_error, context::tcl) << "Tcl error while creating Tcl-interpreter: " << e.what() << endl;   }
         }
     }
@@ -129 +129 @@
         }
         catch (Tcl::tcl_error const &e)
-        {   COUT(1) << "Tcl error while creating Tcl-interpreter: " << e.what() << std::endl; COUT(1) << "Error: Tcl isn't properly initialized. Orxonox might possibly not work like that." << std::endl;   }
+        {
+            orxout(internal_error, context::tcl) << "Tcl error while creating Tcl-interpreter: " << e.what() << endl;
+            orxout(user_error, context::tcl) << "Tcl isn't properly initialized. Orxonox might possibly not work like that." << endl;
+        }
 
         return interpreter;
@@ -154 +157 @@
     std::string TclBind::tcl_query(Tcl::object const &args)
     {
-        COUT(4) << "Tcl_query: " << args.get() << std::endl;
+        orxout(verbose, context::commands) << "Tcl_query: " << args.get() << endl;
         return TclBind::tcl_helper(args, true);
     }
@@ -163 +166 @@
     void TclBind::tcl_execute(Tcl::object const &args)
     {
-        COUT(4) << "Tcl_execute: " << args.get() << std::endl;
+        orxout(verbose, context::commands) << "Tcl_execute: " << args.get() << endl;
         TclBind::tcl_helper(args, false);
     }
@@ -184 +187 @@
             error = evaluation.execute();
 
-        switch (error)
-        {
-            case CommandExecutor::Error:       COUT(1) << "Error: Can't execute command \"" << command << "\", command doesn't exist. (B)" << std::endl; break;
-            case CommandExecutor::Incomplete:  COUT(1) << "Error: Can't execute command \"" << command << "\", not enough arguments given. (B)" << std::endl; break;
-            case CommandExecutor::Deactivated: COUT(1) << "Error: Can't execute command \"" << command << "\", command is not active. (B)" << std::endl; break;
-            case CommandExecutor::Denied:      COUT(1) << "Error: Can't execute command \"" << command << "\", access denied. (B)" << std::endl; break;
-        }
-
-        if (error == CommandExecutor::Error)
-            COUT(3) << "Did you mean \"" << evaluation.getCommandSuggestion() << "\"?" << std::endl;
+        if (error)
+        {
+            orxout(user_error) << "Can't execute command \"" << command << "\", " + CommandExecutor::getErrorDescription(error) + ". (TclBind)" << endl;
+            if (error == CommandExecutor::Inexistent)
+                orxout(user_info) << "Did you mean \"" << evaluation.getCommandSuggestion() << "\"?" << endl;
+        }
 
         return result;
@@ -211 +210 @@
             }
             catch (Tcl::tcl_error const &e)
-            {   COUT(1) << "Tcl error: " << e.what() << std::endl;   }
+            {   orxout(user_error, context::tcl) << "Tcl error: " << e.what() << endl;   }
         }
 
@@ -223 +222 @@
     void TclBind::bgerror(const std::string& error)
     {
-        COUT(1) << "Tcl background error: " << stripEnclosingBraces(error) << std::endl;
+        orxout(user_error, context::tcl) << "Tcl background error: " << stripEnclosingBraces(error) << endl;
     }
 
@@ -243 +242 @@
         }
         catch (Tcl::tcl_error const &e)
-        {   COUT(1) << "Tcl error: " << e.what() << std::endl;   }
+        {   orxout(user_error, context::tcl) << "Tcl error: " << e.what() << endl;   }
 
         if (error)

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