Disable colors if terminal no attached and simplfy ansicolor_sink

include/spdlog/details/log_msg.h

@@ -19,7 +19,10 @@ namespace details
 struct log_msg
 {
     log_msg() = default;
-    log_msg(const std::string *loggers_name, level::level_enum lvl) : logger_name(loggers_name), level(lvl)
+    log_msg(const std::string *loggers_name, level::level_enum lvl) : 
+		logger_name(loggers_name), 
+		level(lvl), 
+		msg_id(0)
     {
 #ifndef SPDLOG_NO_DATETIME
         time = os::now();
@@ -42,7 +45,6 @@ struct log_msg
     fmt::MemoryWriter raw;
     fmt::MemoryWriter formatted;
     size_t msg_id;
-
 };
 }
 }

include/spdlog/details/os.h

@@ -29,7 +29,7 @@
 #endif
 #include <windows.h>
 #include <process.h> //  _get_pid support
-#include <io.h> // _get_osfhandle support
+#include <io.h> // _get_osfhandle and _isatty support
 
 #ifdef __MINGW32__
 #include <share.h>
@@ -56,13 +56,13 @@
 
 namespace spdlog
 {
-namespace details
-{
-namespace os
-{
+	namespace details
+	{
+		namespace os
+		{
 
-inline spdlog::log_clock::time_point now()
-{
+			inline spdlog::log_clock::time_point now()
+			{
 
 #if defined __linux__ && defined SPDLOG_CLOCK_COARSE
 				timespec ts;
@@ -76,9 +76,9 @@ inline spdlog::log_clock::time_point now()
 				return log_clock::now();
 #endif
 
-}
-inline std::tm localtime(const std::time_t &time_tt)
-{
+			}
+			inline std::tm localtime(const std::time_t &time_tt)
+			{
 
 #ifdef _WIN32
 				std::tm tm;
@@ -88,17 +88,17 @@ inline std::tm localtime(const std::time_t &time_tt)
 				localtime_r(&time_tt, &tm);
 #endif
 				return tm;
-}
+			}
 
-inline std::tm localtime()
-{
+			inline std::tm localtime()
+			{
 				std::time_t now_t = time(nullptr);
 				return localtime(now_t);
-}
+			}
 
 
-inline std::tm gmtime(const std::time_t &time_tt)
-{
+			inline std::tm gmtime(const std::time_t &time_tt)
+			{
 
 #ifdef _WIN32
 				std::tm tm;
@@ -108,15 +108,15 @@ inline std::tm gmtime(const std::time_t &time_tt)
 				gmtime_r(&time_tt, &tm);
 #endif
 				return tm;
-}
+			}
 
-inline std::tm gmtime()
-{
+			inline std::tm gmtime()
+			{
 				std::time_t now_t = time(nullptr);
 				return gmtime(now_t);
-}
-inline bool operator==(const std::tm& tm1, const std::tm& tm2)
-{
+			}
+			inline bool operator==(const std::tm& tm1, const std::tm& tm2)
+			{
 				return (tm1.tm_sec == tm2.tm_sec &&
 					tm1.tm_min == tm2.tm_min &&
 					tm1.tm_hour == tm2.tm_hour &&
@@ -124,14 +124,14 @@ inline bool operator==(const std::tm& tm1, const std::tm& tm2)
 					tm1.tm_mon == tm2.tm_mon &&
 					tm1.tm_year == tm2.tm_year &&
 					tm1.tm_isdst == tm2.tm_isdst);
-}
+			}
 
-inline bool operator!=(const std::tm& tm1, const std::tm& tm2)
-{
+			inline bool operator!=(const std::tm& tm1, const std::tm& tm2)
+			{
 				return !(tm1 == tm2);
-}
+			}
 
-// eol definition
+			// eol definition
 #if !defined (SPDLOG_EOL)
 #ifdef _WIN32
 #define SPDLOG_EOL "\r\n"
@@ -140,26 +140,26 @@ inline bool operator!=(const std::tm& tm1, const std::tm& tm2)
 #endif
 #endif
 
-SPDLOG_CONSTEXPR static const char* eol = SPDLOG_EOL;
-SPDLOG_CONSTEXPR static int eol_size = sizeof(SPDLOG_EOL) - 1;
+			SPDLOG_CONSTEXPR static const char* eol = SPDLOG_EOL;
+			SPDLOG_CONSTEXPR static int eol_size = sizeof(SPDLOG_EOL) - 1;
 
-inline void prevent_child_fd(FILE *f)
-{
+			inline void prevent_child_fd(FILE *f)
+			{
 #ifdef _WIN32
 				auto file_handle = (HANDLE)_get_osfhandle(_fileno(f));
 				if (!::SetHandleInformation(file_handle, HANDLE_FLAG_INHERIT, 0))
 					throw spdlog_ex("SetHandleInformation failed", errno);
 #else
 				auto fd = fileno(f);
-    if(fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)
+				if (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)
 					throw spdlog_ex("fcntl with FD_CLOEXEC failed", errno);
 #endif
-}
+			}
 
 
-//fopen_s on non windows for writing
-inline int fopen_s(FILE** fp, const filename_t& filename, const filename_t& mode)
-{
+			//fopen_s on non windows for writing
+			inline int fopen_s(FILE** fp, const filename_t& filename, const filename_t& mode)
+			{
 #ifdef _WIN32
 #ifdef SPDLOG_WCHAR_FILENAMES
 				*fp = _wfsopen((filename.c_str()), mode.c_str(), _SH_DENYWR);
@@ -171,35 +171,35 @@ inline int fopen_s(FILE** fp, const filename_t& filename, const filename_t& mode
 #endif
 
 #ifdef SPDLOG_PREVENT_CHILD_FD
-    if(*fp != nullptr)
+				if (*fp != nullptr)
 					prevent_child_fd(*fp);
 #endif
 				return *fp == nullptr;
-}
+			}
 
 
-inline int remove(const filename_t &filename)
-{
+			inline int remove(const filename_t &filename)
+			{
 #if defined(_WIN32) && defined(SPDLOG_WCHAR_FILENAMES)
 				return _wremove(filename.c_str());
 #else
 				return std::remove(filename.c_str());
 #endif
-}
+			}
 
-inline int rename(const filename_t& filename1, const filename_t& filename2)
-{
+			inline int rename(const filename_t& filename1, const filename_t& filename2)
+			{
 #if defined(_WIN32) && defined(SPDLOG_WCHAR_FILENAMES)
 				return _wrename(filename1.c_str(), filename2.c_str());
 #else
 				return std::rename(filename1.c_str(), filename2.c_str());
 #endif
-}
+			}
 
 
-//Return if file exists
-inline bool file_exists(const filename_t& filename)
-{
+			//Return if file exists
+			inline bool file_exists(const filename_t& filename)
+			{
 #ifdef _WIN32
 #ifdef SPDLOG_WCHAR_FILENAMES
 				auto attribs = GetFileAttributesW(filename.c_str());
@@ -209,16 +209,16 @@ inline bool file_exists(const filename_t& filename)
 				return (attribs != INVALID_FILE_ATTRIBUTES && !(attribs & FILE_ATTRIBUTE_DIRECTORY));
 #else //common linux/unix all have the stat system call
 				struct stat buffer;
-    return (stat (filename.c_str(), &buffer) == 0);
+				return (stat(filename.c_str(), &buffer) == 0);
 #endif
-}
+			}
 
 
 
 
-//Return file size according to open FILE* object
-inline size_t filesize(FILE *f)
-{
+			//Return file size according to open FILE* object
+			inline size_t filesize(FILE *f)
+			{
 				if (f == nullptr)
 					throw spdlog_ex("Failed getting file size. fd is null");
 #ifdef _WIN32
@@ -248,14 +248,14 @@ inline size_t filesize(FILE *f)
 #endif
 #endif
 				throw spdlog_ex("Failed getting file size from fd", errno);
-}
+			}
 
 
 
 
-//Return utc offset in minutes or throw spdlog_ex on failure
-inline int utc_minutes_offset(const std::tm& tm = details::os::localtime())
-{
+			//Return utc offset in minutes or throw spdlog_ex on failure
+			inline int utc_minutes_offset(const std::tm& tm = details::os::localtime())
+			{
 
 #ifdef _WIN32
 #if _WIN32_WINNT < _WIN32_WINNT_WS08
@@ -313,12 +313,12 @@ inline int utc_minutes_offset(const std::tm& tm = details::os::localtime())
 
 				return static_cast<int>(offset_seconds / 60);
 #endif
-}
+			}
 
-//Return current thread id as size_t
-//It exists because the std::this_thread::get_id() is much slower(espcially under VS 2013)
-inline size_t _thread_id()
-{
+			//Return current thread id as size_t
+			//It exists because the std::this_thread::get_id() is much slower(espcially under VS 2013)
+			inline size_t _thread_id()
+			{
 #ifdef _WIN32
 				return  static_cast<size_t>(::GetCurrentThreadId());
 #elif __linux__
@@ -333,63 +333,61 @@ inline size_t _thread_id()
 #else //Default to standard C++11 (OSX and other Unix)
 				return static_cast<size_t>(std::hash<std::thread::id>()(std::this_thread::get_id()));
 #endif
-}
+			}
 
-//Return current thread id as size_t (from thread local storage)
-inline size_t thread_id()
-{
+			//Return current thread id as size_t (from thread local storage)
+			inline size_t thread_id()
+			{
 #if defined(_MSC_VER) && (_MSC_VER < 1900) || defined(__clang__) && !__has_feature(cxx_thread_local)
 				return _thread_id();
 #else
 				static thread_local const size_t tid = _thread_id();
 				return tid;
 #endif
-}
+			}
 
 
 
 
-// wchar support for windows file names (SPDLOG_WCHAR_FILENAMES must be defined)
+			// wchar support for windows file names (SPDLOG_WCHAR_FILENAMES must be defined)
 #if defined(_WIN32) && defined(SPDLOG_WCHAR_FILENAMES)
 #define SPDLOG_FILENAME_T(s) L ## s
-inline std::string filename_to_str(const filename_t& filename)
-{
+			inline std::string filename_to_str(const filename_t& filename)
+			{
 				std::wstring_convert<std::codecvt_utf8<wchar_t>, wchar_t> c;
 				return c.to_bytes(filename);
-}
+			}
 #else
 #define SPDLOG_FILENAME_T(s) s
-inline std::string filename_to_str(const filename_t& filename)
-{
+			inline std::string filename_to_str(const filename_t& filename)
+			{
 				return filename;
-}
+			}
 #endif
 
-inline std::string errno_to_string(char [256], char* res)
-{
+			inline std::string errno_to_string(char[256], char* res)
+			{
 				return std::string(res);
-}
+			}
 
-inline std::string errno_to_string(char buf[256], int res)
-{
-    if (res == 0)
+			inline std::string errno_to_string(char buf[256], int res)
 			{
+				if (res == 0) {
 					return std::string(buf);
 				}
-    else
-    {
+				else {
 					return "Unknown error";
 				}
-}
+			}
 
-// Return errno string (thread safe)
-inline std::string errno_str(int err_num)
-{
+			// Return errno string (thread safe)
+			inline std::string errno_str(int err_num)
+			{
 				char buf[256];
 				SPDLOG_CONSTEXPR auto buf_size = sizeof(buf);
 
 #ifdef _WIN32
-    if(strerror_s(buf, buf_size, err_num) == 0)
+				if (strerror_s(buf, buf_size, err_num) == 0)
 					return std::string(buf);
 				else
 					return "Unknown error";
@@ -406,10 +404,10 @@ inline std::string errno_str(int err_num)
 				auto err = strerror_r(err_num, buf, buf_size); // let compiler choose type
 				return errno_to_string(buf, err); // use overloading to select correct stringify function
 #endif
-}
+			}
 
-inline int pid()
-{
+			inline int pid()
+			{
 
 #ifdef _WIN32
 				return ::_getpid();
@@ -417,13 +415,13 @@ inline int pid()
 				return static_cast<int>(::getpid());
 #endif
 
-}
+			}
 
 
-// Detrmine if the terminal supports colors
-// Source: https://github.com/agauniyal/rang/
-inline bool is_color_terminal()
-{
+			// Detrmine if the terminal supports colors
+			// Source: https://github.com/agauniyal/rang/
+			inline bool is_color_terminal()
+			{
 #ifdef _WIN32
 				return true;
 #else
@@ -434,21 +432,30 @@ inline bool is_color_terminal()
 				};
 
 				const char *env_p = std::getenv("TERM");
-    if (env_p == nullptr)
-    {
+				if (env_p == nullptr) {
 					return false;
 				}
 
 				static const bool result = std::any_of(
-                                   std::begin(Terms), std::end(Terms), [&](const char* term)
-    {
+					std::begin(Terms), std::end(Terms), [&](const char* term) {
 					return std::strstr(env_p, term) != nullptr;
 				});
 				return result;
 #endif
-}
+			}
+
 
+			// Detrmine if the terminal attached 
+			// Source: https://github.com/agauniyal/rang/
+			bool in_terminal(FILE* file)
+			{
 
-} //os
-} //details
+#ifdef _WIN32
+				return _isatty(_fileno(file)) ? true : false;
+#else
+				return isatty(fileno(file)) ? true : false;
+#endif
+			}
+		} //os
+	} //details
 } //spdlog

include/spdlog/details/spdlog_impl.h

@@ -137,25 +137,25 @@ inline std::shared_ptr<spdlog::logger> spdlog::stderr_color_st(const std::string
 
 inline std::shared_ptr<spdlog::logger> spdlog::stdout_color_mt(const std::string& logger_name)
 {
-    auto sink = std::make_shared<spdlog::sinks::ansicolor_sink>(spdlog::sinks::stdout_sink_mt::instance());
+    auto sink = std::make_shared<spdlog::sinks::ansicolor_stdout_sink_mt>();
     return spdlog::details::registry::instance().create(logger_name, sink);
 }
 
 inline std::shared_ptr<spdlog::logger> spdlog::stdout_color_st(const std::string& logger_name)
 {
-    auto sink = std::make_shared<spdlog::sinks::ansicolor_sink>(spdlog::sinks::stdout_sink_st::instance());
+    auto sink = std::make_shared<spdlog::sinks::ansicolor_stdout_sink_st>();
     return spdlog::details::registry::instance().create(logger_name, sink);
 }
 
 inline std::shared_ptr<spdlog::logger> spdlog::stderr_color_mt(const std::string& logger_name)
 {
-    auto sink = std::make_shared<spdlog::sinks::ansicolor_sink>(spdlog::sinks::stderr_sink_mt::instance());
+	auto sink = std::make_shared<spdlog::sinks::ansicolor_stderr_sink_mt>();
     return spdlog::details::registry::instance().create(logger_name, sink);
 }
 
 inline std::shared_ptr<spdlog::logger> spdlog::stderr_color_st(const std::string& logger_name)
 {
-    auto sink = std::make_shared<spdlog::sinks::ansicolor_sink>(spdlog::sinks::stderr_sink_st::instance());
+	auto sink = std::make_shared<spdlog::sinks::ansicolor_stderr_sink_st>();
     return spdlog::details::registry::instance().create(logger_name, sink);
 }
 #endif

include/spdlog/sinks/ansicolor_sink.h

@@ -10,118 +10,90 @@
 #include <spdlog/details/os.h>
 
 #include <string>
-#include <map>
+#include <unordered_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
-{
-public:
-    ansicolor_sink(sink_ptr wrapped_sink);
-    virtual ~ansicolor_sink();
-
-    ansicolor_sink(const ansicolor_sink& other) = delete;
-    ansicolor_sink& operator=(const ansicolor_sink& other) = delete;
-
-    virtual void log(const details::log_msg& msg) override;
-    virtual void flush() override;
-
-    void set_color(level::level_enum color_level, const std::string& color);
-
-    /// Formatting codes
-    const std::string reset = "\033[00m";
-    const std::string bold = "\033[1m";
-    const std::string dark = "\033[2m";
-    const std::string underline = "\033[4m";
-    const std::string blink = "\033[5m";
-    const std::string reverse = "\033[7m";
-    const std::string concealed = "\033[8m";
-
-    // Foreground colors
-    const std::string grey = "\033[30m";
-    const std::string red = "\033[31m";
-    const std::string green = "\033[32m";
-    const std::string yellow = "\033[33m";
-    const std::string blue = "\033[34m";
-    const std::string magenta = "\033[35m";
-    const std::string cyan = "\033[36m";
-    const std::string white = "\033[37m";
-
-    /// Background colors
-    const std::string on_grey = "\033[40m";
-    const std::string on_red = "\033[41m";
-    const std::string on_green = "\033[42m";
-    const std::string on_yellow = "\033[43m";
-    const std::string on_blue = "\033[44m";
-    const std::string on_magenta = "\033[45m";
-    const std::string on_cyan = "\033[46m";
-    const std::string on_white = "\033[47m";
-
-
-protected:
-    bool is_color_terminal_;
-    sink_ptr sink_;
-    std::map<level::level_enum, std::string> colors_;
-};
+		template <class Mutex>
+		class ansicolor_sink SPDLOG_FINAL: public base_sink<Mutex>
+		{
+		public:
+			ansicolor_sink(FILE* file): _target_file(file)
+			{
+				using namespace ansi_color_codes;
+				should_do_colors_ = details::os::in_terminal(file) && details::os::is_color_terminal();
+				colors_[level::trace] = "\033[36m"; // cyan;
+				colors_[level::debug] = "\033[36m"; // cyan;
+				colors_[level::info] = "\033[1m";// bold;
+				colors_[level::warn] = "\033[33m\033[1m"; // yellow_bold;
+				colors_[level::err] = "\033[31m\033[1m"; // red_bold;
+				colors_[level::critical] = "\033[1m\033[41m"; // bold_red_bg;
+				colors_[level::off] = "\033[00m"; //reset;
+			}
+			virtual ~ansicolor_sink()
+			{
+				flush();
+			}
 
-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;
-    colors_[level::warn] = yellow + bold;
-    colors_[level::err] = red + bold;
-    colors_[level::critical] = bold + on_red;
-    colors_[level::off] = reset;
-}
+			void flush() override
+			{
+				fflush(_target_file);
+			}
 
-inline void ansicolor_sink::log(const details::log_msg& msg)
-{
+		protected:
+			virtual void _sink_it(const details::log_msg& msg) override
+			{
 				// Wrap the originally formatted message in color codes.
 				// If color is not supported in the terminal, log as is instead.
-    if (is_color_terminal_)
+				if (should_do_colors_) 
 				{
 					const std::string& prefix = colors_[msg.level];					
-        const std::string& s = msg.formatted.str();
-        const std::string& suffix = reset;
-        details::log_msg m;
-        m.level = msg.level;
-        m.logger_name = msg.logger_name;
-        m.time = msg.time;
-        m.thread_id = msg.thread_id;
-        m.formatted << prefix << s << suffix;
-        sink_->log(m);
+					const std::string& suffix = ansi_color_codes::reset;					
+					fwrite(prefix, sizeof(char), prefix.size(), _target_file);
+					fwrite(msg.formatted.data(), sizeof(char), msg.formatted.size(), _target_file);
+					fwrite(suffix, sizeof(char), suffix.size(), _target_file);
 				}
 				else
 				{
-        sink_->log(msg);
+					fwrite(msg.formatted.data(), sizeof(char), msg.formatted.size(), _target_file);					
 				}
-}
+			}
+		private:
+			bool should_do_colors_;
+			std::unordered_map<level::level_enum, std::string> colors_;				
+		};
 
-inline void ansicolor_sink::flush()
-{
-    sink_->flush();
-}
 
-inline void ansicolor_sink::set_color(level::level_enum color_level, const std::string& color)
-{
-    colors_[color_level] = color;
-}
+		template<class Mutex>
+		class ansicolor_stdout_sink: public ansicolor_sink<Mutex>
+		{
+		public:
+			ansicolor_stdout_sink(): ansicolor_sink<Mutex>(stdout)
+			{}
+		};
 
-inline ansicolor_sink::~ansicolor_sink()
-{
-    flush();
-}
+		template<class Mutex>
+		class ansicolor_stderr_sink: public ansicolor_sink<Mutex>
+		{
+		public:
+			ansicolor_stderr_sink(): ansicolor_sink<Mutex>(stderr)
+			{}
+		};
+
+		typedef ansicolor_stdout_sink<std::mutex> ansicolor_stdout_sink_mt;
+		typedef ansicolor_stdout_sink<details::null_mutex> ansicolor_stdout_sink_st;
+
+		typedef ansicolor_stderr_sink<std::mutex> ansicolor_stderr_sink_mt;
+		typedef ansicolor_stderr_sink<details::null_mutex> ansicolor_stderr_sink_st;
 
-} // namespace sinks
+	} // namespace sinks
 } // namespace spdlog