senf/Utils/Backtrace.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief Backtrace public header */
  30
  31 #ifndef HH_SENF_Utils_Backtrace_
  32 #define HH_SENF_Utils_Backtrace_ 1
  33
  34 // Custom includes
  35 #include <iostream>
  36
  37 //#include "Backtrace.mpp"
  38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 namespace senf {
  41     /** \defgroup backtraces Backtrace formatting and parsing
  42
  43         These functions help format and parse backtrace information as returned by the glibc
  44         ::backtrace function.
  45      */
  46
  47     /** \brief Format a given backtrace
  48
  49         This functions will write \a backtrace formatted to \a os. This includes demangling symbol
  50         names and interpreting some additional kernel symbols.
  51
  52         \ingroup backtraces
  53      */
  54     void formatBacktrace(std::ostream & os, void ** backtrace, int numEntries);
  55
  56     /** \brief Write a backtrace to \a os
  57
  58         backtrace() will write a backtrace of the current call stack to \a os.
  59
  60         \ingroup backtraces
  61      */
  62     void backtrace(std::ostream & os, int numEntries);
  63
  64 }
  65
  66 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  67 //#include "Backtrace.cci"
  68 //#include "Backtrace.ct"
  69 //#include "Backtrace.cti"
  70 #endif
  71
  72 \f
  73 // Local Variables:
  74 // mode: c++
  75 // fill-column: 100
  76 // comment-column: 40
  77 // c-file-style: "senf"
  78 // indent-tabs-mode: nil
  79 // ispell-local-dictionary: "american"
  80 // compile-command: "scons -u test"
  81 // End: