QGCLogging.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QFile>
#include <QtCore/QList>
#include <QtCore/QLoggingCategory>
#include <QtCore/QString>
#include <QtCore/QStringListModel>
#include <QtCore/QTimer>
 
Q_DECLARE_LOGGING_CATEGORY(QGCLoggingLog)
 
 
struct CapturedLogMessage
{
    QtMsgType type = QtDebugMsg;
    QString category;
    QString message;
};
 
class QGCLogging : public QStringListModel
{
    Q_OBJECT
 
public:
    explicit QGCLogging(QObject *parent = nullptr);
    ~QGCLogging();
 
    static QGCLogging *instance();
 
    static void installHandler();
 
    Q_INVOKABLE void writeMessages(const QString &destFile);
 
    void log(const QString &message);
 
    // ========================================================================
    // Test Log Capture
    // ========================================================================
 
    static void setCaptureEnabled(bool enabled);
 
    static void clearCapturedMessages();
 
    [[nodiscard]] static QList<CapturedLogMessage> capturedMessages(const QString &category = {});
 
    [[nodiscard]] static bool hasCapturedMessage(const QString &category, QtMsgType type);
 
    [[nodiscard]] static bool hasCapturedWarning(const QString &category);
 
    [[nodiscard]] static bool hasCapturedCritical(const QString &category);
 
    [[nodiscard]] static bool hasCapturedUncategorizedMessage();
 
    static void captureIfEnabled(QtMsgType type, const QMessageLogContext &context, const QString &msg);
 
signals:
    void emitLog(const QString &message);
 
    void writeStarted();
 
    void writeFinished(bool success);
 
private slots:
    void _threadsafeLog(const QString &message);
 
    void _flushToDisk();
 
private:
    void _rotateLogs();
 
    QFile _logFile;
    QTimer _flushTimer;
    QStringList _pendingDiskWrites;
    bool _ioError = false;
 
    static constexpr int kMaxLogFileSize = 10LL * 1024 * 1024;
    static constexpr int kMaxBackupFiles = 5;
    static constexpr int kFlushIntervalMSecs = 1000;
};