【引擎开发技术点记录】QT引擎中的简易LOG设计

初衷

游戏引擎作为一个大型的软件系统，如果进行设计的话，某一处出现了BUG，那么其查找起来是非常繁琐的。一旦代码量上w，那么debug工作将会变得非常令人困扰。为了解决这个问题，设计一个简单的LOG系统是非常有必要的。

设计思路

由于LOG系统与整个引擎的各个方面都是紧耦合的。为了避免代码冗余，我们使用宏的方式来设计LOG。我们使用一下几个C++当中常用的宏来设计我们的简易LOG。

__FILE__ //用于得到当前的文件路径
__FUNCTION__ //用于得到当前的函数
__LINE__ //当前文件的行数

对于大型系统，我们需要一个统一的头文件Common.h来避免头文件引用循环的编译错误。然后我们在这个统一的头文件中设计如下宏：

#define FILENAME (QFileInfo(__FILE__).fileName().toStdString().c_str())
#define FUNCNAME __FUNCTION__
#define LINENO __LINE__

#define dout ((qDebug().nospace() << FUNCNAME << "(" << FILENAME << ":" << LINENO << "):").space())
#define tab(n) (QByteArray((n) * 4, ' ').data())

#define NO_LOG 0
#define LOG_LEVEL_ERROR 1
#define LOG_LEVEL_WARNING 2
#define LOG_LEVEL_INFO 3

extern int log_level;

如上所示，我们将C++给予的相关宏定义进行了封装。并且基于QT的机制设计了我们自己的宏定义。并且设计相关的LOG等级。从而我们可以得到更加详细的log。同时，我们设计一个外部变量log_level，来设置当前系统的警告等级。这个变量的详细定义将会在唯一的Engine.cpp中定义。在Common.h当中声明，是为了与整个系统的文件进行紧耦合。

应用

以一个经典QObject类为例，当前类A中存在m_B的成员。在销毁的时候将log_level的级别提升到WARNING级别进行delete操作。然后再恢复原来的级别。如果当前log_level是最高级别INFO，那么log输出当前函数的操作结果。

A::~A() {
    int tmp_log_level = log_level;
    log_level = LOG_LEVEL_WARNING;

    delete m_B;

    log_level = tmp_log_level;

    if (log_level >= LOG_LEVEL_INFO)
        dout << "A" << objectName() << "is destroyed";
}

结论

通过这么一套系统，将这几个宏定义紧耦合到整个系统，设计不同级别我们应该去做的事情，那么只需要简单修改Engine.cpp当中的log_level变量的值，就可以log出我们想要的整个系统的情况。从而更好的帮我们监控bug的出现位置。