Add exception handling code to flc

Author: sethrj

src/flc.i

@@ -24,6 +24,23 @@
 
 %flc_add_header
 
+/************************
+ * Exception handling
+ ************************/
+
+/* Rename the error variables' internal C symbols */
+#define SWIG_FORTRAN_ERROR_INT flc_ierr
+#define SWIG_FORTRAN_ERROR_STR flc_get_serr
+
+/* Restore names in the wrapper code */
+%rename(ierr) flc_ierr;
+%rename(get_serr) flc_get_serr;
+
+/* Unless we're directly building this module, delay exception handling */
+#ifndef SWIGIMPORTED
+%include <exception.i>
+#endif
+
 /******************************
  * Data types and instantiation
  ******************************/

src/flc_algorithm.i

@@ -6,8 +6,7 @@
  */
 
 %module "flc_algorithm"
-%import "flc.i"
-%flc_add_header
+%include "import_flc.i"
 
 %{
 #include <algorithm>

src/flc_chrono.i

@@ -6,8 +6,7 @@
  */
 
 %module "flc_chrono"
-%import "flc.i"
-%flc_add_header
+%include "import_flc.i"
 
 %{
 #include <chrono>

src/flc_random.i

@@ -6,8 +6,7 @@
  */
 
 %module "flc_random"
-%import "flc.i"
-%flc_add_header
+%include "import_flc.i"
 
 /******************************
  * Generator definition

src/generated/flc.f90

@@ -14,10 +14,13 @@ module flc
  private
 
  ! DECLARATION CONSTRUCTS
+ integer(C_INT), public, &
+   bind(C, name="flc_ierr") :: ierr
  type, bind(C) :: SwigArrayWrapper
   type(C_PTR), public :: data = C_NULL_PTR
   integer(C_SIZE_T), public :: size = 0
  end type
+ public :: get_serr
  public :: get_flibcpp_version
  integer(C_INT), protected, public, &
    bind(C, name="flibcpp_version_major") :: flibcpp_version_major
@@ -33,6 +36,14 @@ subroutine SWIG_free(cptr) &
  use, intrinsic :: ISO_C_BINDING
  type(C_PTR), value :: cptr
 end subroutine
+function swigc_get_serr() &
+bind(C, name="_wrap_get_serr") &
+result(fresult)
+use, intrinsic :: ISO_C_BINDING
+import :: swigarraywrapper
+type(SwigArrayWrapper) :: fresult
+end function
+
 function swigc_flibcpp_version_get() &
 bind(C, name="_wrap_flibcpp_version_get") &
 result(fresult)
@@ -60,6 +71,17 @@ subroutine SWIGTM_fout_const_SS_char_Sm_(imout, fout)
   end do
 end subroutine
 
+function get_serr() &
+result(swig_result)
+use, intrinsic :: ISO_C_BINDING
+character(kind=C_CHAR, len=:), allocatable :: swig_result
+type(SwigArrayWrapper) :: fresult 
+
+fresult = swigc_get_serr()
+call SWIGTM_fout_const_SS_char_Sm_(fresult, swig_result)
+if (.false.) call SWIG_free(fresult%data)
+end function
+
 function get_flibcpp_version() &
 result(swig_result)
 use, intrinsic :: ISO_C_BINDING

src/generated/flcFORTRAN_wrap.cxx

@@ -192,6 +192,38 @@ template <typename T> T SwigValueInit() {
 #define SWIG_exception_impl(DECL, CODE, MSG, RETURNNULL) \
  { throw std::logic_error("In " DECL ": " MSG); }
 
+/*  Errors in SWIG */
+#define  SWIG_UnknownError    	   -1
+#define  SWIG_IOError        	   -2
+#define  SWIG_RuntimeError   	   -3
+#define  SWIG_IndexError     	   -4
+#define  SWIG_TypeError      	   -5
+#define  SWIG_DivisionByZero 	   -6
+#define  SWIG_OverflowError  	   -7
+#define  SWIG_SyntaxError    	   -8
+#define  SWIG_ValueError     	   -9
+#define  SWIG_SystemError    	   -10
+#define  SWIG_AttributeError 	   -11
+#define  SWIG_MemoryError    	   -12
+#define  SWIG_NullReferenceError   -13
+
+
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+void SWIG_check_unhandled_exception_impl(const char* decl);
+void SWIG_store_exception(const char* decl, int errcode, const char *msg);
+#ifdef __cplusplus
+}
+#endif
+
+
+#undef SWIG_exception_impl
+#define SWIG_exception_impl(DECL, CODE, MSG, RETURNNULL) \
+    SWIG_store_exception(DECL, CODE, MSG); RETURNNULL;
+
 
 #include <stdexcept>
 
@@ -213,23 +245,15 @@ template <typename T> T SwigValueInit() {
 #define SWIG_as_voidptrptr(a) ((void)SWIG_as_voidptr(*a),reinterpret_cast< void** >(a)) 
 
 
-#include <cstdint>
-using std::int32_t;
-using std::int64_t;
-using std::size_t;
 
+extern "C" {
 
-#include <stdint.h>
-
+int flc_ierr = 0;
 
-extern "C" {
-extern const char flibcpp_version[];
-extern const int flibcpp_version_major;
-extern const int flibcpp_version_minor;
-extern const int flibcpp_version_patch;
 }
 
 
+
 #include <stdlib.h>
 #ifdef _MSC_VER
 # ifndef strtoull
@@ -257,7 +281,93 @@ SWIGINTERN SwigArrayWrapper SwigArrayWrapper_uninitialized() {
 
 #include <string.h>
 
+
+// Stored exception message
+SWIGINTERN const char* swig_last_exception_cstr = NULL;
+// Retrieve error message
+SWIGEXPORT const char* flc_get_serr() {
+  if (!swig_last_exception_cstr) {
+    SWIG_store_exception("UNKNOWN", SWIG_RuntimeError,
+                         "no error string was present");
+  }
+  return swig_last_exception_cstr;
+}
+
+
+#include <string>
+
+
+#include <cctype>
+
+
+extern "C" {
+// Call this function before any new action
+SWIGEXPORT void SWIG_check_unhandled_exception_impl(const char* decl) {
+  if (flc_ierr != 0) {
+    // Construct message; calling the error string function ensures that
+    // the string is allocated if the user did something goofy like
+    // manually setting the integer. Since this function is not expected to
+    // be wrapped by a catch statement, it will probably terminate the
+    // program.
+    std::string msg("An unhandled exception occurred before a call to ");
+    msg += decl;
+    msg += "; ";
+    std::string prev_msg = flc_get_serr();
+    prev_msg[0] = std::tolower(prev_msg[0]);
+    msg += prev_msg;
+    throw std::runtime_error(msg);
+  }
+}
+
+// Save an exception to the fortran error code and string
+SWIGEXPORT void SWIG_store_exception(const char *decl,
+                                     int errcode,
+                                     const char *msg) {
+  ::flc_ierr = errcode;
+
+  static std::string last_exception_msg;
+  // Save the message to a std::string first
+  last_exception_msg = "In ";
+  last_exception_msg += decl;
+  last_exception_msg += ": ";
+  last_exception_msg += msg;
+  swig_last_exception_cstr = last_exception_msg.c_str();
+}
+}
+
+
+#include <typeinfo>
+#include <stdexcept>
+
+
+#include <cstdint>
+using std::int32_t;
+using std::int64_t;
+using std::size_t;
+
+
+#include <stdint.h>
+
+
 extern "C" {
+extern const char flibcpp_version[];
+extern const int flibcpp_version_major;
+extern const int flibcpp_version_minor;
+extern const int flibcpp_version_patch;
+}
+
+extern "C" {
+SWIGEXPORT SwigArrayWrapper _wrap_get_serr() {
+  SwigArrayWrapper fresult ;
+  char *result = 0 ;
+  
+  result = (char *)flc_get_serr();
+  fresult.size = strlen(reinterpret_cast< const char* >(result));
+  fresult.data = const_cast< char * >(result);
+  return fresult;
+}
+
+
 SWIGEXPORT SwigArrayWrapper _wrap_flibcpp_version_get() {
   SwigArrayWrapper fresult ;
   char *result = 0 ;

src/generated/flc_algorithmFORTRAN_wrap.cxx

@@ -193,6 +193,21 @@ template <typename T> T SwigValueInit() {
  { throw std::logic_error("In " DECL ": " MSG); }
 
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+void SWIG_check_unhandled_exception_impl(const char* decl);
+void SWIG_store_exception(const char* decl, int errcode, const char *msg);
+#ifdef __cplusplus
+}
+#endif
+
+
+#undef SWIG_exception_impl
+#define SWIG_exception_impl(DECL, CODE, MSG, RETURNNULL) \
+    SWIG_store_exception(DECL, CODE, MSG); RETURNNULL;
+
+
 enum SwigMemFlags {
     SWIG_MEM_OWN = 0x01,
     SWIG_MEM_RVALUE = 0x02,

src/generated/flc_randomFORTRAN_wrap.cxx

@@ -193,6 +193,21 @@ template <typename T> T SwigValueInit() {
  { throw std::logic_error("In " DECL ": " MSG); }
 
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+void SWIG_check_unhandled_exception_impl(const char* decl);
+void SWIG_store_exception(const char* decl, int errcode, const char *msg);
+#ifdef __cplusplus
+}
+#endif
+
+
+#undef SWIG_exception_impl
+#define SWIG_exception_impl(DECL, CODE, MSG, RETURNNULL) \
+    SWIG_store_exception(DECL, CODE, MSG); RETURNNULL;
+
+
 enum SwigMemFlags {
     SWIG_MEM_OWN = 0x01,
     SWIG_MEM_RVALUE = 0x02,

src/import_flc.i

@@ -0,0 +1,19 @@
+/*!
+ * \file import_flc.i
+ *
+ * Copyright (c) 2019 Oak Ridge National Laboratory, UT-Battelle, LLC.
+ * Distributed under an MIT open source license: see LICENSE for details.
+ */
+
+#ifdef SWIGIMPORTED
+#error "To use this header, %include "import_flc.i", don't %import it"
+#endif
+
+// Set up macros, etc.
+%import "flc.i"
+
+// Support external exceptions
+%include <extern_exception.i>
+
+// Instantiate header
+%flc_add_header