Merge pull request #318 from PureAbstract/enum_to_string

Enum to string (for #317)

include/internal/catch_tostring.h

@@ -22,6 +22,11 @@
 #endif
 
 namespace Catch {
+
+// Why we're here.
+template<typename T>
+std::string toString( T const& value );
+
 namespace Detail {
 
 // SFINAE is currently disabled by default for all compilers.
@@ -64,10 +69,38 @@ namespace Detail {
 
 #endif
 
+#if defined(CATCH_CPP11_OR_GREATER)
+    template<typename T,
+             bool IsEmum = std::is_enum<T>::value
+             >
+    struct EnumStringMaker
+    {
+        static std::string convert( T const& ) { return "{?}"; }
+    };
+
+    template<typename T>
+    struct EnumStringMaker<T,true>
+    {
+        static std::string convert( T const& v )
+        {
+            return ::Catch::toString(
+                static_cast<typename std::underlying_type<T>::type>(v)
+                );
+        }
+    };
+#endif
     template<bool C>
     struct StringMakerBase {
+#if defined(CATCH_CPP11_OR_GREATER)
+        template<typename T>
+        static std::string convert( T const& v )
+        {
+            return EnumStringMaker<T>::convert( v );
+        }
+#else
         template<typename T>
         static std::string convert( T const& ) { return "{?}"; }
+#endif
     };
 
     template<>
@@ -89,9 +122,6 @@ namespace Detail {
 
 } // end namespace Detail
 
-template<typename T>
-std::string toString( T const& value );
-
 template<typename T>
 struct StringMaker :
     Detail::StringMakerBase<Detail::IsStreamInsertable<T>::value> {};

projects/SelfTest/EnumToString.cpp

@@ -0,0 +1,71 @@
+#include "catch.hpp"
+
+/*
+  TODO: maybe ought to check that user-provided specialisations of
+ Catch::toString also do the right thing
+*/
+
+// Enum without user-provided stream operator
+enum Enum1 { Enum1Value0, Enum1Value1 };
+
+TEST_CASE( "toString(enum)", "[toString][enum]" )
+{
+    Enum1 e0 = Enum1Value0;
+    CHECK( Catch::toString(e0) == "0" );
+    Enum1 e1 = Enum1Value1;
+    CHECK( Catch::toString(e1) == "1" );
+}
+
+// Enum with user-provided stream operator
+enum Enum2 { Enum2Value0, Enum2Value1 };
+
+std::ostream& operator<<( std::ostream& os, Enum2 v )
+{
+    return os << "E2{" << static_cast<int>(v) << "}";
+}
+
+TEST_CASE( "toString(enum w/operator<<)", "[toString][enum]" )
+{
+    Enum2 e0 = Enum2Value0;
+    CHECK( Catch::toString(e0) == "E2{0}" );
+    Enum2 e1 = Enum2Value1;
+    CHECK( Catch::toString(e1) == "E2{1}" );
+}
+
+#if defined(CATCH_CPP11_OR_GREATER)
+// Enum class without user-provided stream operator
+enum class EnumClass1 { EnumClass1Value0, EnumClass1Value1 };
+
+TEST_CASE( "toString(enum class)", "[toString][enum][enumClass]" )
+{
+    EnumClass1 e0 = EnumClass1::EnumClass1Value0;
+    CHECK( Catch::toString(e0) == "0" );
+    EnumClass1 e1 = EnumClass1::EnumClass1Value1;
+    CHECK( Catch::toString(e1) == "1" );
+}
+
+// Enum class with user-provided stream operator
+enum class EnumClass2 : short { EnumClass2Value0, EnumClass2Value1 };
+
+std::ostream& operator<<( std::ostream& os, EnumClass2 e2 )
+{
+    switch( e2 )
+    {
+      case EnumClass2::EnumClass2Value0:
+          return os << "E2/V0";
+      case EnumClass2::EnumClass2Value1:
+          return os << "E2/V1";
+    }
+    return os << "unexpected...";
+}
+
+TEST_CASE( "toString(enum class w/operator<<)", "[toString][enum][enumClass]" )
+{
+    EnumClass2 e0 = EnumClass2::EnumClass2Value0;
+    CHECK( Catch::toString(e0) == "E2/V0" );
+    EnumClass2 e1 = EnumClass2::EnumClass2Value1;
+    CHECK( Catch::toString(e1) == "E2/V1" );
+}
+
+#endif
+

projects/SelfTest/makefile

@@ -9,13 +9,19 @@ SOURCES =	ApproxTests.cpp \
           TrickyTests.cpp \
           BDDTests.cpp \
           VariadicMacrosTests.cpp \
-      		catch_self_test.cpp
+          EnumToString.cpp
+
+
 OBJECTS    = $(patsubst %.cpp, %.o, $(SOURCES))
 CXX = g++
-CXXFLAGS  = -I../../include
+CXXFLAGS  = -I../../include -std=c++11
 
 CatchSelfTest: $(OBJECTS)
 	$(CXX) -o $@ $^
 
+test: CatchSelfTest
+	./CatchSelfTest
+
 clean:
-	rm -f $(OBJECTS)
+	rm -f $(OBJECTS) CatchSelfTest
+