Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Outline GeneratorException from generators header

Commit
db1a0465dc39e8aed36852984c14072192750b1d
Author
Martin Hořeňovský ·
Parents
b2a6523d85ec

Files · Download .tar.gz

Changes

 examples/301-Gen-MapTypeConversion.cpp             |  2 +-
 src/CMakeLists.txt                                 |  2 ++
 src/catch2/catch_approx.h                          |  6 ++---
 src/catch2/catch_generator_exception.cpp           | 14 +++++++++++
 src/catch2/catch_generator_exception.hpp           | 29 ++++++++++++++++++++++
 src/catch2/catch_generators.cpp                    | 15 +++++++----
 src/catch2/catch_generators.hpp                    | 17 +++++--------
 src/catch2/catch_generators_generic.hpp            |  4 +--
 src/catch2/catch_generators_specific.hpp           |  2 +-
 src/catch2/catch_output_redirect.cpp               |  1 -
 src/catch2/catch_test_case_tracker.cpp             |  1 -
 .../IntrospectiveTests/GeneratorsImpl.tests.cpp    |  1 +
 tests/SelfTest/UsageTests/Generators.tests.cpp     |  1 +
 13 files changed, 69 insertions(+), 26 deletions(-)

diff --git a/examples/301-Gen-MapTypeConversion.cpp b/examples/301-Gen-MapTypeConversion.cpp
index 66f582d6..56434a0d 100644
--- a/examples/301-Gen-MapTypeConversion.cpp
+++ b/examples/301-Gen-MapTypeConversion.cpp
@@ -18,7 +18,7 @@ public:
     LineGenerator() {
         m_stream.str("1\n2\n3\n4\n");
         if (!next()) {
-            throw Catch::GeneratorException("Couldn't read a single line");
+            Catch::Generators::Detail::throw_generator_exception("Couldn't read a single line");
         }
     }
 
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index d1cde1b7..a3e5b53d 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -56,6 +56,7 @@ set(INTERNAL_HEADERS
     ${SOURCES_DIR}/catch_errno_guard.h
     ${SOURCES_DIR}/catch_exception_translator_registry.h
     ${SOURCES_DIR}/catch_fatal_condition.h
+    ${SOURCES_DIR}/catch_generator_exception.hpp
     ${SOURCES_DIR}/catch_generators.hpp
     ${SOURCES_DIR}/catch_generators_generic.hpp
     ${SOURCES_DIR}/catch_generators_specific.hpp
@@ -142,6 +143,7 @@ set(IMPL_SOURCES
     ${SOURCES_DIR}/catch_errno_guard.cpp
     ${SOURCES_DIR}/catch_exception_translator_registry.cpp
     ${SOURCES_DIR}/catch_fatal_condition.cpp
+    ${SOURCES_DIR}/catch_generator_exception.cpp
     ${SOURCES_DIR}/catch_generators.cpp
     ${SOURCES_DIR}/catch_interfaces_capture.cpp
     ${SOURCES_DIR}/catch_interfaces_config.cpp
diff --git a/src/catch2/catch_approx.h b/src/catch2/catch_approx.h
index 9dc9f292..4f3a6958 100644
--- a/src/catch2/catch_approx.h
+++ b/src/catch2/catch_approx.h
@@ -17,11 +17,9 @@ namespace Catch {
     class Approx {
     private:
         bool equalityComparisonImpl(double other) const;
-        // Validates the new margin (margin >= 0)
-        // out-of-line to avoid including stdexcept in the header
+        //! Sets and validates the new margin (margin >= 0)
         void setMargin(double margin);
-        // Validates the new epsilon (0 < epsilon < 1)
-        // out-of-line to avoid including stdexcept in the header
+        //! Sets and validates the new epsilon (0 < epsilon < 1)
         void setEpsilon(double epsilon);
 
     public:
diff --git a/src/catch2/catch_generator_exception.cpp b/src/catch2/catch_generator_exception.cpp
new file mode 100644
index 00000000..9ec5d55b
--- /dev/null
+++ b/src/catch2/catch_generator_exception.cpp
@@ -0,0 +1,14 @@
+/*
+ *  Distributed under the Boost Software License, Version 1.0. (See accompanying
+ *  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ */
+
+#include <catch2/catch_generator_exception.hpp>
+
+namespace Catch {
+
+    const char* GeneratorException::what() const noexcept {
+        return m_msg;
+    }
+
+} // end namespace Catch
diff --git a/src/catch2/catch_generator_exception.hpp b/src/catch2/catch_generator_exception.hpp
new file mode 100644
index 00000000..ff84c4d8
--- /dev/null
+++ b/src/catch2/catch_generator_exception.hpp
@@ -0,0 +1,29 @@
+/*
+ *  Distributed under the Boost Software License, Version 1.0. (See accompanying
+ *  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ */
+
+#ifndef TWOBLUECUBES_CATCH_GENERATOR_EXCEPTION_HPP_INCLUDED
+#define TWOBLUECUBES_CATCH_GENERATOR_EXCEPTION_HPP_INCLUDED
+
+#include <exception>
+
+namespace Catch {
+
+    // Exception type to be thrown when a Generator runs into an error,
+    // e.g. it cannot initialize the first return value based on
+    // runtime information
+    class GeneratorException : public std::exception {
+        const char* const m_msg = "";
+
+    public:
+        GeneratorException(const char* msg):
+            m_msg(msg)
+        {}
+
+        const char* what() const noexcept override final;
+    };
+
+} // end namespace Catch
+
+#endif // TWOBLUECUBES_CATCH_GENERATOR_EXCEPTION_HPP_INCLUDED
diff --git a/src/catch2/catch_generators.cpp b/src/catch2/catch_generators.cpp
index 0cf55a8d..48d98b92 100644
--- a/src/catch2/catch_generators.cpp
+++ b/src/catch2/catch_generators.cpp
@@ -6,7 +6,8 @@
  */
 
 #include <catch2/catch_generators.hpp>
-#include <catch2/catch_random_number_generator.h>
+#include <catch2/catch_enforce.h>
+#include <catch2/catch_generator_exception.hpp>
 #include <catch2/catch_interfaces_capture.h>
 
 #include <limits>
@@ -16,12 +17,16 @@ namespace Catch {
 
 IGeneratorTracker::~IGeneratorTracker() {}
 
-const char* GeneratorException::what() const noexcept {
-    return m_msg;
-}
-
 namespace Generators {
 
+namespace Detail {
+
+    [[noreturn]]
+    void throw_generator_exception(char const* msg) {
+        Catch::throw_exception(GeneratorException{ msg });
+    }
+} // end namespace Detail
+
     GeneratorUntypedBase::~GeneratorUntypedBase() {}
 
     auto acquireGeneratorTracker( SourceLineInfo const& lineInfo ) -> IGeneratorTracker& {
diff --git a/src/catch2/catch_generators.hpp b/src/catch2/catch_generators.hpp
index 86f02006..d49ae2e2 100644
--- a/src/catch2/catch_generators.hpp
+++ b/src/catch2/catch_generators.hpp
@@ -9,29 +9,24 @@
 
 #include <catch2/catch_interfaces_generatortracker.h>
 #include <catch2/catch_common.h>
-#include <catch2/catch_enforce.h>
 
 #include <memory>
 #include <vector>
 #include <cassert>
 #include <tuple>
 #include <utility>
-#include <exception>
 
 namespace Catch {
 
-class GeneratorException : public std::exception {
-    const char* const m_msg = "";
+namespace Generators {
 
-public:
-    GeneratorException(const char* msg):
-        m_msg(msg)
-    {}
+namespace Detail {
 
-    const char* what() const noexcept override final;
-};
+    //! Throws GeneratorException with the provided message
+    [[noreturn]]
+    void throw_generator_exception(char const * msg);
 
-namespace Generators {
+} // end namespace detail
 
     template<typename T>
     struct IGenerator : GeneratorUntypedBase {
diff --git a/src/catch2/catch_generators_generic.hpp b/src/catch2/catch_generators_generic.hpp
index 5a8708dc..954150b9 100644
--- a/src/catch2/catch_generators_generic.hpp
+++ b/src/catch2/catch_generators_generic.hpp
@@ -65,7 +65,7 @@ namespace Generators {
                 // filter. In that case we throw an exception.
                 auto has_initial_value = next();
                 if (!has_initial_value) {
-                    Catch::throw_exception(GeneratorException("No valid value found in filtered generator"));
+                    Detail::throw_generator_exception("No valid value found in filtered generator");
                 }
             }
         }
@@ -202,7 +202,7 @@ namespace Generators {
                 m_chunk.push_back(m_generator.get());
                 for (size_t i = 1; i < m_chunk_size; ++i) {
                     if (!m_generator.next()) {
-                        Catch::throw_exception(GeneratorException("Not enough values to initialize the first chunk"));
+                        Detail::throw_generator_exception("Not enough values to initialize the first chunk");
                     }
                     m_chunk.push_back(m_generator.get());
                 }
diff --git a/src/catch2/catch_generators_specific.hpp b/src/catch2/catch_generators_specific.hpp
index b4ca536c..f61a2be2 100644
--- a/src/catch2/catch_generators_specific.hpp
+++ b/src/catch2/catch_generators_specific.hpp
@@ -140,7 +140,7 @@ public:
     template <typename InputIterator, typename InputSentinel>
     IteratorGenerator(InputIterator first, InputSentinel last):m_elems(first, last) {
         if (m_elems.empty()) {
-            Catch::throw_exception(GeneratorException("IteratorGenerator received no valid values"));
+            Detail::throw_generator_exception("IteratorGenerator received no valid values");
         }
     }
 
diff --git a/src/catch2/catch_output_redirect.cpp b/src/catch2/catch_output_redirect.cpp
index 10ecfe22..5ff7abd0 100644
--- a/src/catch2/catch_output_redirect.cpp
+++ b/src/catch2/catch_output_redirect.cpp
@@ -12,7 +12,6 @@
 #include <cstring>
 #include <fstream>
 #include <sstream>
-#include <stdexcept>
 
 #if defined(CATCH_CONFIG_NEW_CAPTURE)
     #if defined(_MSC_VER)
diff --git a/src/catch2/catch_test_case_tracker.cpp b/src/catch2/catch_test_case_tracker.cpp
index 1781a8db..51aa56ff 100644
--- a/src/catch2/catch_test_case_tracker.cpp
+++ b/src/catch2/catch_test_case_tracker.cpp
@@ -12,7 +12,6 @@
 
 #include <algorithm>
 #include <cassert>
-#include <stdexcept>
 #include <memory>
 #include <sstream>
 
diff --git a/tests/SelfTest/IntrospectiveTests/GeneratorsImpl.tests.cpp b/tests/SelfTest/IntrospectiveTests/GeneratorsImpl.tests.cpp
index df5e036e..459485bc 100644
--- a/tests/SelfTest/IntrospectiveTests/GeneratorsImpl.tests.cpp
+++ b/tests/SelfTest/IntrospectiveTests/GeneratorsImpl.tests.cpp
@@ -1,5 +1,6 @@
 #include <catch2/catch_approx.h>
 #include <catch2/catch_test_macros.hpp>
+#include <catch2/catch_generator_exception.hpp>
 #include <catch2/catch_generators_generic.hpp>
 #include <catch2/catch_generators_specific.hpp>
 
diff --git a/tests/SelfTest/UsageTests/Generators.tests.cpp b/tests/SelfTest/UsageTests/Generators.tests.cpp
index ca03f026..0b4511c6 100644
--- a/tests/SelfTest/UsageTests/Generators.tests.cpp
+++ b/tests/SelfTest/UsageTests/Generators.tests.cpp
@@ -1,4 +1,5 @@
 #include <catch2/catch_test_macros.hpp>
+#include <catch2/catch_generator_exception.hpp>
 #include <catch2/catch_generators_generic.hpp>
 #include <catch2/catch_generators_specific.hpp>