Refactoring Code to Adjust Scoped Logic into the common constructor for Capturer

Author: Riyuzak2510

src/catch2/catch_message.cpp

@@ -39,8 +39,9 @@ namespace Catch {
     Capturer::Capturer( StringRef macroName,
                         SourceLineInfo const& lineInfo,
                         ResultWas::OfType resultType,
-                        StringRef names ):
+                        StringRef names, bool scoped):
         m_resultCapture( getResultCapture() ) {
+        isScoped = scoped;
         auto trimmed = [&] (size_t start, size_t end) {
             while (names[start] == ',' || isspace(static_cast<unsigned char>(names[start]))) {
                 ++start;
@@ -106,20 +107,19 @@ namespace Catch {
     }
 
     void Capturer::captureValue( size_t index, std::string const& value ) {
-        assert( index < m_messages.size() );
-        m_messages[index].message += value;
-        m_resultCapture.pushScopedMessage( m_messages[index] );
-        m_captured++;
-    }
-
-     void Capturer::captureUnscopedValue( size_t index, std::string const& value ) {
-        m_messages[index].message += value;
-        getResultCapture().emplaceUnscopedMessage(Catch::MessageBuilder(
-            m_messages[index].macroName,
-            m_messages[index].lineInfo,
-            m_messages[index].type) << m_messages[index].message);
-        if(index == m_messages.size() - 1){
-            m_messages.clear();
+        if(isScoped){
+            assert( index < m_messages.size() );
+            m_messages[index].message += value;
+            m_resultCapture.pushScopedMessage( m_messages[index] );
+            m_captured++;
+        } else {
+            getResultCapture().emplaceUnscopedMessage(Catch::MessageBuilder(
+                m_messages[index].macroName,
+                m_messages[index].lineInfo,
+                m_messages[index].type) << value);
+            if(index == m_messages.size() - 1){
+                m_messages.clear();
+            }
         }
     }
 

src/catch2/catch_message.hpp

@@ -65,27 +65,15 @@ namespace Catch {
         std::vector<MessageInfo> m_messages;
         IResultCapture& m_resultCapture;
         size_t m_captured = 0;
+        bool isScoped;
     public:
-        Capturer( StringRef macroName, SourceLineInfo const& lineInfo, ResultWas::OfType resultType, StringRef names );
+        Capturer( StringRef macroName, SourceLineInfo const& lineInfo, ResultWas::OfType resultType, StringRef names, bool scoped );
 
         Capturer(Capturer const&) = delete;
         Capturer& operator=(Capturer const&) = delete;
 
         ~Capturer();
 
-        void captureUnscopedValue( size_t index, std::string const& value );
-
-        template<typename T>
-        void captureUnscopedValues( size_t index, T const& value ) {
-            captureUnscopedValue( index, Catch::Detail::stringify( value ) );
-        }
-
-        template<typename T, typename... Ts>
-        void captureUnscopedValues( size_t index, T const& value, Ts const&... values ) {
-            captureUnscopedValue( index, Catch::Detail::stringify(value) );
-            captureUnscopedValues( index+1, values... );
-        }
-
         void captureValue( size_t index, std::string const& value );
 
         template<typename T>
@@ -98,10 +86,6 @@ namespace Catch {
             captureValue( index, Catch::Detail::stringify(value) );
             captureValues( index+1, values... );
         }
-
-         std::vector<MessageInfo> getMessageDetails() const {
-            return m_messages;
-        }
     };
 
 } // end namespace Catch
@@ -119,16 +103,18 @@ namespace Catch {
     Catch::Capturer varName( macroName##_catch_sr,        \
                              CATCH_INTERNAL_LINEINFO,     \
                              Catch::ResultWas::Info,      \
-                             #__VA_ARGS__##_catch_sr );   \
+                             #__VA_ARGS__##_catch_sr,     \
+                             true );                      \
     varName.captureValues( 0, __VA_ARGS__ )
 
 ///////////////////////////////////////////////////////////////////////////////
 #define INTERNAL_CATCH_UNSCOPED_CAPTURE( varName, macroName, ... ) \
     Catch::Capturer varName( macroName##_catch_sr,                 \
                              CATCH_INTERNAL_LINEINFO,              \
                              Catch::ResultWas::Info,               \
-                             #__VA_ARGS__##_catch_sr );            \
-    varName.captureUnscopedValues( 0, __VA_ARGS__ );
+                             #__VA_ARGS__##_catch_sr,              \
+                             false );                              \
+    varName.captureValues( 0, __VA_ARGS__ );
 
 ///////////////////////////////////////////////////////////////////////////////
 #define INTERNAL_CATCH_INFO( macroName, log ) \
@@ -149,12 +135,11 @@ namespace Catch {
 
 #elif defined(CATCH_CONFIG_PREFIX_MESSAGES) && defined(CATCH_CONFIG_DISABLE)
 
-  #define CATCH_INFO( msg )          (void)(0)
-  #define CATCH_UNSCOPED_INFO( msg ) (void)(0)
-  #define CATCH_WARN( msg )          (void)(0)
-  #define CATCH_CAPTURE( ... )       (void)(0)
-  #define CATCH_UNSCOPED_CAPTURE( ... ) (void)(0)
-
+ #define CATCH_INFO( msg )              (void)(0)
+ #define CATCH_UNSCOPED_INFO( msg )     (void)(0)
+ #define CATCH_WARN( msg )              (void)(0)
+ #define CATCH_CAPTURE( ... )           (void)(0)
+ #define CATCH_UNSCOPED_CAPTURE( ... )  (void)(0)
 
 #elif !defined(CATCH_CONFIG_PREFIX_MESSAGES) && !defined(CATCH_CONFIG_DISABLE)
 
@@ -167,12 +152,11 @@ namespace Catch {
 
 #elif !defined(CATCH_CONFIG_PREFIX_MESSAGES) && defined(CATCH_CONFIG_DISABLE)
 
-  #define INFO( msg )          (void)(0)
-  #define UNSCOPED_INFO( msg ) (void)(0)
-  #define WARN( msg )          (void)(0)
-  #define CAPTURE( ... )       (void)(0)
-  #define UNSCOPED_CAPTURE( ... ) (void)(0)
-
+ #define INFO(msg)                (void)(0)
+ #define UNSCOPED_INFO(msg)       (void)(0)
+ #define WARN(msg)                (void)(0)
+ #define CAPTURE(...)             (void)(0)
+ #define UNSCOPED_CAPTURE(...)    (void)(0)
 #endif // end of user facing macro declarations
 
 

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

@@ -2187,8 +2187,8 @@ MatchersRanges.tests.cpp:<line number>: passed: a, !RangeEquals( b ) for: { 1, 2
 MatchersRanges.tests.cpp:<line number>: passed: a, UnorderedRangeEquals( b ) for: { 1, 2, 3 } unordered elements are { 3, 2, 1 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, RangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } elements are { 2, 3, 4 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, UnorderedRangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } unordered elements are { 2, 3, 4 }
-Message.tests.cpp:<line number>: passed: with 7 messages: 'a := 1' and 'b := 2' and 'c := 3' and 'a + b := 3' and 'a+b := 3' and 'c > b := true' and 'a == 1 := true'
-Message.tests.cpp:<line number>: passed: with 11 messages: '("comma, in string", "escaped, \", ") := "escaped, ", "' and '"single quote in string,'," := "single quote in string,',"' and '"some escapes, \\,\\\\" := "some escapes, \,\\"' and '"some, ), unmatched, } prenheses {[<" := "some, ), unmatched, } prenheses {[<"' and ''"' := '"'' and ''\'' := '''' and '',' := ','' and ''}' := '}'' and '')' := ')'' and ''(' := '('' and ''{' := '{''
+Message.tests.cpp:<line number>: passed: with 7 messages: '1' and '2' and '3' and '3' and '3' and 'true' and 'true'
+Message.tests.cpp:<line number>: passed: with 11 messages: '"escaped, ", "' and '"single quote in string,',"' and '"some escapes, \,\\"' and '"some, ), unmatched, } prenheses {[<"' and ''"'' and ''''' and '','' and ''}'' and '')'' and ''('' and ''{''
 Exception.tests.cpp:<line number>: failed: unexpected exception with message: '3.14000000000000012'
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
@@ -2715,9 +2715,9 @@ Skip.tests.cpp:<line number>: skipped: 'skipping because answer = 43'
 StringManip.tests.cpp:<line number>: passed: splitStringRef("", ','), Equals(std::vector<StringRef>()) for: {  } Equals: {  }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc", ','), Equals(std::vector<StringRef>{"abc"}) for: { abc } Equals: { abc }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc,def", ','), Equals(std::vector<StringRef>{"abc", "def"}) for: { abc, def } Equals: { abc, def }
-Message.tests.cpp:<line number>: failed: false with 1 message: 'input := { 7, 8, 9 }'
-Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 1 to 3..." := "Count 1 to 3..."' and 'input := 1' and 'input := 2' and 'input := 3'
-Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 4 to 6..." := "Count 4 to 6..."' and 'input := 4' and 'input := 5' and 'input := 6'
+Message.tests.cpp:<line number>: failed: false with 1 message: '{ 7, 8, 9 }'
+Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 1 to 3..."' and '1' and '2' and '3'
+Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 4 to 6..."' and '4' and '5' and '6'
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 1 to 3...' and '1' and '2' and '3'
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 4 to 6...' and '4' and '5' and '6'
 StringManip.tests.cpp:<line number>: passed: !(startsWith("", 'c')) for: !false

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

@@ -2180,8 +2180,8 @@ MatchersRanges.tests.cpp:<line number>: passed: a, !RangeEquals( b ) for: { 1, 2
 MatchersRanges.tests.cpp:<line number>: passed: a, UnorderedRangeEquals( b ) for: { 1, 2, 3 } unordered elements are { 3, 2, 1 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, RangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } elements are { 2, 3, 4 }
 MatchersRanges.tests.cpp:<line number>: passed: vector_a, UnorderedRangeEquals( array_a_plus_1, close_enough ) for: { 1, 2, 3 } unordered elements are { 2, 3, 4 }
-Message.tests.cpp:<line number>: passed: with 7 messages: 'a := 1' and 'b := 2' and 'c := 3' and 'a + b := 3' and 'a+b := 3' and 'c > b := true' and 'a == 1 := true'
-Message.tests.cpp:<line number>: passed: with 11 messages: '("comma, in string", "escaped, \", ") := "escaped, ", "' and '"single quote in string,'," := "single quote in string,',"' and '"some escapes, \\,\\\\" := "some escapes, \,\\"' and '"some, ), unmatched, } prenheses {[<" := "some, ), unmatched, } prenheses {[<"' and ''"' := '"'' and ''\'' := '''' and '',' := ','' and ''}' := '}'' and '')' := ')'' and ''(' := '('' and ''{' := '{''
+Message.tests.cpp:<line number>: passed: with 7 messages: '1' and '2' and '3' and '3' and '3' and 'true' and 'true'
+Message.tests.cpp:<line number>: passed: with 11 messages: '"escaped, ", "' and '"single quote in string,',"' and '"some escapes, \,\\"' and '"some, ), unmatched, } prenheses {[<"' and ''"'' and ''''' and '','' and ''}'' and '')'' and ''('' and ''{''
 Exception.tests.cpp:<line number>: failed: unexpected exception with message: '3.14000000000000012'
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
 UniquePtr.tests.cpp:<line number>: passed: bptr->i == 3 for: 3 == 3
@@ -2704,9 +2704,9 @@ Skip.tests.cpp:<line number>: skipped: 'skipping because answer = 43'
 StringManip.tests.cpp:<line number>: passed: splitStringRef("", ','), Equals(std::vector<StringRef>()) for: {  } Equals: {  }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc", ','), Equals(std::vector<StringRef>{"abc"}) for: { abc } Equals: { abc }
 StringManip.tests.cpp:<line number>: passed: splitStringRef("abc,def", ','), Equals(std::vector<StringRef>{"abc", "def"}) for: { abc, def } Equals: { abc, def }
-Message.tests.cpp:<line number>: failed: false with 1 message: 'input := { 7, 8, 9 }'
-Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 1 to 3..." := "Count 1 to 3..."' and 'input := 1' and 'input := 2' and 'input := 3'
-Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 4 to 6..." := "Count 4 to 6..."' and 'input := 4' and 'input := 5' and 'input := 6'
+Message.tests.cpp:<line number>: failed: false with 1 message: '{ 7, 8, 9 }'
+Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 1 to 3..."' and '1' and '2' and '3'
+Message.tests.cpp:<line number>: failed: false with 4 messages: '"Count 4 to 6..."' and '4' and '5' and '6'
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 1 to 3...' and '1' and '2' and '3'
 Message.tests.cpp:<line number>: failed: false with 4 messages: 'Count 4 to 6...' and '4' and '5' and '6'
 StringManip.tests.cpp:<line number>: passed: !(startsWith("", 'c')) for: !false

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

@@ -1687,7 +1687,7 @@ Message.tests.cpp:<line number>
 Message.tests.cpp:<line number>: FAILED:
   CHECK( false )
 with message:
-  input := { 7, 8, 9 }
+  { 7, 8, 9 }
 
 -------------------------------------------------------------------------------
 stacks unscoped capture in loops
@@ -1698,18 +1698,18 @@ Message.tests.cpp:<line number>
 Message.tests.cpp:<line number>: FAILED:
   CHECK( false )
 with messages:
-  "Count 1 to 3..." := "Count 1 to 3..."
-  input := 1
-  input := 2
-  input := 3
+  "Count 1 to 3..."
+  1
+  2
+  3
 
 Message.tests.cpp:<line number>: FAILED:
   CHECK( false )
 with messages:
-  "Count 4 to 6..." := "Count 4 to 6..."
-  input := 4
-  input := 5
-  input := 6
+  "Count 4 to 6..."
+  4
+  5
+  6
 
 -------------------------------------------------------------------------------
 stacks unscoped info in loops

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

@@ -14199,13 +14199,13 @@ Message.tests.cpp:<line number>
 
 Message.tests.cpp:<line number>: PASSED:
 with messages:
-  a := 1
-  b := 2
-  c := 3
-  a + b := 3
-  a+b := 3
-  c > b := true
-  a == 1 := true
+  1
+  2
+  3
+  3
+  3
+  true
+  true
 
 -------------------------------------------------------------------------------
 UNSCOPED_CAPTURE parses string and character constants
@@ -14215,18 +14215,17 @@ Message.tests.cpp:<line number>
 
 Message.tests.cpp:<line number>: PASSED:
 with messages:
-  ("comma, in string", "escaped, \", ") := "escaped, ", "
-  "single quote in string,'," := "single quote in string,',"
-  "some escapes, \\,\\\\" := "some escapes, \,\\"
-  "some, ), unmatched, } prenheses {[<" := "some, ), unmatched, } prenheses {[
-  <"
-  '"' := '"'
-  '\'' := '''
-  ',' := ','
-  '}' := '}'
-  ')' := ')'
-  '(' := '('
-  '{' := '{'
+  "escaped, ", "
+  "single quote in string,',"
+  "some escapes, \,\\"
+  "some, ), unmatched, } prenheses {[<"
+  '"'
+  '''
+  ','
+  '}'
+  ')'
+  '('
+  '{'
 
 -------------------------------------------------------------------------------
 Unexpected exceptions can be translated
@@ -18122,7 +18121,7 @@ Message.tests.cpp:<line number>
 Message.tests.cpp:<line number>: FAILED:
   CHECK( false )
 with message:
-  input := { 7, 8, 9 }
+  { 7, 8, 9 }
 
 -------------------------------------------------------------------------------
 stacks unscoped capture in loops
@@ -18133,18 +18132,18 @@ Message.tests.cpp:<line number>
 Message.tests.cpp:<line number>: FAILED:
   CHECK( false )
 with messages:
-  "Count 1 to 3..." := "Count 1 to 3..."
-  input := 1
-  input := 2
-  input := 3
+  "Count 1 to 3..."
+  1
+  2
+  3
 
 Message.tests.cpp:<line number>: FAILED:
   CHECK( false )
 with messages:
-  "Count 4 to 6..." := "Count 4 to 6..."
-  input := 4
-  input := 5
-  input := 6
+  "Count 4 to 6..."
+  4
+  5
+  6
 
 -------------------------------------------------------------------------------
 stacks unscoped info in loops