include/xbt/backtrace.hpp

   1 /* Copyright (c) 2005-2023. 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::xbt {
  21
  22 class BacktraceImpl;
  23 /** A backtrace
  24  *
  25  *  This is used (among other things) in exceptions to store the associated
  26  *  backtrace.
  27  *
  28  *  @ingroup XBT_ex
  29  */
  30 class Backtrace {
  31 public:
  32   std::shared_ptr<BacktraceImpl> impl_;
  33   Backtrace();
  34   /** @brief Translate the backtrace in a human friendly form, unmangled with source code locations. */
  35   std::string resolve() const;
  36   /** @brief Display the resolved backtrace on stderr */
  37   void display() const;
  38 };
  39
  40 } // namespace simgrid::xbt
  41 #endif