From 927f93b7d5292c5e7aa8de817d02bf3d9c1af799 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Thu, 22 Feb 2024 11:52:08 +0100
Subject: [PATCH] Create an error library to collect exceptions
---
src/cluster/cluster.cpp | 4 +
src/include/Configuration.h | 46 ---------
src/include/List.h | 33 +------
src/include/TransitionMatrix.h | 22 -----
src/include/errors.h | 161 +++++++++++++++++++++++++++++++
src/include/tfrfme.h | 44 ---------
src/libnptm/Configuration.cpp | 4 +
src/libnptm/Parsers.cpp | 11 +++
src/libnptm/TransitionMatrix.cpp | 4 +
src/libnptm/file_io.cpp | 16 +--
src/libnptm/tfrfme.cpp | 4 +
src/sphere/sphere.cpp | 4 +
src/testing/test_TEDF.cpp | 14 +++
src/testing/test_TTMS.cpp | 14 +++
14 files changed, 231 insertions(+), 150 deletions(-)
create mode 100644 src/include/errors.h
diff --git a/src/cluster/cluster.cpp b/src/cluster/cluster.cpp
index 94bec3c3..4591b28a 100644
--- a/src/cluster/cluster.cpp
+++ b/src/cluster/cluster.cpp
@@ -8,6 +8,10 @@
#include <fstream>
#include <string>
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
#ifndef INCLUDE_CONFIGURATION_H_
#include "../include/Configuration.h"
#endif
diff --git a/src/include/Configuration.h b/src/include/Configuration.h
index 99dc090c..f3c4df91 100644
--- a/src/include/Configuration.h
+++ b/src/include/Configuration.h
@@ -28,52 +28,6 @@
#ifndef INCLUDE_CONFIGURATION_H_
#define INCLUDE_CONFIGURATION_H_
-/**
- * \brief Exception for open file error handlers.
- */
-class OpenConfigurationFileException: public std::exception {
-protected:
- //! \brief Name of the file that was accessed.
- std::string file_name;
-
-public:
- /**
- * \brief Exception instance constructor.
- *
- * \param name: `string` Name of the file that was accessed.
- */
- OpenConfigurationFileException(std::string name) { file_name = name; }
-
- /**
- * \brief Exception message.
- */
- virtual const char* what() const throw() {
- return file_name.c_str();
- }
-};
-
-/**
- * \brief Exception for unrecognized configuration data sets.
- */
-class UnrecognizedConfigurationException: public std::exception {
-protected:
- //! Description of the problem.
- std::string message;
-public:
- /**
- * \brief Exception instance constructor.
- *
- * \param problem: `string` Description of the problem that occurred.
- */
- UnrecognizedConfigurationException(std::string problem) { message = problem; }
- /**
- * \brief Exception message.
- */
- virtual const char* what() const throw() {
- return message.c_str();
- }
-};
-
/**
* \brief A class to represent the configuration of the scattering geometry.
*
diff --git a/src/include/List.h b/src/include/List.h
index 8c51bd1c..f97ebc60 100644
--- a/src/include/List.h
+++ b/src/include/List.h
@@ -6,38 +6,7 @@
#ifndef INCLUDE_LIST_H_
#define INCLUDE_LIST_H_
-/**
- * \brief Exception for out of bounds List requests.
- */
-class ListOutOfBoundsException: public std::exception {
-protected:
- //! Description of the problem.
- std::string message;
-
-public:
- /**
- * \brief Exception instance constructor.
- *
- * \param requested: `int` The index that was requested.
- * \param min: `int` The minimum index allowed by the list.
- * \param max: `int` The maximum index allowed by the list.
- */
- ListOutOfBoundsException(int requested, int min, int max) {
- message = "Error: requested index " + std::to_string(requested)
- + " out of list allowed bounds [" + std::to_string(min) + ", "
- + std::to_string(max - 1) + "]";
- }
-
- /**
- * \brief Exception message.
- */
- virtual const char* what() const throw() {
- return message.c_str();
- }
-};
-
-/**
- * \brief A class to represent dynamic lists.
+/*! \brief A class to represent dynamic lists.
*
* This class helps in the creation and management of dynamic lists of
* objects, whose size is not known in advance. List offers the advantage
diff --git a/src/include/TransitionMatrix.h b/src/include/TransitionMatrix.h
index 25e5cf86..447457f4 100644
--- a/src/include/TransitionMatrix.h
+++ b/src/include/TransitionMatrix.h
@@ -6,28 +6,6 @@
#ifndef INCLUDE_TRANSITIONMATRIX_H_
#define INCLUDE_TRANSITIONMATRIX_H_
-/**
- * \brief Exception for unrecognized file formats.
- */
-class UnrecognizedFormatException: public std::exception {
-protected:
- //! Description of the problem.
- std::string message;
-public:
- /**
- * \brief Exception instance constructor.
- *
- * \param problem: `string` Description of the problem that occurred.
- */
- UnrecognizedFormatException(std::string problem) { message = problem; }
- /**
- * \brief Exception message.
- */
- virtual const char* what() const throw() {
- return message.c_str();
- }
-};
-
/*! \brief Class to represent the Transition Matrix.
*/
class TransitionMatrix {
diff --git a/src/include/errors.h b/src/include/errors.h
new file mode 100644
index 00000000..8730b36b
--- /dev/null
+++ b/src/include/errors.h
@@ -0,0 +1,161 @@
+/*! \file errors.h
+ *
+ * \brief Collection of proprietary code exceptions.
+ *
+ * There are many circumstances that can prevent the correct execution
+ * of a code. These range from user mistakes, to improper configuration,
+ * to unsupported hardware and all the way up to various system failures.
+ * Although it is not possible to grant proper execution in all cases,
+ * it is often possible to design a code in such a way that the program
+ * detects unexpected conditions, informs the user and takes the proper
+ * actions, eventually stopping without crash, if no other options are
+ * available. C++ handles such unexpected circumstances by means of
+ * `exceptions`. These are special procedures that can be launched
+ * whenever an unexpected situation occurs and they allow to restore the
+ * code work-flow and attempt recovery. Exceptions can be divided in
+ * different cathegories, which respond to various types of problems.
+ * This library contains a set of exceptions designed to the most common
+ * problems that may occur while executing an application of the `NP_TMcode`
+ * suite.
+ */
+
+#ifndef INCLUDE_ERRORS_H_
+#define INCLUDE_ERRORS_H_
+
+/*! \brief Exception for out of bounds List requests.
+ */
+class ListOutOfBoundsException: public std::exception {
+protected:
+ //! Description of the problem.
+ std::string message;
+
+public:
+ /**
+ * \brief Exception instance constructor.
+ *
+ * \param requested: `int` The index that was requested.
+ * \param min: `int` The minimum index allowed by the list.
+ * \param max: `int` The maximum index allowed by the list.
+ */
+ ListOutOfBoundsException(int requested, int min, int max) {
+ message = "Error: requested index " + std::to_string(requested)
+ + " out of list allowed bounds [" + std::to_string(min) + ", "
+ + std::to_string(max - 1) + "]";
+ }
+
+ /**
+ * \brief Exception message.
+ */
+ virtual const char* what() const throw() {
+ return message.c_str();
+ }
+};
+
+/*! \brief Exception for open file error handlers.
+ */
+class OpenConfigurationFileException: public std::exception {
+protected:
+ //! \brief Name of the file that was accessed.
+ std::string file_name;
+
+public:
+ /**
+ * \brief Exception instance constructor.
+ *
+ * \param name: `string` Name of the file that was accessed.
+ */
+ OpenConfigurationFileException(std::string name) { file_name = name; }
+
+ /**
+ * \brief Exception message.
+ */
+ virtual const char* what() const throw() {
+ return file_name.c_str();
+ }
+};
+
+/*! \brief Exception for access requests out of matrix bounds.
+ */
+class MatrixOutOfBoundsException: public std::exception {
+protected:
+ //! Description of the problem.
+ std::string message;
+public:
+ /**
+ * \brief Exception instance constructor.
+ *
+ * \param problem: `string` Description of the problem that occurred.
+ */
+ MatrixOutOfBoundsException(std::string problem) { message = problem; }
+ /**
+ * \brief Exception message.
+ */
+ virtual const char* what() const throw() {
+ return message.c_str();
+ }
+};
+
+/*! \brief Exception for unrecognized configuration data sets.
+ */
+class UnrecognizedConfigurationException: public std::exception {
+protected:
+ //! Description of the problem.
+ std::string message;
+public:
+ /**
+ * \brief Exception instance constructor.
+ *
+ * \param problem: `string` Description of the problem that occurred.
+ */
+ UnrecognizedConfigurationException(std::string problem) { message = problem; }
+ /**
+ * \brief Exception message.
+ */
+ virtual const char* what() const throw() {
+ return message.c_str();
+ }
+};
+
+/*! \brief Exception for unrecognized file formats.
+ */
+class UnrecognizedFormatException: public std::exception {
+protected:
+ //! Description of the problem.
+ std::string message;
+public:
+ /**
+ * \brief Exception instance constructor.
+ *
+ * \param problem: `string` Description of the problem that occurred.
+ */
+ UnrecognizedFormatException(std::string problem) { message = problem; }
+ /**
+ * \brief Exception message.
+ */
+ virtual const char* what() const throw() {
+ return message.c_str();
+ }
+};
+
+/*! \brief Exception for unrecognized parameters.
+ */
+class UnrecognizedParameterException: public std::exception {
+protected:
+ //! Description of the problem.
+ std::string message;
+public:
+ /**
+ * \brief Exception instance constructor.
+ *
+ * \param problem: `string` Description of the problem that occurred.
+ */
+ UnrecognizedParameterException(std::string problem) { message = problem; }
+ /**
+ * \brief Exception message.
+ */
+ virtual const char* what() const throw() {
+ return message.c_str();
+ }
+};
+
+#endif
diff --git a/src/include/tfrfme.h b/src/include/tfrfme.h
index e9efff3e..19174277 100644
--- a/src/include/tfrfme.h
+++ b/src/include/tfrfme.h
@@ -6,50 +6,6 @@
#ifndef INCLUDE_TFRFME_H_
#define INCLUDE_TFRFME_H_
-/**
- * \brief Exception for unrecognized parameters.
- */
-class MatrixOutOfBoundsException: public std::exception {
-protected:
- //! Description of the problem.
- std::string message;
-public:
- /**
- * \brief Exception instance constructor.
- *
- * \param problem: `string` Description of the problem that occurred.
- */
- MatrixOutOfBoundsException(std::string problem) { message = problem; }
- /**
- * \brief Exception message.
- */
- virtual const char* what() const throw() {
- return message.c_str();
- }
-};
-
-/**
- * \brief Exception for unrecognized parameters.
- */
-class UnrecognizedParameterException: public std::exception {
-protected:
- //! Description of the problem.
- std::string message;
-public:
- /**
- * \brief Exception instance constructor.
- *
- * \param problem: `string` Description of the problem that occurred.
- */
- UnrecognizedParameterException(std::string problem) { message = problem; }
- /**
- * \brief Exception message.
- */
- virtual const char* what() const throw() {
- return message.c_str();
- }
-};
-
/*! \brief Class to represent the trapping configuration.
*/
class TFRFME {
diff --git a/src/libnptm/Configuration.cpp b/src/libnptm/Configuration.cpp
index 399370c4..e7ed703b 100644
--- a/src/libnptm/Configuration.cpp
+++ b/src/libnptm/Configuration.cpp
@@ -12,6 +12,10 @@
#include <regex>
#include <string>
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
#endif
diff --git a/src/libnptm/Parsers.cpp b/src/libnptm/Parsers.cpp
index 3f8c9ff5..22ff56db 100644
--- a/src/libnptm/Parsers.cpp
+++ b/src/libnptm/Parsers.cpp
@@ -3,10 +3,21 @@
* \brief Implementation of the parsing functions.
*/
+#include <exception>
#include <fstream>
#include <string>
+
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
+#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
+#endif
+
+#ifndef INCLUDE_PARSERS_H_
#include "../include/Parsers.h"
+#endif
std::string *load_file(std::string file_name, int *count = 0) {
std::fstream input_file(file_name.c_str(), std::ios::in);
diff --git a/src/libnptm/TransitionMatrix.cpp b/src/libnptm/TransitionMatrix.cpp
index 3e192fa8..30126ff1 100644
--- a/src/libnptm/TransitionMatrix.cpp
+++ b/src/libnptm/TransitionMatrix.cpp
@@ -8,6 +8,10 @@
#include <hdf5.h>
#include <string>
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
#endif
diff --git a/src/libnptm/file_io.cpp b/src/libnptm/file_io.cpp
index 0c0b0c17..f960e26c 100644
--- a/src/libnptm/file_io.cpp
+++ b/src/libnptm/file_io.cpp
@@ -2,11 +2,15 @@
*
* \brief Implementation of file I/O operations.
*/
-#include <stdexcept>
+#include <exception>
#include <regex>
#include <string>
#include <hdf5.h>
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
#endif
@@ -126,7 +130,7 @@ HDFFile* HDFFile::from_schema(
delete[] max_dims;
} else {
string message = "unrecognized type \"" + rec_types[ri] + "\"\n";
- throw runtime_error(message);
+ throw UnrecognizedParameterException(message);
}
}
@@ -159,7 +163,7 @@ herr_t HDFFile::read(
case 2:
mem_type_id = H5T_NATIVE_DOUBLE; break;
default:
- throw runtime_error("Unrecognized data type \"" + data_type + "\"");
+ throw UnrecognizedParameterException("unrecognized data type \"" + data_type + "\"");
}
if (dataset_id != H5I_INVALID_HID) {
status = H5Dread(dataset_id, mem_type_id, mem_space_id, file_space_id, dxpl_id, buffer);
@@ -169,7 +173,7 @@ herr_t HDFFile::read(
status = (herr_t)-1;
}
} else {
- throw runtime_error("Unrecognized data type \"" + data_type + "\"");
+ throw UnrecognizedParameterException("unrecognized data type \"" + data_type + "\"");
}
return status;
}
@@ -198,7 +202,7 @@ herr_t HDFFile::write(
case 2:
mem_type_id = H5T_NATIVE_DOUBLE; break;
default:
- throw runtime_error("Unrecognized data type \"" + data_type + "\"");
+ throw UnrecognizedParameterException("unrecognized data type \"" + data_type + "\"");
}
if (dataset_id != H5I_INVALID_HID) {
status = H5Dwrite(dataset_id, mem_type_id, mem_space_id, file_space_id, dxpl_id, buffer);
@@ -208,7 +212,7 @@ herr_t HDFFile::write(
status = (herr_t)-1;
}
} else {
- throw runtime_error("Unrecognized data type \"" + data_type + "\"");
+ throw UnrecognizedParameterException("unrecognized data type \"" + data_type + "\"");
}
return status;
}
diff --git a/src/libnptm/tfrfme.cpp b/src/libnptm/tfrfme.cpp
index 27941bcb..2b649f86 100644
--- a/src/libnptm/tfrfme.cpp
+++ b/src/libnptm/tfrfme.cpp
@@ -9,6 +9,10 @@
#include <hdf5.h>
#include <string>
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
#endif
diff --git a/src/sphere/sphere.cpp b/src/sphere/sphere.cpp
index efad7ad1..7016d836 100644
--- a/src/sphere/sphere.cpp
+++ b/src/sphere/sphere.cpp
@@ -8,6 +8,10 @@
#include <fstream>
#include <string>
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
#ifndef INCLUDE_CONFIGURATION_H_
#include "../include/Configuration.h"
#endif
diff --git a/src/testing/test_TEDF.cpp b/src/testing/test_TEDF.cpp
index b384cc1d..98a681d3 100644
--- a/src/testing/test_TEDF.cpp
+++ b/src/testing/test_TEDF.cpp
@@ -2,11 +2,25 @@
#include <complex>
#include <cstdio>
+#include <exception>
#include <hdf5.h>
#include <string>
+
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
+#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
+#endif
+
+#ifndef INCLUDE_FILE_IO_H_
#include "../include/file_io.h"
+#endif
+
+#ifndef INCLUDE_CONFIGURATION_H_
#include "../include/Configuration.h"
+#endif
using namespace std;
diff --git a/src/testing/test_TTMS.cpp b/src/testing/test_TTMS.cpp
index 3b054359..7c55d16a 100644
--- a/src/testing/test_TTMS.cpp
+++ b/src/testing/test_TTMS.cpp
@@ -2,11 +2,25 @@
#include <complex>
#include <cstdio>
+#include <exception>
#include <hdf5.h>
#include <string>
+
+#ifndef INCLUDE_ERRORS_H_
+#include "../include/errors.h"
+#endif
+
+#ifndef INCLUDE_LIST_H_
#include "../include/List.h"
+#endif
+
+#ifndef INCLUDE_FILE_IO_H_
#include "../include/file_io.h"
+#endif
+
+#ifndef INCLUDE_TRANSITIONMATRIX_H_
#include "../include/TransitionMatrix.h"
+#endif
using namespace std;
--
GitLab