FEAT: Added an error catch function

docs/changelog.rst

@@ -9,6 +9,10 @@ Changelog
 0.7.3 (unreleased)
 ******************
 
+New Features
+============
+- Added a catch function to replace the if statement pattern (:pull:`2`). By `Nathan Miller`_.
+
 ******************
 0.7.2 (2023-09-27)
 ******************

src/cpp/tardigrade_error_tools.h

@@ -89,6 +89,26 @@
 */
 #define TARDIGRADE_ERROR_TOOLS_CATCH_NODE_POINTER(expr) TARDIGRADE_ERROR_TOOLS_CATCH_NODE_POINTER_INTERNAL(expr, __func__, __LINE__, __FILE__)
 
+/*!
+    \brief A macro to check for issues that we want to throw an exception if a condition isn't met
+    \param condition: An expression that evaluates as a boolean
+    \param error_message: The output message if it fails
+    \param func: A standard string or char function name
+    \param line: The integer filename
+    \param file: A standard string or char filename
+*/
+#define TARDIGRADE_ERROR_TOOLS_CHECK_INTERNAL(condition, error_message, func, line, file) \
+    if ( ! condition ){                                                                   \
+        TARDIGRADE_ERROR_TOOLS_CATCH(throw std::runtime_error(error_message) )            \
+    }                                                                                     \
+
+/*!
+    \brief A macro to check for issues that we want to throw an exception if a condition isn't met
+    \param condition: An expression that evaluates as a boolean
+    \param error_message: The output message if it fails
+*/
+#define TARDIGRADE_ERROR_TOOLS_CHECK(condition, error_message) TARDIGRADE_ERROR_TOOLS_CHECK_INTERNAL(condition, error_message, __func__, __LINE__, __FILE__)
+
 
 namespace tardigradeErrorTools{
 

src/cpp/tests/test_tardigrade_error_tools.cpp

@@ -232,3 +232,27 @@ BOOST_AUTO_TEST_CASE( test_form_node_stacktrace ){
     BOOST_CHECK( !result.is_empty( ) );
 
 }
+
+void runCheck( const bool condition ){
+    TARDIGRADE_ERROR_TOOLS_CHECK(condition, "mymessage")
+}
+
+BOOST_AUTO_TEST_CASE( test_tardigrade_error_tools_check ){
+
+    boost::test_tools::output_test_stream result;
+
+    //Initialize test variables
+    cerr_redirect guard( result.rdbuf( ) );
+
+    BOOST_CHECK_NO_THROW( runCheck( true ) );
+
+    try{
+        TARDIGRADE_ERROR_TOOLS_CATCH( runCheck( false ) );
+    }
+    catch( std::exception &e ){
+        tardigradeErrorTools::printNestedExceptions( e );
+    }
+
+    BOOST_CHECK( !result.is_empty( ) );
+
+}