modemanager.cpp 11.1 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
#include "modemanager.h"
hjk's avatar
hjk committed
31

con's avatar
con committed
32 33
#include "fancytabwidget.h"
#include "fancyactionbar.h"
34
#include "icore.h"
con's avatar
con committed
35 36
#include "mainwindow.h"

37
#include <coreplugin/actionmanager/actionmanager.h>
con's avatar
con committed
38 39 40
#include <coreplugin/coreconstants.h>
#include <coreplugin/imode.h>

41 42
#include <extensionsystem/pluginmanager.h>

hjk's avatar
hjk committed
43 44
#include <utils/qtcassert.h>

45 46 47
#include <QDebug>
#include <QMap>
#include <QVector>
48

49 50 51
#include <QSignalMapper>
#include <QShortcut>
#include <QAction>
con's avatar
con committed
52

53 54
namespace Core {

55 56 57 58 59 60 61 62 63
/*!
    \class Core::ModeManager

    The mode manager handles everything related to the instances of IMode
    that were added to the plugin manager's object pool as well as their
    buttons and the tool bar with the round buttons in the lower left
    corner of Qt Creator.
*/

64 65
struct ModeManagerPrivate
{
66 67 68
    Internal::MainWindow *m_mainWindow;
    Internal::FancyTabWidget *m_modeStack;
    Internal::FancyActionBar *m_actionBar;
69
    QMap<QAction*, int> m_actions;
70 71 72
    QVector<IMode*> m_modes;
    QVector<Command*> m_modeShortcuts;
    QSignalMapper *m_signalMapper;
73
    Context m_addedContexts;
74
    int m_oldCurrent;
Tobias Hunger's avatar
Tobias Hunger committed
75
    bool m_saveSettingsOnModeChange;
76 77
};

78 79
static ModeManagerPrivate *d;
static ModeManager *m_instance = 0;
80

81
static int indexOf(Id id)
82
{
83 84 85 86
    for (int i = 0; i < d->m_modes.count(); ++i) {
        if (d->m_modes.at(i)->id() == id)
            return i;
    }
87
    qDebug() << "Warning, no such mode:" << id.toString();
88
    return -1;
89
}
90

91
ModeManager::ModeManager(Internal::MainWindow *mainWindow,
92
                         Internal::FancyTabWidget *modeStack)
con's avatar
con committed
93
{
94 95 96 97 98 99
    m_instance = this;
    d = new ModeManagerPrivate();
    d->m_mainWindow = mainWindow;
    d->m_modeStack = modeStack;
    d->m_signalMapper = new QSignalMapper(this);
    d->m_oldCurrent = -1;
100 101
    d->m_actionBar = new Internal::FancyActionBar(modeStack);
    d->m_modeStack->addCornerWidget(d->m_actionBar);
Tobias Hunger's avatar
Tobias Hunger committed
102
    d->m_saveSettingsOnModeChange = false;
con's avatar
con committed
103

104 105
    connect(d->m_modeStack, SIGNAL(currentAboutToShow(int)), SLOT(currentTabAboutToChange(int)));
    connect(d->m_modeStack, SIGNAL(currentChanged(int)), SLOT(currentTabChanged(int)));
106
    connect(d->m_signalMapper, SIGNAL(mapped(int)), this, SLOT(slotActivateMode(int)));
Tobias Hunger's avatar
Tobias Hunger committed
107 108
    connect(ExtensionSystem::PluginManager::instance(), SIGNAL(initializationDone()), this, SLOT(handleStartup()));
    connect(ICore::instance(), SIGNAL(coreAboutToClose()), this, SLOT(handleShutdown()));
con's avatar
con committed
109 110 111 112 113
}

void ModeManager::init()
{
    QObject::connect(ExtensionSystem::PluginManager::instance(), SIGNAL(objectAdded(QObject*)),
114
                     m_instance, SLOT(objectAdded(QObject*)));
con's avatar
con committed
115
    QObject::connect(ExtensionSystem::PluginManager::instance(), SIGNAL(aboutToRemoveObject(QObject*)),
116
                     m_instance, SLOT(aboutToRemoveObject(QObject*)));
con's avatar
con committed
117 118
}

119 120 121
ModeManager::~ModeManager()
{
    delete d;
122 123
    d = 0;
    m_instance = 0;
124 125
}

con's avatar
con committed
126 127 128
void ModeManager::addWidget(QWidget *widget)
{
    // We want the actionbar to stay on the bottom
129
    // so d->m_modeStack->cornerWidgetCount() -1 inserts it at the position immediately above
con's avatar
con committed
130
    // the actionbar
131
    d->m_modeStack->insertCornerWidget(d->m_modeStack->cornerWidgetCount() -1, widget);
con's avatar
con committed
132 133
}

134
IMode *ModeManager::currentMode()
con's avatar
con committed
135
{
136
    int currentIndex = d->m_modeStack->currentIndex();
con's avatar
con committed
137 138
    if (currentIndex < 0)
        return 0;
139
    return d->m_modes.at(currentIndex);
con's avatar
con committed
140 141
}

142
IMode *ModeManager::mode(Id id)
con's avatar
con committed
143 144 145
{
    const int index = indexOf(id);
    if (index >= 0)
146
        return d->m_modes.at(index);
con's avatar
con committed
147 148 149
    return 0;
}

150
void ModeManager::activateModeType(Id type)
151
{
152 153
    if (currentMode() && currentMode()->type() == type)
        return;
154 155 156 157 158 159 160 161 162 163 164
    int index = -1;
    for (int i = 0; i < d->m_modes.count(); ++i) {
        if (d->m_modes.at(i)->type() == type) {
            index = i;
            break;
        }
    }
    if (index != -1)
        d->m_modeStack->setCurrentIndex(index);
}

165
void ModeManager::slotActivateMode(int id)
166
{
167
    m_instance->activateMode(Id::fromUniqueIdentifier(id));
168
    ICore::raiseWindow(d->m_modeStack);
169 170
}

171
void ModeManager::activateMode(Id id)
con's avatar
con committed
172 173 174
{
    const int index = indexOf(id);
    if (index >= 0)
175
        d->m_modeStack->setCurrentIndex(index);
con's avatar
con committed
176 177 178 179 180 181 182 183
}

void ModeManager::objectAdded(QObject *obj)
{
    IMode *mode = Aggregation::query<IMode>(obj);
    if (!mode)
        return;

184
    d->m_mainWindow->addContextObject(mode);
con's avatar
con committed
185 186 187

    // Count the number of modes with a higher priority
    int index = 0;
188
    foreach (const IMode *m, d->m_modes)
con's avatar
con committed
189 190 191
        if (m->priority() > mode->priority())
            ++index;

192 193 194
    d->m_modes.insert(index, mode);
    d->m_modeStack->insertTab(index, mode->widget(), mode->icon(), mode->displayName());
    d->m_modeStack->setTabEnabled(index, mode->isEnabled());
con's avatar
con committed
195 196

    // Register mode shortcut
197
    const Id shortcutId = mode->id().withPrefix("QtCreator.Mode.");
198
    QShortcut *shortcut = new QShortcut(d->m_mainWindow);
199
    shortcut->setWhatsThis(tr("Switch to <b>%1</b> mode").arg(mode->displayName()));
Eike Ziller's avatar
Eike Ziller committed
200
    Command *cmd = ActionManager::registerShortcut(shortcut, shortcutId, Context(Constants::C_GLOBAL));
con's avatar
con committed
201

202
    d->m_modeShortcuts.insert(index, cmd);
con's avatar
con committed
203
    connect(cmd, SIGNAL(keySequenceChanged()), this, SLOT(updateModeToolTip()));
204 205
    for (int i = 0; i < d->m_modeShortcuts.size(); ++i) {
        Command *currentCmd = d->m_modeShortcuts.at(i);
206 207 208
        // we need this hack with currentlyHasDefaultSequence
        // because we call setDefaultShortcut multiple times on the same cmd
        // and still expect the current shortcut to change with it
con's avatar
con committed
209 210
        bool currentlyHasDefaultSequence = (currentCmd->keySequence()
                                            == currentCmd->defaultKeySequence());
211 212
        currentCmd->setDefaultKeySequence(QKeySequence(UseMacShortcuts ? QString::fromLatin1("Meta+%1").arg(i+1)
                                                                       : QString::fromLatin1("Ctrl+%1").arg(i+1)));
con's avatar
con committed
213 214
        if (currentlyHasDefaultSequence)
            currentCmd->setKeySequence(currentCmd->defaultKeySequence());
con's avatar
con committed
215 216
    }

217
    d->m_signalMapper->setMapping(shortcut, mode->id().uniqueIdentifier());
218
    connect(shortcut, SIGNAL(activated()), d->m_signalMapper, SLOT(map()));
con's avatar
con committed
219 220
    connect(mode, SIGNAL(enabledStateChanged(bool)),
            this, SLOT(enabledStateChanged()));
con's avatar
con committed
221 222 223 224
}

void ModeManager::updateModeToolTip()
{
con's avatar
con committed
225
    Command *cmd = qobject_cast<Command *>(sender());
con's avatar
con committed
226
    if (cmd) {
227
        int index = d->m_modeShortcuts.indexOf(cmd);
con's avatar
con committed
228
        if (index != -1)
229
            d->m_modeStack->setTabToolTip(index, cmd->stringWithAppendedShortcut(cmd->shortcut()->whatsThis()));
con's avatar
con committed
230 231 232
    }
}

con's avatar
con committed
233 234 235 236
void ModeManager::enabledStateChanged()
{
    IMode *mode = qobject_cast<IMode *>(sender());
    QTC_ASSERT(mode, return);
237
    int index = d->m_modes.indexOf(mode);
con's avatar
con committed
238
    QTC_ASSERT(index >= 0, return);
239
    d->m_modeStack->setTabEnabled(index, mode->isEnabled());
240 241 242 243 244 245 246 247 248 249 250 251

    // Make sure we leave any disabled mode to prevent possible crashes:
    if (mode == currentMode() && !mode->isEnabled()) {
        // This assumes that there is always at least one enabled mode.
        for (int i = 0; i < d->m_modes.count(); ++i) {
            if (d->m_modes.at(i) != mode &&
                d->m_modes.at(i)->isEnabled()) {
                activateMode(d->m_modes.at(i)->id());
                break;
            }
        }
    }
con's avatar
con committed
252 253
}

Tobias Hunger's avatar
Tobias Hunger committed
254 255 256 257 258 259
void ModeManager::handleStartup()
{ d->m_saveSettingsOnModeChange = true; }

void ModeManager::handleShutdown()
{ d->m_saveSettingsOnModeChange = false; }

con's avatar
con committed
260 261 262 263 264 265
void ModeManager::aboutToRemoveObject(QObject *obj)
{
    IMode *mode = Aggregation::query<IMode>(obj);
    if (!mode)
        return;

266 267 268 269
    const int index = d->m_modes.indexOf(mode);
    d->m_modes.remove(index);
    d->m_modeShortcuts.remove(index);
    d->m_modeStack->removeTab(index);
con's avatar
con committed
270

271
    d->m_mainWindow->removeContextObject(mode);
con's avatar
con committed
272 273
}

274
void ModeManager::addAction(QAction *action, int priority)
con's avatar
con committed
275
{
276
    d->m_actions.insert(action, priority);
con's avatar
con committed
277 278 279

    // Count the number of commands with a higher priority
    int index = 0;
280
    foreach (int p, d->m_actions) {
con's avatar
con committed
281 282
        if (p > priority)
            ++index;
con's avatar
con committed
283
    }
con's avatar
con committed
284

285
    d->m_actionBar->insertAction(index, action);
con's avatar
con committed
286 287
}

288 289
void ModeManager::addProjectSelector(QAction *action)
{
290
    d->m_actionBar->addProjectSelector(action);
291
    d->m_actions.insert(0, INT_MAX);
292 293
}

con's avatar
con committed
294 295 296
void ModeManager::currentTabAboutToChange(int index)
{
    if (index >= 0) {
297
        IMode *mode = d->m_modes.at(index);
Tobias Hunger's avatar
Tobias Hunger committed
298 299 300
        if (mode) {
            if (d->m_saveSettingsOnModeChange)
                ICore::saveSettings();
con's avatar
con committed
301
            emit currentModeAboutToChange(mode);
Tobias Hunger's avatar
Tobias Hunger committed
302
        }
con's avatar
con committed
303 304 305 306 307 308 309
    }
}

void ModeManager::currentTabChanged(int index)
{
    // Tab index changes to -1 when there is no tab left.
    if (index >= 0) {
310
        IMode *mode = d->m_modes.at(index);
con's avatar
con committed
311 312 313 314

        // FIXME: This hardcoded context update is required for the Debug and Edit modes, since
        // they use the editor widget, which is already a context widget so the main window won't
        // go further up the parent tree to find the mode context.
hjk's avatar
hjk committed
315
        ICore::updateAdditionalContexts(d->m_addedContexts, mode->context());
316
        d->m_addedContexts = mode->context();
317

318
        IMode *oldMode = 0;
319 320 321
        if (d->m_oldCurrent >= 0)
            oldMode = d->m_modes.at(d->m_oldCurrent);
        d->m_oldCurrent = index;
322
        emit currentModeChanged(mode, oldMode);
con's avatar
con committed
323 324 325 326 327 328
    }
}

void ModeManager::setFocusToCurrentMode()
{
    IMode *mode = currentMode();
hjk's avatar
hjk committed
329
    QTC_ASSERT(mode, return);
con's avatar
con committed
330 331 332 333 334 335 336 337 338
    QWidget *widget = mode->widget();
    if (widget) {
        QWidget *focusWidget = widget->focusWidget();
        if (focusWidget)
            focusWidget->setFocus();
        else
            widget->setFocus();
    }
}
339

340
void ModeManager::setModeSelectorVisible(bool visible)
341
{
342 343 344 345 346 347
    d->m_modeStack->setSelectionWidgetVisible(visible);
}

bool ModeManager::isModeSelectorVisible()
{
    return d->m_modeStack->isSelectionWidgetVisible();
348 349
}

350 351
ModeManager *ModeManager::instance()
{
352
    return m_instance;
353 354 355
}

} // namespace Core