/* * Created by Brett on 20/07/23. * Licensed under GNU General Public License V3.0 * See LICENSE file for license detail */ #ifndef BLT_TESTS_LOGGING2_H #define BLT_TESTS_LOGGING2_H #include #include #include #include namespace blt::logging { template using hashmap = std::unordered_map; enum class log_level { // default NONE, // low level TRACE0, TRACE1, TRACE2, TRACE3, // normal TRACE, DEBUG, INFO, // errors WARN, ERROR, FATAL, }; struct tag_func_param { blt::logging::log_level level; const std::string& file, line, raw_string, formatted_string; }; struct tag { // tag without the ${{ or }} std::string tag; // function to run: log level, file, line, and raw user input string are provided std::function func; }; struct log_format { /** * the log output format is the string which will be used to create the log output string * * Available tags: * - ${{YEAR}} // current year * - ${{MONTH}} // current month * - ${{DAY}} // current day * - ${{HOUR}} // current hour * - ${{MINUTE}} // current minute * - ${{SECOND}} // current second * - ${{MS}} // current unix time * - ${{NS}} // current ns from the high resolution system timer * - ${{ISO_YEAR}} // ISO formatted 'year-month-day' in a single variable * - ${{TIME}} // 'hour:minute:second' formatted string in a single variable * - ${{FULL_TIME}} // 'year-month-day hour:minute:second' in a single variable * - ${{LF}} // log level color (ANSI color code) * - ${{ER}} // Error red * - ${{CNR}} // conditional error red (only outputs if log level is an error!) * - ${{RC}} // ANSI color reset * - ${{LOG_LEVEL}} // current log level * - ${{THREAD_NAME}} // current thread name, NOTE: thread names must be set by calling "setThreadName()" from the thread in question! * - ${{FILE}} // file from which the macro is invoked * - ${{LINE}} // line in the from which the macro is invoked * - ${{RAW_STR}} // raw user string without formatting applied (NOTE: format args are not provided!) * - ${{STR}} // the user supplied string (format applied!) */ std::string logOutputFormat = "\033[94m[${{TIME}}]${{RC}} ${{LF}}[${{LOG_LEVEL}}]${{RC}} \033[35m(${{FILE}}:${{LINE}})${{RC}} ${{CNR}}${{STR}}${{RC}}\n"; std::string levelNames[11] = {"STDOUT", "TRACE0", "TRACE1", "TRACE2", "TRACE3", "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"}; std::string levelColors[11] = {"\033[0m", "\033[22;97m", "\033[97m", "\033[97m", "\033[97m", "\033[97m", "\033[36m", "\033[92m", "\033[93m", "\033[91m", "\033[97;41m"}; // if true prints the whole path to the file (eg /home/user/.../.../project/src/source.cpp:line#) bool printFullFileName = false; // the logging lib will keep track of the largest line found so far and try to keep the spacing accordingly // this is not thread safe! bool ensureAlignment = false; // should we log to file? bool logToFile = false; // should we log to console? bool logToConsole = true; // where should we log? (empty for current binary directory) should end in a / if not empty! std::string logFilePath; // logs to a file called $fileName_$count.log where count is the number of rollover files // this accepts any of the macros above, using level names and colors should work but isn't supported. std::string logFileName = "${{ISO_YEAR}}"; // default limit on file size: 10mb; size_t logMaxFileSize = 1024 * 1024 * 10; /** * Variables below this line should never be changed by the user! */ // the current alignment width found (you shouldn't chance this variable!) size_t currentWidth = 0; // current number of file roll-overs. you shouldn't change this either. size_t currentRollover = 0; std::string lastFile; }; struct logger { log_level level; const char* file; int line; }; struct empty_logger { }; void log(const std::string& format, log_level level, const char* file, int line, ...); void log_stream(const std::string& str, const logger& logger); template::value>::type* = nullptr> inline void log(T t, log_level level, const char* file, int line) { log(std::to_string(t), level, file, line); } template::value>::type* = nullptr> inline void log_stream(T t, const logger& logger) { log_stream(std::to_string(t), logger); } static inline const blt::logging::logger& operator<<(const blt::logging::logger& out, const std::string& str) { log_stream(str, out); return out; } template::value>::type* = nullptr> static inline const blt::logging::logger& operator<<(const blt::logging::logger& out, T t) { log_stream(std::to_string(t), out); return out; } static inline const blt::logging::empty_logger& operator<<(const blt::logging::empty_logger& out, const std::string&) { return out; } template::value>::type* = nullptr> static inline const blt::logging::empty_logger& operator<<(const blt::logging::empty_logger& out, T) { return out; } void flush(); void setThreadName(const std::string& name); void setLogFormat(const log_format& format); void setLogColor(log_level level, const std::string& newFormat); void setLogName(log_level level, const std::string& newFormat); void setLogOutputFormat(const std::string& newFormat); void setLogToFile(bool shouldLogToFile); void setLogToConsole(bool shouldLogToConsole); void setLogPath(const std::string& path); void setLogFileName(const std::string& fileName); void setMaxFileSize(size_t fileSize); } //#define BLT_LOGGING_IMPLEMENTATION #ifdef BLT_LOGGING_IMPLEMENTATION #include #include #include #include #include #include #include #include #include #include namespace blt::logging { /** * Used to store fast associations between built in tags and their respective values */ class tag_map { private: tag* tags; size_t size; [[nodiscard]] static inline size_t hash(const tag& t) { size_t h = t.tag[1] * 3 - t.tag[0]; return h - 100; } // TODO: fix void expand() { auto newSize = size * 2; auto newTags = new tag[newSize]; for (size_t i = 0; i < size; i++) newTags[i] = tags[i]; delete[] tags; tags = newTags; size = newSize; } public: tag_map(std::initializer_list initial_tags){ size_t max = 0; for (const auto& t : initial_tags) max = std::max(max, hash(t)); tags = new tag[(size = max+1)]; for (const auto& t : initial_tags) insert(t); } tag_map(const tag_map& copy) { tags = new tag[(size = copy.size)]; for (size_t i = 0; i < size; i++) tags[i] = copy.tags[i]; } void insert(const tag& t) { auto h = hash(t); //if (h > size) // expand(); if (!tags[h].tag.empty()) std::cerr << "Tag not empty! " << tags[h].tag << "!!!\n"; tags[h] = t; } tag& operator[](const std::string& name) const { auto h = hash(tag{name, nullptr}); if (h > size) std::cerr << "Tag out of bounds"; return tags[h]; } ~tag_map(){ delete[] tags; tags = nullptr; } }; class LogFileWriter { private: std::string m_path; std::fstream* output = nullptr; public: explicit LogFileWriter() = default; void writeLine(const std::string& path, const std::string& line){ if (path != m_path || output == nullptr){ clear(); delete output; output = new std::fstream(path, std::ios::out | std::ios::app); if (!output->good()){ throw std::runtime_error("Unable to open console filestream!\n"); } } if (!output->good()){ std::cerr << "There has been an error in the logging file stream!\n"; output->clear(); } *output << line; } void clear(){ if (output != nullptr) { try { output->flush(); output->close(); } catch (std::exception& e){ std::cerr << e.what() << "\n"; } } } ~LogFileWriter() { clear(); delete(output); } }; #define BLT_NOW() auto t = std::time(nullptr); auto now = std::localtime(&t) #define BLT_ISO_YEAR(S) auto S = std::to_string(now->tm_year + 1900); \ S += '-'; \ S += ensureHasDigits(now->tm_mon+1, 2); \ S += '-'; \ S += ensureHasDigits(now->tm_mday, 2); #define BLT_CUR_TIME(S) auto S = ensureHasDigits(now->tm_hour, 2); \ S += ':'; \ S += ensureHasDigits(now->tm_min, 2); \ S += ':'; \ S += ensureHasDigits(now->tm_sec, 2); static inline std::string ensureHasDigits(int current, int digits) { std::string asString = std::to_string(current); auto length = digits - asString.length(); if (length <= 0) return asString; std::string zeros; zeros.reserve(length); for (unsigned int i = 0; i < length; i++){ zeros += '0'; } return zeros + asString; } log_format loggingFormat {}; hashmap loggingThreadNames; hashmap> loggingStreamLines; LogFileWriter writer; const std::unique_ptr tagMap = std::make_unique(tag_map{ {"YEAR", [](const tag_func_param&) -> std::string { BLT_NOW(); return std::to_string(now->tm_year); }}, {"MONTH", [](const tag_func_param&) -> std::string { BLT_NOW(); return ensureHasDigits(now->tm_mon+1, 2); }}, {"DAY", [](const tag_func_param&) -> std::string { BLT_NOW(); return ensureHasDigits(now->tm_mday, 2); }}, {"HOUR", [](const tag_func_param&) -> std::string { BLT_NOW(); return ensureHasDigits(now->tm_hour, 2); }}, {"MINUTE", [](const tag_func_param&) -> std::string { BLT_NOW(); return ensureHasDigits(now->tm_min, 2); }}, {"SECOND", [](const tag_func_param&) -> std::string { BLT_NOW(); return ensureHasDigits(now->tm_sec, 2); }}, {"MS", [](const tag_func_param&) -> std::string { return std::to_string(std::chrono::duration_cast( std::chrono::high_resolution_clock::now().time_since_epoch()).count() ); }}, {"NS", [](const tag_func_param&) -> std::string { return std::to_string(std::chrono::duration_cast( std::chrono::high_resolution_clock::now().time_since_epoch()).count() ); }}, {"ISO_YEAR", [](const tag_func_param&) -> std::string { BLT_NOW(); BLT_ISO_YEAR(returnStr); return returnStr; }}, {"TIME", [](const tag_func_param&) -> std::string { BLT_NOW(); BLT_CUR_TIME(returnStr); return returnStr; }}, {"FULL_TIME", [](const tag_func_param&) -> std::string { BLT_NOW(); BLT_ISO_YEAR(ISO); BLT_CUR_TIME(TIME); ISO += ' '; ISO += TIME; return ISO; }}, {"LF", [](const tag_func_param& f) -> std::string { return loggingFormat.levelColors[(int)f.level]; }}, {"ER", [](const tag_func_param&) -> std::string { return loggingFormat.levelColors[(int)log_level::ERROR]; }}, {"CNR", [](const tag_func_param& f) -> std::string { return f.level >= log_level::ERROR ? loggingFormat.levelColors[(int)log_level::ERROR] : ""; }}, {"RC", [](const tag_func_param&) -> std::string { return "\033[0m"; }}, {"LOG_LEVEL", [](const tag_func_param& f) -> std::string { return loggingFormat.levelNames[(int)f.level]; }}, {"THREAD_NAME", [](const tag_func_param&) -> std::string { if (loggingThreadNames.find(std::this_thread::get_id()) == loggingThreadNames.end()) return "UNKNOWN"; return loggingThreadNames[std::this_thread::get_id()]; }}, {"FILE", [](const tag_func_param& f) -> std::string { return f.file; }}, {"LINE", [](const tag_func_param& f) -> std::string { return f.line; }}, {"RAW_STR", [](const tag_func_param& f) -> std::string { return f.raw_string; }}, {"STR", [](const tag_func_param& f) -> std::string { return f.formatted_string; }} }); static inline std::vector split(std::string s, const std::string& delim) { size_t pos = 0; std::vector tokens; while ((pos = s.find(delim)) != std::string::npos) { auto token = s.substr(0, pos); tokens.push_back(token); s.erase(0, pos + delim.length()); } tokens.push_back(s); return tokens; } inline std::string filename(const std::string& path){ if (loggingFormat.printFullFileName) return path; auto paths = split(path, "/"); auto final = paths[paths.size()-1]; if (final == "/") return paths[paths.size()-2]; return final; } class string_parser { private: std::string _str; size_t _pos; public: explicit string_parser(std::string str): _str(std::move(str)), _pos(0) {} inline char next(){ return _str[_pos++]; } [[nodiscard]] inline bool has_next() const { return _pos < _str.size(); } }; std::string stripANSI(const std::string& str){ string_parser parser(str); std::string out; while (parser.has_next()){ char c = parser.next(); if (c == '\033'){ while (parser.has_next() && parser.next() != 'm'); } else out += c; } return out; } void applyCFormatting(const std::string& format, std::string& output, va_list& args){ // args must be copied because they will be consumed by the first vsnprintf va_list args_copy; va_copy(args_copy, args); auto buffer_size = std::vsnprintf(nullptr, 0, format.c_str(), args_copy) + 1; auto* buffer = new char[static_cast(buffer_size)]; vsnprintf(buffer, buffer_size, format.c_str(), args); output = std::string(buffer); delete[] buffer; va_end(args_copy); } /** * Checks if the next character in the parser is a tag opening, if not output the chars to the out string */ inline bool tagOpening(string_parser& parser, std::string& out){ char c = ' '; if (parser.has_next() && (c = parser.next()) == '{') if (parser.has_next() && (c = parser.next()) == '{') return true; else out += c; else out += c; return false; } void parseString(string_parser& parser, std::string& out, const std::string& userStr, log_level level, const char* file, int line){ while (parser.has_next()){ char c = parser.next(); std::string nonTag; if (c == '$' && tagOpening(parser, nonTag)){ std::string tag; while (parser.has_next()){ c = parser.next(); if (c == '}') break; tag += c; } c = parser.next(); if (parser.has_next() && c != '}') { std::cerr << "Error processing tag, is not closed with two '}'!\n"; break; } if (loggingFormat.ensureAlignment && tag == "STR") { auto currentOutputWidth = out.size(); auto& longestWidth = loggingFormat.currentWidth; longestWidth = std::max(longestWidth, currentOutputWidth); // pad with spaces if (currentOutputWidth != longestWidth){ for (size_t i = currentOutputWidth; i < longestWidth; i++) out += ' '; } } tag_func_param param{ level, filename({file}), std::to_string(line), userStr, userStr }; out += (*tagMap)[tag].func(param); } else { out += c; out += nonTag; } } } std::string applyFormatString(const std::string& str, log_level level, const char* file, int line){ // this can be speedup by preprocessing the string into an easily callable class // where all the variables are ready to be substituted in one step // and all static information already entered string_parser parser(loggingFormat.logOutputFormat); std::string out; parseString(parser, out, str, level, file, line); return out; } void log(const std::string& format, log_level level, const char* file, int line, ...) { va_list args; va_start(args, line); std::string withoutLn = format; auto len = withoutLn.length(); if (len > 0 && withoutLn[len - 1] == '\n') withoutLn = withoutLn.substr(0, len-1); std::string out; applyCFormatting(withoutLn, out, args); if (level == log_level::NONE){ std::cout << out << std::endl; return; } std::string finalFormattedOutput = applyFormatString(out, level, file, line); if (loggingFormat.logToConsole) std::cout << finalFormattedOutput; if (loggingFormat.logToFile){ string_parser parser(loggingFormat.logFileName); std::string fileName; parseString(parser, fileName, withoutLn, level, file, line); auto path = loggingFormat.logFilePath; if (!path.empty() && path[path.length()-1] != '/') path += '/'; // if the file has changed (new day in default case) we should reset the rollover count if (loggingFormat.lastFile != fileName){ loggingFormat.currentRollover = 0; loggingFormat.lastFile = fileName; } path += fileName; path += '-'; path += std::to_string(loggingFormat.currentRollover); path += ".log"; if (std::filesystem::exists(path)) { auto fileSize = std::filesystem::file_size(path); // will start on next file if (fileSize > loggingFormat.logMaxFileSize) loggingFormat.currentRollover++; } writer.writeLine(path, stripANSI(finalFormattedOutput)); } //std::cout.flush(); va_end(args); } void log_stream(const std::string& str, const logger& logger) { auto& s = loggingStreamLines[std::this_thread::get_id()][logger.level]; s += str; for (char c : str){ if (c == '\n'){ log(s, logger.level, logger.file, logger.line); s = ""; } } } void setThreadName(const std::string& name) { loggingThreadNames[std::this_thread::get_id()] = name; } void setLogFormat(const log_format& format){ loggingFormat = format; } void setLogColor(log_level level, const std::string& newFormat){ loggingFormat.levelColors[(int)level] = newFormat; } void setLogName(log_level level, const std::string& newFormat){ loggingFormat.levelNames[(int)level] = newFormat; } void setLogOutputFormat(const std::string& newFormat){ loggingFormat.logOutputFormat = newFormat; } void setLogToFile(bool shouldLogToFile){ loggingFormat.logToFile = shouldLogToFile; } void setLogToConsole(bool shouldLogToConsole){ loggingFormat.logToConsole = shouldLogToConsole; } void setLogPath(const std::string& path){ loggingFormat.logFilePath = path; } void setLogFileName(const std::string& fileName){ loggingFormat.logFileName = fileName; } void setMaxFileSize(size_t fileSize) { loggingFormat.logMaxFileSize = fileSize; } void flush() { std::cerr.flush(); std::cout.flush(); } } #endif #ifdef BLT_DISABLE_LOGGING #define BLT_LOG(format, level, ...) #define BLT_LOG_STREAM(level) #define BLT_TRACE0_STREAM #define BLT_TRACE1_STREAM #define BLT_TRACE2_STREAM #define BLT_TRACE3_STREAM #define BLT_TRACE_STREAM #define BLT_DEBUG_STREAM #define BLT_INFO_STREAM #define BLT_WARN_STREAM #define BLT_ERROR_STREAM #define BLT_FATAL_STREAM #define BLT_TRACE(format, ...) #define BLT_DEBUG(format, ...) #define BLT_INFO(format, ...) #define BLT_WARN(format, ...) #define BLT_ERROR(format, ...) #define BLT_FATAL(format, ...) #else #define BLT_LOG(format, level, ...) blt::logging::log(format, level, __FILE__, __LINE__, ##__VA_ARGS__) #define BLT_LOG_STREAM(level) blt::logging::logger{level, __FILE__, __LINE__} #ifdef BLT_DISABLE_TRACE #define BLT_TRACE(format, ...) #define BLT_TRACE0_STREAM blt::logging::empty_logger{} #define BLT_TRACE1_STREAM blt::logging::empty_logger{} #define BLT_TRACE2_STREAM blt::logging::empty_logger{} #define BLT_TRACE3_STREAM blt::logging::empty_logger{} #define BLT_TRACE_STREAM blt::logging::empty_logger{} #else #define BLT_TRACE(format, ...) BLT_LOG(format, blt::logging::log_level::TRACE, ##__VA_ARGS__) #define BLT_TRACE0_STREAM BLT_LOG_STREAM(blt::logging::log_level::TRACE0) #define BLT_TRACE1_STREAM BLT_LOG_STREAM(blt::logging::log_level::TRACE1) #define BLT_TRACE2_STREAM BLT_LOG_STREAM(blt::logging::log_level::TRACE2) #define BLT_TRACE3_STREAM BLT_LOG_STREAM(blt::logging::log_level::TRACE3) #define BLT_TRACE_STREAM BLT_LOG_STREAM(blt::logging::log_level::TRACE) #endif #ifdef BLT_DISABLE_DEBUG #define BLT_DEBUG(format, ...) #define BLT_DEBUG_STREAM blt::logging::empty_logger{} #else #define BLT_DEBUG(format, ...) BLT_LOG(format, blt::logging::log_level::DEBUG, ##__VA_ARGS__) #define BLT_DEBUG_STREAM BLT_LOG_STREAM(blt::logging::log_level::DEBUG) #endif #ifdef BLT_DISABLE_INFO #define BLT_INFO(format, ...) #define BLT_INFO_STREAM blt::logging::empty_logger{} #else #define BLT_INFO(format, ...) BLT_LOG(format, blt::logging::log_level::INFO, ##__VA_ARGS__) #define BLT_INFO_STREAM BLT_LOG_STREAM(blt::logging::log_level::INFO) #endif #ifdef BLT_DISABLE_WARN #define BLT_WARN(format, ...) #define BLT_WARN_STREAM blt::logging::empty_logger{} #else #define BLT_WARN(format, ...) BLT_LOG(format, blt::logging::log_level::WARN, ##__VA_ARGS__) #define BLT_WARN_STREAM BLT_LOG_STREAM(blt::logging::log_level::WARN) #endif #ifdef BLT_DISABLE_ERROR #define BLT_ERROR(format, ...) #define BLT_ERROR_STREAM blt::logging::empty_logger{} #else #define BLT_ERROR(format, ...) BLT_LOG(format, blt::logging::log_level::ERROR, ##__VA_ARGS__) #define BLT_ERROR_STREAM BLT_LOG_STREAM(blt::logging::log_level::ERROR) #endif #ifdef BLT_DISABLE_FATAL #define BLT_FATAL(format, ...) #define BLT_FATAL_STREAM blt::logging::empty_logger{} #else #define BLT_FATAL(format, ...) BLT_LOG(format, blt::logging::log_level::FATAL, ##__VA_ARGS__) #define BLT_FATAL_STREAM BLT_LOG_STREAM(blt::logging::log_level::FATAL) #endif #endif #endif //BLT_TESTS_LOGGING2_H