From 113ebcfd97264e7956f387b344f7abf9a5cd0377 Mon Sep 17 00:00:00 2001 From: unknown Date: Sat, 2 Apr 2016 22:12:43 -0500 Subject: [PATCH] Add the SPDLOG_USE_WCHAR tweak to enable support for Unicode names on Windows. Refs #111 --- include/spdlog/common.h | 26 +++++++++++++++++ include/spdlog/details/file_helper.h | 22 +++++++-------- include/spdlog/details/os.h | 30 ++++++++++++++++++-- include/spdlog/details/spdlog_impl.h | 17 +++++------ include/spdlog/sinks/file_sinks.h | 42 ++++++++++++++-------------- include/spdlog/spdlog.h | 9 +++--- include/spdlog/tweakme.h | 6 ++++ 7 files changed, 104 insertions(+), 48 deletions(-) diff --git a/include/spdlog/common.h b/include/spdlog/common.h index 819e888d..31d24503 100644 --- a/include/spdlog/common.h +++ b/include/spdlog/common.h @@ -11,6 +11,11 @@ #include #include +#if defined(_WIN32) && defined(SPDLOG_USE_WCHAR) +#include +#include +#endif + //visual studio does not support noexcept yet #ifndef _MSC_VER #define SPDLOG_NOEXCEPT noexcept @@ -95,4 +100,25 @@ private: }; +#if defined(_WIN32) && defined(SPDLOG_USE_WCHAR) + #define SPDLOG_FILENAME_T(s) L ## s + typedef std::wstring filename_str_t; + typedef wchar_t filename_char_t; + + inline std::string filename_to_bytes(const filename_str_t& filename) + { + std::wstring_convert, wchar_t> c; + return c.to_bytes(filename); + } +#else + #define SPDLOG_FILENAME_T(s) s + typedef std::string filename_str_t; + typedef char filename_char_t; + + inline std::string filename_to_bytes(const filename_str_t& filename) + { + return filename; + } +#endif + } //spdlog diff --git a/include/spdlog/details/file_helper.h b/include/spdlog/details/file_helper.h index c08f2830..c2116638 100644 --- a/include/spdlog/details/file_helper.h +++ b/include/spdlog/details/file_helper.h @@ -43,11 +43,11 @@ public: } - void open(const std::string& fname, bool truncate = false) + void open(const filename_str_t& fname, bool truncate = false) { close(); - const char* mode = truncate ? "wb" : "ab"; + const filename_char_t* mode = truncate ? SPDLOG_FILENAME_T("wb") : SPDLOG_FILENAME_T("ab"); _filename = fname; for (int tries = 0; tries < open_tries; ++tries) { @@ -57,7 +57,7 @@ public: std::this_thread::sleep_for(std::chrono::milliseconds(open_interval)); } - throw spdlog_ex("Failed opening file " + fname + " for writing"); + throw spdlog_ex("Failed opening file " + filename_to_bytes(_filename) + " for writing"); } void reopen(bool truncate) @@ -88,7 +88,7 @@ public: size_t msg_size = msg.formatted.size(); auto data = msg.formatted.data(); if (std::fwrite(data, 1, msg_size, _fd) != msg_size) - throw spdlog_ex("Failed writing to file " + _filename); + throw spdlog_ex("Failed writing to file " + filename_to_bytes(_filename)); if (_force_flush) std::fflush(_fd); @@ -98,19 +98,19 @@ public: long size() { if (!_fd) - throw spdlog_ex("Cannot use size() on closed file " + _filename); + throw spdlog_ex("Cannot use size() on closed file " + filename_to_bytes(_filename)); auto pos = ftell(_fd); if (fseek(_fd, 0, SEEK_END) != 0) - throw spdlog_ex("fseek failed on file " + _filename); + throw spdlog_ex("fseek failed on file " + filename_to_bytes(_filename)); auto file_size = ftell(_fd); if(fseek(_fd, pos, SEEK_SET) !=0) - throw spdlog_ex("fseek failed on file " + _filename); + throw spdlog_ex("fseek failed on file " + filename_to_bytes(_filename)); if (file_size == -1) - throw spdlog_ex("ftell failed on file " + _filename); + throw spdlog_ex("ftell failed on file " + filename_to_bytes(_filename)); return file_size; @@ -118,12 +118,12 @@ public: } - const std::string& filename() const + const filename_str_t& filename() const { return _filename; } - static bool file_exists(const std::string& name) + static bool file_exists(const filename_str_t& name) { return os::file_exists(name); @@ -133,7 +133,7 @@ public: private: FILE* _fd; - std::string _filename; + filename_str_t _filename; bool _force_flush; diff --git a/include/spdlog/details/os.h b/include/spdlog/details/os.h index aedc4942..6d55e572 100644 --- a/include/spdlog/details/os.h +++ b/include/spdlog/details/os.h @@ -137,24 +137,49 @@ constexpr inline unsigned short eol_size() #endif //fopen_s on non windows for writing -inline int fopen_s(FILE** fp, const std::string& filename, const char* mode) +inline int fopen_s(FILE** fp, const filename_str_t& filename, const filename_char_t* mode) { #ifdef _WIN32 +#ifdef SPDLOG_USE_WCHAR + *fp = _wfsopen((filename.c_str()), mode, _SH_DENYWR); +#else *fp = _fsopen((filename.c_str()), mode, _SH_DENYWR); +#endif return *fp == nullptr; #else *fp = fopen((filename.c_str()), mode); return *fp == nullptr; #endif +} +inline int remove(const filename_char_t* filename) +{ +#if defined(_WIN32) && defined(SPDLOG_USE_WCHAR) + return _wremove(filename); +#else + return std::remove(filename); +#endif +} + +inline int rename(const filename_char_t* filename1, const filename_char_t* filename2) +{ +#if defined(_WIN32) && defined(SPDLOG_USE_WCHAR) + return _wrename(filename1, filename2); +#else + return std::rename(filename1, filename2); +#endif } //Return if file exists -inline bool file_exists(const std::string& filename) +inline bool file_exists(const filename_str_t& filename) { #ifdef _WIN32 +#ifdef SPDLOG_USE_WCHAR + auto attribs = GetFileAttributesW(filename.c_str()); +#else auto attribs = GetFileAttributesA(filename.c_str()); +#endif return (attribs != INVALID_FILE_ATTRIBUTES && !(attribs & FILE_ATTRIBUTE_DIRECTORY)); #elif __linux__ struct stat buffer; @@ -169,7 +194,6 @@ inline bool file_exists(const std::string& filename) return false; #endif - } //Return utc offset in minutes or throw spdlog_ex on failure diff --git a/include/spdlog/details/spdlog_impl.h b/include/spdlog/details/spdlog_impl.h index 61c3a217..1a3964cb 100644 --- a/include/spdlog/details/spdlog_impl.h +++ b/include/spdlog/details/spdlog_impl.h @@ -36,24 +36,25 @@ inline void spdlog::drop(const std::string &name) } // Create multi/single threaded rotating file logger -inline std::shared_ptr spdlog::rotating_logger_mt(const std::string& logger_name, const std::string& filename, size_t max_file_size, size_t max_files, bool force_flush) +inline std::shared_ptr spdlog::rotating_logger_mt(const std::string& logger_name, const filename_str_t& filename, size_t max_file_size, size_t max_files, bool force_flush) { - return create(logger_name, filename, "txt", max_file_size, max_files, force_flush); + return create(logger_name, filename, SPDLOG_FILENAME_T("txt"), max_file_size, max_files, force_flush); } -inline std::shared_ptr spdlog::rotating_logger_st(const std::string& logger_name, const std::string& filename, size_t max_file_size, size_t max_files, bool force_flush) +inline std::shared_ptr spdlog::rotating_logger_st(const std::string& logger_name, const filename_str_t& filename, size_t max_file_size, size_t max_files, bool force_flush) { - return create(logger_name, filename, "txt", max_file_size, max_files, force_flush); + return create(logger_name, filename, SPDLOG_FILENAME_T("txt"), max_file_size, max_files, force_flush); } // Create file logger which creates new file at midnight): -inline std::shared_ptr spdlog::daily_logger_mt(const std::string& logger_name, const std::string& filename, int hour, int minute, bool force_flush) +inline std::shared_ptr spdlog::daily_logger_mt(const std::string& logger_name, const filename_str_t& filename, int hour, int minute, bool force_flush) { - return create(logger_name, filename, "txt", hour, minute, force_flush); + return create(logger_name, filename, SPDLOG_FILENAME_T("txt"), hour, minute, force_flush); } -inline std::shared_ptr spdlog::daily_logger_st(const std::string& logger_name, const std::string& filename, int hour, int minute, bool force_flush) + +inline std::shared_ptr spdlog::daily_logger_st(const std::string& logger_name, const filename_str_t& filename, int hour, int minute, bool force_flush) { - return create(logger_name, filename, "txt", hour, minute, force_flush); + return create(logger_name, filename, SPDLOG_FILENAME_T("txt"), hour, minute, force_flush); } // Create stdout/stderr loggers (with optinal color support) diff --git a/include/spdlog/sinks/file_sinks.h b/include/spdlog/sinks/file_sinks.h index d5932951..a212e1a3 100644 --- a/include/spdlog/sinks/file_sinks.h +++ b/include/spdlog/sinks/file_sinks.h @@ -28,7 +28,7 @@ template class simple_file_sink : public base_sink < Mutex > { public: - explicit simple_file_sink(const std::string &filename, + explicit simple_file_sink(const filename_str_t &filename, bool force_flush = false) : _file_helper(force_flush) { @@ -58,7 +58,7 @@ template class rotating_file_sink : public base_sink < Mutex > { public: - rotating_file_sink(const std::string &base_filename, const std::string &extension, + rotating_file_sink(const filename_str_t &base_filename, const filename_str_t &extension, std::size_t max_size, std::size_t max_files, bool force_flush = false) : _base_filename(base_filename), @@ -90,13 +90,13 @@ protected: } private: - static std::string calc_filename(const std::string& filename, std::size_t index, const std::string& extension) + static filename_str_t calc_filename(const filename_str_t& filename, std::size_t index, const filename_str_t& extension) { - fmt::MemoryWriter w; + std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; if (index) - w.write("{}.{}.{}", filename, index, extension); + w.write(SPDLOG_FILENAME_T("{}.{}.{}"), filename, index, extension); else - w.write("{}.{}", filename, extension); + w.write(SPDLOG_FILENAME_T("{}.{}"), filename, extension); return w.str(); } @@ -111,25 +111,25 @@ private: _file_helper.close(); for (auto i = _max_files; i > 0; --i) { - std::string src = calc_filename(_base_filename, i - 1, _extension); - std::string target = calc_filename(_base_filename, i, _extension); + filename_str_t src = calc_filename(_base_filename, i - 1, _extension); + filename_str_t target = calc_filename(_base_filename, i, _extension); if (details::file_helper::file_exists(target)) { - if (std::remove(target.c_str()) != 0) + if (details::os::remove(target.c_str()) != 0) { - throw spdlog_ex("rotating_file_sink: failed removing " + target); + throw spdlog_ex("rotating_file_sink: failed removing " + filename_to_bytes(target)); } } - if (details::file_helper::file_exists(src) && std::rename(src.c_str(), target.c_str())) + if (details::file_helper::file_exists(src) && details::os::rename(src.c_str(), target.c_str())) { - throw spdlog_ex("rotating_file_sink: failed renaming " + src + " to " + target); + throw spdlog_ex("rotating_file_sink: failed renaming " + filename_to_bytes(src) + " to " + filename_to_bytes(target)); } } _file_helper.reopen(true); } - std::string _base_filename; - std::string _extension; + filename_str_t _base_filename; + filename_str_t _extension; std::size_t _max_size; std::size_t _max_files; std::size_t _current_size; @@ -148,8 +148,8 @@ class daily_file_sink :public base_sink < Mutex > public: //create daily file sink which rotates on given time daily_file_sink( - const std::string& base_filename, - const std::string& extension, + const filename_str_t& base_filename, + const filename_str_t& extension, int rotation_hour, int rotation_minute, bool force_flush = false) : _base_filename(base_filename), @@ -198,16 +198,16 @@ private: } //Create filename for the form basename.YYYY-MM-DD.extension - static std::string calc_filename(const std::string& basename, const std::string& extension) + static filename_str_t calc_filename(const filename_str_t& basename, const filename_str_t& extension) { std::tm tm = spdlog::details::os::localtime(); - fmt::MemoryWriter w; - w.write("{}_{:04d}-{:02d}-{:02d}_{:02d}-{:02d}.{}", basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, extension); + std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; + w.write(SPDLOG_FILENAME_T("{}_{:04d}-{:02d}-{:02d}_{:02d}-{:02d}.{}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, extension); return w.str(); } - std::string _base_filename; - std::string _extension; + filename_str_t _base_filename; + filename_str_t _extension; int _rotation_h; int _rotation_m; std::chrono::system_clock::time_point _rotation_tp; diff --git a/include/spdlog/spdlog.h b/include/spdlog/spdlog.h index 59314785..b66b1a90 100644 --- a/include/spdlog/spdlog.h +++ b/include/spdlog/spdlog.h @@ -61,15 +61,14 @@ void set_sync_mode(); // // Create and register multi/single threaded rotating file logger // -std::shared_ptr rotating_logger_mt(const std::string& logger_name, const std::string& filenameB, size_t max_file_size, size_t max_files, bool force_flush = false); -std::shared_ptr rotating_logger_st(const std::string& logger_name, const std::string& filename, size_t max_file_size, size_t max_files, bool force_flush = false); +std::shared_ptr rotating_logger_mt(const std::string& logger_name, const filename_str_t& filename, size_t max_file_size, size_t max_files, bool force_flush = false); +std::shared_ptr rotating_logger_st(const std::string& logger_name, const filename_str_t& filename, size_t max_file_size, size_t max_files, bool force_flush = false); // // Create file logger which creates new file on the given time (default in midnight): // -std::shared_ptr daily_logger_mt(const std::string& logger_name, const std::string& filename, int hour=0, int minute=0, bool force_flush = false); -std::shared_ptr daily_logger_st(const std::string& logger_name, const std::string& filename, int hour=0, int minute=0, bool force_flush = false); - +std::shared_ptr daily_logger_mt(const std::string& logger_name, const filename_str_t& filename, int hour=0, int minute=0, bool force_flush = false); +std::shared_ptr daily_logger_st(const std::string& logger_name, const filename_str_t& filename, int hour=0, int minute=0, bool force_flush = false); // // Create and register stdout/stderr loggers diff --git a/include/spdlog/tweakme.h b/include/spdlog/tweakme.h index f1365147..9e68012f 100644 --- a/include/spdlog/tweakme.h +++ b/include/spdlog/tweakme.h @@ -51,3 +51,9 @@ // Note that upon creating a logger the registry is modified by spdlog.. // #define SPDLOG_NO_REGISTRY_MUTEX /////////////////////////////////////////////////////////////////////////////// + + +/////////////////////////////////////////////////////////////////////////////// +// Uncomment to enable usage of wchar_t for file names on Windows. +// #define SPDLOG_USE_WCHAR +///////////////////////////////////////////////////////////////////////////////