/****************************************************************************
**
** 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