Changeset 21046

Timestamp:

02/23/08 10:42:23 (9 months ago)

Author:

patrick

Message:

Updated the implementation of the debug output classes to use more modern
C++ techniques and recommendations. There is still more room for improvement,
of course.

Make better use of puncutation and language style in various status messages.

Files:

• juggler/trunk/modules/vapor/vpr/Util/Debug.cpp (modified) (29 diffs)
• juggler/trunk/modules/vapor/vpr/Util/Debug.h (modified) (11 diffs)

juggler/trunk/modules/vapor/vpr/Util/Debug.cpp

@@ -36 +36 @@
-#include <vpr/vprConfig.h>
-
-stdlib.h
+cstdlib
-#include <iostream>
-#include <fstream>
-#include <sstream>
-#include <vector>
+#include <utility>
-#include <boost/concept_check.hpp>
-
@@ -81 +82 @@
-
-Debug::Debug()
-
+
+
+
+
-   , mStreamPtr(&std::cout)
-
-
-
-
-
+
+
-   std::string debug_lev;
-   vpr::System::getenv("VPR_DEBUG_NFY_LEVEL", debug_lev);
@@ -93 +94 @@
-   if ( ! debug_lev.empty() )
-   {
-
-
-
+
+
-   }
-   else
-   {
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-   std::string debug_enable;
@@ -114 +113 @@
-   if ( ! debug_enable.empty() )
-   {
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-   }
-   else
-   {
-      mDebugEnabled = true;
-
-
-
-
+
+
-   }
-
-   // Check to see if there is a default Debug target
-
-
-
-
-
-
-
+
+
+
+
+
+
-      {
-         mStreamPtr = &std::cerr;
-      }
-"stdout" != debug_file
+ "stdout" != debug_file 
-      {
-         setOutputFile(debug_file);
@@ -156 +144 @@
-      }
-   }
+}
+
+Debug::~Debug()
+{
+   /* Do nothing. */ ;
-}
-
@@ -192 +185 @@
-
-std::ostream& Debug::getStream(const vpr::DebugCategory& cat, const int level,
-_thread_i
-_i
+ThreadI
+I
-                               const bool lockStream)
-{
@@ -200 +193 @@
-   // Lock the stream
-#ifdef LOCK_DEBUG_STREAM
-(lockStream
+ ( lockStream 
-   {
-      debugLock().acquire();     // Get the lock
@@ -208 +201 @@
-   // this allows us to avoid pointer dereferences until necessary
-   std::ostream& os = *mStreamPtr;
-(indentChange < 0
-
-i
-
-
-i
+ ( indentChange < 0 
+
+mI
+
+
+mI
-
-   // --- Create stream header --- //
-   // If we have thread local stuff to do
-(mUseThreadLocal
-
-(*gVprDebugCurColor).size() == 0
+ ( mUseThreadLocal 
+
+ (*gVprDebugCurColor).size() == 0 
-      {
-         os << clrRESET;
@@ -230 +223 @@
-
-   // Autoregister
-(mCategories.find(cat.mGuid) == mCategories.end()
+ ( mCategories.find(cat.mGuid) == mCategories.end() 
-   {
-      addCategory(cat);
-   }
-
-
-
-
+
+
+
+
-   sstream << "[" << vpr::Thread::self() << "] "
-           << (*mCategories.find(cat.mGuid)).second.mPrefix;
@@ -244 +238 @@
-   // If not, then output space if we are also using indent (assume this means
-   // new line used)
-(show_thread_info
+ ( showThreadInfo 
-   {
-      os << sstream.str();
-   }
-(use_indent
+ ( useIndent 
-   {
-      os << std::string(sstream.str().length(), ' ');
@@ -254 +248 @@
-
-   // Insert the correct number of tabs into the stream for indenting
-(use_indent
-
-(int i=0;i<indentLevel;i++
+ ( useIndent 
+
+ ( int i = 0; i < mIndentLevel; ++i 
-      {
-         os << "\t";
@@ -263 +257 @@
-
-   // If we have thread local stuff to do
-(mUseThreadLocal
+ ( mUseThreadLocal 
-   {
-      const int column_width(3);
-      int column(0);
-( (*gVprDebugCurColumn).size() > 0
+ ( (*gVprDebugCurColumn).size() > 0 
-      {
-         column = (*gVprDebugCurColumn).back();
-      }
-
-(column * column_width)
+column * column_width
-      {
-         os << "\t";
-      }
-
-
-
-
-
-
+
+
+
+
+
-   }
-
@@ -289 +282 @@
-void Debug::addCategory(const vpr::DebugCategory& catId)
-{
-(getLevel() >= vprDBG_VERB_LVL
-
-Adding category named [
-]  -- prefix: " << catId.mPrefix
- " -- guid: " << catId.mGuid
-to debug categories:
-size: " << mCategories.size()
-
-
-                                                     CategoryInfo(catId.mName
-                               
-                   false,
-
-
-if(getLevel() >= vprDBG_HVERB_LVL)
-{
-std::cout << "new size: " << mCategories.size()
+ ( getLevel() >= vprDBG_VERB_LVL 
+
+[vpr::Debug] Adding category named '
+' (prefix='" << catId.mPrefix <<  "', GUID="
+catId.mGuid << ")\n"
+            to debug categories: 
+(size=" << mCategories.size() << ")"
+
+
+mCategories.insert(std::make_pair(catId.mGuid
+CategoryInfo(catId.mName,
+false, false)));
+
+
+{
+   std::cout << "             new size=" << mCategories.size()
+         
-      debugDump();
-   }
+
-   updateAllowedCategories();
-
+
+
-   {
-      debugDump();
@@ -321 +316 @@
-
-   // Make sure category is in the vector
-Debug::
-
-(cat == mCategories.end()
+
+
+ ( cat == mCategories.end() 
-   {
-      // Autoregister
@@ -332 +327 @@
-   vprASSERT(cat != mCategories.end() && "Auto-register failed");    // ASSERT: We have a valid category
-
-Debug::
+
-   vprASSERT(cat_all != mCategories.end());    // ASSERT: We have a valid category
-
-   // If I specified to listen to all OR
-   // If it has category of ALL
-bool cat_is_all = 
-bool allow_all = 
-
-(cat_is_all || allow_all
+const bool cat_is_all
+const bool allow_all
+
+ ( cat_is_all || allow_all 
-   {
-      allow_category = true;
@@ -351 +346 @@
-   // Check dis-allowing
-   // - If a category is disallowed, then set it false
-(allow_category
-
-( (*cat).second.mDisallowed
+ ( allow_category 
+
+ ( (*cat).second.mDisallowed 
-      {
-         allow_category = false;          // Dis-allow it
@@ -373 +368 @@
-   vpr::System::getenv(disallow_var, dbg_disallow_cats);
-
-(getLevel() >= vprDBG_VERB_LVL
-
-updateAllowedCategories" << std::endl;
-std::cout << "   updateAllowedCat: Trying to find vprDBG_ALL. guid ["
-vprDBG_ALL.mGuid << "] 
+ ( getLevel() >= vprDBG_VERB_LVL 
+
+[vpr::Debug::updateAllowedCategories()] "
+          << "Trying to find vprDBG_ALL (guid=" << vprDBG_ALL.mGuid
+")
-   }
-
-   // Get cat info for vprDBG_ALL
-   // Auto-register vprDBG_ALL if needed
-Debug::
-
-(cat_all == mCategories.end()
+
+
+ ( cat_all == mCategories.end() 
-   {
-      addCategory(vprDBG_ALL);
-      cat_all = mCategories.find(vprDBG_ALL.mGuid);
-   }
-
-
+
+
+
+
+
-
-   // --- Setup allowed categories --- //
@@ -401 +399 @@
-     (*cat_all).second.mAllowed = false;       // Disable the showing of all for now
-
-
-
-
-
-
+
+
+
+
+
+
-      }
-
-      // For each currently known category name
-category_map_t::iterator i
-
-
-std::string
-
+typedef category_map_t::iterator iter_type
+ter_type i
+
+const std::string&
+ 
-         {
-(getLevel() >= vprDBG_CONFIG_LVL
+ ( getLevel() >= vprDBG_CONFIG_LVL 
-            {
-   vprDEBUG::updateAllowedCategories: Allowing:
-(*i).second.mName.c_str() << " val:"
-(*i).first.toString()
+[vpr::Debug::updateAllowedCategories()]
+"Allowing " << (*i).second.mName
+" (GUID=" << (*i).first << ")"
-            }
-            (*i).second.mAllowed = true;
@@ -425 +424 @@
-         else
-         {
-(getLevel() >= vprDBG_HVERB_LVL
+ ( getLevel() >= vprDBG_HVERB_LVL 
-            {
-std::cout << "vprDEBUG::updateAllowedCategories: Not found (to allow):
-<< (*i).second.mName.c_str() << " val:"
-<< (*i).first.toString()
+ std::cout << "[vpr::Debug::updateAllowedCategories()]
+ << "Not found (to allow) " << (*i).second.mName
+ << " (GUID=" << (*i).first << ")"
-            }
-         }
@@ -436 +435 @@
-   else
-   {
-(getLevel() >= vprDBG_CONFIG_LVL
-
-   vprDEBUG::VPR_DEBUG_ALLOW_CATEGORIES not found:\n
- Setting to:
+ ( getLevel() >= vprDBG_CONFIG_LVL 
+
+[vpr::Debug] VPR_DEBUG_ALLOW_CATEGORIES not found; 
+setting to
-      }
-      (*cat_all).second.mAllowed = true;       // Enable the showing of all for now
@@ -447 +446 @@
-   if ( ! dbg_disallow_cats.empty() )
-   {
-
-
-
-
-
+
+
+
+
+
+
-      }
-
-      // For each currently known category name
-category_map_t::iterator i
-
-
-std::string
-
+typedef category_map_t::iterator iter_type
+ter_type i
+
+const std::string&
+ 
-         {
-(getLevel() >= vprDBG_CONFIG_LVL
+ ( getLevel() >= vprDBG_CONFIG_LVL 
-            {
-   vprDEBUG::updateAllowedCategories: Disallowing:
-(*i).second.mName.c_str() << " val:
-.toString()
+[vpr::Debug::updateAllowedCategories()]
+"Disallowing " << (*i).second.mName << " (GUID=
+ << ")"
-            }
-            (*i).second.mDisallowed = true;
@@ -471 +471 @@
-         else
-         {
-(getLevel() >= vprDBG_VERB_LVL
+ ( getLevel() >= vprDBG_VERB_LVL 
-            {
-vprDEBUG::updateAllowedCategories: Not found (to allow):
-(*i).second.mName.c_str() << " val:"
-(*i).first.toString()
+[vpr::Debug::updateAllowedCategories()]
+"Not found (to disallow): " << (*i).second.mName
+" (GUID=" << (*i).first << ")"
-            }
-         }
@@ -482 +482 @@
-   else
-   {
-(getLevel() >= vprDBG_VERB_LVL
-
-   vprDEBUG::VPR_DEBUG_DISALLOW_CATEGORIES not found.\n
-flush
-
-
-
-
-
-
+ ( getLevel() >= vprDBG_VERB_LVL 
+
+[vpr::Debug] VPR_DEBUG_DISALLOW_CATEGORIES not found.
+endl
+
+
+
+
+
+const 
-{
-   (*gVprDebugCurColumn).push_back(column);
@@ -498 +498 @@
-void Debug::popThreadLocalColumn()
-{
-( (*gVprDebugCurColumn).size() > 0
+ ( (*gVprDebugCurColumn).size() > 0 
-   {
-      (*gVprDebugCurColumn).pop_back();
@@ -511 +511 @@
-void Debug::popThreadLocalColor()
-{
-( (*gVprDebugCurColor).size() > 0
+ ( (*gVprDebugCurColor).size() > 0 
-   {
-      (*gVprDebugCurColor).pop_back();
@@ -517 +517 @@
-}
-
-
+ const
-{
-   std::cout << "--- vpr::Debug Status ----" << std::endl;
-Debug::category_map_t::iterator i
-
-(i=mCategories.begin(); i != mCategories.end(); ++i
+typedef category_map_t::const_iterator iter_type
+
+ ( iter_type i = mCategories.begin(); i != mCategories.end(); ++i 
-   {
-      CategoryInfo cat_info = (*i).second;
- cat [" << (*i).first << "] 
- [" << cat_info.mName << "] 
- [" << cat_info.mPrefix << "] 
- [" << cat_info.mAllowed << "]
- [" << cat_info.mDisallowed << "] " << std::endl;
-}
-
+cateogry=" << (*i).first << "
+='" << cat_info.mName << "'
+='" << cat_info.mPrefix << "'
+=" << cat_info.mAllowed << "
+=" << cat_info.mDisallowed << " "
+             << std::endl;
+
-}
-
-void Debug::decrementIndentLevel()
-{
-
-
+
+
+
-}
-
-void Debug::incrementIndentLevel()
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
-}
-
@@ -556 +568 @@
-   , mIndent(indent)
-{
-(mIndent
+ ( mIndent 
-   {
-      vprDEBUG_BEGIN(mCat, mLevel) << mEntryText << vprDEBUG_FLUSH;
@@ -568 +580 @@
-DebugOutputGuard::~DebugOutputGuard()
-{
-(mIndent
+ ( mIndent 
-   {
-      // Don't bother printing anything if mExitText is an empty string.
-(mExitText == std::string("")
+ ( mExitText.empty() 
-      {
-         vprDEBUG_DECREMENT_INDENT(mCat, mLevel);
@@ -583 +595 @@
-   {
-      // Don't bother printing anything if mExitText is an empty string.
-(mExitText != std::string("")
+ ( ! mExitText.empty() 
-      {
-         vprDEBUG(mCat, mLevel) << mExitText << vprDEBUG_FLUSH;

juggler/trunk/modules/vapor/vpr/Util/Debug.h

@@ -42 +42 @@
-#include <string>
-#include <map>
+#include <boost/noncopyable.hpp>
-
-#include <vpr/Sync/Mutex.h>
@@ -50 +51 @@
-
-
-d
+
-//
-// 0 - Critical messages (always need to be seen)
@@ -211 +212 @@
-    * Class to support debug output.
-    */
-
+ : private boost::noncopyable
-   {
-   protected:
@@ -220 +221 @@
-      Debug();
-
-      // These two have to be here because Visual C++ will try to make them
-      // exported public symbols.  This causes problems because copying 
-      // vpr::Mutex objects is not allowed.
-      Debug(const Debug&) {;}
-      void operator= (const Debug&) {;}
-
-      /** Initialize the system */
-      void init();
@@ -231 +226 @@
-   public:
-
-
-
-
+
-
-      /**
@@ -257 +250 @@
-      /** Gets the debug stream to use */
-      std::ostream& getStream(const vpr::DebugCategory& cat, const int level,
-_thread_i
-_i
+ThreadI
+I
-                              const int indentChange = 0,
-                              const bool lockStream = true);
-
-
-
-d
+ const
+
+mD
-      }
-
@@ -301 +294 @@
-       */
-      //@{
-
+const 
-      void popThreadLocalColumn();
-      void pushThreadLocalColor(const std::string& color);
@@ -310 +303 @@
-      //@{
-      /** Is debugging enabled? */
-
+ const
-      {
-         return mDebugEnabled;
@@ -329 +322 @@
-
-      /** Dumps the current status to screen. */
-
+ const
-
-      /** Decrements the level of indention. */
@@ -338 +331 @@
-
-   private:
-
-d
-i
+  
+ mD
+ mI
-
-      std::ofstream* mFile;     /**< File we are using for all output. */
@@ -350 +343 @@
-      Mutex mDebugLock;
-
-
-
-
-
-
-
+
+
-         CategoryInfo(const std::string& name, const std::string& prefix,
-
-
-
-
-
-
+
-
-         std::string mName;         /**< What is the name of the category */