includeLinks/MsqDebug.hpp

Go to the documentation of this file.

/* ***************************************************************** 
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2004 Sandia Corporation and Argonne National
    Laboratory.  Under the terms of Contract DE-AC04-94AL85000 
    with Sandia Corporation, the U.S. Government retains certain 
    rights in this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License 
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   
  ***************************************************************** */

#ifndef MSQ_DEBUG_HPP
#define MSQ_DEBUG_HPP


#include "Mesquite.hpp"

#ifdef MSQ_USE_OLD_STD_HEADERS
#  include <vector.h>
#else
#  include <vector>
#endif

#ifdef MSQ_USE_OLD_IO_HEADERS
#  include <iostream.h>
#else
#  include <iostream>
#endif

#ifdef MSQ_USE_OLD_C_HEADERS
#  include <stdio.h>
#else
#  include <cstdio>
#endif

namespace Mesquite {


class MsqDebug
{
  public:
    
      // some pre-defined meanings of debug flags
    enum {
      WARN = 1,
      INFO = 2
    };
  
    static void enable( unsigned flag )          { set( flag, true );  }
    static void disable( unsigned flag )         { set( flag, false ); }
    static void set( unsigned flag, bool state );
    static bool get( unsigned flag );
    
    static void disable_all();
  
    static msq_stdio::ostream& get_stream( unsigned flag );
    static void set_stream( unsigned flag, msq_stdio::ostream& stream );
    
      // Work around limitations of preprocessor macros.
      // You probably don't want to use this directly.  See
      // MSQ_PRINT macro below.
    class FormatPrinter {
      public:
        FormatPrinter( unsigned flag ) : myFlag(flag) {}
        void print( const char* format, ... ) const
          #ifdef __GNUC__
           __attribute__ ((format (printf, 2, 3)))
          #endif
          ;
        const unsigned myFlag;
    };
    
      // Static initialize function (declare a static instance of this
      // such that the constructor can be used as a function to initialize
      // static data.)
    class InitializeFlags {
      public:
        InitializeFlags();
    };
      
  private:
  
    static msq_std::vector<msq_stdio::ostream*> streams;
    static msq_std::vector<bool> flags;
    static InitializeFlags init;
};

#ifdef MSQ_ENABLE_DEBUG
#  define MSQ_DBG(flag) Mesquite::MsqDebug::get(flag)
#else
#  define MSQ_DBG(flag) false
#endif

#define MSQ_DBGOUT(flag) if (MSQ_DBG(flag)) Mesquite::MsqDebug::get_stream(flag)

#define MSQ_PRINT(flag)  if (MSQ_DBG(flag)) Mesquite::MsqDebug::FormatPrinter(flag).print

} // namespace Mesquite

#endif