cvrDebug.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrDebug.h
 *         Defines many macros used when debugging CVR-Libclasses.
 *         The main macros are _cvr_debug* and _cvr_if_debug*,
 *         which are active only if the macro symbol _CVR_DEBUG is high enough.
 * \author Jochen Wickel
 * \author Pablo Alvarado
 * \date   24.02.2003
 *
 * $Id: cvrDebug.h,v 1.3 2005/07/09 04:20:13 alvarado Exp $
 */

#undef _cvr_debug
#undef _cvr_debug1
#undef _cvr_debug2
#undef _cvr_debug3
#undef _cvr_debug4

#undef _cvr_if_debug
#undef _cvr_if_debug1
#undef _cvr_if_debug2
#undef _cvr_if_debug3
#undef _cvr_if_debug4

#undef _cvr_enterCTOR
#undef _cvr_leaveCTOR
#undef _cvr_enterDTOR
#undef _cvr_leaveDTOR

#undef _cvr_showVar

/**
 * \name Debugging Macros
 *
 * Developers of the CVR-Libuse following macros to activate debugging
 * code in their implementations.
 *
 * To activate them, the macro _CVR_DEBUG must be defined before including
 * this file.  The value of _CVR_DEBUG must be an integer value between 1 and 4
 * Debug level i+1 includes all information of level i.  This means, you
 * should use the macros _cvr_debug and _cvr_debug1 to display critical
 * information, that must always be displayed when debugging is activated and
 * less critical information with higher levels.
 *
 * Don't forget to include the "cvrUndebug.h" file at the end of your source
 * code, to undefine all the debug macros defined here, especially if it is
 * a header file (e.g. _template.h, _inline.h).
 *
 * The typical use of this file is:
 * \code
 * // somewhere at the beginning of your source file
 * #undef _CVR_DEBUG
 * #define _CVR_DEBUG 1 // comment out this line to remove all debug info.
 * #include "cvrDebug.h"
 *
 * // somewhere in your code you can use
 * _cvr_debug("I've been here with value" << val);
 *
 * _cvr_debug4("Only in level 4 this will be displayed");
 *
 * // at the end of your file you MUST undefine every debugging macro, to
 * // avoid confusion if someone includes your file!  Of course this is
 * // not necessary if your file is a .cpp file.  This is important for
 * // _template.h and _inline.h files.
 * #include "cvrUndebug.h"
 * \endcode
 */
//@{
#ifdef _CVR_DEBUG
#  include <iostream>

  /**
   * \def _cvr_debug
   * Debug Information Level 0 (always displayed)
   */
#  define _cvr_debug(a) std::cerr << a
#  define _cvr_if_debug(a) a

  /**
   * \def _cvr_debug1
   * Debug Information Level 1 (always displayed)
   */
#  define _cvr_debug1(a) std::cerr << a
#  define _cvr_if_debug1(a) a

#  if _CVR_DEBUG > 1
#    include "cvrClassName.h"
     /**
      * \def _cvr_debug2
      * Debug Information Level 2
      */
#    define _cvr_debug2(a) std::cerr << a
#    define _cvr_if_debug2(a) a

#    if _CVR_DEBUG > 2
       /**
        * \def _cvr_debug3
        * Debug Information Level 3
        */
#      define _cvr_debug3(a) std::cerr << a
#      define _cvr_if_debug3(a) a

#      if _CVR_DEBUG > 3
         /**
          * \def _cvr_debug4
          * Debug Information Level 4
          */
#        define _cvr_debug4(a) std::cerr << a
#        define _cvr_if_debug4(a) a

#      else
         /**
          * \def _cvr_debug4
          * Debug Information Level 4
          */
#        define _cvr_debug4(a)
#        define _cvr_if_debug4(a)

#      endif
#    else
       /**
        * \def _cvr_debug3
        * Debug Information Level 3
        */
#      define _cvr_debug3(a)
#      define _cvr_if_debug3(a)

#    endif
#  else
    /**
     * \def _cvr_debug2
     * Debug Information Level 2
     */
#    define _cvr_debug2(a)
#    define _cvr_if_debug2(a)

#  endif
#endif

#ifndef _cvr_debug
  /**
   * \def _cvr_debug
   * Debug Information Level 0 (always displayed)
   */
#  define _cvr_debug(a)
#  define _cvr_if_debug(a)

#endif

#ifndef _cvr_debug1
  /**
   * \def _cvr_debug1
   * Debug Information Level 1 (always displayed)
   */
#  define _cvr_debug1(a)
#  define _cvr_if_debug1(a)
#endif


#ifndef _cvr_debug2
  /**
   * \def _cvr_debug2
   * Debug Information Level 2
   */
#  define _cvr_debug2(a)
#  define _cvr_if_debug2(a)
#endif

#ifndef _cvr_debug3
  /**
   * \def _cvr_debug3
   * Debug Information Level 3
   */
#  define _cvr_debug3(a)
#  define _cvr_if_debug3(a)
#endif

#ifndef _cvr_debug4
  /**
   * \def _cvr_debug4
   * Debug Information Level 4
   */
#  define _cvr_debug4(a)
#  define _cvr_if_debug4(a)
#endif

/**
 * \def _cvr_enterCTOR
 * Debug macro to indicate "entering constructor".  It displays the class name
 * followed by the string "::ctor(".  It uses debug level 2.
 */
#define _cvr_enterCTOR() \
  _cvr_debug2(cvr::className::demangle(typeid(*this).name()) << \
              "::ctor(" << std::endl)

/**
 * \def _cvr_leaveCTOR
 * Debug macro to indicate "leaving constructor".  It displays the class name
 * followed by the string "::ctor)".  It uses debug level 2.
 */
#define _cvr_leaveCTOR() \
  _cvr_debug2(cvr::className::demangle(typeid(*this).name()) << \
              "::ctor)" << std::endl)

/**
 * \def _cvr_enterDTOR
 * Debug macro to indicate "entering destructor".  It displays the class name
 * followed by the string "::dtor(".  It uses debug level 2.
 */
#define _cvr_enterDTOR() \
  _cvr_debug2(cvr::className::demangle(typeid(*this).name()) << \
              "::dtor(" << std::endl)

/**
 * \def _cvr_leaveDTOR
 * Debug macro to indicate "leaving destructor".  It displays the class name
 * followed by the string "::ctor)".  It uses debug level 2.
 */
#define _cvr_leaveDTOR() \
  _cvr_debug2(cvr::className::demangle(typeid(*this).name()) << \
              "::dtor)" << std::endl)

/**
 * \def _cvr_showVar
 * Debug macro to display at debug level 0 the value of a given variable.
 * It displays the name of the variable followed by " = " and the contents
 * of it.  The type of the variable must be supported by the std::cerr stream.
 */
#define _cvr_showVar(a) _cvr_debug(#a " = " << a << "\n")

//@}