Add AbortingAttribute. Implement a noexcept overload of the getArraySize function

Author: thelfer

bindings/python/src/Variable.cxx

@@ -109,7 +109,10 @@ void declareVariable(pybind11::module_& m) {
                                 const mgis::behaviour::Hypothesis>(
             &mgis::behaviour::getVariableSize));
   m.def("getVariableSize", getVariableSizeByString);
-  m.def("getArraySize", &mgis::behaviour::getArraySize);
+  m.def("getArraySize",
+        pybind11::overload_cast<const std::vector<Variable>&,
+                                const mgis::behaviour::Hypothesis>(
+            &mgis::behaviour::getArraySize));
   m.def("getVariableOffset", getVariableOffsetByString);
   m.def("getVariableTypeSymbolicRepresentation",
         &mgis::behaviour::getVariableTypeSymbolicRepresentation);

include/MGIS/Behaviour/Variable.hxx

@@ -111,6 +111,16 @@ namespace mgis::behaviour {
    */
   MGIS_EXPORT [[nodiscard]] size_type getArraySize(
       const std::vector<Variable> &, const Hypothesis);
+  /*!
+   * \return the size of an array that may contain the values described by the
+   * given array of variables
+   *
+   * \param[in, out] ctx: execution context
+   * \param[in] vs: variables
+   * \param[in] h: modelling hypothesis
+   */
+  MGIS_EXPORT [[nodiscard]] std::optional<size_type> getArraySize(
+      Context &, const std::vector<Variable> &, const Hypothesis) noexcept;
   /*!
    * \return the offset of the given variable for the given hypothesis
    * \param[in] vs: variables

include/MGIS/Config.hxx

@@ -97,6 +97,13 @@ namespace mgis::attributes {
   template <bool>
   struct ThrowingAttribute {};
 
+  /*!
+   * \brief an attribute use to indicate that a method may abort the process in
+   * case of error is the boolean value is true
+   */
+  template <bool>
+  struct AbortingAttribute {};
+
 }  // namespace mgis::attributes
 
 namespace mgis {
@@ -107,6 +114,8 @@ namespace mgis {
   inline constexpr auto throwing = attributes::ThrowingAttribute<true>{};
   //
   inline constexpr auto not_throwing = attributes::ThrowingAttribute<false>{};
+  //
+  inline constexpr auto aborting = attributes::AbortingAttribute<true>{};
 
   //! \brief a simple alias to the the default indexing type used by mgis
   using size_type = mgis_size_type;

src/Variable.cxx

@@ -351,17 +351,25 @@ namespace mgis::behaviour {
     return s;
   }  // end of getArraySize
 
-  size_type getVariableOffset(const std::vector<Variable> &vs,
-                              const std::string_view n,
-                              const Hypothesis h) {
-    auto o = size_type{};
+  std::optional<size_type> getArraySize(Context &ctx,
+                                        const std::vector<Variable> &vs,
+                                        const Hypothesis h) noexcept {
+    auto s = size_type{};
     for (const auto &v : vs) {
-      if (v.name == n) {
-        return o;
+      const auto os2 = getVariableSize(ctx, v, h);
+      if (isInvalid(os2)) {
+        return {};
       }
-      o += getVariableSize(v, h);
+      s += *os2;
     }
-    raise("getVariableOffset: no variable named '" + std::string(n) + "'");
+    return s;
+  }  // end of getArraySize
+
+  size_type getVariableOffset(const std::vector<Variable> &vs,
+                              const std::string_view n,
+                              const Hypothesis h) {
+    auto ctx = Context{};
+    return getVariableOffset(ctx, vs, n, h) | ctx.getThrowingFailureHandler();
   }  // end of getVariableOffset
 
   std::optional<size_type> getVariableOffset(Context &ctx,