Console.h

浏览该文件的文档.

/************************************************************************
* @file Console.h
*
* @brief 控制相关类
*
* @details 控制相关类
*
* @author wukx
*
* @version  v1.0
*
* @date  2016.9.29
*
* @license 北京华科软科技有限公司
*
*************************************************************************/
 
 
#ifndef BIMHOMEBASE_CONSOLE_H
#define BIMHOMEBASE_CONSOLE_H
 
#include <chrono>
#include <map>
#include <set>
#include <string>
#include <sstream>
#include "BHGlobal.h"
 
// Python 相关定义
typedef struct _object PyObject;
typedef struct PyMethodDef PyMethodDef;
 
// FIXME: ISO C++11 要求变参宏的 "..." 至少有一个参数
#if defined(__clang__)
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wgnu-zero-variadic-macro-arguments"
#endif
 
//**************************************************************************
// 日志级别
 
#ifdef FC_DEBUG
#  undef FC_LOGPYOBJECTS
#  define FC_LOGFEATUREUPDATE
#  undef FC_LOGUPDATECHAIN
#endif
 
 
 
#define FC_LOGLEVEL_DEFAULT -1
#define FC_LOGLEVEL_ERR 0
#define FC_LOGLEVEL_WARN 1
#define FC_LOGLEVEL_MSG 2
#define FC_LOGLEVEL_LOG 3
#define FC_LOGLEVEL_TRACE 4
 
#define _FC_LOG_LEVEL_INIT(_name,_tag,...) \
    static Base::LogLevel _name(_tag,## __VA_ARGS__);
 
#ifndef FC_LOG_INSTANCE
#   define FC_LOG_INSTANCE _s_fclvl
#endif
 
#define FC_LOG_LEVEL_INIT(_tag,...) \
    _FC_LOG_LEVEL_INIT(FC_LOG_INSTANCE, _tag, ## __VA_ARGS__)
 
#define __FC_PRINT(_instance,_l,_func,_msg,_file,_line) do{\
    if(_instance.isEnabled(_l)) {\
        std::stringstream _str;\
        _instance.prefix(_str,_file,_line) << _msg;\
        if(_instance.add_eol) \
            _str<<std::endl;\
        Base::Console()._func(_str.str().c_str());\
        if(_instance.refresh) Base::Console().Refresh();\
    }\
}while(0)
 
#define _FC_PRINT(_instance,_l,_func,_msg) __FC_PRINT(_instance,_l,_func,_msg,__FILE__,__LINE__)
 
#define FC_MSG(_msg) _FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_MSG,NotifyMessage,_msg)
#define FC_WARN(_msg) _FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_WARN,NotifyWarning,_msg)
#define FC_ERR(_msg) _FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_ERR,NotifyError,_msg)
#define FC_LOG(_msg) _FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_LOG,NotifyLog,_msg)
#define FC_TRACE(_msg) _FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_TRACE,NotifyLog,_msg)
 
#define _FC_MSG(_file,_line,_msg) __FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_MSG,NotifyMessage,_msg,_file,_line)
#define _FC_WARN(_file,_line,_msg) __FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_WARN,NotifyWarning,_msg,_file,_line)
#define _FC_ERR(_file,_line,_msg) __FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_ERR,NotifyError,_msg,_file,_line)
#define _FC_LOG(_file,_line,_msg) __FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_LOG,NotifyLog,_msg,_file,_line)
#define _FC_TRACE(_file,_line,_msg) __FC_PRINT(FC_LOG_INSTANCE,FC_LOGLEVEL_TRACE,NotifyLog,_msg,_file,_line)
 
#define FC_XYZ(_pt) '('<<(_pt).X()<<", " << (_pt).Y()<<", " << (_pt).Z()<<')'
#define FC_xy(_pt) '('<<(_pt).x<<", " << (_pt).y<<')'
#define FC_xyz(_pt) '('<<(_pt).x<<", " << (_pt).y<<", " << (_pt).z<<')'
 
#ifndef FC_LOG_NO_TIMING
#   define FC_TIME_CLOCK high_resolution_clock
#   define FC_TIME_POINT std::chrono::FC_TIME_CLOCK::time_point
#   define FC_DURATION std::chrono::duration<double>
 
#   define _FC_TIME_INIT(_t) _t=std::chrono::FC_TIME_CLOCK::now()
#   define FC_TIME_INIT(_t) FC_TIME_POINT _FC_TIME_INIT(_t)
#   define FC_TIME_INIT2(_t1,_t2) FC_TIME_INIT(_t1),_t2=_t1
#   define FC_TIME_INIT3(_t1,_t2,_t3) FC_TIME_INIT(_t1),_t2=_t1,_t3=_t1
 
#   define _FC_DURATION_PRINT(_l,_d,_msg) \
        FC_##_l(_msg<< " time: " << _d.count()<<'s');
 
#   define FC_DURATION_MSG(_d,_msg) _FC_DURATION_PRINT(MSG,_d,_msg)
#   define FC_DURATION_LOG(_d,_msg) _FC_DURATION_PRINT(LOG,_d,_msg)
#   define FC_DURATION_TRACE(_d,_msg) _FC_DURATION_PRINT(TRACE,_d,_msg)
 
#   define _FC_TIME_PRINT(_l,_t,_msg) \
        _FC_DURATION_PRINT(_l,Base::GetDuration(_t),_msg);
 
#   define FC_TIME_MSG(_t,_msg) _FC_TIME_PRINT(MSG,_t,_msg)
#   define FC_TIME_LOG(_t,_msg) _FC_TIME_PRINT(LOG,_t,_msg)
#   define FC_TIME_TRACE(_t,_msg) _FC_TIME_PRINT(TRACE,_t,_msg)
 
#   define FC_DURATION_DECLARE(_d) FC_DURATION _d
#   define FC_DURATION_DECLARE2(_d,_d1) FC_DURATION_DECLARE(_d),_d1
#   define FC_DURATION_DECLARE3(_d,_d1) FC_DURATION_DECLARE2(_d,_d1),_d2
 
#   define FC_DURATION_INIT(_d) _d=FC_DURATION(0)
#   define FC_DURATION_INIT2(_d,_d1) _d=_d1=FC_DURATION(0)
#   define FC_DURATION_INIT3(_d,_d1,_d2) _d=_d1=_d2=FC_DURATION(0)
 
#   define FC_DURATION_DECL_INIT(_d) FC_DURATION _d(0)
#   define FC_DURATION_DECL_INIT2(_d,_d1) FC_DURATION_DECL_INIT(_d),_d1(0)
#   define FC_DURATION_DECL_INIT3(_d,_d1) FC_DURATION_DECL_INIT2(_d,_d1),_d3(0)
 
#   define FC_DURATION_PLUS(_d,_t) _d += Base::GetDuration(_t)
 
#else //FC_LOG_NO_TIMING
#   define FC_TIME_POINT
#   define _FC_TIME_INIT(...) do{}while(0)
#   define FC_TIME_INIT(...) do{}while(0)
#   define FC_TIME_INIT2(...) do{}while(0)
#   define FC_TIME_INIT3(...) do{}while(0)
#   define _FC_DURATION_PRINT(...) do{}while(0)
#   define _FC_TIME(_t) do{}while(0)
#   define FC_DURATION_PRINT(...) do{}while(0)
#   define FC_DURATION
#   define FC_DURATION_INIT(...) do{}while(0)
#   define FC_DURATION_INIT1(...) do{}while(0)
#   define FC_DURATION_INIT2(...) do{}while(0)
#   define FC_DURATION_DECLARE(...)
#   define FC_DURATION_DECLARE1(...)
#   define FC_DURATION_DECLARE2(...)
#   define FC_DURATION_DECL_INIT(...) do{}while(0)
#   define FC_DURATION_DECL_INIT2(...) do{}while(0)
#   define FC_DURATION_DECL_INIT3(...) do{}while(0)
#   define FC_DURATION_PLUS(...) do{}while(0)
 
#endif //FC_LOG_NO_TIMING
 
namespace Base
{
    class ConsoleSingleton;
} // namespace Base
 
typedef unsigned int ConsoleMsgFlags;
 
namespace Base
{
 
#ifndef FC_LOG_NO_TIMING
    inline FC_DURATION GetDuration(FC_TIME_POINT& t)
    {
        auto tnow = std::chrono::FC_TIME_CLOCK::now();
        auto d = std::chrono::duration_cast<FC_DURATION>(tnow - t);
        t = tnow;
        return d;
    }
#endif
 
    enum class LogStyle
    {
        Warning,
        Message,
        Error,
        Log
    };
 
    class BaseExport ILogger
    {
    public:
        ILogger() :bErr(true), bMsg(true), bLog(true), bWrn(true) {}
        virtual ~ILogger() = 0;
 
        virtual void SendLog(const std::string& msg, LogStyle level) = 0;
 
        virtual const char* Name() { return nullptr; }
 
    public:
        bool bErr, bMsg, bLog, bWrn;//控制是否记录错误日志、普通消息日志、一般日志、警告日志；
    };
 
 
    class BaseExport ConsoleSingleton
    {
    public:
 
        enum ConsoleMode
        {
            Verbose = 1, 
        };
 
        enum ConnectionMode
        {
            Direct = 0, 
            Queued = 1  
        };
 
        enum BIMHome_ConsoleMsgType
        {
            MsgType_Txt = 1, 
            MsgType_Log = 2, 
            MsgType_Wrn = 4, 
            MsgType_Err = 8  
        };
 
        virtual void Message(const char* pMsg, ...);
        virtual void Warning(const char* pMsg, ...);
        virtual void Error(const char* pMsg, ...);
        virtual void Log(const char* pMsg, ...);
 
        void NotifyMessage(const char* sMsg);
 
        void NotifyWarning(const char* sMsg);
 
        void NotifyError(const char* sMsg);
 
        void NotifyLog(const char* sMsg);
 
        void AttachObserver(ILogger* pcObserver);
 
        void DetachObserver(ILogger* pcObserver);
 
        void SetConsoleMode(ConsoleMode m);
 
        void UnsetConsoleMode(ConsoleMode m);
 
        ConsoleMsgFlags SetEnabledMsgType(const char* sObs, ConsoleMsgFlags type, bool b);
 
        bool IsMsgTypeEnabled(const char* sObs, BIMHome_ConsoleMsgType type) const;
 
        void SetConnectionMode(ConnectionMode mode);
 
        int* GetLogLevel(const char* tag, bool create = true);
 
        void SetDefaultLogLevel(int level)
        {
            _defaultLogLevel = level;
        }
 
        inline int LogLevel(int level) const
        {
            return level < 0 ? _defaultLogLevel : level;
        }
 
        static ConsoleSingleton& Instance();
 
        ILogger* Get(const char* Name) const;
 
        static PyMethodDef    Methods[];
 
        void Refresh();
 
        void EnableRefresh(bool enable);
 
    protected:
 
        ConsoleSingleton();
        virtual ~ConsoleSingleton();
 
        static PyObject* sPyLog(PyObject* self, PyObject* args);
        static PyObject* sPyMessage(PyObject* self, PyObject* args);
        static PyObject* sPyWarning(PyObject* self, PyObject* args);
        static PyObject* sPyError(PyObject* self, PyObject* args);
        static PyObject* sPySetStatus(PyObject* self, PyObject* args);
        static PyObject* sPyGetStatus(PyObject* self, PyObject* args);
 
    private:
        static void Destruct();
 
    public:
        static const unsigned int BufferSize = 4024;
 
    protected:
        bool _bVerbose;
        bool _bCanRefresh;
        ConnectionMode connectionMode;
 
    private:
        static ConsoleSingleton* _pcSingleton;
        std::set<ILogger* > _aclObservers;
        std::map<std::string, int> _logLevels;
        int _defaultLogLevel;
 
        friend class ConsoleOutput;
    };
 
    inline ConsoleSingleton& Console()
    {
        return ConsoleSingleton::Instance();
    }
 
    class BaseExport ConsoleRefreshDisabler
    {
    public:
        ConsoleRefreshDisabler()
        {
            Console().EnableRefresh(false);
        }
 
        ~ConsoleRefreshDisabler()
        {
            Console().EnableRefresh(true);
        }
    };
 
    class BaseExport LogLevel
    {
    public:
        LogLevel(const char* tag, bool print_tag = true, int print_src = 0,bool print_time = false, bool add_eol = true, bool refresh = false)
            :tag(tag), 
            lvl(*Console().GetLogLevel(tag)),
            print_tag(print_tag), print_src(print_src),
            print_time(print_time),
            add_eol(add_eol), refresh(refresh)
        {}
        bool isEnabled(int l)
        {
            return l <= level();
        }
        int level() const
        {
            return Console().LogLevel(lvl);
        }
        std::stringstream& prefix(std::stringstream& str, const char* src, int line);
 
    public:
        std::string tag; 
        int& lvl;        
        bool print_tag;  
        int print_src;   
        bool print_time; 
        bool add_eol;    
        bool refresh;    
    };
 
 
} // namespace Base
 
#if defined(__clang__)
# pragma clang diagnostic pop
#endif
 
#endif // BIMHOMEBASE_CONSOLE_H