senf/Utils/Backtrace.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Backtrace public header */
  25
  26 #ifndef HH_SENF_Utils_Backtrace_
  27 #define HH_SENF_Utils_Backtrace_ 1
  28
  29 // Custom includes
  30 #include <iostream>
  31
  32 //#include "Backtrace.mpp"
  33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  34
  35 namespace senf {
  36     /** \defgroup backtraces Backtrace formatting and parsing
  37
  38         These functions help format and parse backtrace information as returned by the glibc
  39         ::backtrace function.
  40      */
  41
  42     /** \brief Format a given backtrace
  43
  44         This functions will write \a backtrace formatted to \a os. This includes demangling symbol
  45         names and interpreting some additional kernel symbols.
  46
  47         \ingroup backtraces
  48      */
  49     void formatBacktrace(std::ostream & os, void ** backtrace, int numEntries);
  50
  51     /** \brief Write a backtrace to \a os
  52
  53         backtrace() will write a backtrace of the current call stack to \a os.
  54
  55         \ingroup backtraces
  56      */
  57     void backtrace(std::ostream & os, int numEntries);
  58
  59 }
  60
  61 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  62 //#include "Backtrace.cci"
  63 //#include "Backtrace.ct"
  64 //#include "Backtrace.cti"
  65 #endif
  66
  67 \f
  68 // Local Variables:
  69 // mode: c++
  70 // fill-column: 100
  71 // comment-column: 40
  72 // c-file-style: "senf"
  73 // indent-tabs-mode: nil
  74 // ispell-local-dictionary: "american"
  75 // compile-command: "scons -u test"
  76 // End: