log.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* logtools                                                                                                             *
*                                                                                                                      *
* Copyright (c) 2016-2025 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef log_h
#define log_h
 
#include <memory>
#include <string>
#include <vector>
#include <set>
#include <mutex>
 
#if defined(__MINGW32__)
#undef ERROR
#endif
 
#if defined(_MSC_VER)
// MSVC
#include <thread>
#undef ERROR
#define __thread __declspec(thread)
#endif
 
enum class Severity
{
    FATAL   = 1,
 
    ERROR   = 2,
 
    WARNING = 3,
 
    NOTICE  = 4,
 
    VERBOSE = 5,
 
    DEBUG = 6,
 
    TRACE = 7
};
 
extern __thread unsigned int g_logIndentLevel;
 
class LogSink
{
public:
    LogSink(Severity min_severity = Severity::VERBOSE)
    : m_indentSize(4)
    , m_termWidth(120)  //default if not using ioctls to check
    , m_lastMessageWasNewline(true)
    , m_min_severity(min_severity)
    {}
 
    virtual ~LogSink() {}
 
    Severity GetSeverity()
    { return m_min_severity; }
 
    void SetSeverity(Severity sev)
    { m_min_severity = sev; }
 
    std::string GetIndentString();
 
    virtual void Log(Severity severity, const std::string &msg) = 0;
    virtual void Log(Severity severity, const char *format, va_list va) = 0;
 
    std::string vstrprintf(const char* format, va_list va);
 
protected:
 
    std::string WrapString(std::string str);
    virtual void PreprocessLine(std::string& line);
 
    unsigned int m_indentSize;
 
    unsigned int m_termWidth;
 
    bool m_lastMessageWasNewline;
 
    Severity m_min_severity;
};
 
class STDLogSink : public LogSink
{
public:
    STDLogSink(Severity min_severity = Severity::VERBOSE);
    ~STDLogSink() override;
 
    void Log(Severity severity, const std::string &msg) override;
    void Log(Severity severity, const char *format, va_list va) override;
 
protected:
    void Flush();
};
 
class ColoredSTDLogSink : public STDLogSink
{
public:
    ColoredSTDLogSink(Severity min_severity = Severity::VERBOSE);
    ~ColoredSTDLogSink() override;
 
protected:
    void PreprocessLine(std::string& line) override;
    std::string replace(
        const std::string& search,
        const std::string& before,
        const std::string& after,
        std::string subject);
};
 
class FILELogSink : public LogSink
{
public:
    FILELogSink(FILE *f, bool line_buffered = false, Severity min_severity = Severity::VERBOSE);
    ~FILELogSink() override;
 
    void Log(Severity severity, const std::string &msg) override;
    void Log(Severity severity, const char *format, va_list va) override;
 
protected:
    FILE        *m_file;
};
 
extern std::mutex g_log_mutex;
extern std::vector<std::unique_ptr<LogSink>> g_log_sinks;
extern std::set<std::string> g_trace_filters;
 
class LogIndenter
{
public:
    LogIndenter();
 
    ~LogIndenter();
};
 
bool ParseLoggerArguments(
    int& i,
    int argc,
    char* argv[],
    Severity& console_verbosity);
 
 
#ifdef __GNUC__
#if defined(__MINGW32__) && !defined(__clang__)
#define ATTR_FORMAT(n, m) __attribute__((__format__ (gnu_printf, n, m)))
#else
#define ATTR_FORMAT(n, m) __attribute__((__format__ (__printf__, n, m)))
#endif
#define ATTR_NORETURN     __attribute__((noreturn))
#else
//FIXME on MSVC/Windows
#define ATTR_FORMAT(n, m)
#define ATTR_NORETURN
#endif
 
#ifdef __GNUC__
#define LogTrace(...) LogDebugTrace(__PRETTY_FUNCTION__, ##__VA_ARGS__)
#else
#define LogTrace(...) LogDebugTrace(__func__, __VA_ARGS__)
#endif
 
ATTR_FORMAT(1, 2) void LogVerbose(const char *format, ...);
ATTR_FORMAT(1, 2) void LogNotice(const char *format, ...);
ATTR_FORMAT(1, 2) void LogWarning(const char *format, ...);
ATTR_FORMAT(1, 2) void LogError(const char *format, ...);
ATTR_FORMAT(1, 2) void LogDebug(const char *format, ...);
ATTR_FORMAT(2, 3) void LogDebugTrace(const char* function, const char *format, ...);
ATTR_FORMAT(1, 2) ATTR_NORETURN void LogFatal(const char *format, ...);
 
ATTR_FORMAT(2, 3) void Log(Severity severity, const char *format, ...);
 
#undef ATTR_FORMAT
#undef ATTR_NORETURN
 
#endif