AppDebugMessageHandler.h

Go to the documentation of this file.

/*
  AppDebugMessageHandler
  https://github.com/mpaperno/maxLibQt

  COPYRIGHT: (c)2017 Maxim Paperno; All Right Reserved.
  Contact: http://www.WorldDesign.com/contact

  LICENSE:

  Commercial License Usage
  Licensees holding valid commercial licenses may use this file in
  accordance with the terms contained in a written agreement between
  you and the copyright holder.

  GNU General Public License Usage
  Alternatively, this file may be used under the terms of the GNU
  General Public License as published by the Free Software Foundation,
  either version 3 of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  A copy of the GNU General Public License is available at <http://www.gnu.org/licenses/>.
*/

#ifndef APPDEBUGMESSAGEHANDLER_H
#define APPDEBUGMESSAGEHANDLER_H

#include <QtCore>
#include <QDebug>
#include <QIODevice>
#include <QObject>
#include <QRegularExpression>
#include <QReadWriteLock>

#ifndef APP_DBG_HANDLER_ENABLE
  #define APP_DBG_HANDLER_ENABLE                1
#endif

#ifndef APP_DBG_HANDLER_DEFAULT_LEVEL
  #define APP_DBG_HANDLER_DEFAULT_LEVEL         0
#endif

#ifndef APP_DBG_HANDLER_SHOW_SRC_PATH
  #define APP_DBG_HANDLER_SHOW_SRC_PATH         0
#endif

#ifndef APP_DBG_HANDLER_SHOW_FUNCTION_DECL
  #define APP_DBG_HANDLER_SHOW_FUNCTION_DECL    0
#endif

#ifndef APP_DBG_HANDLER_SHOW_TIMESTAMP
  #define APP_DBG_HANDLER_SHOW_TIMESTAMP        0
#endif

#ifndef APP_DBG_HANDLER_TIMESTAMP_FORMAT
  #define APP_DBG_HANDLER_TIMESTAMP_FORMAT      "process"
#endif

#ifndef APP_DBG_HANDLER_SRC_PATH
  #define APP_DBG_HANDLER_SRC_PATH              ".*src"
#endif

// Make sure to include this header if using qInfo()
#if (QT_VERSION < QT_VERSION_CHECK(5, 5, 0))
  #if defined(QT_NO_INFO_OUTPUT)
    #define qInfo      QT_NO_QDEBUG_MACRO
  #else
    #define qInfo      qDebug
  #endif
  #define QtInfoMsg    QtMsgType(4)
#endif

class AppDebugMessageHandler : public QObject
{
    Q_OBJECT
    Q_PROPERTY(int appDebugOutputLevel READ appDebugOutputLevel WRITE setAppDebugOutputLevel)
    Q_PROPERTY(bool showSourcePath READ showSourcePath WRITE setShowSourcePath)
    Q_PROPERTY(bool showFunctionDeclarations READ showFunctionDeclarations WRITE setShowFunctionDeclarations)
    Q_PROPERTY(bool showTimestamp READ showTimestamp WRITE setShowTimestamp)
    Q_PROPERTY(QString timestampFormat READ timestampFormat WRITE setTimestampFormat)

  public:
    static AppDebugMessageHandler *instance();
    void installAppMessageHandler();

    inline quint8 appDebugOutputLevel() const { return m_appDebugOutputLevel; }  
    void setAppDebugOutputLevel(quint8 appDebugOutputLevel);  

    inline bool showSourcePath() const { return m_showSourcePath; }  
    void setShowSourcePath(bool showSourcePath);  
    void setSourceBasePath(const QString &path = QString());

    inline bool showFunctionDeclarations() const { return m_showFunctionDeclarations; }  
    void setShowFunctionDeclarations(bool showFunctionDeclarations);  

    inline bool showTimestamp() const { return m_showTimestamp; }  
    void setShowTimestamp(bool showTimestamp);  

    inline QString timestampFormat() const { return m_tsFormat; }  
    void setTimestampFormat(const QString &timeFormat);  

    void addOutputDevice(QIODevice *device);
    void removeOutputDevice(QIODevice *device);

    QString messagePattern() const;
    QString defaultMessagePattern() const;

    void setMessagePattern(const QString &pattern = QString());

    void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);

    static QHash<int, QString> &shortTypeNames();

#if (QT_VERSION < QT_VERSION_CHECK(5, 4, 0))
    static QHash<int, QString> &fullTypeNames();
#endif

  signals:
    void messageOutput(quint8 level, const QString &msg);

  private:
    explicit AppDebugMessageHandler();
    Q_DISABLE_COPY(AppDebugMessageHandler)

    QtMessageHandler m_defaultHandler;
    QRegularExpression m_srcPathFilter;
    quint8 m_appDebugOutputLevel;
    QVector<QIODevice *> m_outputDevices;
    bool m_showSourcePath;
    bool m_showFunctionDeclarations;
    bool m_showTimestamp;
    QString m_tsFormat;
    QString m_msgPattern;
    mutable QString m_defaultPattern;
    QReadWriteLock m_mutex;
#if (QT_VERSION < QT_VERSION_CHECK(5, 4, 0))
    QRegularExpression m_functionFilter;
#endif

};

void g_appDebugMessageHandler(QtMsgType, const QMessageLogContext &, const QString &);

#endif // APPDEBUGMESSAGEHANDLER_H