qt-creator/src/plugins/analyzerbase/analyzerplugin.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Author: Nicolas Arnaud-Cormos, KDAB (nicolas.arnaud-cormos@kdab.com)
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/

#include "analyzerplugin.h"
#include "analyzerconstants.h"
#include "analyzermanager.h"
#include "analyzeroutputpane.h"
#include "ianalyzertool.h"

#include <coreplugin/icore.h>
#include <coreplugin/imode.h>
#include <coreplugin/coreconstants.h>
#include <coreplugin/editormanager/editormanager.h>

#include <extensionsystem/pluginmanager.h>
#include <projectexplorer/task.h>
#include <projectexplorer/taskhub.h>

#include <QtCore/QtPlugin>
#include <QtGui/QMessageBox>
#include <QtGui/QMainWindow>
#include <QtGui/QApplication>

using namespace Analyzer;
using namespace Analyzer::Internal;

static const QLatin1String lastActiveToolC("Analyzer.Plugin.LastActiveTool");

AnalyzerPlugin *AnalyzerPlugin::m_instance = 0;


// AnalyzerPluginPrivate ////////////////////////////////////////////////////
class AnalyzerPlugin::AnalyzerPluginPrivate
{
public:
    AnalyzerPluginPrivate(AnalyzerPlugin *qq):
        q(qq),
        m_manager(0)
    {}

    void initialize(const QStringList &arguments, QString *errorString);

    AnalyzerPlugin *q;
    AnalyzerManager *m_manager;
};

void AnalyzerPlugin::AnalyzerPluginPrivate::initialize(const QStringList &arguments, QString *errorString)
{
    Q_UNUSED(arguments)
    Q_UNUSED(errorString)
    AnalyzerOutputPane *outputPane =  new AnalyzerOutputPane;
    q->addAutoReleasedObject(outputPane);
    m_manager = new AnalyzerManager(outputPane, q);
}


// AnalyzerPlugin ////////////////////////////////////////////////////
AnalyzerPlugin::AnalyzerPlugin()
    : d(new AnalyzerPluginPrivate(this))
{
    m_instance = this;
}

AnalyzerPlugin::~AnalyzerPlugin()
{
    // Unregister objects from the plugin manager's object pool
    // Delete members
    delete d;
    m_instance = 0;
}

bool AnalyzerPlugin::initialize(const QStringList &arguments, QString *errorString)
{
    // Register objects in the plugin manager's object pool
    // Load settings
    // connect to other plugins' signals
    // "In the initialize method, a plugin can be sure that the plugins it
    //  depends on have initialized their members."

    Q_UNUSED(arguments)
    Q_UNUSED(errorString)

    d->initialize(arguments, errorString);

    // Task integration
    ExtensionSystem::PluginManager *pm = ExtensionSystem::PluginManager::instance();
    ProjectExplorer::TaskHub *hub = pm->getObject<ProjectExplorer::TaskHub>();
    //: Category under which Analyzer tasks are listed in build issues view
    hub->addCategory(QLatin1String(Constants::ANALYZERTASK_ID), tr("Analyzer"));

    return true;
}

void AnalyzerPlugin::extensionsInitialized()
{
    // Retrieve objects from the plugin manager's object pool
    // "In the extensionsInitialized method, a plugin can be sure that all
    //  plugins that depend on it are completely initialized."

    // notify tools about the extensions initialized state
    const QList<IAnalyzerTool *> tools = d->m_manager->tools();
    if (tools.isEmpty())
        return;

    const QSettings *settings = Core::ICore::instance()->settings();
    const QString lastActiveToolId = settings->value(QLatin1String(lastActiveToolC), QString()).toString();
    IAnalyzerTool *lastActiveTool = 0;

    foreach (IAnalyzerTool *tool, tools) {
        tool->extensionsInitialized();
        if (tool->id() == lastActiveToolId)
            lastActiveTool = tool;
    }

    if (!lastActiveTool)
        lastActiveTool = tools.back();
    if (lastActiveTool)
        d->m_manager->selectTool(lastActiveTool);
}

ExtensionSystem::IPlugin::ShutdownFlag AnalyzerPlugin::aboutToShutdown()
{
    // Save settings
    // Disconnect from signals that are not needed during shutdown
    // Hide UI (if you add UI that is not in the main window directly)

    if (const IAnalyzerTool *tool = d->m_manager->currentTool()) {
        QSettings *settings = Core::ICore::instance()->settings();
        settings->setValue(QLatin1String(lastActiveToolC), tool->id());
    }

    d->m_manager->shutdown();
    return SynchronousShutdown;
}

AnalyzerPlugin *AnalyzerPlugin::instance()
{
    return m_instance;
}

Q_EXPORT_PLUGIN(AnalyzerPlugin)