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

Improve XmlWriter::writeAttribute overload set for string-like types

Previously, string literals and `std::string`s would match the
template variant, which would serialize them into a stream and then
call the `StringRef` overload for resulting string. This caused
bunch of codebloat and unnecessary pessimization for common usage.
Commit
41ad0fda11d0898ce3aaeee9db4e7bc16eec5051
Author
Martin Hořeňovský ·
Parents
d9f72868b266

Files · Download .tar.gz

Changes

 src/catch2/internal/catch_xmlwriter.cpp | 16 +++++++++++++++-
 src/catch2/internal/catch_xmlwriter.hpp | 27 +++++++++++++++++++++------
 2 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/src/catch2/internal/catch_xmlwriter.cpp b/src/catch2/internal/catch_xmlwriter.cpp
index 730f1dbd..b8635f7f 100644
--- a/src/catch2/internal/catch_xmlwriter.cpp
+++ b/src/catch2/internal/catch_xmlwriter.cpp
@@ -217,6 +217,14 @@ namespace {
         return *this;
     }
 
+    XmlWriter::ScopedElement&
+    XmlWriter::ScopedElement::writeAttribute( StringRef name,
+                                              StringRef attribute ) {
+        m_writer->writeAttribute( name, attribute );
+        return *this;
+    }
+
+
     XmlWriter::XmlWriter( std::ostream& os ) : m_os( os )
     {
         writeDeclaration();
@@ -276,7 +284,13 @@ namespace {
     }
 
     XmlWriter& XmlWriter::writeAttribute( StringRef name, bool attribute ) {
-        m_os << ' ' << name << "=\"" << ( attribute ? "true" : "false" ) << '"';
+        writeAttribute(name, (attribute ? "true"_sr : "false"_sr));
+        return *this;
+    }
+
+    XmlWriter& XmlWriter::writeAttribute( StringRef name,
+                                          char const* attribute ) {
+        writeAttribute( name, StringRef( attribute ) );
         return *this;
     }
 
diff --git a/src/catch2/internal/catch_xmlwriter.hpp b/src/catch2/internal/catch_xmlwriter.hpp
index 36a3b69b..3ba8c08e 100644
--- a/src/catch2/internal/catch_xmlwriter.hpp
+++ b/src/catch2/internal/catch_xmlwriter.hpp
@@ -61,7 +61,15 @@ namespace Catch {
                        XmlFormatting fmt = XmlFormatting::Newline |
                                            XmlFormatting::Indent );
 
-            template<typename T>
+            ScopedElement& writeAttribute( StringRef name,
+                                           StringRef attribute );
+            template <typename T,
+                      // Without this SFINAE, this overload is a better match
+                      // for `std::string`, `char const*`, `char const[N]` args.
+                      // While it would still work, it would cause code bloat
+                      // and multiple iteration over the strings
+                      typename = typename std::enable_if_t<
+                          !std::is_convertible<T, StringRef>::value>>
             ScopedElement& writeAttribute( StringRef name,
                                            T const& attribute ) {
                 m_writer->writeAttribute( name, attribute );
@@ -91,15 +99,22 @@ namespace Catch {
         //! Writes the attribute as "true/false"
         XmlWriter& writeAttribute( StringRef name, bool attribute );
 
-        //! The attribute value must provide op<<(ostream&, T). Resulting
+        //! The attribute content is XML-encoded
+        XmlWriter& writeAttribute( StringRef name, char const* attribute );
+
+        //! The attribute value must provide op<<(ostream&, T). The resulting
         //! serialization is XML-encoded
-        template<typename T>
+        template <typename T,
+                  // Without this SFINAE, this overload is a better match
+                  // for `std::string`, `char const*`, `char const[N]` args.
+                  // While it would still work, it would cause code bloat
+                  // and multiple iteration over the strings
+                  typename = typename std::enable_if_t<
+                      !std::is_convertible<T, StringRef>::value>>
         XmlWriter& writeAttribute( StringRef name, T const& attribute ) {
             ReusableStringStream rss;
             rss << attribute;
-            // We need to explicitly convert the string to StringRef to
-            // guarantee the right overload is picked
-            return writeAttribute( name, StringRef(rss.str()) );
+            return writeAttribute( name, rss.str() );
         }
 
         XmlWriter& writeText( StringRef text,