QXmppLogger.h

// SPDX-FileCopyrightText: 2009 Manjeet Dahiya <manjeetdahiya@gmail.com>
// SPDX-FileCopyrightText: 2010 Jeremy Lainé <jeremy.laine@m4x.org>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#ifndef QXMPPLOGGER_H
#define QXMPPLOGGER_H
 
#include "QXmppGlobal.h"
 
#include <memory>
 
#include <QObject>
 
#ifdef QXMPP_LOGGABLE_TRACE
#define qxmpp_loggable_trace(x) QString("%1(0x%2) %3").arg(metaObject()->className(), QString::number(reinterpret_cast<qint64>(this), 16), x)
#else
#define qxmpp_loggable_trace(x) (x)
#endif
 
class QXmppLoggerPrivate;
 
class QXMPP_EXPORT QXmppLogger : public QObject
{
    Q_OBJECT
    Q_FLAGS(MessageType MessageTypes)
 
    
    Q_PROPERTY(QString logFilePath READ logFilePath WRITE setLogFilePath NOTIFY logFilePathChanged)
    Q_PROPERTY(LoggingType loggingType READ loggingType WRITE setLoggingType NOTIFY loggingTypeChanged)
    Q_PROPERTY(MessageTypes messageTypes READ messageTypes WRITE setMessageTypes NOTIFY messageTypesChanged)
    Q_PROPERTY(bool prettyXml READ prettyXml WRITE setPrettyXml NOTIFY prettyXmlChanged)
    Q_PROPERTY(ColorMode colorMode READ colorMode WRITE setColorMode NOTIFY colorModeChanged)
 
public:
    enum LoggingType {
        NoLogging = 0,      
        FileLogging = 1,    
        StdoutLogging = 2,  
        SignalLogging = 4   
    };
    Q_ENUM(LoggingType)
 
    
    enum MessageType {
        NoMessage = 0,           
        DebugMessage = 1,        
        InformationMessage = 2,  
        WarningMessage = 4,      
        ReceivedMessage = 8,     
        SentMessage = 16,        
        AnyMessage = 31          
    };
    Q_DECLARE_FLAGS(MessageTypes, MessageType)
 
    
    enum ColorMode {
        ColorOff,   
        ColorOn,    
        ColorAuto,  
    };
    Q_ENUM(ColorMode)
 
    QXmppLogger(QObject *parent = nullptr);
    ~QXmppLogger() override;
 
    static QXmppLogger *getLogger();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    QXmppLogger::LoggingType loggingType();
    void setLoggingType(QXmppLogger::LoggingType type);
    Q_SIGNAL void loggingTypeChanged();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    QString logFilePath();
    void setLogFilePath(const QString &path);
    Q_SIGNAL void logFilePathChanged();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    QXmppLogger::MessageTypes messageTypes();
    void setMessageTypes(QXmppLogger::MessageTypes types);
    Q_SIGNAL void messageTypesChanged();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    bool prettyXml() const;
    void setPrettyXml(bool enable);
    Q_SIGNAL void prettyXmlChanged();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    QXmppLogger::ColorMode colorMode() const;
    void setColorMode(QXmppLogger::ColorMode mode);
    Q_SIGNAL void colorModeChanged();
 
    void enablePrettyXml(bool enable = true);
 
    Q_SLOT virtual void setGauge(const QString &gauge, double value);
    Q_SLOT virtual void updateCounter(const QString &counter, qint64 amount);
 
    Q_SLOT void log(QXmppLogger::MessageType type, const QString &text);
    Q_SLOT void reopen();
 
    Q_SIGNAL void message(QXmppLogger::MessageType type, const QString &text);
 
private:
    static QXmppLogger *m_logger;
    const std::unique_ptr<QXmppLoggerPrivate> d;
};
 
class QXMPP_EXPORT QXmppLoggable : public QObject
{
    Q_OBJECT
 
public:
    QXmppLoggable(QObject *parent = nullptr);
 
protected:
    void childEvent(QChildEvent *event) override;
 
    void debug(const QString &message)
    {
        Q_EMIT logMessage(QXmppLogger::DebugMessage, qxmpp_loggable_trace(message));
    }
 
    void info(const QString &message)
    {
        Q_EMIT logMessage(QXmppLogger::InformationMessage, qxmpp_loggable_trace(message));
    }
 
    void warning(const QString &message)
    {
        Q_EMIT logMessage(QXmppLogger::WarningMessage, qxmpp_loggable_trace(message));
    }
 
    void logReceived(const QString &message)
    {
        Q_EMIT logMessage(QXmppLogger::ReceivedMessage, qxmpp_loggable_trace(message));
    }
 
    void logSent(const QString &message)
    {
        Q_EMIT logMessage(QXmppLogger::SentMessage, qxmpp_loggable_trace(message));
    }
 
public:
    Q_SIGNAL void setGauge(const QString &gauge, double value);
 
    Q_SIGNAL void logMessage(QXmppLogger::MessageType type, const QString &msg);
 
    Q_SIGNAL void updateCounter(const QString &counter, qint64 amount = 1);
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(QXmppLogger::MessageTypes)
#endif  // QXMPPLOGGER_H