/**************************************************************************** ** ** Copyright (C) 2015 The Qt Company Ltd. ** Contact: http://www.qt.io/licensing ** Author: Andreas Hartmetz, KDAB (andreas.hartmetz@kdab.com) ** ** This file is part of Qt Creator. ** ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms and ** conditions see http://www.qt.io/terms-conditions. For further information ** use the contact form at http://www.qt.io/contact-us. ** ** 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 or version 3 as published by the Free ** Software Foundation and appearing in the file LICENSE.LGPLv21 and ** LICENSE.LGPLv3 included in the packaging of this file. Please review the ** following information to ensure the GNU Lesser General Public License ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, The Qt Company gives you certain additional ** rights. These rights are described in The Qt Company LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ****************************************************************************/ #include "analyzermanager.h" #include "analyzerplugin.h" #include "analyzerstartparameters.h" #include "ianalyzertool.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 using namespace Core; using namespace Utils; using namespace Core::Constants; using namespace Analyzer::Internal; using namespace Analyzer::Constants; using namespace ProjectExplorer; namespace Analyzer { namespace Internal { const char LAST_ACTIVE_TOOL[] = "Analyzer.Plugin.LastActiveTool"; const char INITIAL_DOCK_AREA[] = "initial_dock_area"; //////////////////////////////////////////////////////////////////// // // AnalyzerMode // //////////////////////////////////////////////////////////////////// class AnalyzerMode : public IMode { public: AnalyzerMode(QObject *parent = 0) : IMode(parent) { setContext(Context(C_ANALYZEMODE, C_NAVIGATION_PANE)); setDisplayName(AnalyzerManager::tr("Analyze")); setIcon(QIcon(QLatin1String(":/images/mode_analyze.png"))); setPriority(P_MODE_ANALYZE); setId(MODE_ANALYZE); } ~AnalyzerMode() { delete m_widget; m_widget = 0; } }; } // namespace Internal //////////////////////////////////////////////////////////////////// // // AnalyzerManagerPrivate // //////////////////////////////////////////////////////////////////// class AnalyzerManagerPrivate : public QObject { Q_DECLARE_TR_FUNCTIONS(Analyzer::AnalyzerManager) public: typedef QHash FancyMainWindowSettings; AnalyzerManagerPrivate(AnalyzerManager *qq); ~AnalyzerManagerPrivate(); /** * After calling this, a proper instance of IMode 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(); void createModeMainWindow(); bool showPromptDialog(const QString &title, const QString &text, const QString &stopButtonText, const QString &cancelButtonText) const; void activateDock(Qt::DockWidgetArea area, QDockWidget *dockWidget); void deactivateDock(QDockWidget *dockWidget); void addAction(AnalyzerAction *action); void selectSavedTool(); void selectAction(AnalyzerAction *action); void handleToolStarted(); void handleToolFinished(); void saveToolSettings(Id toolId); void loadToolSettings(Id toolId); void startCurrentTool(); void selectToolboxAction(const QString &item); void modeChanged(IMode *mode); void resetLayout(); void updateRunActions(); public: AnalyzerManager *q; AnalyzerMode *m_mode; bool m_isRunning; FancyMainWindow *m_mainWindow; AnalyzerAction *m_currentAction; QList m_actions; QAction *m_startAction; QAction *m_stopAction; ActionContainer *m_menu; QComboBox *m_toolBox; QStackedWidget *m_controlsStackWidget; QStackedWidget *m_statusLabelsStackWidget; typedef QMap MainWindowSettingsMap; QHash > m_toolWidgets; QHash m_controlsWidgetFromTool; QHash m_statusLabelsPerTool; MainWindowSettingsMap m_defaultSettings; // list of dock widgets to prevent memory leak typedef QPointer DockPtr; QList m_dockWidgets; private: void rebuildToolBox(); }; AnalyzerManagerPrivate::AnalyzerManagerPrivate(AnalyzerManager *qq): q(qq), m_mode(0), m_isRunning(false), m_mainWindow(0), m_currentAction(0), m_startAction(0), m_stopAction(0), m_menu(0), m_toolBox(new QComboBox), m_controlsStackWidget(new QStackedWidget), m_statusLabelsStackWidget(new QStackedWidget) { m_toolBox->setObjectName(QLatin1String("AnalyzerManagerToolBox")); connect(m_toolBox, static_cast(&QComboBox::activated), this, &AnalyzerManagerPrivate::selectToolboxAction); setupActions(); ProjectExplorerPlugin *pe = ProjectExplorerPlugin::instance(); connect(pe, &ProjectExplorerPlugin::updateRunActions, this, &AnalyzerManagerPrivate::updateRunActions); } 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 AnalyzerManagerPrivate::setupActions() { Command *command = 0; // Menus m_menu = ActionManager::createMenu(M_DEBUG_ANALYZER); m_menu->menu()->setTitle(tr("&Analyze")); m_menu->menu()->setEnabled(true); m_menu->appendGroup(G_ANALYZER_CONTROL); m_menu->appendGroup(G_ANALYZER_TOOLS); m_menu->appendGroup(G_ANALYZER_REMOTE_TOOLS); m_menu->appendGroup(G_ANALYZER_OPTIONS); ActionContainer *menubar = ActionManager::actionContainer(MENU_BAR); ActionContainer *mtools = ActionManager::actionContainer(M_TOOLS); menubar->addMenu(mtools, m_menu); m_startAction = new QAction(tr("Start"), m_menu); m_startAction->setIcon(QIcon(QLatin1String(ANALYZER_CONTROL_START_ICON))); ActionManager::registerAction(m_startAction, "Analyzer.Start"); connect(m_startAction, &QAction::triggered, this, &AnalyzerManagerPrivate::startCurrentTool); m_stopAction = new QAction(tr("Stop"), m_menu); m_stopAction->setEnabled(false); m_stopAction->setIcon(QIcon(QLatin1String(ANALYZER_CONTROL_STOP_ICON))); command = ActionManager::registerAction(m_stopAction, "Analyzer.Stop"); m_menu->addAction(command, G_ANALYZER_CONTROL); m_menu->addSeparator(G_ANALYZER_TOOLS); m_menu->addSeparator(G_ANALYZER_REMOTE_TOOLS); m_menu->addSeparator(G_ANALYZER_OPTIONS); } void AnalyzerManagerPrivate::delayedInit() { if (m_mode) return; m_mode = new AnalyzerMode(q); createModeMainWindow(); connect(ModeManager::instance(), &ModeManager::currentModeChanged, this, &AnalyzerManagerPrivate::modeChanged); // Right-side window with editor, output etc. auto mainWindowSplitter = new MiniSplitter; mainWindowSplitter->addWidget(m_mainWindow); mainWindowSplitter->addWidget(new OutputPanePlaceHolder(m_mode, mainWindowSplitter)); mainWindowSplitter->setStretchFactor(0, 10); mainWindowSplitter->setStretchFactor(1, 0); mainWindowSplitter->setOrientation(Qt::Vertical); // Navigation + right-side window. auto splitter = new MiniSplitter; splitter->addWidget(new NavigationWidgetPlaceHolder(m_mode)); splitter->addWidget(mainWindowSplitter); splitter->setStretchFactor(0, 0); splitter->setStretchFactor(1, 1); auto modeContextObject = new IContext(this); modeContextObject->setContext(Context(C_EDITORMANAGER)); modeContextObject->setWidget(splitter); ICore::addContextObject(modeContextObject); m_mode->setWidget(splitter); AnalyzerPlugin::instance()->addAutoReleasedObject(m_mode); // Populate Windows->Views menu with standard actions. Context analyzerContext(C_ANALYZEMODE); ActionContainer *viewsMenu = ActionManager::actionContainer(M_WINDOW_VIEWS); Command *cmd = ActionManager::registerAction(m_mainWindow->menuSeparator1(), "Analyzer.Views.Separator1", analyzerContext); cmd->setAttribute(Command::CA_Hide); viewsMenu->addAction(cmd, G_DEFAULT_THREE); cmd = ActionManager::registerAction(m_mainWindow->autoHideTitleBarsAction(), "Analyzer.Views.AutoHideTitleBars", analyzerContext); cmd->setAttribute(Command::CA_Hide); viewsMenu->addAction(cmd, G_DEFAULT_THREE); cmd = ActionManager::registerAction(m_mainWindow->menuSeparator2(), "Analyzer.Views.Separator2", analyzerContext); cmd->setAttribute(Command::CA_Hide); viewsMenu->addAction(cmd, G_DEFAULT_THREE); cmd = ActionManager::registerAction(m_mainWindow->resetLayoutAction(), "Analyzer.Views.ResetSimple", analyzerContext); cmd->setAttribute(Command::CA_Hide); viewsMenu->addAction(cmd, G_DEFAULT_THREE); } static QToolButton *toolButton(QAction *action) { auto button = new QToolButton; button->setDefaultAction(action); return button; } void AnalyzerManagerPrivate::createModeMainWindow() { m_mainWindow = new FancyMainWindow(); m_mainWindow->setObjectName(QLatin1String("AnalyzerManagerMainWindow")); m_mainWindow->setDocumentMode(true); m_mainWindow->setDockNestingEnabled(true); m_mainWindow->setDockActionsVisible(false); connect(m_mainWindow, &FancyMainWindow::resetLayout, this, &AnalyzerManagerPrivate::resetLayout); auto editorHolderLayout = new QVBoxLayout; editorHolderLayout->setMargin(0); editorHolderLayout->setSpacing(0); auto editorAndFindWidget = new QWidget; editorAndFindWidget->setLayout(editorHolderLayout); editorHolderLayout->addWidget(new EditorManagerPlaceHolder(m_mode)); editorHolderLayout->addWidget(new FindToolBarPlaceHolder(editorAndFindWidget)); auto documentAndRightPane = new MiniSplitter; documentAndRightPane->addWidget(editorAndFindWidget); documentAndRightPane->addWidget(new RightPanePlaceHolder(m_mode)); documentAndRightPane->setStretchFactor(0, 1); documentAndRightPane->setStretchFactor(1, 0); auto analyzeToolBar = new StyledBar; analyzeToolBar->setProperty("topBorder", true); auto analyzeToolBarLayout = new QHBoxLayout(analyzeToolBar); analyzeToolBarLayout->setMargin(0); analyzeToolBarLayout->setSpacing(0); analyzeToolBarLayout->addWidget(toolButton(m_startAction)); analyzeToolBarLayout->addWidget(toolButton(m_stopAction)); analyzeToolBarLayout->addWidget(new StyledSeparator); analyzeToolBarLayout->addWidget(m_toolBox); analyzeToolBarLayout->addWidget(m_controlsStackWidget); analyzeToolBarLayout->addWidget(m_statusLabelsStackWidget); analyzeToolBarLayout->addStretch(); auto dock = new QDockWidget(tr("Analyzer Toolbar")); dock->setObjectName(QLatin1String("Analyzer Toolbar")); dock->setWidget(analyzeToolBar); dock->setFeatures(QDockWidget::NoDockWidgetFeatures); dock->setProperty("managed_dockwidget", QLatin1String("true")); dock->setAllowedAreas(Qt::BottomDockWidgetArea); // hide title bar dock->setTitleBarWidget(new QWidget(dock)); m_mainWindow->addDockWidget(Qt::BottomDockWidgetArea, dock); m_mainWindow->setToolBarDockWidget(dock); auto centralWidget = new QWidget; m_mainWindow->setCentralWidget(centralWidget); auto centralLayout = new QVBoxLayout(centralWidget); centralWidget->setLayout(centralLayout); centralLayout->setMargin(0); centralLayout->setSpacing(0); centralLayout->addWidget(documentAndRightPane); centralLayout->setStretch(0, 1); centralLayout->setStretch(1, 0); } void AnalyzerManagerPrivate::activateDock(Qt::DockWidgetArea area, QDockWidget *dockWidget) { dockWidget->setParent(m_mainWindow); m_mainWindow->addDockWidget(area, dockWidget); QAction *toggleViewAction = dockWidget->toggleViewAction(); toggleViewAction->setText(dockWidget->windowTitle()); Command *cmd = ActionManager::registerAction(toggleViewAction, Id("Analyzer.").withSuffix(dockWidget->objectName())); cmd->setAttribute(Command::CA_Hide); ActionContainer *viewsMenu = ActionManager::actionContainer(Id(M_WINDOW_VIEWS)); viewsMenu->addAction(cmd); } void AnalyzerManagerPrivate::deactivateDock(QDockWidget *dockWidget) { QAction *toggleViewAction = dockWidget->toggleViewAction(); ActionManager::unregisterAction(toggleViewAction, Id("Analyzer.").withSuffix(dockWidget->objectName())); m_mainWindow->removeDockWidget(dockWidget); dockWidget->hide(); // Prevent saveState storing the data of the wrong children. dockWidget->setParent(0); } bool AnalyzerManagerPrivate::showPromptDialog(const QString &title, const QString &text, const QString &stopButtonText, const QString &cancelButtonText) const { CheckableMessageBox messageBox(ICore::mainWindow()); messageBox.setWindowTitle(title); messageBox.setText(text); messageBox.setStandardButtons(QDialogButtonBox::Yes|QDialogButtonBox::Cancel); if (!stopButtonText.isEmpty()) messageBox.button(QDialogButtonBox::Yes)->setText(stopButtonText); if (!cancelButtonText.isEmpty()) messageBox.button(QDialogButtonBox::Cancel)->setText(cancelButtonText); messageBox.setDefaultButton(QDialogButtonBox::Yes); messageBox.setCheckBoxVisible(false); messageBox.exec(); return messageBox.clickedStandardButton() == QDialogButtonBox::Yes; } void AnalyzerManagerPrivate::startCurrentTool() { QTC_ASSERT(m_currentAction, return); m_currentAction->startTool(); } void AnalyzerManagerPrivate::modeChanged(IMode *mode) { if (mode && mode == m_mode) { m_mainWindow->setDockActionsVisible(true); static bool firstTime = !m_currentAction; if (firstTime) selectSavedTool(); firstTime = false; updateRunActions(); } else { m_mainWindow->setDockActionsVisible(false); } } void AnalyzerManagerPrivate::selectSavedTool() { const QSettings *settings = ICore::settings(); if (settings->contains(QLatin1String(LAST_ACTIVE_TOOL))) { const Id lastAction = Id::fromSetting(settings->value(QLatin1String(LAST_ACTIVE_TOOL))); foreach (AnalyzerAction *action, m_actions) { if (action->toolId() == lastAction) { selectAction(action); return; } } } // fallback to first available tool if (!m_actions.isEmpty()) selectAction(m_actions.first()); } void AnalyzerManagerPrivate::selectToolboxAction(const QString &item) { selectAction(Utils::findOrDefault(m_actions, [item](const AnalyzerAction *action) { return action->text() == item; })); } void AnalyzerManagerPrivate::selectAction(AnalyzerAction *action) { QTC_ASSERT(action, return); if (m_currentAction == action) return; const int toolboxIndex = m_toolBox->findText(action->text()); QTC_ASSERT(toolboxIndex >= 0, return); // Clean up old tool. if (m_currentAction) { saveToolSettings(m_currentAction->toolId()); foreach (QDockWidget *widget, m_toolWidgets.value(m_currentAction->toolId())) deactivateDock(widget); } // Now change the tool. m_currentAction = action; Id toolId = action->toolId(); if (!m_defaultSettings.contains(toolId)) { QWidget *widget = action->createWidget(); QTC_CHECK(widget); m_defaultSettings.insert(toolId, m_mainWindow->saveSettings()); QTC_CHECK(!m_controlsWidgetFromTool.contains(toolId)); m_controlsWidgetFromTool[toolId] = widget; m_controlsStackWidget->addWidget(widget); StatusLabel * const toolStatusLabel = new StatusLabel; m_statusLabelsPerTool[toolId] = toolStatusLabel; m_statusLabelsStackWidget->addWidget(toolStatusLabel); } foreach (QDockWidget *widget, m_toolWidgets.value(toolId)) activateDock(Qt::DockWidgetArea(widget->property(INITIAL_DOCK_AREA).toInt()), widget); loadToolSettings(action->toolId()); QTC_CHECK(m_controlsWidgetFromTool.contains(toolId)); m_controlsStackWidget->setCurrentWidget(m_controlsWidgetFromTool.value(toolId)); m_statusLabelsStackWidget->setCurrentWidget(m_statusLabelsPerTool.value(toolId)); m_toolBox->setCurrentIndex(toolboxIndex); updateRunActions(); } void AnalyzerManagerPrivate::rebuildToolBox() { const bool blocked = m_toolBox->blockSignals(true); // Do not make current. QStringList integratedTools; QStringList externalTools; foreach (AnalyzerAction * const action, m_actions) { if (action->menuGroup() == Constants::G_ANALYZER_TOOLS) integratedTools << action->text(); else externalTools << action->text(); } m_toolBox->clear(); m_toolBox->addItems(integratedTools); m_toolBox->addItems(externalTools); if (!integratedTools.isEmpty() && !externalTools.isEmpty()) m_toolBox->insertSeparator(integratedTools.count()); m_toolBox->blockSignals(blocked); m_toolBox->setEnabled(true); } void AnalyzerManagerPrivate::addAction(AnalyzerAction *action) { delayedInit(); // Make sure that there is a valid IMode instance. Id menuGroup = action->menuGroup(); if (menuGroup.isValid()) { Command *command = ActionManager::registerAction(action, action->actionId()); m_menu->addAction(command, menuGroup); } m_actions.append(action); rebuildToolBox(); connect(action, &QAction::triggered, this, [this, action] { selectAction(action); action->startTool(); }); } void AnalyzerManagerPrivate::handleToolStarted() { m_isRunning = true; // FIXME: Make less global. updateRunActions(); } void AnalyzerManagerPrivate::handleToolFinished() { m_isRunning = false; updateRunActions(); } void AnalyzerManagerPrivate::loadToolSettings(Id toolId) { QTC_ASSERT(m_mainWindow, return); QSettings *settings = ICore::settings(); settings->beginGroup(QLatin1String("AnalyzerViewSettings_") + toolId.toString()); if (settings->value(QLatin1String("ToolSettingsSaved"), false).toBool()) m_mainWindow->restoreSettings(settings); else m_mainWindow->restoreSettings(m_defaultSettings.value(toolId)); settings->endGroup(); } void AnalyzerManagerPrivate::saveToolSettings(Id toolId) { QTC_ASSERT(m_mainWindow, return); QSettings *settings = ICore::settings(); settings->beginGroup(QLatin1String("AnalyzerViewSettings_") + toolId.toString()); m_mainWindow->saveSettings(settings); settings->setValue(QLatin1String("ToolSettingsSaved"), true); settings->endGroup(); settings->setValue(QLatin1String(LAST_ACTIVE_TOOL), toolId.toString()); } void AnalyzerManagerPrivate::updateRunActions() { QString disabledReason; bool enabled = true; if (m_isRunning) { disabledReason = tr("An analysis is still in progress."); enabled = false; } else if (!m_currentAction) { disabledReason = tr("No analyzer tool selected."); enabled = false; } else { enabled = m_currentAction->isRunnable(&disabledReason); } m_startAction->setEnabled(enabled); m_startAction->setToolTip(disabledReason); m_toolBox->setEnabled(!m_isRunning); m_stopAction->setEnabled(m_isRunning); foreach (AnalyzerAction *action, m_actions) action->setEnabled(!m_isRunning && action->isRunnable()); } //////////////////////////////////////////////////////////////////// // // AnalyzerManager // //////////////////////////////////////////////////////////////////// static AnalyzerManagerPrivate *d = 0; AnalyzerManager::AnalyzerManager(QObject *parent) : QObject(parent) { QTC_CHECK(d == 0); d = new AnalyzerManagerPrivate(this); } AnalyzerManager::~AnalyzerManager() { QTC_CHECK(d); delete d; d = 0; } void AnalyzerManager::shutdown() { if (d->m_currentAction) d->saveToolSettings(d->m_currentAction->toolId()); } void AnalyzerManager::addAction(AnalyzerAction *action) { d->addAction(action); } QDockWidget *AnalyzerManager::createDockWidget(Core::Id toolId, QWidget *widget, Qt::DockWidgetArea area) { QTC_ASSERT(!widget->objectName().isEmpty(), return 0); QDockWidget *dockWidget = d->m_mainWindow->addDockForWidget(widget); dockWidget->setProperty(INITIAL_DOCK_AREA, int(area)); d->m_dockWidgets.append(AnalyzerManagerPrivate::DockPtr(dockWidget)); d->m_toolWidgets[toolId].push_back(dockWidget); return dockWidget; } void AnalyzerManager::selectAction(Id actionId, bool alsoRunIt) { foreach (AnalyzerAction *action, d->m_actions) { if (action->actionId() == actionId) { d->selectAction(action); if (alsoRunIt) action->startTool(); } } } FancyMainWindow *AnalyzerManager::mainWindow() { return d->m_mainWindow; } void AnalyzerManagerPrivate::resetLayout() { QTC_ASSERT(m_currentAction, return); m_mainWindow->restoreSettings(m_defaultSettings.value(m_currentAction->toolId())); } void AnalyzerManager::showStatusMessage(Id toolId, const QString &message, int timeoutMS) { StatusLabel * const statusLabel = d->m_statusLabelsPerTool.value(toolId); QTC_ASSERT(statusLabel, return); statusLabel->showStatusMessage(message, timeoutMS); } void AnalyzerManager::showPermanentStatusMessage(Id toolId, const QString &message) { showStatusMessage(toolId, message, -1); } void AnalyzerManager::showMode() { if (d->m_mode) ModeManager::activateMode(d->m_mode->id()); } void AnalyzerManager::stopTool() { stopAction()->trigger(); } QAction *AnalyzerManager::stopAction() { return d->m_stopAction; } void AnalyzerManager::handleToolStarted() { d->handleToolStarted(); } void AnalyzerManager::handleToolFinished() { d->handleToolFinished(); } AnalyzerRunControl *AnalyzerManager::createRunControl( const AnalyzerStartParameters &sp, RunConfiguration *runConfiguration) { foreach (AnalyzerAction *action, d->m_actions) { if (action->runMode() == sp.runMode) return action->runControlCreator()(sp, runConfiguration); } return 0; } } // namespace Analyzer