Changeset 699

Timestamp:

Dec 27, 2007, 4:58:52 PM (17 years ago)

Author:

landauf

Message:

introduced 3 different soft debug levels: one for each output device (console, logfile, ingame-shell (to come))
all are configurable in the config file

Location:

code/branches/FICN/src/orxonox/core

Files:

• Debug.h (modified) (6 diffs)
• DebugLevel.cc (modified) (5 diffs)
• DebugLevel.h (modified) (4 diffs)
• OutputHandler.cc (modified) (6 diffs)
• OutputHandler.h (modified) (4 diffs)

code/branches/FICN/src/orxonox/core/Debug.h

@@ -68 +68 @@
 
 #define PRINT_EXEC  printf
-//#define COUT_EXEC   std::cout
-#define COUT_EXEC   orxonox::OutputHandler::getOutStream()
+#define COUT_EXEC(x) \
+  orxonox::OutputHandler::getOutStream().setOutputLevel(x)
 
 #ifndef PRINTF
@@ -207 +207 @@
    #define COUT1  \
     if (getSoftDebugLevel() >= ORX_ERROR)  \
-     COUT_EXEC
+     COUT_EXEC(1)
   #else
    #define COUT1 if (ORX_NONE)\
-    COUT_EXEC
+    COUT_EXEC(1)
   #endif
 
@@ -216 +216 @@
    #define COUT2 \
     if (getSoftDebugLevel() >= ORX_WARNING) \
-     COUT_EXEC
+     COUT_EXEC(2)
   #else
    #define COUT2 if (ORX_NONE) \
-    COUT_EXEC
+    COUT_EXEC(2)
   #endif
 
@@ -225 +225 @@
    #define COUT3 \
     if (getSoftDebugLevel() >= ORX_INFO) \
-     COUT_EXEC
+     COUT_EXEC(3)
   #else
    #define COUT3 if (ORX_NONE) \
-    COUT_EXEC
+    COUT_EXEC(3)
   #endif
 
@@ -234 +234 @@
    #define COUT4 \
     if (getSoftDebugLevel() >= ORX_DEBUG) \
-     COUT_EXEC
+     COUT_EXEC(4)
   #else
    #define COUT4 if (ORX_NONE) \
-    COUT_EXEC
+    COUT_EXEC(4)
   #endif
 
@@ -243 +243 @@
    #define COUT5 \
     if (getSoftDebugLevel() >= ORX_vDEBUG) \
-     COUT_EXEC
+     COUT_EXEC(5)
   #else
    #define COUT5 if (ORX_NONE) \
-    COUT_EXEC
+    COUT_EXEC(5)
   #endif
 
  #else /* if ORX_PRINT_DEBUG_OUTPUT */
   #define COUT(x) if (ORX_NONE) \
-   COUT_EXEC
+   COUT_EXEC(5)
  #endif /* if ORX_PRINT_DEBUG_OUTPUT */
 
  #define COUT0 \
-  COUT_EXEC
+  COUT_EXEC(0)
 #endif /* ifndef COUT */
 

code/branches/FICN/src/orxonox/core/DebugLevel.cc

@@ -32 +32 @@
 
 #include "CoreIncludes.h"
-#include "Debug.h"
 #include "DebugLevel.h"
 
@@ -53 +52 @@
     void DebugLevel::setConfigValues()
     {
-        SetConfigValue(softDebugLevel_, 2);
+        SetConfigValue(softDebugLevelConsole_, 3);
+        SetConfigValue(softDebugLevelLogfile_, 3);
+        SetConfigValue(softDebugLevelShell_, 1);
+
+        // softDebugLevel_ is the maximum of the 3 variables
+        this->softDebugLevel_ = this->softDebugLevelConsole_;
+        if (this->softDebugLevelLogfile_ > this->softDebugLevel_)
+            this->softDebugLevel_ = this->softDebugLevelLogfile_;
+        if (this->softDebugLevelShell_ > this->softDebugLevel_)
+            this->softDebugLevel_ = this->softDebugLevelShell_;
     }
 
@@ -59 +67 @@
         @brief Static function that holds the singleton.
     */
-    int DebugLevel::getSoftDebugLevel()
+    int DebugLevel::getSoftDebugLevel(OutputHandler::OutputDevice device)
     {
         static bool bCreatingSoftDebugLevelObject = true;   // Static variable - used to enhance the performance
@@ -67 +75 @@
         // If bReturnSoftDebugLevel is true, the instance of DebugLevel was created (it's set to true at the end of the constructor, call by reference)
         if (bReturnSoftDebugLevel)
-            return theOnlyDebugLevelObject->softDebugLevel_;
+        {
+            if (device == OutputHandler::LD_All)
+                return theOnlyDebugLevelObject->softDebugLevel_;
+            else if (device == OutputHandler::LD_Console)
+                return theOnlyDebugLevelObject->softDebugLevelConsole_;
+            else if (device == OutputHandler::LD_Logfile)
+                return theOnlyDebugLevelObject->softDebugLevelLogfile_;
+            else if (device == OutputHandler::LD_Shell)
+                return theOnlyDebugLevelObject->softDebugLevelShell_;
+        }
 
         // If bCreatingSoftDebugLevelObject is true, we're just about to create an instance of the DebugLevel class
@@ -74 +91 @@
             bCreatingSoftDebugLevelObject = false;
             theOnlyDebugLevelObject = new DebugLevel(bReturnSoftDebugLevel);
-            return theOnlyDebugLevelObject->softDebugLevel_;
+            return getSoftDebugLevel(device);
         }
 

code/branches/FICN/src/orxonox/core/DebugLevel.h

@@ -31 +31 @@
 
     The DebugLevel class is a singleton, only used to configure the amount of debug
-    output (see Debug.h) into the console and the log-file (see OutputHandler.h).
+    output (see Debug.h) into the console and the logfile (see OutputHandler.h).
 */
 
@@ -39 +39 @@
 #include "CorePrereqs.h"
 #include "OrxonoxClass.h"
+#include "OutputHandler.h"
 
 namespace orxonox
@@ -46 +47 @@
     {
         public:
-            static int getSoftDebugLevel();
+            static int getSoftDebugLevel(OutputHandler::OutputDevice device = OutputHandler::LD_All);
             void setConfigValues();
 
@@ -55 +56 @@
 
             int softDebugLevel_;                            //!< The debug level
+            int softDebugLevelConsole_;                     //!< The debug level for the console
+            int softDebugLevelLogfile_;                     //!< The debug level for the logfile
+            int softDebugLevelShell_;                       //!< The debug level for the ingame shell
             ConfigValueContainer* softDebugLevelContainer_; //!< The config value container for the debug level
     };

code/branches/FICN/src/orxonox/core/OutputHandler.cc

@@ -27 +27 @@
 
 #include "OutputHandler.h"
+#include "DebugLevel.h"
 
 namespace orxonox
@@ -61 +62 @@
 
     /**
+        @brief Returns the soft debug level for a given output device.
+        @param device The output device
+        @return The debug level
+    */
+    int OutputHandler::getSoftDebugLevel(OutputHandler::OutputDevice device)
+    {
+        return DebugLevel::getSoftDebugLevel(device);
+    }
+
+    /**
         @brief Overloaded << operator, redirects the output to the console and the logfile.
         @param sb The streambuffer that should be shown in the console
@@ -67 +78 @@
     OutputHandler& OutputHandler::operator<<(std::streambuf* sb)
     {
-        std::cout << sb;
-        this->logfile_ << sb;
-        this->logfile_.flush();
+        if (getSoftDebugLevel(OutputHandler::LD_Console) >= this->outputLevel_)
+            std::cout << sb;
+
+        if (getSoftDebugLevel(OutputHandler::LD_Logfile) >= this->outputLevel_)
+        {
+            this->logfile_ << sb;
+            this->logfile_.flush();
+        }
+
         return *this;
     }
@@ -80 +97 @@
     OutputHandler& OutputHandler::operator<<(std::ostream& (*manipulator)(std::ostream&))
     {
-        manipulator(std::cout);
-        manipulator(this->logfile_);
-        this->logfile_.flush();
+        if (getSoftDebugLevel(OutputHandler::LD_Console) >= this->outputLevel_)
+            manipulator(std::cout);
+
+        if (getSoftDebugLevel(OutputHandler::LD_Logfile) >= this->outputLevel_)
+        {
+            manipulator(this->logfile_);
+            this->logfile_.flush();
+        }
+
         return *this;
     }
@@ -93 +116 @@
     OutputHandler& OutputHandler::operator<<(std::ios& (*manipulator)(std::ios&))
     {
-        manipulator(std::cout);
-        manipulator(this->logfile_);
-        this->logfile_.flush();
+        if (getSoftDebugLevel(OutputHandler::LD_Console) >= this->outputLevel_)
+            manipulator(std::cout);
+
+        if (getSoftDebugLevel(OutputHandler::LD_Logfile) >= this->outputLevel_)
+        {
+            manipulator(this->logfile_);
+            this->logfile_.flush();
+        }
+
         return *this;
     }
@@ -106 +135 @@
     OutputHandler& OutputHandler::operator<<(std::ios_base& (*manipulator)(std::ios_base&))
     {
-        manipulator(std::cout);
-        manipulator(this->logfile_);
-        this->logfile_.flush();
+        if (getSoftDebugLevel(OutputHandler::LD_Console) >= this->outputLevel_)
+            manipulator(std::cout);
+
+        if (getSoftDebugLevel(OutputHandler::LD_Logfile) >= this->outputLevel_)
+        {
+            manipulator(this->logfile_);
+            this->logfile_.flush();
+        }
+
         return *this;
     }
-
-    /**
-        @brief Overloaded non-member << operator, redirects the output to the console and the logfile.
-        @param output The value that should be shown in the console
-        @return A reference to the OutputHandler itself
-    *//*
-    OutputHandler& operator<<(OutputHandler& out, char c)
-    {
-        std::cout << c;
-        out.getLogfile() << c;
-        out.getLogfile().flush();
-        return out;
-    }*/
-
-    /**
-        @brief Overloaded non-member << operator, redirects the output to the console and the logfile.
-        @param output The value that should be shown in the console
-        @return A reference to the OutputHandler itself
-    *//*
-    OutputHandler& operator<<(OutputHandler& out, signed char c)
-    {
-        std::cout << c;
-        out.getLogfile() << c;
-        out.getLogfile().flush();
-        return out;
-    }*/
-
-    /**
-        @brief Overloaded non-member << operator, redirects the output to the console and the logfile.
-        @param output The value that should be shown in the console
-        @return A reference to the OutputHandler itself
-    *//*
-    OutputHandler& operator<<(OutputHandler& out, unsigned char c)
-    {
-        std::cout << c;
-        out.getLogfile() << c;
-        out.getLogfile().flush();
-        return out;
-    }*/
-
-    /**
-        @brief Overloaded non-member << operator, redirects the output to the console and the logfile.
-        @param output The value that should be shown in the console
-        @return A reference to the OutputHandler itself
-    *//*
-    OutputHandler& operator<<(OutputHandler& out, const char* s)
-    {
-        std::cout << s;
-        out.getLogfile() << s;
-        out.getLogfile().flush();
-        return out;
-    }*/
-
-    /**
-        @brief Overloaded non-member << operator, redirects the output to the console and the logfile.
-        @param output The value that should be shown in the console
-        @return A reference to the OutputHandler itself
-    *//*
-    OutputHandler& operator<<(OutputHandler& out, const signed char* s)
-    {
-        std::cout << s;
-        out.getLogfile() << s;
-        out.getLogfile().flush();
-        return out;
-    }*/
-
-    /**
-        @brief Overloaded non-member << operator, redirects the output to the console and the logfile.
-        @param output The value that should be shown in the console
-        @return A reference to the OutputHandler itself
-    *//*
-    OutputHandler& operator<<(OutputHandler& out, const unsigned char* s)
-    {
-        std::cout << s;
-        out.getLogfile() << s;
-        out.getLogfile().flush();
-        return out;
-    }*/
- }
+}

code/branches/FICN/src/orxonox/core/OutputHandler.h

@@ -49 +49 @@
     {
         public:
+            enum OutputDevice
+            {
+                LD_All,
+                LD_Console,
+                LD_Logfile,
+                LD_Shell
+            };
+
             static OutputHandler& getOutStream();
 
             /** @returns a reference to the logfile. */
-            inline std::ofstream& getLogfile() { return this->logfile_; }
+            inline std::ofstream& getLogfile()
+                { return this->logfile_; }
+
+            /** @brief Sets the level of the incoming output. @param level The level of the incoming output @return The OutputHandler itself */
+            inline OutputHandler& setOutputLevel(int level)
+                { this->outputLevel_ = level; return *this; }
+
+            /** @returns the level of the incoming output. */
+            inline int getOutputLevel() const
+                { return this->outputLevel_; }
+
+            static int getSoftDebugLevel(OutputHandler::OutputDevice device);
 
             template <class T>
@@ -94 +113 @@
             std::ofstream logfile_;     //!< The logfile where the output is logged
             std::string logfilename_;   //!< The name of the logfile
+            int outputLevel_;           //!< The level of the incoming output
     };
 
@@ -104 +124 @@
     OutputHandler& OutputHandler::output(const T& output)
     {
-        std::cout << output;
-        this->logfile_ << output;
-        this->logfile_.flush();
+        if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Console) >= this->outputLevel_)
+            std::cout << output;
+
+        if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Logfile) >= this->outputLevel_)
+        {
+            this->logfile_ << output;
+            this->logfile_.flush();
+        }
+
         return *this;
     }
-/*
-    _CoreExport OutputHandler& operator<<(OutputHandler& out, char c);
-    _CoreExport OutputHandler& operator<<(OutputHandler& out, signed char c);
-    _CoreExport OutputHandler& operator<<(OutputHandler& out, unsigned char c);
 
-    _CoreExport OutputHandler& operator<<(OutputHandler& out, const char* s);
-    _CoreExport OutputHandler& operator<<(OutputHandler& out, const signed char* s);
-    _CoreExport OutputHandler& operator<<(OutputHandler& out, const unsigned char* s);
-*/
     /**
         @brief Overloading of the non-member << operator to redirect the output of classes with self defined '<< to std::ostream' operators to the console and the logfile.
@@ -127 +145 @@
     OutputHandler& operator<<(OutputHandler& out, const T& output)
     {
-        std::cout << output;
-        out.getLogfile() << output;
-        out.getLogfile().flush();
+        if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Console) >= out.getOutputLevel())
+            std::cout << output;
+
+        if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Logfile) >= out.getOutputLevel())
+        {
+            out.getLogfile() << output;
+            out.getLogfile().flush();
+        }
+
         return out;
     }