Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Forgotten cleanups in includes.
[simgrid.git] / include / xbt / backtrace.hpp
index ae378b7..4a3a589 100644 (file)
@@ -1,17 +1,21 @@
-/* Copyright (c) 2005-2018. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2005-2020. The SimGrid Team. All rights reserved.          */
 
-#ifndef SIMGRIX_XBT_BACKTRACE_HPP
-#define SIMGRIX_XBT_BACKTRACE_HPP
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include <cstddef>
+#ifndef SIMGRID_XBT_BACKTRACE_HPP
+#define SIMGRID_XBT_BACKTRACE_HPP
 
-#include <string>
+#include <xbt/base.h>
+
+#include <functional>
 #include <memory>
-#include <vector>
+#include <string>
 
-#include <xbt/base.h>
-#include <xbt/backtrace.h>
+SG_BEGIN_DECL
+/** @brief Shows a backtrace of the current location */
+XBT_PUBLIC void xbt_backtrace_display_current();
+SG_END_DECL
 
 namespace simgrid {
 namespace xbt {
@@ -20,18 +24,26 @@ namespace xbt {
  *
  *  Return the origin string if this fails.
  */
-XBT_PUBLIC std::unique_ptr<char, void (*)(void*)> demangle(const char* name);
+XBT_PUBLIC std::unique_ptr<char, std::function<void(char*)>> demangle(const char* name);
 
-/** Get the current backtrace */
-XBT_PUBLIC std::vector<xbt_backtrace_location_t> backtrace();
-
-/* Translate the backtrace in a human friendly form
+class BacktraceImpl;
+/** A backtrace
+ *
+ *  This is used (among other things) in exceptions to store the associated
+ *  backtrace.
  *
- *  Try ro resolve symbols and source code location.
+ *  @ingroup XBT_ex
  */
-XBT_PUBLIC std::vector<std::string> resolve_backtrace(xbt_backtrace_location_t const* loc, std::size_t count);
-XBT_ATTRIB_DEPRECATED_v323("Please use xbt::resolve_backtrace()") XBT_PUBLIC std::vector<std::string> resolveBacktrace(xbt_backtrace_location_t const* loc, std::size_t count);
+class Backtrace {
+public:
+  std::shared_ptr<BacktraceImpl> impl_;
+  Backtrace();
+  /** @brief Translate the backtrace in a human friendly form, unmangled with source code locations. */
+  std::string resolve() const;
+  /** @brief Display the resolved backtrace on stderr */
+  void display() const;
+};
+
 }
 }
-
 #endif