Add option to skip forward to the generator interface

Author: horenmar

docs/generators.md

@@ -264,9 +264,23 @@ struct IGenerator : GeneratorUntypedBase {
     // Returns user-friendly string showing the current generator element
     // Does not have to be overridden, IGenerator provides default implementation
     virtual std::string stringifyImpl() const;
+
+    /**
+     * Customization point for `skipToNthElement`
+     *
+     * Does not have to be overridden, there is a default implementation.
+     * Can be overridden for better performance.
+     *
+     * If there are not enough elements, shall throw an error.
+     *
+     * Going backwards is not supported.
+     */
+    virtual void skipToNthElementImpl( std::size_t n );
 };
 ```
 
+> `skipToNthElementImpl` was added in Catch2 vX.Y.Z
+
 However, to be able to use your custom generator inside `GENERATE`, it
 will need to be wrapped inside a `GeneratorWrapper<T>`.
 `GeneratorWrapper<T>` is a value wrapper around a

examples/300-Gen-OwnGenerator.cpp

@@ -39,6 +39,22 @@ class RandomIntGenerator final : public Catch::Generators::IGenerator<int> {
         current_number = m_dist(m_rand);
         return true;
     }
+
+    // Note: this improves the performance only a bit, but it is here
+    //       to show how you can override the skip functionality.
+    void skipToNthElementImpl( std::size_t n ) override {
+        auto current_index = currentElementIndex();
+        assert(current_index <= n);
+        // We cannot jump forward the underlying generator directly,
+        // because we do not know how many bits each distributed number
+        // would consume to be generated.
+        for (; current_index < n; ++current_index) {
+            (void)m_dist(m_rand);
+        }
+
+        // We do not have to touch the current element index; it is handled
+        // by the base class.
+    }
 };
 
 // Avoids -Wweak-vtables

src/catch2/interfaces/catch_interfaces_generatortracker.cpp

@@ -7,6 +7,8 @@
 // SPDX-License-Identifier: BSL-1.0
 
 #include <catch2/interfaces/catch_interfaces_generatortracker.hpp>
+#include <catch2/generators/catch_generators.hpp>
+
 #include <string>
 
 namespace Catch {
@@ -21,6 +23,31 @@ namespace Catch {
             return ret;
         }
 
+        void GeneratorUntypedBase::skipToNthElementImpl( std::size_t n ) {
+            for ( size_t i = m_currentElementIndex; i < n; ++i ) {
+                bool isValid = next();
+                if ( !isValid ) {
+                    Detail::throw_generator_exception(
+                        "Coud not jump to Nth element: not enough elements" );
+                }
+            }
+        }
+
+        void GeneratorUntypedBase::skipToNthElement( std::size_t n ) {
+            if ( n < m_currentElementIndex ) {
+                Detail::throw_generator_exception(
+                    "Tried to jump generator backwards" );
+            }
+            if ( n == m_currentElementIndex ) { return; }
+
+            skipToNthElementImpl(n);
+            // Fixup tracking after moving the generator forward
+            //  * Ensure that the correct element index is set after skipping
+            //  * Invalidate cache
+            m_currentElementIndex = n;
+            m_stringReprCache.clear();
+        }
+
         StringRef GeneratorUntypedBase::currentElementAsString() const {
             if ( m_stringReprCache.empty() ) {
                 m_stringReprCache = stringifyImpl();

src/catch2/interfaces/catch_interfaces_generatortracker.hpp

@@ -35,6 +35,15 @@ namespace Catch {
             //! Customization point for `currentElementAsString`
             virtual std::string stringifyImpl() const = 0;
 
+            /**
+             * Customization point for skipping to the n-th element
+             *
+             * Defaults to successively calling `countedNext`. If there
+             * are not enough elements to reach the nth one, will throw
+             * an error.
+             */
+            virtual void skipToNthElementImpl( std::size_t n );
+
         public:
             GeneratorUntypedBase() = default;
             // Generation of copy ops is deprecated (and Clang will complain)
@@ -58,6 +67,13 @@ namespace Catch {
 
             std::size_t currentElementIndex() const { return m_currentElementIndex; }
 
+            /**
+             * Moves the generator forward **to** the n-th element
+             *
+             * Cannot move backwards. Can stay in place.
+             */
+            void skipToNthElement( std::size_t n );
+
             /**
              * Returns generator's current element as user-friendly string.
              *

tests/SelfTest/Baselines/automake.sw.approved.txt

@@ -170,6 +170,7 @@ Nor would this
 :test-result: PASS GENERATE can combine literals and generators
 :test-result: PASS Generators -- adapters
 :test-result: PASS Generators -- simple
+:test-result: PASS Generators can be skipped forward
 :test-result: PASS Generators internals
 :test-result: PASS Greater-than inequalities with different epsilons
 :test-result: PASS Hashers with different seed produce different hash with same test case

tests/SelfTest/Baselines/automake.sw.multi.approved.txt

@@ -168,6 +168,7 @@
 :test-result: PASS GENERATE can combine literals and generators
 :test-result: PASS Generators -- adapters
 :test-result: PASS Generators -- simple
+:test-result: PASS Generators can be skipped forward
 :test-result: PASS Generators internals
 :test-result: PASS Greater-than inequalities with different epsilons
 :test-result: PASS Hashers with different seed produce different hash with same test case

tests/SelfTest/Baselines/compact.sw.approved.txt

@@ -801,6 +801,15 @@ Generators.tests.cpp:<line number>: passed: j < i for: -1 < 3
 Generators.tests.cpp:<line number>: passed: 4u * i > str.size() for: 12 > 1
 Generators.tests.cpp:<line number>: passed: 4u * i > str.size() for: 12 > 2
 Generators.tests.cpp:<line number>: passed: 4u * i > str.size() for: 12 > 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 0 for: 0 == 0
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.get() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.get() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 5 for: 5 == 5
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.get() == 5 for: 5 == 5
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.skipToNthElement( 3 )
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.skipToNthElement( 6 )
 GeneratorsImpl.tests.cpp:<line number>: passed: gen.get() == 123 for: 123 == 123
 GeneratorsImpl.tests.cpp:<line number>: passed: !(gen.next()) for: !false
 GeneratorsImpl.tests.cpp:<line number>: passed: gen.get() == 1 for: 1 == 1
@@ -2915,7 +2924,7 @@ InternalBenchmark.tests.cpp:<line number>: passed: med == 18. for: 18.0 == 18.0
 InternalBenchmark.tests.cpp:<line number>: passed: q3 == 23. for: 23.0 == 23.0
 Misc.tests.cpp:<line number>: passed:
 Misc.tests.cpp:<line number>: passed:
-test cases:  439 |  319 passed |  96 failed | 6 skipped | 18 failed as expected
-assertions: 2331 | 2130 passed | 158 failed | 43 failed as expected
+test cases:  440 |  320 passed |  96 failed | 6 skipped | 18 failed as expected
+assertions: 2340 | 2139 passed | 158 failed | 43 failed as expected
 
 

tests/SelfTest/Baselines/compact.sw.multi.approved.txt

@@ -799,6 +799,15 @@ Generators.tests.cpp:<line number>: passed: j < i for: -1 < 3
 Generators.tests.cpp:<line number>: passed: 4u * i > str.size() for: 12 > 1
 Generators.tests.cpp:<line number>: passed: 4u * i > str.size() for: 12 > 2
 Generators.tests.cpp:<line number>: passed: 4u * i > str.size() for: 12 > 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 0 for: 0 == 0
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.get() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.get() == 3 for: 3 == 3
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.currentElementIndex() == 5 for: 5 == 5
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.get() == 5 for: 5 == 5
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.skipToNthElement( 3 )
+GeneratorsImpl.tests.cpp:<line number>: passed: generator.skipToNthElement( 6 )
 GeneratorsImpl.tests.cpp:<line number>: passed: gen.get() == 123 for: 123 == 123
 GeneratorsImpl.tests.cpp:<line number>: passed: !(gen.next()) for: !false
 GeneratorsImpl.tests.cpp:<line number>: passed: gen.get() == 1 for: 1 == 1
@@ -2904,7 +2913,7 @@ InternalBenchmark.tests.cpp:<line number>: passed: med == 18. for: 18.0 == 18.0
 InternalBenchmark.tests.cpp:<line number>: passed: q3 == 23. for: 23.0 == 23.0
 Misc.tests.cpp:<line number>: passed:
 Misc.tests.cpp:<line number>: passed:
-test cases:  439 |  319 passed |  96 failed | 6 skipped | 18 failed as expected
-assertions: 2331 | 2130 passed | 158 failed | 43 failed as expected
+test cases:  440 |  320 passed |  96 failed | 6 skipped | 18 failed as expected
+assertions: 2340 | 2139 passed | 158 failed | 43 failed as expected
 
 

tests/SelfTest/Baselines/console.std.approved.txt

@@ -1743,6 +1743,6 @@ due to unexpected exception with message:
   Why would you throw a std::string?
 
 ===============================================================================
-test cases:  439 |  337 passed |  76 failed | 7 skipped | 19 failed as expected
-assertions: 2309 | 2130 passed | 136 failed | 43 failed as expected
+test cases:  440 |  338 passed |  76 failed | 7 skipped | 19 failed as expected
+assertions: 2318 | 2139 passed | 136 failed | 43 failed as expected
 

tests/SelfTest/Baselines/console.sw.approved.txt

@@ -5921,6 +5921,53 @@ Generators.tests.cpp:<line number>: PASSED:
 with expansion:
   12 > 3
 
+-------------------------------------------------------------------------------
+Generators can be skipped forward
+-------------------------------------------------------------------------------
+GeneratorsImpl.tests.cpp:<line number>
+...............................................................................
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.currentElementIndex() == 0 )
+with expansion:
+  0 == 0
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.currentElementIndex() == 3 )
+with expansion:
+  3 == 3
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.get() == 3 )
+with expansion:
+  3 == 3
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.currentElementIndex() == 3 )
+with expansion:
+  3 == 3
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.get() == 3 )
+with expansion:
+  3 == 3
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.currentElementIndex() == 5 )
+with expansion:
+  5 == 5
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE( generator.get() == 5 )
+with expansion:
+  5 == 5
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE_THROWS( generator.skipToNthElement( 3 ) )
+
+GeneratorsImpl.tests.cpp:<line number>: PASSED:
+  REQUIRE_THROWS( generator.skipToNthElement( 6 ) )
+
 -------------------------------------------------------------------------------
 Generators internals
   Single value
@@ -19542,6 +19589,6 @@ Misc.tests.cpp:<line number>
 Misc.tests.cpp:<line number>: PASSED:
 
 ===============================================================================
-test cases:  439 |  319 passed |  96 failed | 6 skipped | 18 failed as expected
-assertions: 2331 | 2130 passed | 158 failed | 43 failed as expected
+test cases:  440 |  320 passed |  96 failed | 6 skipped | 18 failed as expected
+assertions: 2340 | 2139 passed | 158 failed | 43 failed as expected