qt-creator/src/plugins/qtestlib/qtestlibplugin.h

/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 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 GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.2, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/

#ifndef QTESTLIBPLUGIN_H
#define QTESTLIBPLUGIN_H

#include <coreplugin/ioutputpane.h>
#include <projectexplorer/ProjectExplorerInterfaces>

#include <QPixmap>
#include <QStandardItem>
#include <QWidget>
#include <QSortFilterProxyModel>

class QStandardItemModel;
class QTreeView;
class QTextEdit;
class QComboBox;

namespace QTestLib {
namespace Internal {

class QTestLibPlugin;
class QTestOutputWidget;

struct QTestLocation
{
    QString file;
    QString line;
};

class QTestFunction : public QStandardItem
{
public:
    enum IncidentType {
        Pass,
        XFail,
        Fail,
        XPass
    };

    enum MessageType {
        Warning,
        QWarning,
        QDebug,
        QSystem,
        QFatal,
        Skip,
        Info
    };

    inline QTestFunction(const QString &name)
        : QStandardItem(name) {
        setColumnCount(2);
        // ### hardcoding colors sucks...
        setForeground(Qt::darkBlue);
    }

    void addIncident(IncidentType type,
                     const QString &file = QString(),
                     const QString &line = QString(),
                     const QString &details = QString());

    void addMessage(MessageType type, const QString &text);

    static bool indexHasIncidents(const QModelIndex &function, IncidentType type);
};

class QTestOutputPane : public QObject,
                        public Core::IOutputPane
{
    Q_OBJECT
    Q_INTERFACES(Core::IOutputPane)
public:
    QTestOutputPane(QTestLibPlugin *plugin);

    void addFunction(QTestFunction *function);

    virtual QWidget *outputWidget(QWidget *parent);
    QList<QWidget*> toolBarWidgets(void) const { return QList<QWidget *>(); }
    virtual QString name() const;

    virtual void clearContents();
    virtual void visibilityChanged(bool visible);

    void show();

Q_SIGNALS:
//signals
    void showPage();

private:
    QTestLibPlugin *m_plugin;
    QTestOutputWidget *m_widget;
    QStandardItemModel *m_model;
};

class QTestOutputFilter : public QSortFilterProxyModel
{
public:
    inline QTestOutputFilter(QObject *parent)
        : QSortFilterProxyModel(parent), m_filter(QTestFunction::Fail)
    {}

    inline void setIncidentFilter(QTestFunction::IncidentType incident) {
        m_filter = incident;
        filterChanged();
    }

protected:
    virtual bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;

private:
    QTestFunction::IncidentType m_filter;
};

class QTestOutputWidget : public QWidget
{
    Q_OBJECT
public:
    QTestOutputWidget(QStandardItemModel *model,
                      Core::ICore *iCore,
                      QWidget *parent);

    void expand();

private Q_SLOTS:
    void activateComboFilter(int index);
    void gotoLocation(QModelIndex index);

private:
    Core::ICore *m_coreInterface;
    QStandardItemModel *m_model;
    QTreeView *m_resultsView;
    QComboBox *m_filterCombo;
    QTestOutputFilter *m_filterModel;
};

class QTestLibPlugin : public QObject,
                       public ExtensionSystem::PluginInterface,
                       public ProjectExplorer::IApplicationOutput
{
    Q_OBJECT
    Q_INTERFACES(ExtensionSystem::PluginInterface
                 ProjectExplorer::IApplicationOutput)

public:
    QTestLibPlugin();
    virtual ~QTestLibPlugin();

    bool init(ExtensionSystem::PluginManagerInterface *app, QString *error_message);
    void extensionsInitialized();

    inline Core::ICore *coreInterface() const {
        return m_core;
    }

    // IApplicationOutput
    virtual void clear();
    virtual void appendOutput(const QString &out);
    virtual void processExited(int exitCode);

private slots:
    void projectRunHook(ProjectExplorer::Project *project);

private:
    ProjectExplorer::ProjectExplorerPlugin *m_projectExplorer;
    Core::ICore *m_core;
    QString m_outputFile;
    QString m_projectDirectory;
    QTestOutputPane *m_outputPane;
};

} // namespace Internal
} // namespace QTestLibPlugin

Q_DECLARE_METATYPE(QTestLib::Internal::QTestLocation)
Q_DECLARE_METATYPE(QTestLib::Internal::QTestFunction::IncidentType)
Q_DECLARE_METATYPE(QTestLib::Internal::QTestFunction::MessageType)

#endif // QTESTLIBPLUGIN_H