Logger.hpp

浏览该文件的文档.

 
 
#pragma once
 
#include "AstGlobal.h"
#include "AstUtil/I18n.hpp"
#include "AstUtil/SourceLocation.hpp"   // for A_SOURCE_FILE_PATH
#include <iostream>                     // for std::cout
#include <sstream>                      // for std::ostringstream
#include <stdarg.h>                     // for va_list
 
 
AST_NAMESPACE_BEGIN
 
enum class ELogLevel
{
    eDebug,     
    eInfo,      
    eWarning,   
    eError,     
    eCritical,  
    eFatal      
};
 
 
 
 
class MessageLogContext
{
public:
    MessageLogContext()
        : line_{0}
        , file_{nullptr}
        , function_{nullptr}
        , category_{nullptr}
    {}
    MessageLogContext(const char* fileName, int lineNumber, const char* functionName, const char* categoryName = nullptr)
        : line_{lineNumber}
        , file_{fileName}
        , function_{functionName}
        , category_{categoryName}
    {}
 
    int   line_{};             
    const char* file_{};       
    const char* function_{};   
    const char* category_{};   
};
 
 
AST_UTIL_CAPI void aLogMessageV(ELogLevel level, const MessageLogContext& context, const char* format, va_list ap);
AST_UTIL_CAPI void aLogMessage(ELogLevel level, const MessageLogContext& context, const char* format, ...);
 
 
class LoggerStream
{
public:
    LoggerStream(ELogLevel level, const MessageLogContext& context)
        : context_{ context }
        , level_{ level }
        , stream_{}
    {}
    LoggerStream(ELogLevel level, const char* fileName, int lineNumber, const char* functionName, const char* categoryName = nullptr)
        : context_{ fileName, lineNumber, functionName, categoryName }
        , level_{ level }
        , stream_{}
    {}
    LoggerStream(const LoggerStream& other)
        : context_{ other.context_ }
        , level_{ other.level_ }
        , stream_{}
    {}
    ~LoggerStream()
    {
        aLogMessage(level_, context_, stream_.str().c_str());
    }
    inline LoggerStream& space()
    {
        stream() << ' '; return *this;
    }
    inline LoggerStream& operator<<(bool t)
    {
        stream() << (t ? "true" : "false"); return space();
    }
    inline LoggerStream& operator<<(char t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(signed short t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(unsigned short t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(signed int t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(unsigned int t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(signed long t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(unsigned long t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(float t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(double t)
    {
        stream() << t; return space();
    }
    inline LoggerStream& operator<<(const char* t)
    {
        stream() << (t); return space();
    }
    inline LoggerStream& operator<<(const void* t)
    {
        stream() << t; return space();
    }
    inline std::ostringstream& stream()
    {
        return stream_;
    }
protected:
    MessageLogContext   context_;    
    ELogLevel           level_;      
    std::ostringstream  stream_;     
};
 
class NoopStream
{
public:
    inline NoopStream& space()
    {
        return *this;
    }
    template<typename T>
    inline NoopStream& operator<<(const T&)
    {
        return *this;
    }
};
 
 
class MessageLogger
{
public:
    MessageLogger()
        :context_{}
    {}
    MessageLogger(const char* file, int line, const char* function)
        : context_{file, line, function}
    {}
    template<typename ...Args>
    inline void debug(const char* msg, Args&& ...args) const
    {
        aLogMessage(ELogLevel::eDebug, context_, msg, std::forward<Args>(args)...);
    };
    template<typename ...Args>
    inline void noDebug(const char*, Args&& ...args) const{}
    template<typename ...Args>
    void info(const char* msg, Args&& ...args) const
    {
        aLogMessage(ELogLevel::eInfo, context_, msg, std::forward<Args>(args)...);
    }
    template<typename ...Args>
    inline void warning(const char* msg, Args&& ...args) const
    {
        aLogMessage(ELogLevel::eWarning, context_, msg, std::forward<Args>(args)...);
    }
    template<typename ...Args>
    inline void error(const char* msg, Args&& ...args) const
    {
        aLogMessage(ELogLevel::eError, context_, msg, std::forward<Args>(args)...);
    }
    template<typename ...Args>
    inline void critical(const char* msg, Args&& ...args) const
    {
        aLogMessage(ELogLevel::eCritical, context_, msg, std::forward<Args>(args)...);
    }
    template<typename ...Args>
    inline void fatal(const char* msg, Args&& ...args) const
    {
        aLogMessage(ELogLevel::eFatal, context_, msg, std::forward<Args>(args)...);
    }
    inline LoggerStream debug() const{return LoggerStream(ELogLevel::eDebug, context_); }
    inline NoopStream   noDebug() const{ return NoopStream(); }
    inline LoggerStream info() const{return LoggerStream(ELogLevel::eInfo, context_); }
    inline LoggerStream warning() const{return LoggerStream(ELogLevel::eWarning, context_);}
    inline LoggerStream error() const{return LoggerStream(ELogLevel::eError, context_);}
    inline LoggerStream critical() const{return LoggerStream(ELogLevel::eCritical, context_); };
    inline LoggerStream fatal() const{return LoggerStream(ELogLevel::eFatal, context_); };
private:
    MessageLogContext context_;
};
 
 
// 日志宏定义
 
#ifdef NDEBUG
#define aDebug(...)    while(false) AST_PREPEND_NAMESPACE(MessageLogger)().noDebug()
#else
#define aDebug(...)    AST_PREPEND_NAMESPACE(MessageLogger)(A_SOURCE_FILE_PATH, __LINE__, __FUNCTION__).debug(__VA_ARGS__)
#endif
#define aInfo(...)     AST_PREPEND_NAMESPACE(MessageLogger)(A_SOURCE_FILE_PATH, __LINE__, __FUNCTION__).info(__VA_ARGS__)
#define aWarning(...)  AST_PREPEND_NAMESPACE(MessageLogger)(A_SOURCE_FILE_PATH, __LINE__, __FUNCTION__).warning(__VA_ARGS__)
#define aError(...)    AST_PREPEND_NAMESPACE(MessageLogger)(A_SOURCE_FILE_PATH, __LINE__, __FUNCTION__).error(__VA_ARGS__)
#define aCritical(...) AST_PREPEND_NAMESPACE(MessageLogger)(A_SOURCE_FILE_PATH, __LINE__, __FUNCTION__).critical(__VA_ARGS__)
#define aFatal(...)    AST_PREPEND_NAMESPACE(MessageLogger)(A_SOURCE_FILE_PATH, __LINE__, __FUNCTION__).fatal(__VA_ARGS__)
 
 
#define AST_CHECK_NULLPTR(variable) if(variable == nullptr){aError(_(#variable " 未设置(nullptr)")); return eErrorNullPtr;}
#define AST_CHECK_ERRCODE(rc, msg) if(rc){aError(msg); return rc;}
#define AST_CHECK_INVALID(condition) if(condition){aError(_("无效参数，条件为 " #condition)); return eErrorInvalidParam;}
 
 
AST_NAMESPACE_END