summaryrefslogtreecommitdiffstats
path: root/src/generators/messagetrace_p.h
blob: 44c6cfc959dc3c7005e3f93ead99b9d61aa66fb5 (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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/****************************************************************************
**
** Copyright (C) 2016 Shawn Rutledge
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Labs UmlQuick project.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/


#ifndef MESSAGETRACE_H
#define MESSAGETRACE_H

#include <QFile>
#include <QHash>
#include <QLoggingCategory>
#include <QRegularExpression>
#include <QQmlEngine>

QT_BEGIN_NAMESPACE

class MessageTrace : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString category READ category WRITE setCategory NOTIFY categoryChanged)
    Q_PROPERTY(QString outputPrefix READ outputPrefix WRITE setOutputPrefix NOTIFY outputPrefixChanged)
    Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
    Q_PROPERTY(OutputFormat outputFormat READ outputFormat WRITE setOutputFormat NOTIFY outputFormatChanged)
    QML_ELEMENT

public:
    enum class OutputFormat {
        QML,
        PlantUML
    };
    Q_ENUM(OutputFormat)

    MessageTrace();

    QString category() const;
    void setCategory(QString category);

    QString outputPrefix() const { return m_outputPrefix; }
    void setOutputPrefix(QString outputPrefix);

    bool enabled() const { return m_enabled; }
    void setEnabled(bool enabled);

    OutputFormat outputFormat() const;
    void setOutputFormat(OutputFormat fmt);

signals:
    void categoryChanged();
    void outputPrefixChanged();
    void enabledChanged();

    void outputFormatChanged();

private:
    static void categoryFilter(QLoggingCategory *cat);
    static void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &text);
    void log(QtMsgType type, const QMessageLogContext &context, const QString &rawText);
    void logBacktrace(QStringList trace);
    void parseClassAndMethod(const QString &classAndMethod, QString &className, QString &methodName);
    static QString objectId(void *obj);
    void addObjectInstance(void *obj, const QString &objClass);
    void writeObjectInstanceQml(QFile &f, QObject *o);
    void writeObjectInstancePuml(QFile &f, QObject *o);
    void write();
    void writeQml(const QString &plainFilePath);
    void writePuml(const QString &plainFilePath);

private:
    struct Message {
        double timestamp;
        bool inferredFromBacktrace = false;
        QtMsgType type;
        void *callerPointer;
        QString callerClass;
        QString callerMethod;
        void *calleePointer;
        QString calleeClass;
        QString calleeMethod;
        QString calleeSignature;
        QStringList backtrace;
        QString params;
        QString toQml() const;
        QString toPuml() const;
    };

    static QHash<QByteArray, QList<MessageTrace*> > m_categoryInstances;
    static QtMessageHandler m_parentMessageHandler;

    static QRegularExpression m_regexObjectFormatted;
    static QRegularExpression m_regexPointer;

    static QHash<void*, QObject*> m_objects; // both QObjects and QObjectPrivates have entries here

    QList<Message> m_messages;
    QStringList m_previousBacktrace;
    double m_previousTimestamp;

    QHash<QString, QString> m_tracedObjectsById;
    QHash<QString, void*> m_recentObjectsByClass;

    bool m_enabled;
    QByteArray m_category;
    QString m_outputPrefix;
    OutputFormat m_outputFormat = OutputFormat::PlantUML;
};

QT_END_NAMESPACE

#endif // MESSAGETRACE_H