debug.h 2.15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/*! \file debug.h
 * \brief suport debugging in libstfinv (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
 * \author Thomas Forbriger
 * \date 05/05/2011
 * 
 * suport debugging in libstfinv (prototypes)
 * 
 * Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach) 
 *
 * ----
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version. 
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ----
 *
 * 
 * REVISIONS and CHANGES 
 *  - 05/05/2011   V1.0   Thomas Forbriger
 * 
 * ============================================================================
 */

// include guard
#ifndef STFINV_DEBUG_H_VERSION

#define STFINV_DEBUG_H_VERSION \
40
  "STFINV_DEBUG_H   V1.0"
41 42

/*! \brief produce debug output
43
 * \ingroup group_debug
44 45 46 47 48 49 50 51 52 53 54 55 56
 *
 * \param C output will be generated if C == true
 * \param N name of function 
 * \param M message to print
 */
#define STFINV_debug(C,N,M) \
  if (C) { \
    std::cerr << "DEBUG (" << N << ", " \
      << __FILE__ << " line #" << __LINE__ << "):" << std::endl \
      << "      " << M << std::endl; \
    std::cerr.flush(); \
  }

57 58 59 60 61 62 63
/*! \brief report value in a sequence of output operators
 * \ingroup group_debug
 *
 * \param P parameter to dump
 */
#define STFINV_value( P ) #P << "=" << P

64
/*! \brief report value of expression
65
 * \ingroup group_debug
66 67 68 69 70 71 72 73 74 75 76
 *
 * \param P parameter to dump
 */
#define STFINV_DUMP( P ) \
  std::cerr << "DEBUG: " \
    << __FILE__ << " line #" << __LINE__ << " " \
    << #P << "=" << P << std::endl;

#endif // STFINV_DEBUG_H_VERSION (includeguard)

/* ----- END OF debug.h ----- */