QGCLoggingCategory.h

Go to the documentation of this file.

#pragma once
 
#include "QmlObjectListModel.h"
 
#include <QtCore/QLoggingCategory>
#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QMap>
 
class QGCLoggingCategoryItem;
 
#define QGC_LOGGING_CATEGORY(name, categoryStr) \
    static QGCLoggingCategory qgcCategory ## name (categoryStr); \
    Q_LOGGING_CATEGORY(name, categoryStr, QtWarningMsg)
 
#define QGC_LOGGING_CATEGORY_ON(name, categoryStr) \
    static QGCLoggingCategory qgcCategory ## name (categoryStr); \
    Q_LOGGING_CATEGORY(name, categoryStr, QtInfoMsg)
 
class QGCLoggingCategoryManager : public QObject
{
    Q_GADGET
 
public:
    static QGCLoggingCategoryManager *instance();
 
    void registerCategory(const QString &category);
 
    QmlObjectListModel *treeCategoryModel() { return &_treeCategoryModel; }
 
    QmlObjectListModel *flatCategoryModel() { return &_flatCategoryModel; }
 
    static bool categoryLoggingOn(const QString &fullCategroryName);
 
    void setFilterRulesFromSettings(const QString &commandLineLoggingOptions);
 
    void disableAllCategories();
 
public slots:
    void setCategoryLoggingOn(const QString &fullCategoryName, bool enable);
 
private:
    static void _splitFullCategoryName(const QString &fullCategoryName, QString &parentCategory, QString &childCategory);
    QGCLoggingCategoryItem *_findLoggingCategory(const QString &fullCategoryName);
    void _insertSorted(QmlObjectListModel* model, QGCLoggingCategoryItem* item);
 
    QmlObjectListModel _treeCategoryModel;
    QmlObjectListModel _flatCategoryModel;
 
    static constexpr const char *kFilterRulesSettingsGroup = "LoggingFilters";
};
 
/*===========================================================================*/
 
class QGCLoggingCategory
{
public:
    QGCLoggingCategory(const QString &category) { QGCLoggingCategoryManager::instance()->registerCategory(category); }
};
 
class QGCLoggingCategoryItem : public QObject
{
    Q_OBJECT
 
    Q_PROPERTY(QString  shortCategory   MEMBER shortCategory   CONSTANT)
    Q_PROPERTY(QString  fullCategory    MEMBER fullCategory    CONSTANT)
    Q_PROPERTY(bool     enabled         READ enabled WRITE setEnabled NOTIFY enabledChanged)
    Q_PROPERTY(bool     expanded        MEMBER expanded        NOTIFY expandedChanged)
    Q_PROPERTY(QmlObjectListModel* children MEMBER children CONSTANT)
 
public:
    QGCLoggingCategoryItem(const QString& shortCategory_, const QString& fullCategory_, bool enabled_, QObject* parent = nullptr);
 
    bool enabled() const { return _enabled; }
    void setEnabled(bool enabled);
 
    QString shortCategory;
    QString fullCategory;
    bool _enabled = false;
    bool expanded = false;
    QmlObjectListModel* children = nullptr;
 
signals:
    void enabledChanged();
    void expandedChanged();
};