scriptlogger.h

Go to the documentation of this file.

/*
 *   This file is part of the Okteta Kasten Framework, made within the KDE community.
 *
 *   Copyright 2010, 2011, 2012 Alex Richardson <alex.richardson@gmx.de>
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser General Public
 *   License as published by the Free Software Foundation; either
 *   version 2.1 of the License, or (at your option) version 3, or any
 *   later version accepted by the membership of KDE e.V. (or its
 *   successor approved by the membership of KDE e.V.), which shall
 *   act as a proxy defined in Section 6 of version 3 of the license.
 *
 *   This library 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
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SCRIPTLOGGER_H
#define SCRIPTLOGGER_H

#include <QAbstractTableModel>
#include <QVector>
#include <QDebug>
#include <QTime>

class KIcon;

class DataInformation;
class ScriptLogger : public QAbstractTableModel {
    Q_DISABLE_COPY(ScriptLogger)
    Q_OBJECT
public:
    explicit ScriptLogger();
    virtual ~ScriptLogger();

    enum Columns {
        ColumnTime = 0, ColumnOrigin, ColumnMessage, COLUMN_COUNT
    };
    //fits into 2 bits
    enum LogLevel {
        LogInvalid = 0, LogInfo = 1, LogWarning = 2, LogError = 3
    };
    struct Data {
        inline Data() : level(LogInvalid) {}
        inline Data(LogLevel lvl, const QString& o)
            : level(lvl), origin(o), time(QTime::currentTime()) {}
        inline Data(const Data& d)
            : level(d.level), message(d.message), origin(d.origin), time(d.time) {}
        inline ~Data() {}
        ScriptLogger::LogLevel level;
        QString message;
        QString origin;
        QTime time;
    };
    virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const;
    virtual int rowCount(const QModelIndex& parent = QModelIndex()) const;
    virtual int columnCount(const QModelIndex& parent = QModelIndex()) const;
    virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const;

    inline QDebug info(const DataInformation* origin) { return log(LogInfo, origin); }
    inline QDebug warn(const DataInformation* origin) { return log(LogWarning, origin); }
    inline QDebug error(const DataInformation* origin) { return log(LogError, origin); }
    inline QDebug info(const QString& origin = QString()) { return log(LogInfo, origin); }
    inline QDebug warn(const QString& origin = QString()) { return log(LogWarning, origin); }
    inline QDebug error(const QString& origin = QString()) { return log(LogError, origin); }
    QDebug log(LogLevel level, const DataInformation* origin);
    QDebug log(LogLevel level, const QString& origin);
    void clear();
    QStringList messages(LogLevel minLevel = LogInfo) const;
    inline void setLogToStdOut(bool val) { mLogToStdOut = val; }

    static KIcon iconForLevel(LogLevel level);
private:
    QVector<Data> mData;
    bool mLogToStdOut;
};

struct LoggerWithContext {
public:
    LoggerWithContext(ScriptLogger* l, const QString& s) : logger(l), context(s) {}
    inline QDebug info() const { return logger ? logger->info(context) : qDebug(); }
    inline QDebug warn() const { return logger ? logger->warn(context) : qWarning(); }
    inline QDebug error() const { return logger ? logger->error(context) : qWarning(); }
private:
    ScriptLogger* const logger;
    QString context;
};

#endif // SCRIPTLOGGER_H