tracer.h

/***************************************************************************
 *   Copyright (C) 2006 by Tobias Koenig <tokoe@kde.org>                   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License as       *
 *   published by the Free Software Foundation; either version 2 of the    *
 *   License, or (at your option) any later version.                       *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this program; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
 ***************************************************************************/

#ifndef AKONADI_TRACER_H
#define AKONADI_TRACER_H

#include <QObject>
#include <QMutex>
#include <QJsonObject>
#include <QJsonDocument>

#include "tracerinterface.h"
#include <private/protocol_p.h>

class QSettings;

namespace Akonadi
{

namespace Protocol
{
class Command;
using CommandPtr = QSharedPointer<Command>;
}

namespace Server
{

class Tracer : public QObject, public TracerInterface
{
    Q_OBJECT

public:
    static Tracer *self();

    ~Tracer() override;

    template<typename T>
    typename std::enable_if<std::is_base_of<Protocol::Command, T>::value>::type
    connectionOutput(const QString &identifier, qint64 tag, const T &cmd) {
        QByteArray msg;
        if (mTracerBackend->connectionFormat() == TracerInterface::Json) {
            QJsonObject json;
            json[QStringLiteral("tag")] = tag;
            cmd.toJson(json);
            QJsonDocument doc(json);

            msg = doc.toJson(QJsonDocument::Indented);
        } else {
            msg = QByteArray::number(tag) + ' ' + Protocol::debugString(cmd).toUtf8();
        }
        connectionOutput(identifier, msg);
    }

public Q_SLOTS:
    void beginConnection(const QString &identifier, const QString &msg) override;

    void endConnection(const QString &identifier, const QString &msg) override;

    void connectionInput(const QString &identifier, const QByteArray &msg) override;

    void connectionInput(const QString &identifier, qint64 tag, const Protocol::CommandPtr &cmd);

    void connectionOutput(const QString &identifier, const QByteArray &msg) override;

    void connectionOutput(const QString &identifier, qint64 tag, const Protocol::CommandPtr &cmd);

    void signal(const QString &signalName, const QString &msg) override;

    void signal(const char *signalName, const QString &msg);

    void warning(const QString &componentName, const QString &msg) override;

    void error(const QString &componentName, const QString &msg) override;

    void error(const char *componentName, const QString &msg);

    QString currentTracer() const;

    void activateTracer(const QString &type);

private:
    Tracer();

    static Tracer *mSelf;

    TracerInterface *mTracerBackend;
    mutable QMutex mMutex;
    QScopedPointer<QSettings> mSettings;
};

} // namespace Server
} // namespace Akonadi

#endif