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

Refactored colour handling

* POSIX colour impl is now compiled for all platforms.
* Deciding whether a colour impl should be picked is now stream
  dependent, and thus incompatible implementations can be removed
  immediately, rather than checking when the colour is being used.
Commit
0e176c318bf309aaa4acd8686a82517fda7b859a
Author
Martin Hořeňovský ·
Parents
c1c72c7e0559

Files · Download .tar.gz

Changes

 src/catch2/internal/catch_console_colour.cpp    | 54 ++++++++++++++-----------
 src/catch2/reporters/catch_reporter_console.cpp |  4 +-
 2 files changed, 33 insertions(+), 25 deletions(-)

diff --git a/src/catch2/internal/catch_console_colour.cpp b/src/catch2/internal/catch_console_colour.cpp
index 4504eddc..fcfd953c 100644
--- a/src/catch2/internal/catch_console_colour.cpp
+++ b/src/catch2/internal/catch_console_colour.cpp
@@ -93,16 +93,15 @@ namespace {
             originalBackgroundAttributes = csbiInfo.wAttributes & ~( FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_INTENSITY );
         }
 
-        static bool useColourOnPlatform() { return true; }
+        static bool useColourOnPlatform(IStream const& stream) {
+            // Win32 text colour APIs can only be used on console streams
+            // We cannot check that the output hasn't been redirected,
+            // so we just check that the original stream is console stream.
+            return stream.isStdout();
+        }
 
     private:
         void use( Colour::Code _colourCode ) const override {
-            // Early exit if we are not writing to the console, because
-            // Win32 API can only change colour of the console.
-            if ( !m_stream->isStdout() ) {
-                return;
-            }
-
             switch( _colourCode ) {
                 case Colour::None:      return setTextAttribute( originalForegroundAttributes );
                 case Colour::White:     return setTextAttribute( FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE );
@@ -138,9 +137,13 @@ namespace {
 } // end anon namespace
 } // end namespace Catch
 
-#elif defined( CATCH_CONFIG_COLOUR_ANSI ) //////////////////////////////////////
+#endif // Windows/ ANSI/ None
 
-#include <unistd.h>
+
+#if defined( CATCH_PLATFORM_LINUX ) || defined( CATCH_PLATFORM_MAC )
+#    define CATCH_INTERNAL_HAS_ISATTY
+#    include <unistd.h>
+#endif
 
 namespace Catch {
 namespace {
@@ -153,18 +156,25 @@ namespace {
     public:
         PosixColourImpl( IStream const* stream ): ColourImpl( stream ) {}
 
-        static bool useColourOnPlatform() {
+        static bool useColourOnPlatform(IStream const& stream) {
+            // This is kinda messy due to trying to support a bunch of
+            // different platforms at once.
+            // The basic idea is that if we are asked to do autodetection (as
+            // opposed to being told to use posixy colours outright), then we
+            // only want to use the colours if we are writing to console.
+            // However, console might be redirected, so we make an attempt at
+            // checking for that on platforms where we know how to do that.
+            bool useColour = stream.isStdout();
+#if defined( CATCH_INTERNAL_HAS_ISATTY ) && \
+    !( defined( __DJGPP__ ) && defined( __STRICT_ANSI__ ) )
             ErrnoGuard _; // for isatty
-            return
-#    if defined( CATCH_PLATFORM_MAC ) || defined( CATCH_PLATFORM_IPHONE )
-                !isDebuggerActive() &&
+            useColour = useColour && isatty( STDOUT_FILENO );
 #    endif
-#    if !( defined( __DJGPP__ ) && defined( __STRICT_ANSI__ ) )
-                isatty( STDOUT_FILENO )
-#    else
-                false
+#    if defined( CATCH_PLATFORM_MAC ) || defined( CATCH_PLATFORM_IPHONE )
+            useColour = useColour && !isDebuggerActive();
 #    endif
-                    ;
+
+            return useColour;
         }
 
     private:
@@ -201,8 +211,6 @@ namespace {
 } // end anon namespace
 } // end namespace Catch
 
-#endif // Windows/ ANSI/ None
-
 namespace Catch {
 
     Detail::unique_ptr<ColourImpl> makeColourImpl(IConfig const* config, IStream const* stream) {
@@ -220,11 +228,11 @@ namespace Catch {
         if ( colourMode == UseColour::Auto ) {
             createPlatformInstance =
 #if defined( CATCH_CONFIG_COLOUR_ANSI )
-                PosixColourImpl::useColourOnPlatform()
+                PosixColourImpl::useColourOnPlatform( *stream )
 #elif defined( CATCH_CONFIG_COLOUR_WINDOWS )
-                Win32ColourImpl::useColourOnPlatform()
+                Win32ColourImpl::useColourOnPlatform( *stream )
 #else
-                NoColourImpl::useColourOnPlatform()
+                false
 #endif
                 ;
         }
diff --git a/src/catch2/reporters/catch_reporter_console.cpp b/src/catch2/reporters/catch_reporter_console.cpp
index 42a71d56..0d110a5a 100644
--- a/src/catch2/reporters/catch_reporter_console.cpp
+++ b/src/catch2/reporters/catch_reporter_console.cpp
@@ -661,8 +661,8 @@ void ConsoleReporter::printSummaryRow(StringRef label, std::vector<SummaryColumn
                          << "- none -";
             }
         } else if (value != "0") {
-            m_stream << m_colour->startColour( Colour::LightGrey ) << " | "
-                     << m_colour->startColour( col.colour ) << value << ' '
+            m_stream << m_colour->startColour( Colour::LightGrey ) << " | ";
+            m_stream << m_colour->startColour( col.colour ) << value << ' '
                      << col.label;
         }
     }