Simplify the library initialization + deprecate 2 XBT functions

[simgrid.git] / include / simgrid / Exception.hpp

diff --git a/include/simgrid/Exception.hpp b/include/simgrid/Exception.hpp
index 3db6d24..f4d151f 100644 (file)
--- a/include/simgrid/Exception.hpp
+++ b/include/simgrid/Exception.hpp
@@ -1,16 +1,13 @@
-/* Copyright (c) 2018-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2018-2023. 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. */
 
+/* This file defines all possible exception that could occur in a SimGrid library. */
+
 #ifndef SIMGRID_EXCEPTIONS_HPP
 #define SIMGRID_EXCEPTIONS_HPP
 
-/** @file exception.hpp SimGrid-specific Exceptions
- *
- *  Defines all possible exception that could occur in a SimGrid library.
- */
-
 #include <xbt/backtrace.hpp>
 #include <xbt/ex.h>
 #include <xbt/string.hpp>
@@ -28,9 +25,7 @@ namespace xbt {
  *  Constitute the contextual information of where an exception was thrown
  *
  *  These tuples (__FILE__, __LINE__, __func__, backtrace, procname, pid)
- *  are best created with @ref XBT_THROW_POINT.
- *
- *  @ingroup XBT_ex
+ *  are best created with the macro XBT_THROW_POINT.
  */
 class ThrowPoint {
 public:
@@ -56,7 +51,8 @@ public:
 
 /** Create a ThrowPoint with (__FILE__, __LINE__, __func__) */
 #define XBT_THROW_POINT                                                                                                \
-  ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), xbt_procname(), xbt_getpid())
+  ::simgrid::xbt::ThrowPoint(__FILE__, __LINE__, __func__, simgrid::xbt::Backtrace(), sg_actor_self_get_name(),        \
+                             sg_actor_self_get_pid())
 
 class XBT_PUBLIC ImpossibleError : public std::logic_error {
 public:
@@ -81,8 +77,8 @@ public:
 /** Ancestor class of all SimGrid exception */
 class Exception : public std::runtime_error {
 public:
-  Exception(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message)
-      : std::runtime_error(std::move(message)), throwpoint_(std::move(throwpoint))
+  Exception(simgrid::xbt::ThrowPoint&& throwpoint, const std::string& message)
+      : std::runtime_error(message), throwpoint_(std::move(throwpoint))
   {
   }
   Exception(const Exception&)     = default;
@@ -93,19 +89,20 @@ public:
   xbt::ThrowPoint const& throw_point() const { return throwpoint_; }
 
   /** Allow to carry a value (used by testany/waitany) */
-  int get_value() const { return value_; }
-  void set_value(int value) { value_ = value; }
+  ssize_t get_value() const { return value_; }
+  void set_value(ssize_t value) { value_ = value; }
 
   std::string resolve_backtrace() const { return throwpoint_.backtrace_.resolve(); }
 
-  virtual void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) const
+  XBT_ATTRIB_NORETURN virtual void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint,
+                                                  const std::string& message) const
   {
-    std::throw_with_nested(Exception(std::move(throwpoint), std::move(message)));
+    std::throw_with_nested(Exception(std::move(throwpoint), message));
   }
 
 private:
   xbt::ThrowPoint throwpoint_;
-  int value_ = 0;
+  ssize_t value_ = 0;
 };
 
 #define DECLARE_SIMGRID_EXCEPTION(AnyException, ...)                                                                   \
@@ -114,17 +111,16 @@ private:
     using Exception::Exception;                                                                                        \
     __VA_ARGS__                                                                                                        \
     ~AnyException() override;                                                                                          \
-    void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint, std::string&& message) const override                   \
+    XBT_ATTRIB_NORETURN void rethrow_nested(simgrid::xbt::ThrowPoint&& throwpoint,                                     \
+                                            const std::string& message) const override                                 \
     {                                                                                                                  \
-      std::throw_with_nested(AnyException(std::move(throwpoint), std::move(message)));                                 \
+      std::throw_with_nested(AnyException(std::move(throwpoint), message));                                            \
     }                                                                                                                  \
   }
 
 /** Exception raised when a timeout elapsed */
 DECLARE_SIMGRID_EXCEPTION(TimeoutException);
 
-using TimeoutError XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::TimeoutException") = TimeoutException;
-
 /** Exception raised when a host fails */
 DECLARE_SIMGRID_EXCEPTION(HostFailureException);
 
@@ -153,6 +149,9 @@ DECLARE_SIMGRID_EXCEPTION(TracingError);
 DECLARE_SIMGRID_EXCEPTION(ParseError, PARSE_ERROR_CONSTRUCTOR);
 #undef PARSE_ERROR_CONSTRUCTOR
 
+/** Exception raised by xbt_enforce, when an assertion is not satisfied */
+DECLARE_SIMGRID_EXCEPTION(AssertionError);
+
 #undef DECLARE_SIMGRID_EXCEPTION
 
 class XBT_PUBLIC ForcefulKillException {
@@ -180,9 +179,7 @@ class XBT_PUBLIC ForcefulKillException {
    */
 public:
   ForcefulKillException() = default;
-  explicit ForcefulKillException(const std::string& msg) : msg_(std::string("Actor killed (") + msg + std::string(")."))
-  {
-  }
+  explicit ForcefulKillException(const std::string& msg) : msg_("Actor killed (" + msg + ").") {}
   ~ForcefulKillException();
   const char* what() const noexcept { return msg_.c_str(); }
 
@@ -190,11 +187,8 @@ public:
   static bool try_n_catch(const std::function<void()>& try_block);
 
 private:
-  std::string msg_ = std::string("Actor killed.");
+  std::string msg_ = "Actor killed.";
 };
 
 } // namespace simgrid
-
-using xbt_ex XBT_ATTRIB_DEPRECATED_v328("Please use simgrid::Exception") = simgrid::Exception;
-
 #endif