Don't use color escape codes if terminal doesn't support them in ansicolor_sink

include/spdlog/details/os.h

@@ -12,6 +12,7 @@
 #include <string>
 #include <chrono>
 #include <thread>
+#include <algorithm>
 #include <stdio.h>
 #include <string.h>
 #include <sys/stat.h>
@@ -401,6 +402,32 @@ inline int pid()
 
 }
 
+
+// Detrmine if the terminal supports colors
+// Source: https://github.com/agauniyal/rang/
+bool is_color_terminal()
+{
+#ifdef _WIN32
+	return true;
+#else		
+	static constexpr const char* Terms[] = {
+		"ansi", "color", "console", "cygwin", "gnome", "konsole", "kterm",
+		"linux", "msys", "putty", "rxvt", "screen", "vt100", "xterm"
+	};
+
+	const char *env_p = std::getenv("TERM");
+	if (env_p == nullptr) {
+		return false;
+	}
+
+	static const bool result = std::any_of(
+		std::begin(Terms), std::end(Terms), [&](const char* term) {
+		return std::strstr(env_p, term) != nullptr;
+	});
+#endif 
+}
+
+
 } //os
 } //details
 } //spdlog

include/spdlog/sinks/ansicolor_sink.h

@@ -7,23 +7,24 @@
 
 #include <spdlog/sinks/base_sink.h>
 #include <spdlog/common.h>
+#include <spdlog/details/os.h>
 
 #include <string>
 #include <map>
 
 namespace spdlog
 {
-namespace sinks
+	namespace sinks
-{
+	{
 
-/**
+		/**
 		 * @brief The ansi_color_sink is a decorator around another sink and prefixes
 		 * the output with an ANSI escape sequence color code depending on the severity
 		 * of the message.
 		 */
-class ansicolor_sink SPDLOG_FINAL : public sink
+		class ansicolor_sink SPDLOG_FINAL: public sink
-{
+		{
-public:
+		public:
 			ansicolor_sink(sink_ptr wrapped_sink);
 			virtual ~ansicolor_sink();
 
@@ -65,13 +66,15 @@ public:
 			const std::string on_white = "\033[47m";
 
 
-protected:
+		protected:
+			bool is_color_terminal_;
 			sink_ptr sink_;
 			std::map<level::level_enum, std::string> colors_;
-};
+		};
 
-inline ansicolor_sink::ansicolor_sink(sink_ptr wrapped_sink) : sink_(wrapped_sink)
+		inline ansicolor_sink::ansicolor_sink(sink_ptr wrapped_sink): sink_(wrapped_sink)
-{
+		{
+			is_color_terminal_ = details::os::is_color_terminal();
 			colors_[level::trace] = cyan;
 			colors_[level::debug] = cyan;
 			colors_[level::info] = bold;
@@ -79,11 +82,13 @@ inline ansicolor_sink::ansicolor_sink(sink_ptr wrapped_sink) : sink_(wrapped_sin
 			colors_[level::err] = red + bold;
 			colors_[level::critical] = bold + on_red;
 			colors_[level::off] = reset;
-}
+		}
 
-inline void ansicolor_sink::log(const details::log_msg& msg)
+		inline void ansicolor_sink::log(const details::log_msg& msg)
-{
+		{
-    // Wrap the originally formatted message in color codes
+			// Wrap the originally formatted message in color codes.
+			// If color is not supported in the terminal, log as is instead.
+			if (is_color_terminal_) {
 				const std::string& prefix = colors_[msg.level];
 				const std::string& s = msg.formatted.str();
 				const std::string& suffix = reset;
@@ -94,23 +99,27 @@ inline void ansicolor_sink::log(const details::log_msg& msg)
 				m.thread_id = msg.thread_id;
 				m.formatted << prefix << s << suffix;
 				sink_->log(m);
-}
+			}
+			else {
+				sink_->log(msg);
+			}
+		}
 
-inline void ansicolor_sink::flush()
+		inline void ansicolor_sink::flush()
-{
+		{
 			sink_->flush();
-}
+		}
 
-inline void ansicolor_sink::set_color(level::level_enum color_level, const std::string& color)
+		inline void ansicolor_sink::set_color(level::level_enum color_level, const std::string& color)
-{
+		{
 			colors_[color_level] = color;
-}
+		}
 
-inline ansicolor_sink::~ansicolor_sink()
+		inline ansicolor_sink::~ansicolor_sink()
-{
+		{
 			flush();
-}
+		}
 
-} // namespace sinks
+	} // namespace sinks
 } // namespace spdlog