Refactor tools library error handling macros

1 files changed, 129 insertions, 62 deletions

diff --git a/tools/lib/h5tools_error.h b/tools/lib/h5tools_error.h
index 6e20b7c..9ad54bc 100644
--- a/tools/lib/h5tools_error.h
+++ b/tools/lib/h5tools_error.h
@@ -40,30 +40,67 @@ H5TOOLS_DLLVAR hid_t H5E_tools_min_dbg_id_g;
 /*
  * H5TOOLS_INIT_ERROR macro, used to initialize error reporting.
  */
-#define H5TOOLS_INIT_ERROR() {                                                                      \
-        H5tools_ERR_CLS_g = H5Eregister_class("H5tools", "HDF5:tools", lib_str);                    \
-        H5E_tools_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MAJOR, "Failure in tools library");      \
-        H5E_tools_min_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "error in function");      \
-        H5E_tools_min_info_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "function info");     \
-        H5E_tools_min_dbg_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "function debug");     \
-}
+#define H5TOOLS_INIT_ERROR()                                                                            \
+do {                                                                                                    \
+    char lib_str[256];                                                                                  \
+                                                                                                        \
+    /* Initialize library version string for error class */                                             \
+    HDsnprintf(lib_str, sizeof(lib_str), "%d.%d.%d", H5_VERS_MAJOR, H5_VERS_MINOR, H5_VERS_RELEASE);    \
+                                                                                                        \
+    /* Create new HDF5 error stack for the tools to use */                                              \
+    if ((H5tools_ERR_STACK_g = H5Ecreate_stack()) < 0)                                                  \
+        HDfprintf(stderr, "Failed to create HDF5 tools error stack\n");                                 \
+                                                                                                        \
+    /* Register errors from the HDF5 tools as a new error class */                                      \
+    if ((H5tools_ERR_CLS_g = H5Eregister_class("H5tools", "HDF5:tools", lib_str)) < 0)                  \
+        HDfprintf(stderr, "Failed to register HDF5 tools error class\n");                               \
+                                                                                                        \
+    /* Create a new HDF5 major error message for errors from the tools library */                       \
+    if ((H5E_tools_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MAJOR, "Failure in tools library")) < 0)    \
+        HDfprintf(stderr, "Failed to register major error message for tools library errors\n");         \
+                                                                                                        \
+    /* Create a new HDF5 minor error message for errors from the tools library */                       \
+    if ((H5E_tools_min_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "error in function")) < 0)    \
+        HDfprintf(stderr, "Failed to register minor error message for tools library errors\n");         \
+                                                                                                        \
+    /* Create a new HDF5 minor error message for info messages from the tools library */                \
+    if ((H5E_tools_min_info_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "function info")) < 0)   \
+        HDfprintf(stderr, "Failed to register minor error message for tools library info messages\n");  \
+                                                                                                        \
+    /* Create a new HDF5 minor error message for debug messages from the tools library */               \
+    if ((H5E_tools_min_dbg_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "function debug")) < 0)   \
+        HDfprintf(stderr, "Failed to register minor error message for tools library debug messages\n"); \
+} while(0)
 
 /*
- * H5TOOLS_CLOSE_ERROR macro, used to initialize error reporting.
+ * H5TOOLS_CLOSE_ERROR macro, used to terminate error reporting.
  */
-#define H5TOOLS_CLOSE_ERROR() {                                 \
-        H5Eclose_msg(H5E_tools_min_dbg_id_g);                   \
-        H5Eclose_msg(H5E_tools_min_info_id_g);                  \
-        H5Eclose_msg(H5E_tools_min_id_g);                       \
-        H5Eclose_msg(H5E_tools_g);                              \
-        H5Eunregister_class(H5tools_ERR_CLS_g);                 \
-}
+#define H5TOOLS_CLOSE_ERROR()                                                                        \
+do {                                                                                                 \
+    /* Close all error messages created by H5TOOLS_INIT_ERROR() */                                   \
+    if (H5Eclose_msg(H5E_tools_min_dbg_id_g) < 0)                                                    \
+        HDfprintf(stderr, "Failed to close minor error message for tools library debug messages\n"); \
+    if (H5Eclose_msg(H5E_tools_min_info_id_g) < 0)                                                   \
+        HDfprintf(stderr, "Failed to close minor error message for tools library info messages\n");  \
+    if (H5Eclose_msg(H5E_tools_min_id_g) < 0)                                                        \
+        HDfprintf(stderr, "Failed to close minor error message for tools library errors\n");         \
+    if (H5Eclose_msg(H5E_tools_g) < 0)                                                               \
+        HDfprintf(stderr, "Failed to close major error message for tools library errors\n");         \
+                                                                                                     \
+    /* Unregister the HDF5 tools error class */                                                      \
+    if (H5Eunregister_class(H5tools_ERR_CLS_g) < 0)                                                  \
+        HDfprintf(stderr, "Failed to unregister the HDF5 tools error class\n");                      \
+                                                                                                     \
+    /* Close the tools error stack */                                                                \
+    if (H5Eclose_stack(H5tools_ERR_STACK_g) < 0)                                                     \
+        HDfprintf(stderr, "Failed to close HDF5 tools error stack\n");                               \
+} while(0)
 
 /*
  * H5TOOLS_ERR_INIT macro, used to facilitate error reporting. Declaration and assignments of error variables.
  * Use at the beginning of a function using error handling macros.
  */
-#define H5TOOLS_ERR_INIT(ret_typ, ret_init)           \
+#define H5TOOLS_ERR_INIT(ret_typ, ret_init)    \
     hid_t   pstack_id = H5I_INVALID_HID;       \
     hid_t   estack_id = H5tools_ERR_STACK_g;   \
     hbool_t past_catch = FALSE;                \
@@ -73,7 +110,7 @@ H5TOOLS_DLLVAR hid_t H5E_tools_min_dbg_id_g;
  * H5TOOLS_PUSH_STACK macro, used to create a new error stack.
  */
 #define H5TOOLS_PUSH_STACK() {                \
-        pstack_id = estack_id;   \
+        pstack_id = estack_id;                \
         estack_id = H5Ecreate_stack();        \
 }
 
@@ -89,40 +126,88 @@ H5TOOLS_DLLVAR hid_t H5E_tools_min_dbg_id_g;
 }
 
 /*
- * H5TOOLS_DEBUG macro, used to facilitate error reporting.  The arguments are the minor error number, and a description of the error.
+ * H5TOOLS_PUSH_ERROR macro, used to push an error to an error stack. Not meant to
+ * be called directly.
  */
-#ifdef H5_TOOLS_DEBUG
-#define H5TOOLS_DEBUG(min_id, ...) {                                                                        \
-        H5Epush2(estack_id, __FILE__, FUNC, __LINE__, H5tools_ERR_CLS_g, H5E_tools_g, min_id, __VA_ARGS__);     \
-}
-#define H5TOOLS_ENDDEBUG(min_id, ...) {                                                                        \
-        H5Epush2(estack_id, __FILE__, FUNC, __LINE__, H5tools_ERR_CLS_g, H5E_tools_g, min_id, __VA_ARGS__);     \
-        H5Eprint2(estack_id, stderr);     \
-}
-#else
-#define H5TOOLS_DEBUG(min_id, ...) {    \
-        ;                               \
-}
-#define H5TOOLS_ENDDEBUG(min_id, ...) {    \
-        ;                               \
-}
-#endif
+#define H5TOOLS_PUSH_ERROR(estack_id, err_cls, maj_err_id, min_err_id, ...)                          \
+do {                                                                                                 \
+    if (estack_id >= 0 && err_cls >= 0)                                                              \
+        H5Epush2(estack_id, __FILE__, FUNC, __LINE__, err_cls, maj_err_id, min_err_id, __VA_ARGS__); \
+    else {                                                                                           \
+        HDfprintf(stderr, __VA_ARGS__);                                                              \
+        HDfprintf(stderr, "\n");                                                                     \
+    }                                                                                                \
+} while(0)
 
 /*
- * H5TOOLS_INFO macro, used to facilitate error reporting .  The arguments are the minor error number, and a description of the error.
+ * H5TOOLS_ERROR macro, used to facilitate error reporting within a function body.
+ * The arguments are the return value and an error string. The return value is assigned
+ * to a variable `ret_value'. This macro is meant to be used for reporting an error without
+ * having control branch to the `done' label. This is often used when an error occurs
+ * after the `done' label, in which case an infinite loop would ensue if control branched
+ * backwards.
  */
-#define H5TOOLS_INFO(min_id, ...) {                                                                        \
-        H5Epush2(estack_id, __FILE__, FUNC, __LINE__, H5tools_ERR_CLS_g, H5E_tools_g, min_id, __VA_ARGS__);     \
-}
+#define H5TOOLS_ERROR(ret_val, ...)                                                                           \
+do {                                                                                                          \
+    H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_id_g, __VA_ARGS__); \
+    ret_value = ret_val;                                                                                      \
+} while(0)
 
 /*
- * H5TOOLS_ERROR macro, used to facilitate error reporting .  The arguments are the major
- * error number, the minor error number, and a description of the error.
+ * H5TOOLS_GOTO_ERROR macro, used to facilitate error reporting within a function body.
+ * The arguments are the return value and an error string. The return value is assigned
+ * to a variable `ret_value' and control branches to the `done' label.
  */
-#define H5TOOLS_ERROR(maj_id, min_id, ...) {                                                                        \
-        H5Epush2(estack_id, __FILE__, FUNC, __LINE__, H5tools_ERR_CLS_g, maj_id, min_id, __VA_ARGS__);     \
-        ret_value = FAIL;                                                                                    \
-}
+#define H5TOOLS_GOTO_ERROR(ret_val, ...)                                                                      \
+do {                                                                                                          \
+    H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_id_g, __VA_ARGS__); \
+    H5TOOLS_GOTO_DONE(ret_val);                                                                               \
+} while(0)
+
+/*
+ * H5TOOLS_GOTO_DONE macro, used to facilitate normal return within a function body.
+ * The argument is the return value which is assigned to the `ret_value'
+ * variable. Control branches to the `done' label.
+ */
+#define H5TOOLS_GOTO_DONE(ret_val) \
+do {                               \
+    ret_value = ret_val;           \
+    goto done;                     \
+} while(0)
+
+/*
+ * H5TOOLS_INFO macro, used to facilitate error reporting. The arguments are
+ * a description of the error.
+ */
+#define H5TOOLS_INFO(...)                                                                                          \
+do {                                                                                                               \
+    H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_info_id_g, __VA_ARGS__); \
+} while(0)
+
+/*
+ * H5TOOLS_DEBUG macro, used to facilitate error reporting. The arguments are the
+ * minor error number, and a description of the error.
+ */
+#ifdef H5_TOOLS_DEBUG
+#define H5TOOLS_DEBUG(...)                                                                                        \
+do {                                                                                                              \
+    H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_dbg_id_g, __VA_ARGS__); \
+} while(0)
+#define H5TOOLS_ENDDEBUG(...)                                                                                     \
+do {                                                                                                              \
+    H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_dbg_id_g, __VA_ARGS__); \
+    H5Eprint2(H5tools_ERR_STACK_g, stderr);                                                                       \
+} while(0)
+#else
+#define H5TOOLS_DEBUG(...) \
+do {                       \
+    ;                      \
+} while(0)
+#define H5TOOLS_ENDDEBUG(...) \
+do {                          \
+    ;                         \
+} while(0)
+#endif
 
 
 /* Macro for "catching" flow of control when an error occurs.  Note that the
@@ -156,23 +241,5 @@ H5TOOLS_DLLVAR hid_t H5E_tools_min_dbg_id_g;
     H5_LEAVE(fail_value)                               \
 }
 
-/*
- * H5TOOLS_GOTO_ERROR macro, used to facilitate error reporting within a function body.  The arguments are
- * the major error number, the minor error number, the return value, and an
- * error string.  The return value is assigned to a variable `ret_value' and
- * control branches to the `done' label.
- */
-#define H5TOOLS_GOTO_ERROR(fail_value, min_id, ...) {        \
-   H5TOOLS_ERROR(H5E_tools_g, min_id, __VA_ARGS__);          \
-   HGOTO_DONE(fail_value)                                    \
-}
-
-/*
- * HGOTO_DONE macro, used to facilitate normal return within a function body.
- * The argument is the return value which is assigned to the `ret_value'
- * variable.  Control branches to the `done' label.
- */
-/* #define HGOTO_DONE(ret_val) {ret_value = ret_val; goto done;} defined in H5Eprivate.h */
-
 #endif /* H5TOOLS_ERROR_H_ */