backtrace: fix various portability issues I just introduced

[simgrid.git] / include / xbt / backtrace.hpp

diff --git a/include/xbt/backtrace.hpp b/include/xbt/backtrace.hpp
index 754bd5fb2205940ce4e1ead41f3db246976b8816..cfcd475229963cf7e6f77204d1cd70feeda55895 100644 (file)
--- a/include/xbt/backtrace.hpp
+++ b/include/xbt/backtrace.hpp
@@ -1,21 +1,37 @@
-/* Copyright (c) 2005-2018. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2005-2018. The SimGrid Team. All rights reserved.          */
+
+/* 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. */
 
 #ifndef SIMGRIX_XBT_BACKTRACE_HPP
 #define SIMGRIX_XBT_BACKTRACE_HPP
 
-#include <cstddef>
+#include <xbt/base.h>
 
-#include <string>
+#include <cstddef>
 #include <memory>
+#include <string>
 #include <vector>
 
-#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()
+
+typedef void* xbt_backtrace_location_t;
 
 namespace simgrid {
 namespace xbt {
 
+/** A backtrace
+ *
+ *  This is used (among other things) in exceptions to store the associated
+ *  backtrace.
+ *
+ *  @ingroup XBT_ex
+ */
+typedef std::vector<xbt_backtrace_location_t> Backtrace;
+
 /** Try to demangle a C++ name
  *
  *  Return the origin string if this fails.
@@ -23,14 +39,20 @@ namespace xbt {
 XBT_PUBLIC std::unique_ptr<char, void (*)(void*)> demangle(const char* name);
 
 /** Get the current backtrace */
-XBT_PUBLIC std::vector<xbt_backtrace_location_t> backtrace();
+XBT_PUBLIC Backtrace backtrace();
 
 /* Translate the backtrace in a human friendly form
  *
- *  Try ro resolve symbols and source code location.
+ *  Try resolve symbols and source code location.
  */
-XBT_PUBLIC std::vector<std::string> resolveBacktrace(xbt_backtrace_location_t const* loc, std::size_t count);
+XBT_PUBLIC std::vector<std::string> resolve_backtrace(xbt_backtrace_location_t const* loc, std::size_t count);
 }
 }
 
+/** @brief Captures a backtrace for further use */
+XBT_PUBLIC size_t xbt_backtrace_current(xbt_backtrace_location_t* loc, size_t count);
+
+/** @brief Display a previously captured backtrace */
+XBT_PUBLIC void xbt_backtrace_display(xbt_backtrace_location_t* loc, size_t count);
+
 #endif