/************************************************************************** ** ** This file is part of Qt Creator ** ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). ** ** Author: Andreas Hartmetz, KDAB (andreas.hartmetz@kdab.com) ** ** Contact: Nokia Corporation (qt-info@nokia.com) ** ** No Commercial Usage ** ** This file contains pre-release code and may not be distributed. ** You may use this file in accordance with the terms and conditions ** contained in the Technology Preview License Agreement accompanying ** this package. ** ** GNU Lesser General Public License Usage ** ** Alternatively, 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. ** **************************************************************************/ #include "analyzermanager.h" #include "analyzerconstants.h" #include "ianalyzertool.h" #include "analyzerplugin.h" #include "analyzerruncontrol.h" #include "analyzeroptionspage.h" #include "analyzeroutputpane.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace Core; using namespace Analyzer; using namespace Analyzer::Internal; // A separate 'Analzye' mode is not used in Qt Creator 2.2. // Consider re-introducing it if a real use case for a separate main window with docks // appears. enum { useAnalyzeMode = 0 }; namespace Analyzer { namespace Internal { class DockWidgetEventFilter : public QObject { Q_OBJECT public: explicit DockWidgetEventFilter(QObject *parent = 0) : QObject(parent) {} signals: void widgetResized(); protected: virtual bool eventFilter(QObject *obj, QEvent *event); }; bool DockWidgetEventFilter::eventFilter(QObject *obj, QEvent *event) { switch (event->type()) { case QEvent::Resize: case QEvent::ZOrderChange: emit widgetResized(); break; default: break; } return QObject::eventFilter(obj, event); } // AnalyzerMode //////////////////////////////////////////////////// class AnalyzerMode : public Core::IMode { Q_OBJECT public: AnalyzerMode(QObject *parent = 0) : Core::IMode(parent) , m_widget(0) {} ~AnalyzerMode() { // Make sure the editor manager does not get deleted. if (m_widget) { delete m_widget; m_widget = 0; } Core::EditorManager::instance()->setParent(0); } QString displayName() const { return tr("Analyze"); } QIcon icon() const { return QIcon(":/images/analyzer_mode.png"); } int priority() const { return Constants::P_MODE_ANALYZE; } QWidget *widget() { return m_widget; } QString id() const { return QLatin1String(Constants::MODE_ANALYZE); } QString type() const { return Core::Constants::MODE_EDIT_TYPE; } Core::Context context() const { return Core::Context(Core::Constants::C_EDITORMANAGER, Constants::C_ANALYZEMODE, Core::Constants::C_NAVIGATION_PANE); } QString contextHelpId() const { return QString(); } void setWidget(QWidget *widget) { m_widget = widget; } private: QWidget *m_widget; }; } // namespace Internal } // namespace Analyzer // AnalyzerManagerPrivate //////////////////////////////////////////////////// class AnalyzerManager::AnalyzerManagerPrivate { public: AnalyzerManagerPrivate(AnalyzerManager *qq); ~AnalyzerManagerPrivate(); /** * After calling this, a proper instance of Core::IMore is initialized * It is delayed since an analyzer mode makes no sense without analyzer tools * * \note Call this before adding a tool to the manager */ void delayedInit(); void setupActions(); QWidget *createModeContents(); QWidget *createModeMainWindow(); void addDock(IAnalyzerTool *tool, Qt::DockWidgetArea area, QDockWidget *dockWidget); void startTool(); AnalyzerManager *q; AnalyzerMode *m_mode; AnalyzerOutputPane *m_outputpane; AnalyzerRunControlFactory *m_runControlFactory; ProjectExplorer::RunControl *m_currentRunControl; Utils::FancyMainWindow *m_mainWindow; QList m_tools; QActionGroup *m_toolGroup; QAction *m_startAction; QAction *m_stopAction; QMenu *m_menu; QComboBox *m_toolBox; ActionContainer *m_viewsMenu; Utils::StatusLabel *m_statusLabel; typedef QPair ToolWidgetPair; typedef QList ToolWidgetPairList; QMap m_toolWidgets; DockWidgetEventFilter *m_resizeEventFilter; QMap m_defaultSettings; // list of dock widgets to prevent memory leak typedef QWeakPointer DockPtr; QList m_dockWidgets; bool m_initialized; }; AnalyzerManager::AnalyzerManagerPrivate::AnalyzerManagerPrivate(AnalyzerManager *qq): q(qq), m_mode(0), m_outputpane(0), m_runControlFactory(0), m_currentRunControl(0), m_mainWindow(0), m_toolGroup(0), m_startAction(0), m_stopAction(0), m_menu(0), m_toolBox(new QComboBox), m_viewsMenu(0), m_statusLabel(new Utils::StatusLabel), m_resizeEventFilter(new DockWidgetEventFilter(qq)), m_initialized(false) { m_toolBox->setObjectName(QLatin1String("AnalyzerManagerToolBox")); m_runControlFactory = new AnalyzerRunControlFactory(); AnalyzerPlugin::instance()->addAutoReleasedObject(m_runControlFactory); connect(m_runControlFactory, SIGNAL(runControlCreated(Analyzer::Internal::AnalyzerRunControl *)), q, SLOT(runControlCreated(Analyzer::Internal::AnalyzerRunControl *))); connect(m_toolBox, SIGNAL(currentIndexChanged(int)), q, SLOT(toolSelected(int))); setupActions(); } AnalyzerManager::AnalyzerManagerPrivate::~AnalyzerManagerPrivate() { // as we have to setParent(0) on dock widget that are not selected, // we keep track of all and make sure we don't leak any foreach(const DockPtr &ptr, m_dockWidgets) { if (ptr) delete ptr.data(); } } void AnalyzerManager::AnalyzerManagerPrivate::setupActions() { Core::ICore *core = Core::ICore::instance(); Core::ActionManager *am = core->actionManager(); Core::ActionContainer *mtools = am->actionContainer(ProjectExplorer::Constants::M_DEBUG); Core::ActionContainer *mAnalyzermenu = am->createMenu(Constants::M_TOOLS_ANALYZER); // Menus m_menu = mAnalyzermenu->menu(); m_menu->setTitle(tr("Start &Analyzer")); m_menu->setEnabled(true); mtools->addMenu(mAnalyzermenu); m_toolGroup = new QActionGroup(m_menu); connect(m_toolGroup, SIGNAL(triggered(QAction*)), q, SLOT(toolSelected(QAction*))); const Core::Context globalcontext(Core::Constants::C_GLOBAL); m_startAction = new QAction(tr("Start"), m_menu); m_startAction->setIcon(QIcon(QLatin1String(":/images/analyzer_start_small.png"))); Core::Command *command = am->registerAction(m_startAction, Constants::START, globalcontext); mAnalyzermenu->addAction(command); connect(m_startAction, SIGNAL(triggered()), q, SLOT(startTool())); m_stopAction = new QAction(tr("Stop"), m_menu); m_stopAction->setEnabled(false); m_stopAction->setIcon(QIcon(QLatin1String(":/debugger/images/debugger_stop_small.png"))); command = am->registerAction(m_stopAction, Constants::STOP, globalcontext); mAnalyzermenu->addAction(command); connect(m_stopAction, SIGNAL(triggered()), q, SLOT(stopTool())); m_menu->addSeparator(); m_viewsMenu = am->actionContainer(Core::Id(Core::Constants::M_WINDOW_VIEWS)); } void AnalyzerManager::AnalyzerManagerPrivate::delayedInit() { if (m_initialized) return; if (useAnalyzeMode) { m_mode = new AnalyzerMode(q); m_mode->setWidget(createModeContents()); AnalyzerPlugin::instance()->addAutoReleasedObject(m_mode); } m_initialized = true; } QWidget *AnalyzerManager::AnalyzerManagerPrivate::createModeContents() { QTC_ASSERT(useAnalyzeMode, return 0; ) // right-side window with editor, output etc. MiniSplitter *mainWindowSplitter = new MiniSplitter; mainWindowSplitter->addWidget(createModeMainWindow()); mainWindowSplitter->addWidget(new OutputPanePlaceHolder(m_mode, mainWindowSplitter)); mainWindowSplitter->setStretchFactor(0, 10); mainWindowSplitter->setStretchFactor(1, 0); mainWindowSplitter->setOrientation(Qt::Vertical); // navigation + right-side window MiniSplitter *splitter = new MiniSplitter; splitter->addWidget(new NavigationWidgetPlaceHolder(m_mode)); splitter->addWidget(mainWindowSplitter); splitter->setStretchFactor(0, 0); splitter->setStretchFactor(1, 1); return splitter; } static QToolButton *toolButton(QAction *action) { QToolButton *button = new QToolButton; button->setDefaultAction(action); return button; } void AnalyzerManager::addOutputPaneToolBarWidgets(QWidgetList *list) const { list->prepend(d->m_toolBox); list->prepend(toolButton(d->m_stopAction)); list->prepend(toolButton(d->m_startAction)); (*list) << new Utils::StyledSeparator << d->m_statusLabel; } QWidget *AnalyzerManager::AnalyzerManagerPrivate::createModeMainWindow() { QTC_ASSERT(useAnalyzeMode, return 0; ) m_mainWindow = new Utils::FancyMainWindow(); m_mainWindow->setObjectName(QLatin1String("AnalyzerManagerMainWindow")); connect(m_mainWindow, SIGNAL(resetLayout()), q, SLOT(resetLayout())); m_mainWindow->setDocumentMode(true); m_mainWindow->setDockNestingEnabled(true); m_mainWindow->setDockActionsVisible(ModeManager::instance()->currentMode()->id() == Constants::MODE_ANALYZE); QBoxLayout *editorHolderLayout = new QVBoxLayout; editorHolderLayout->setMargin(0); editorHolderLayout->setSpacing(0); QWidget *editorAndFindWidget = new QWidget; editorAndFindWidget->setLayout(editorHolderLayout); editorHolderLayout->addWidget(new EditorManagerPlaceHolder(m_mode)); editorHolderLayout->addWidget(new FindToolBarPlaceHolder(editorAndFindWidget)); MiniSplitter *documentAndRightPane = new MiniSplitter; documentAndRightPane->addWidget(editorAndFindWidget); documentAndRightPane->addWidget(new RightPanePlaceHolder(m_mode)); documentAndRightPane->setStretchFactor(0, 1); documentAndRightPane->setStretchFactor(1, 0); QWidget *centralWidget = new QWidget; m_mainWindow->setCentralWidget(centralWidget); QVBoxLayout *centralLayout = new QVBoxLayout(centralWidget); centralWidget->setLayout(centralLayout); centralLayout->setMargin(0); centralLayout->setSpacing(0); centralLayout->addWidget(documentAndRightPane); centralLayout->setStretch(0, 1); centralLayout->setStretch(1, 0); return m_mainWindow; } void AnalyzerManager::AnalyzerManagerPrivate::addDock(IAnalyzerTool *tool, Qt::DockWidgetArea area, QDockWidget *dockWidget) { QTC_ASSERT(useAnalyzeMode && tool == q->currentTool(), return) dockWidget->setParent(m_mainWindow); m_mainWindow->addDockWidget(area, dockWidget); Context globalContext(Core::Constants::C_GLOBAL); ActionManager *am = ICore::instance()->actionManager(); QAction *toggleViewAction = dockWidget->toggleViewAction(); toggleViewAction->setText(dockWidget->windowTitle()); Command *cmd = am->registerAction(toggleViewAction, QString("Analyzer." + dockWidget->objectName()), globalContext); cmd->setAttribute(Command::CA_Hide); m_viewsMenu->addAction(cmd); /* TODO: save settings connect(dockWidget->toggleViewAction(), SIGNAL(triggered(bool)), SLOT(updateDockWidgetSettings())); connect(dockWidget, SIGNAL(topLevelChanged(bool)), SLOT(updateDockWidgetSettings())); connect(dockWidget, SIGNAL(dockLocationChanged(Qt::DockWidgetArea)), SLOT(updateDockWidgetSettings())); */ // just add the dock below the toolbar by default m_mainWindow->splitDockWidget(m_mainWindow->toolBarDockWidget(), dockWidget, Qt::Vertical); dockWidget->show(); } bool buildTypeAcceppted(IAnalyzerTool::ToolMode toolMode, ProjectExplorer::BuildConfiguration::BuildType buildType) { if (toolMode == IAnalyzerTool::AnyMode) return true; else if (buildType == ProjectExplorer::BuildConfiguration::Unknown) return true; else if (buildType == ProjectExplorer::BuildConfiguration::Debug && toolMode == IAnalyzerTool::DebugMode) return true; else if (buildType == ProjectExplorer::BuildConfiguration::Release && toolMode == IAnalyzerTool::ReleaseMode) return true; else return false; } void AnalyzerManager::AnalyzerManagerPrivate::startTool() { QTC_ASSERT(!m_currentRunControl && q->currentTool(), return); // make sure our mode is shown m_outputpane->popup(); if (m_mode) ModeManager::instance()->activateMode(m_mode->id()); ProjectExplorer::ProjectExplorerPlugin *pe = ProjectExplorer::ProjectExplorerPlugin::instance(); // ### not sure if we're supposed to check if the RunConFiguration isEnabled ProjectExplorer::Project *pro = pe->startupProject(); const ProjectExplorer::RunConfiguration *runConfig = 0; ProjectExplorer::BuildConfiguration::BuildType buildType = ProjectExplorer::BuildConfiguration::Unknown; if (pro) { if (const ProjectExplorer::Target *target = pro->activeTarget()) { runConfig = target->activeRunConfiguration(); // Build configuration is 0 for QML projects. if (const ProjectExplorer::BuildConfiguration *buildConfig = target->activeBuildConfiguration()) buildType = buildConfig->buildType(); } } if (!runConfig || !runConfig->isEnabled()) return; IAnalyzerTool::ToolMode toolMode = q->currentTool()->mode(); // check the project for whether the build config is in the correct mode // if not, notify the user and urge him to use the correct mode if (!buildTypeAcceppted(toolMode, buildType)) { const QString &toolName = q->currentTool()->displayName(); const QString &toolMode = q->currentTool()->modeString(); const QString currentMode = buildType == ProjectExplorer::BuildConfiguration::Debug ? tr("Debug") : tr("Release"); QSettings *settings = Core::ICore::instance()->settings(); const QString configKey = QLatin1String(Constants::MODE_ANALYZE) + QLatin1Char('/') + QLatin1String("AnalyzeCorrectMode"); int ret; if (settings->contains(configKey)) { ret = settings->value(configKey, QDialog::Accepted).toInt(); } else { const QString title = tr("Run %1 in %2 Mode?").arg(toolName).arg(currentMode); const QString message = tr("

You are trying to run the tool '%1' on an application in %2 mode. " "The tool is designed to be used in %3 mode.

" "Do you want to continue and run it in %2 mode?

"). arg(toolName).arg(currentMode).arg(toolMode); const QString checkBoxText = tr("&Do not ask again"); bool checkBoxSetting = false; const QDialogButtonBox::StandardButton button = Utils::CheckableMessageBox::question(Core::ICore::instance()->mainWindow(), title, message, checkBoxText, &checkBoxSetting, QDialogButtonBox::Yes|QDialogButtonBox::Cancel, QDialogButtonBox::Cancel); ret = button == QDialogButtonBox::Yes ? QDialog::Accepted : QDialog::Rejected; if (checkBoxSetting && ret == QDialog::Accepted) settings->setValue(configKey, ret); } if (ret == QDialog::Rejected) return; } pe->runProject(pro, Constants::MODE_ANALYZE); m_startAction->setEnabled(false); m_stopAction->setEnabled(true); m_toolBox->setEnabled(false); m_toolGroup->setEnabled(false); } // AnalyzerManager //////////////////////////////////////////////////// AnalyzerManager *AnalyzerManager::m_instance = 0; AnalyzerManager::AnalyzerManager(AnalyzerOutputPane *op, QObject *parent) : QObject(parent), d(new AnalyzerManagerPrivate(this)) { m_instance = this; d->m_outputpane = op; if (useAnalyzeMode) connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)), this, SLOT(modeChanged(Core::IMode*))); ProjectExplorer::ProjectExplorerPlugin *pe = ProjectExplorer::ProjectExplorerPlugin::instance(); connect(pe, SIGNAL(updateRunActions()), this, SLOT(updateRunActions())); } AnalyzerManager::~AnalyzerManager() { delete d; } bool AnalyzerManager::isInitialized() const { return d->m_initialized; } void AnalyzerManager::shutdown() { if (useAnalyzeMode) saveToolSettings(currentTool()); } AnalyzerManager * AnalyzerManager::instance() { return m_instance; } void AnalyzerManager::modeChanged(IMode *mode) { QTC_ASSERT(d->m_mainWindow, return; ) const bool makeVisible = mode->id() == Constants::MODE_ANALYZE; if (!makeVisible) return; d->m_mainWindow->setDockActionsVisible(makeVisible); } void AnalyzerManager::selectTool(IAnalyzerTool *tool) { QTC_ASSERT(d->m_tools.contains(tool), return); toolSelected(d->m_tools.indexOf(tool)); } void AnalyzerManager::toolSelected(int idx) { static bool selectingTool = false; if (selectingTool) return; selectingTool = true; IAnalyzerTool *oldTool = currentTool(); if (useAnalyzeMode && oldTool != 0) { saveToolSettings(oldTool); ActionManager *am = ICore::instance()->actionManager(); foreach(const AnalyzerManagerPrivate::ToolWidgetPair &widget, d->m_toolWidgets.value(oldTool)) { QAction *toggleViewAction = widget.second->toggleViewAction(); am->unregisterAction(toggleViewAction, QString("Analyzer." + widget.second->objectName())); d->m_mainWindow->removeDockWidget(widget.second); ///NOTE: QMainWindow (and FancyMainWindow) just look at @c findChildren() ///if we don't do this, all kind of havoc might happen, including: ///- improper saveState/restoreState ///- improper list of qdockwidgets in popup menu ///- ... widget.second->setParent(0); } } d->m_toolGroup->actions().at(idx)->setChecked(true); d->m_toolBox->setCurrentIndex(idx); IAnalyzerTool *newTool = currentTool(); if (useAnalyzeMode) { foreach (const AnalyzerManagerPrivate::ToolWidgetPair &widget, d->m_toolWidgets.value(newTool)) { d->addDock(newTool, widget.first, widget.second); } loadToolSettings(newTool); } d->m_outputpane->setTool(newTool); selectingTool = false; } void AnalyzerManager::toolSelected(QAction *action) { toolSelected(d->m_toolGroup->actions().indexOf(action)); } void AnalyzerManager::addTool(IAnalyzerTool *tool) { d->delayedInit(); // be sure that there is a valid IMode instance Internal::AnalyzerPlugin *plugin = Internal::AnalyzerPlugin::instance(); QAction *action = new QAction(tool->displayName(), d->m_toolGroup); action->setData(d->m_tools.count()); action->setCheckable(true); d->m_menu->addAction(action); d->m_toolGroup->setVisible(d->m_toolGroup->actions().count() > 1); d->m_tools.append(tool); d->m_toolBox->addItem(tool->displayName()); d->m_toolBox->setEnabled(d->m_toolBox->count() > 1); if (currentTool() != tool) selectTool(tool); // the first tool gets selected automatically due to signal emission from toolbox tool->initialize(plugin); if (useAnalyzeMode) { QSettings *defaultSettings = new QSettings(this); d->m_defaultSettings[tool] = defaultSettings; d->m_mainWindow->saveSettings(defaultSettings); loadToolSettings(tool); } } QDockWidget *AnalyzerManager::createDockWidget(IAnalyzerTool *tool, const QString &title, QWidget *widget, Qt::DockWidgetArea area) { QTC_ASSERT(useAnalyzeMode && !widget->objectName().isEmpty(), return 0;); QDockWidget *dockWidget = d->m_mainWindow->addDockForWidget(widget); d->m_dockWidgets << AnalyzerManagerPrivate::DockPtr(dockWidget); dockWidget->setWindowTitle(title); d->m_toolWidgets[tool] << qMakePair(area, dockWidget); dockWidget->installEventFilter(d->m_resizeEventFilter); d->addDock(tool, area, dockWidget); return dockWidget; } IAnalyzerTool *AnalyzerManager::currentTool() const { if (!d->m_toolGroup->checkedAction()) { return 0; } return d->m_tools.value(d->m_toolGroup->checkedAction()->data().toInt()); } QList AnalyzerManager::tools() const { return d->m_tools; } void AnalyzerManager::startTool() { d->startTool(); } void AnalyzerManager::runControlCreated(AnalyzerRunControl *rc) { QTC_ASSERT(!d->m_currentRunControl, qt_noop()); d->m_currentRunControl = rc; connect(rc, SIGNAL(finished()), this, SLOT(handleToolFinished())); } void AnalyzerManager::stopTool() { if (!d->m_currentRunControl) return; d->m_currentRunControl->stop(); handleToolFinished(); } void AnalyzerManager::handleToolFinished() { // this may run as a consequence of calling stopMemcheck() or valgrind may have terminated // for a different reason (application exited through user action, segfault, ...), so we // duplicate some code from stopMemcheck(). d->m_startAction->setEnabled(true); d->m_stopAction->setEnabled(false); d->m_toolBox->setEnabled(true); d->m_toolGroup->setEnabled(true); d->m_currentRunControl = 0; } Utils::FancyMainWindow *AnalyzerManager::mainWindow() const { return d->m_mainWindow; } void AnalyzerManager::resetLayout() { d->m_mainWindow->restoreSettings(d->m_defaultSettings.value(currentTool())); } void AnalyzerManager::loadToolSettings(IAnalyzerTool *tool) { QTC_ASSERT(d->m_mainWindow, return; ) QSettings *settings = Core::ICore::instance()->settings(); settings->beginGroup(QLatin1String("AnalyzerViewSettings_") + tool->id()); if (settings->value("ToolSettingsSaved", false).toBool()) { d->m_mainWindow->restoreSettings(settings); } settings->endGroup(); } void AnalyzerManager::saveToolSettings(IAnalyzerTool *tool) { if (!tool) return; // no active tool, do nothing QTC_ASSERT(d->m_mainWindow, return ; ) QSettings *settings = Core::ICore::instance()->settings(); settings->beginGroup(QLatin1String("AnalyzerViewSettings_") + tool->id()); d->m_mainWindow->saveSettings(settings); settings->setValue("ToolSettingsSaved", true); settings->endGroup(); } void AnalyzerManager::updateRunActions() { ProjectExplorer::ProjectExplorerPlugin *pe = ProjectExplorer::ProjectExplorerPlugin::instance(); ProjectExplorer::Project *project = pe->startupProject(); bool startEnabled = !d->m_currentRunControl && pe->canRun(project, Constants::MODE_ANALYZE) && currentTool(); d->m_startAction->setEnabled(startEnabled); } void AnalyzerManager::showStatusMessage(const QString &message, int timeoutMS) { d->m_statusLabel->showStatusMessage(message, timeoutMS); } void AnalyzerManager::showPermanentStatusMessage(const QString &message) { showStatusMessage(message, -1); } QString AnalyzerManager::msgToolStarted(const QString &name) { return tr("Tool '%1' started...").arg(name); } QString AnalyzerManager::msgToolFinished(const QString &name, int issuesFound) { return issuesFound ? tr("Tool '%1' finished, %n issues were found.", 0, issuesFound).arg(name) : tr("Tool '%1' finished, no issues were found.").arg(name); } #include "analyzermanager.moc"