kde-playground/massif-visualizer/app/documentwidget.cpp

/*
   This file is part of Massif Visualizer

   Copyright 2010 Milian Wolff <mail@milianw.de>
   Copyright 2013 Arnold Dumas <contact@arnolddumas.fr>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 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 14 of version 3 of the license.

   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 General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "documentwidget.h"

#include <QApplication>

#include "massifdata/filedata.h"
#include "massifdata/parser.h"
#include "massifdata/parseworker.h"
#include "massifdata/snapshotitem.h"
#include "massifdata/treeleafitem.h"
#include "massifdata/util.h"

#include <KStandardAction>
#include <KColorScheme>

#include <KLocalizedString>
// forward include not available until later KDE versions...
#include <kmessagewidget.h>
#include <KIcon>
#include <KDebug>
#include <KXMLGUIFactory>

#include <QLabel>
#include <QProgressBar>
#include <QStackedWidget>
#include <QTabWidget>
#include <QToolButton>
#include <QVBoxLayout>

#include "charttab.h"
#include "allocatorstab.h"

#ifdef HAVE_KGRAPHVIEWER
#include "callgraphtab.h"

#include <KPluginLoader>
#include <KPluginFactory>
#include <KParts/ReadOnlyPart>
#endif

using namespace Massif;

DocumentWidget::DocumentWidget(const KUrl& file, const QStringList& customAllocators,
                               KXMLGUIClient* guiParent, QWidget* parent)
    : QWidget(parent)
    , KXMLGUIClient(guiParent)
    , m_data(0)
    , m_parseWorker(new ParseWorker)
    , m_file(file)
    , m_currentTab(0)
    , m_stackedWidget(new QStackedWidget(this))
    , m_tabs(new QTabWidget(m_stackedWidget))
    , m_errorMessage(0)
    , m_loadingMessage(0)
    , m_loadingProgressBar(0)
    , m_stopParserButton(0)
    , m_isLoaded(false)
{
    connect(m_parseWorker, SIGNAL(finished(KUrl, Massif::FileData*)),
            this, SLOT(parserFinished(KUrl, Massif::FileData*)));
    connect(m_parseWorker, SIGNAL(error(QString, QString)),
            this, SLOT(showError(QString, QString)));
    connect(m_parseWorker, SIGNAL(progressRange(int, int)),
            this, SLOT(setRange(int,int)));
    connect(m_parseWorker, SIGNAL(progress(int)),
            this, SLOT(setProgress(int)));

    // Create dedicated thread for this document.
    // TODO: use ThreadWeaver
    QThread* thread = new QThread(this);
    thread->start();
    m_parseWorker->moveToThread(thread);
    m_parseWorker->parse(file, customAllocators);

    setXMLFile("documentwidgetui.rc", true);

    // Set m_stackedWidget as the main widget.
    setLayout(new QVBoxLayout(this));
    layout()->addWidget(m_stackedWidget);

    m_tabs->setTabPosition(QTabWidget::South);
    m_stackedWidget->addWidget(m_tabs);

    // Second widget : loadingPage
    QWidget* loadingPage = new QWidget(m_stackedWidget);
    QVBoxLayout* verticalLayout = new QVBoxLayout(loadingPage);
    QSpacerItem* upperSpacerItem = new QSpacerItem(20, 247, QSizePolicy::Minimum, QSizePolicy::Expanding);
    verticalLayout->addItem(upperSpacerItem);

    m_loadingMessage = new QLabel(loadingPage);
    m_loadingMessage->setText(i18n("loading file <i>%1</i>...", file.pathOrUrl()));
    m_loadingMessage->setAlignment(Qt::AlignCenter);
    verticalLayout->addWidget(m_loadingMessage);

    m_loadingProgressBar = new QProgressBar(loadingPage);
    m_loadingProgressBar->setValue(24);
    m_loadingProgressBar->setRange(0, 0);
    verticalLayout->addWidget(m_loadingProgressBar);

    QWidget* stopParserWidget = new QWidget(loadingPage);
    stopParserWidget->setLayoutDirection(Qt::LeftToRight);
    QHBoxLayout* stopParserWidgetLayout = new QHBoxLayout(stopParserWidget);
    m_stopParserButton = new QToolButton(stopParserWidget);
    m_stopParserButton->setObjectName(QString::fromUtf8("stopParsing"));
    m_stopParserButton->setToolButtonStyle(Qt::ToolButtonTextUnderIcon);
    m_stopParserButton->setIcon(KIcon("process-stop"));
    m_stopParserButton->setIconSize(QSize(48, 48));
    connect(m_stopParserButton, SIGNAL(clicked()),
            this, SIGNAL(requestClose()));
    stopParserWidgetLayout->addWidget(m_stopParserButton);
    verticalLayout->addWidget(stopParserWidget);

    QSpacerItem* bottomSpacerItem = new QSpacerItem(20, 230, QSizePolicy::Minimum, QSizePolicy::Expanding);
    verticalLayout->addItem(bottomSpacerItem);
    m_stackedWidget->addWidget(loadingPage);

    // By default we show the loadingPage.
    m_stackedWidget->setCurrentIndex(1);
}

DocumentWidget::~DocumentWidget()
{
    stopParser();
    if (m_data) {
        delete m_data;
        m_data = 0;
        m_file.clear();
    }
}

FileData* DocumentWidget::data() const
{
    return m_data;
}

KUrl DocumentWidget::file() const
{
    return m_file;
}

bool DocumentWidget::isLoaded() const
{
    return m_isLoaded;
}

void DocumentWidget::settingsChanged()
{
    for (int i = 0; i < m_tabs->count(); ++i) {
        static_cast<DocumentTabInterface*>(m_tabs->widget(i))->settingsChanged();
    }
}

void DocumentWidget::parserFinished(const KUrl& file, FileData* data)
{
    Q_ASSERT(data->peak());

    kDebug() << "loaded massif file:" << file;
    qDebug() << "description:" << data->description();
    qDebug() << "command:" << data->cmd();
    qDebug() << "time unit:" << data->timeUnit();
    qDebug() << "snapshots:" << data->snapshots().size();
    qDebug() << "peak: snapshot #" << data->peak()->number() << "after" << QString("%1%2").arg(data->peak()->time()).arg(data->timeUnit());
    qDebug() << "peak cost:" << prettyCost(data->peak()->memHeap()) << " heap"
                             << prettyCost(data->peak()->memHeapExtra()) << " heap extra"
                             << prettyCost(data->peak()->memStacks()) << " stacks";

    m_data = data;
    m_file = file;

    m_tabs->addTab(new ChartTab(m_data, this, this), KIcon("office-chart-area-stacked"),
                   i18n("Memory Chart"));

#ifdef HAVE_KGRAPHVIEWER
    static KPluginFactory *factory = KPluginLoader("kgraphviewerpart").factory();
    if (factory) {
        KParts::ReadOnlyPart* part = factory->create<KParts::ReadOnlyPart>("kgraphviewerpart", this);
        if (part) {
            m_tabs->addTab(new CallGraphTab(m_data, part, this, this), KIcon("kgraphviewer"),
                           i18n("Callgraph"));
        }
    }
#endif

    m_tabs->addTab(new AllocatorsTab(m_data, this, this), KIcon("view-list-text"),
                   i18n("Allocators"));

    for (int i = 0; i < m_tabs->count(); ++i) {
        DocumentTabInterface* tab = static_cast<DocumentTabInterface*>(m_tabs->widget(i));
        connect(tab, SIGNAL(modelItemSelected(Massif::ModelItem)),
                this, SIGNAL(modelItemSelected(Massif::ModelItem)));
        connect(tab, SIGNAL(contextMenuRequested(Massif::ModelItem,QMenu*)),
                this, SIGNAL(contextMenuRequested(Massif::ModelItem,QMenu*)));
    }

    m_tabs->setCurrentIndex(0);
    connect(m_tabs, SIGNAL(currentChanged(int)),
            this, SLOT(slotTabChanged(int)));
    slotTabChanged(0);

    m_isLoaded = true;

    // Switch to the display page and notify that everything is setup.
    m_stackedWidget->setCurrentIndex(0);
    emit loadingFinished();
}

void DocumentWidget::addGuiActions(KXMLGUIFactory* factory)
{
    factory->addClient(this);

    // ensure only the current tab's client is in the factory
    // otherwise the actions from the other tabs are visible
    const int current = m_tabs->currentIndex();
    for (int i = 0; i < m_tabs->count(); ++i) {
        if (i != current) {
            factory->removeClient(static_cast<DocumentTabInterface*>(m_tabs->widget(i)));
        }
    }
}

void DocumentWidget::clearGuiActions(KXMLGUIFactory* factory)
{
    factory->removeClient(this);
}

void DocumentWidget::slotTabChanged(int tab)
{
    if (!factory()) {
        return;
    }

    if (m_currentTab) {
        factory()->removeClient(m_currentTab);
    }

    if (tab >= 0 && tab < m_tabs->count()) {
        m_currentTab = static_cast<DocumentTabInterface*>(m_tabs->widget(tab));
        factory()->addClient(m_currentTab);
    }
}

void DocumentWidget::selectModelItem(const ModelItem& item)
{
    for (int i = 0; i < m_tabs->count(); ++i) {
        static_cast<DocumentTabInterface*>(m_tabs->widget(i))->selectModelItem(item);
    }
}

void DocumentWidget::setProgress(int value)
{
    m_loadingProgressBar->setValue(value);
}

void DocumentWidget::setRange(int minimum, int maximum)
{
    m_loadingProgressBar->setRange(minimum, maximum);
}

void DocumentWidget::showError(const QString& title, const QString& error)
{
    if (!m_errorMessage) {
        m_errorMessage = new KMessageWidget(m_stackedWidget);
        m_stackedWidget->addWidget(m_errorMessage);
        m_errorMessage->setWordWrap(true);
        m_errorMessage->setMessageType(KMessageWidget::Error);
        m_errorMessage->setCloseButtonVisible(false);
    }
    m_errorMessage->setText(QString("<b>%1</b><p style=\"text-align:left\">%2</p>").arg(title).arg(error));
    m_stackedWidget->setCurrentWidget(m_errorMessage);
}

void DocumentWidget::stopParser()
{
    if (!m_parseWorker) {
        return;
    }

    QThread* thread = m_parseWorker->thread();
    m_parseWorker->stop();
    m_parseWorker->deleteLater();
    m_parseWorker = 0;
    thread->quit();
    thread->wait();
}