gmLog.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together 
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND, 
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR 
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_LOG_H_
#define _GEMA_LOG_H_
 
#include "gmCoreConfig.h"
 
#include <QLoggingCategory>
 
class QStringList;
 
enum GmLogLevel
{
  GM_TRACE,    
  GM_EXT_INFO, 
  GM_INFO,     
  GM_WARNING,  
  GM_ERROR,    
  GM_FATAL,    
  GM_TIME,     
  GM_MEMORY,   
  // ATTENTION: Do not add values  below this line
  //            Also remember to adjust the GmLogCategory constructor + GmLogCategory::str2Level() if adding a new category
  GM_COUNT     
};
 
class GMC_API_EXPORT GmLogCategory
{
public:
  GmLogCategory(QString name);
  ~GmLogCategory();
  
  bool isEnabled(GmLogLevel level) const { return _categories[level]->isDebugEnabled(); }
 
  void setEnabled(GmLogLevel level, bool mode) { _categories[level]->setEnabled(QtDebugMsg, mode); }
 
  QLoggingCategory& qtCategory(GmLogLevel level) const { return *_categories[level]; }
 
  static GmLogLevel str2Level(const char* levelStr);
 
private:
  Q_DISABLE_COPY(GmLogCategory);
 
  QByteArray        _names[GM_COUNT];       
  QLoggingCategory* _categories[GM_COUNT];  
};
 
#define gmLog(category, level, ...) qCDebug((category).qtCategory(level), __VA_ARGS__)
 
#define gmTrace(category, ...)   qCDebug((category).qtCategory(GM_TRACE),    __VA_ARGS__)
#define gmExtInfo(category, ...) qCDebug((category).qtCategory(GM_EXT_INFO), __VA_ARGS__)
#define gmInfo(category, ...)    qCDebug((category).qtCategory(GM_INFO),     __VA_ARGS__)
#define gmWarn(category, ...)    qCDebug((category).qtCategory(GM_WARNING),  __VA_ARGS__)
#define gmError(category, ...)   qCDebug((category).qtCategory(GM_ERROR),    __VA_ARGS__)
#define gmFatal(category, ...)   qCDebug((category).qtCategory(GM_FATAL),    __VA_ARGS__)
#define gmTime(category, ...)    qCDebug((category).qtCategory(GM_TIME),     __VA_ARGS__)
#define gmMemory(category, ...)  qCDebug((category).qtCategory(GM_MEMORY),   __VA_ARGS__)
 
#define gmLogMsg(category, level, msg) qCDebug((category).qtCategory(level), qPrintable(msg))
 
#define gmTraceMsg(category, msg)   qCDebug((category).qtCategory(GM_TRACE),    qPrintable(msg))
#define gmExtInfoMsg(category, msg) qCDebug((category).qtCategory(GM_EXT_INFO), qPrintable(msg))
#define gmInfoMsg(category, msg)    qCDebug((category).qtCategory(GM_INFO),     qPrintable(msg))
#define gmWarnMsg(category, msg)    qCDebug((category).qtCategory(GM_WARNING),  qPrintable(msg))
#define gmErrorMsg(category, msg)   qCDebug((category).qtCategory(GM_ERROR),    qPrintable(msg))
#define gmFatalMsg(category, msg)   qCDebug((category).qtCategory(GM_FATAL),    qPrintable(msg))
#define gmTimeMsg(category, msg)    qCDebug((category).qtCategory(GM_TIME),     qPrintable(msg))
#define gmMemoryMsg(category, msg)  qCDebug((category).qtCategory(GM_MEMORY),   qPrintable(msg))
 
class GmLogSignalEmitter: public QObject
{
  Q_OBJECT
 
signals:
  void logMessage(int level, QString msg);
};
 
 
class LuaTable;
 
GMC_API_EXPORT void GmLogInit();
GMC_API_EXPORT bool GmSetConsoleLogging(bool mode);
GMC_API_EXPORT void GmSetLogFile(QString logfile, bool flush, const GmLogCategory& logger);
GMC_API_EXPORT void GmCloseLogFile();
GMC_API_EXPORT void GmFlushLogFile();
GMC_API_EXPORT bool GmSetShowLoggerName(bool mode);
GMC_API_EXPORT bool GmSetShowThreadId(bool mode);
GMC_API_EXPORT bool GmSetHideRepeatedWarnings(bool mode);
GMC_API_EXPORT void GmSetLogLevels(const QList<QPair<QString, bool> >& rules);
GMC_API_EXPORT void GmSetLogLevels(LuaTable& tab, const QList<QPair<QString, bool> >& extraRules, const GmLogCategory& logger);
 
GMC_API_EXPORT bool GmLoggerDecorations(void);
GMC_API_EXPORT bool GmSetLoggerDecorations(bool mode);
 
GMC_API_EXPORT bool GmSetStringListLogging(bool mode, QStringList* targetList = NULL);
GMC_API_EXPORT const QStringList& GmLogStringList();
 
GMC_API_EXPORT const QObject* GmSetLoggingSignal(bool enable);
 
GMC_API_EXPORT void GmLogWrappedMsg(const GmLogCategory& logger, GmLogLevel level, const QString& msg, 
                                    int maxSize = 120, int maxBreak = 30);
 
GMC_API_EXPORT void GmLogIdent(int offset);
GMC_API_EXPORT int  GmLogIdentClear();
 
GMC_API_EXPORT void    GmLogMemoryUsage(const GmLogCategory& logger, const QString& msg);
GMC_API_EXPORT QString GmLogFormatMemory(size_t s);
 
GMC_API_EXPORT const GmLogCategory& GmPanicLogger();
 
class GMC_API_EXPORT GmLogIdenter
{
public:
  GmLogIdenter(int l = 1) : _l(l) { GmLogIdent(_l);  }
  ~GmLogIdenter()                 { GmLogIdent(-_l); }
private:
  int _l; // Number of ident levels
};
 
class GMC_API_EXPORT GmLogIdentClearer
{
public:
  GmLogIdentClearer()  { _old = GmLogIdentClear(); }
  ~GmLogIdentClearer() { GmLogIdent(_old); }
private:
  int _old; // Old number of ident levels
};
 
 
#endif