debug.h

Go to the documentation of this file.

/*!
  \file   debug.h
  \author Klaus Holst
  \date   Jan 2005
  
  \brief  Debug class. Implements much safer arrays.
    
*/

#ifndef _DEBUG_H_
#define _DEBUG_H_

/* All debug-print-statements are removed by preprocessor
   when NDEBUG is defined. Debug-printing goes to stderr. 
   dbg1 through dbg5 are used in a printf-like manner and
   dbg() is used to output the single argument using the
   c++ stream-object cerr. */
#ifndef NDEBUG

# include <iostream>
# include <stdio.h>
# include <vector>
# include <cassert>

# define dbg1(msg) fprintf(stderr, msg)
# define dbg2(fmt,a1) fprintf(stderr, fmt, a1)
# define dbg3(fmt,a1,a2) fprintf(stderr, fmt, a1, a2)
# define dbg4(fmt,a1,a2,a3) fprintf(stderr, fmt, a1, a2, a3)
# define dbg5(fmt,a1,a2,a3,a4) fprintf(stderr, fmt, a1, a2, a3, a4)
# define dbg(data) { std::cerr << (data); std::cerr.flush(); }

// This class asserts all subscripts to std::vector unless NDEBUG is
// defined, in which case it has zero overhead.
template <class T>
class safevector : public std::vector<T> {
 public:
  safevector() {}
  safevector(unsigned size):std::vector<T>(size) {}
  safevector(unsigned size, T const& value):std::vector<T>(size, value) {}
  safevector(std::vector<T> const& array): std::vector<T>(array) {}
  safevector(T const* begin, T const* end): std::vector<T>(begin, end) {}
  safevector(typename std::vector<T>::const_iterator begin, 
             typename std::vector<T>::const_iterator end): std::vector<T>(begin, end) {}

  inline typename std::vector<T>::const_reference operator[](unsigned idx)const {
    assert(idx < this->size());
    return std::vector<T>::operator[](idx);
  }
  inline typename std::vector<T>::reference operator[](unsigned idx) {
    assert(idx < this->size());
    return std::vector<T>::operator[](idx);
  }

  inline void insert(typename std::vector<T>::iterator pos, T const& value) {
    assert(pos >= this->begin() && pos <= this->end());
    std::vector<T>::insert(pos, value);
  }

  inline void insert(typename std::vector<T>::iterator pos, 
                     typename std::vector<T>::const_iterator from, 
                     typename std::vector<T>::const_iterator to) {
    assert(pos >= this->begin() && pos <= this->end());
    assert(from <= to);
    std::vector<T>::insert(pos, from, to);
  }

};

#else //!NDEBUG

# define dbg1(msg) {}
# define dbg2(fmt,a1) {} 
# define dbg3(fmt,a1,a2) {}
# define dbg4(fmt,a1,a2,a3) {}
# define dbg5(fmt,a1,a2,a3,a4) {} 
# define dbg(data) {} 

# define safevector std::vector

#endif//NDEBUG
#endif//_DEBUG_H_

---