summaryrefslogtreecommitdiffstats
path: root/src/common-lib/logging.h
blob: 71c13a7079a21aeae0f44803aa5cb01c1c92be57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#ifndef LOGGING_H
#define LOGGING_H

#include <QtAppManCommon/global.h>
#include <QtCore/QLoggingCategory>
#include <QtCore/QMutex>
#include <QtCore/QVariant>

QT_BEGIN_NAMESPACE_AM

#define QTAM_DUMMY_EXPORT // we're building static libraries, so no need to export symbols
#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
#  define QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(cat, dummy) Q_DECLARE_LOGGING_CATEGORY(cat)
#endif

QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogSystem, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogInstaller, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogGraphics, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogWayland, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogQml, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogNotifications, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogRuntime, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogQuickLaunch, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogQmlRuntime, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogDeployment, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogIntents, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogCache, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogDBus, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogWatchdog, QTAM_DUMMY_EXPORT)
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(LogStartupTimer, QTAM_DUMMY_EXPORT)

#if QT_VERSION < QT_VERSION_CHECK(6, 9, 0)
#  undef QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY
#endif
#undef QTAM_DUMMY_EXPORT

class Logging
{
public:
    static void initialize();
    static void initialize(int argc, const char * const *argv);

    static QStringList filterRules();
    static void setFilterRules(const QStringList &rules);

    static void setMessagePattern(const QString &pattern);

    static QVariant useAMConsoleLogger();
    static void setUseAMConsoleLogger(const QVariant &config);

    static bool hasDeferredMessages();
    static void completeSetup();

    static QByteArray applicationId();
    static void setApplicationId(const QByteArray &appId);

    // DLT functionality
    static bool isDltAvailable();
    static bool isDltEnabled();
    static void setDltEnabled(bool enabled);

    static void setSystemUiDltId(const QByteArray &dltAppId, const QByteArray &dltAppDescription);
    static void setDltApplicationId(const QByteArray &dltAppId, const QByteArray &dltAppDescription);

    static void registerUnregisteredDltContexts();

    static QString dltLongMessageBehavior();
    static void setDltLongMessageBehavior(const QString &behaviorString);

    static void logToDlt(QtMsgType msgType, const QMessageLogContext &context, const QString &message);

private:
    static void messageHandler(QtMsgType msgType, const QMessageLogContext &context, const QString &message);
    static void deferredMessageHandler(QtMsgType msgType, const QMessageLogContext &context, const QString &message);
};

template <typename... Ts> void am_trace(QDebug dbg, Ts &&... ts)
{ (dbg << ... << ts); }

#define AM_TRACE(category, ...) \
    for (bool qt_category_enabled = category().isDebugEnabled(); qt_category_enabled; qt_category_enabled = false) { \
        QT_PREPEND_NAMESPACE_AM(am_trace(QMessageLogger(__FILE__, __LINE__, __FUNCTION__, category().categoryName()).debug(), "TRACE", __FUNCTION__, __VA_ARGS__)); \
    }

QT_END_NAMESPACE_AM

#endif // LOGGING_H