include/xbt/backtrace.hpp

   1 /* Copyright (c) 2005-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_XBT_BACKTRACE_HPP
   7 #define SIMGRID_XBT_BACKTRACE_HPP
   8
   9 #include <xbt/base.h>
  10
  11 #include <functional>
  12 #include <memory>
  13 #include <string>
  14
  15 SG_BEGIN_DECL
  16 /** @brief Shows a backtrace of the current location */
  17 XBT_PUBLIC void xbt_backtrace_display_current();
  18 SG_END_DECL
  19
  20 namespace simgrid {
  21 namespace xbt {
  22
  23 class BacktraceImpl;
  24 /** A backtrace
  25  *
  26  *  This is used (among other things) in exceptions to store the associated
  27  *  backtrace.
  28  *
  29  *  @ingroup XBT_ex
  30  */
  31 class Backtrace {
  32 public:
  33   std::shared_ptr<BacktraceImpl> impl_;
  34   Backtrace();
  35   /** @brief Translate the backtrace in a human friendly form, unmangled with source code locations. */
  36   std::string resolve() const;
  37   /** @brief Display the resolved backtrace on stderr */
  38   void display() const;
  39 };
  40
  41 }
  42 }
  43 #endif