cppeditorplugin.cpp 15.5 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

30
#include "cppeditorplugin.h"
31

32
#include "cppclasswizard.h"
con's avatar
con committed
33 34 35
#include "cppeditor.h"
#include "cppeditorconstants.h"
#include "cppfilewizard.h"
36
#include "cpphoverhandler.h"
37
#include "cppoutline.h"
38
#include "cpptypehierarchy.h"
39
#include "cppsnippetprovider.h"
Leandro Melo's avatar
Leandro Melo committed
40
#include "cppquickfixassistant.h"
Nikolai Kosjar's avatar
Nikolai Kosjar committed
41
#include "cppquickfixes.h"
con's avatar
con committed
42

43
#include <coreplugin/actionmanager/actioncontainer.h>
44 45 46 47
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/coreconstants.h>
#include <coreplugin/fileiconprovider.h>
#include <coreplugin/icore.h>
48
#include <coreplugin/navigationwidget.h>
49 50
#include <coreplugin/progressmanager/progressmanager.h>
#include <cpptools/cpptoolsconstants.h>
51
#include <texteditor/texteditoractionhandler.h>
con's avatar
con committed
52
#include <texteditor/texteditorsettings.h>
53

54
#include <utils/hostosinfo.h>
con's avatar
con committed
55

56 57
#include <QCoreApplication>
#include <QStringList>
con's avatar
con committed
58

59
using namespace CppEditor;
con's avatar
con committed
60 61
using namespace CppEditor::Internal;

Leandro Melo's avatar
Leandro Melo committed
62 63
void registerQuickFixes(ExtensionSystem::IPlugin *plugIn);

64 65
enum { QUICKFIX_INTERVAL = 20 };

66
//////////////////////////// CppEditorFactory /////////////////////////////
con's avatar
con committed
67

68
CppEditorFactory::CppEditorFactory(CppEditorPlugin *owner) :
con's avatar
con committed
69 70 71
    m_owner(owner)
{
    m_mimeTypes << QLatin1String(CppEditor::Constants::C_SOURCE_MIMETYPE)
72 73 74 75
            << QLatin1String(CppEditor::Constants::C_HEADER_MIMETYPE)
            << QLatin1String(CppEditor::Constants::CPP_SOURCE_MIMETYPE)
            << QLatin1String(CppEditor::Constants::CPP_HEADER_MIMETYPE);

76 77 78 79 80 81 82 83 84 85
    if (!Utils::HostOsInfo::isMacHost() && !Utils::HostOsInfo::isWindowsHost()) {
        Core::FileIconProvider *iconProvider = Core::FileIconProvider::instance();
        Core::MimeDatabase *mimeDatabase = Core::ICore::mimeDatabase();
        iconProvider->registerIconOverlayForMimeType(QIcon(QLatin1String(":/cppeditor/images/qt_cpp.png")),
                                                     mimeDatabase->findByType(QLatin1String(CppEditor::Constants::CPP_SOURCE_MIMETYPE)));
        iconProvider->registerIconOverlayForMimeType(QIcon(QLatin1String(":/cppeditor/images/qt_c.png")),
                                                     mimeDatabase->findByType(QLatin1String(CppEditor::Constants::C_SOURCE_MIMETYPE)));
        iconProvider->registerIconOverlayForMimeType(QIcon(QLatin1String(":/cppeditor/images/qt_h.png")),
                                                     mimeDatabase->findByType(QLatin1String(CppEditor::Constants::CPP_HEADER_MIMETYPE)));
    }
con's avatar
con committed
86 87
}

hjk's avatar
hjk committed
88
Core::Id CppEditorFactory::id() const
con's avatar
con committed
89
{
90
    return Core::Id(CppEditor::Constants::CPPEDITOR_ID);
91 92 93 94
}

QString CppEditorFactory::displayName() const
{
95
    return qApp->translate("OpenWith::Editors", CppEditor::Constants::CPPEDITOR_DISPLAY_NAME);
con's avatar
con committed
96 97
}

98
Core::IEditor *CppEditorFactory::createEditor(QWidget *parent)
con's avatar
con committed
99
{
100
    CPPEditorWidget *editor = new CPPEditorWidget(parent);
con's avatar
con committed
101 102
    editor->setRevisionsVisible(true);
    m_owner->initializeEditor(editor);
103
    return editor->editor();
con's avatar
con committed
104 105
}

106
QStringList CppEditorFactory::mimeTypes() const
con's avatar
con committed
107 108 109 110
{
    return m_mimeTypes;
}

111
///////////////////////////////// CppEditorPlugin //////////////////////////////////
con's avatar
con committed
112

113
CppEditorPlugin *CppEditorPlugin::m_instance = 0;
con's avatar
con committed
114

115
CppEditorPlugin::CppEditorPlugin() :
con's avatar
con committed
116
    m_actionHandler(0),
117
    m_sortedOutline(false),
118 119
    m_renameSymbolUnderCursorAction(0),
    m_findUsagesAction(0),
120
    m_updateCodeModelAction(0),
Leandro Melo's avatar
Leandro Melo committed
121 122
    m_openTypeHierarchyAction(0),
    m_quickFixProvider(0)
con's avatar
con committed
123 124 125 126
{
    m_instance = this;
}

127
CppEditorPlugin::~CppEditorPlugin()
con's avatar
con committed
128 129 130 131 132
{
    delete m_actionHandler;
    m_instance = 0;
}

133
CppEditorPlugin *CppEditorPlugin::instance()
con's avatar
con committed
134 135 136 137
{
    return m_instance;
}

138
void CppEditorPlugin::initializeEditor(CPPEditorWidget *editor)
con's avatar
con committed
139 140 141
{
    m_actionHandler->setupActions(editor);

Orgad Shaneh's avatar
Orgad Shaneh committed
142
    editor->setLanguageSettingsId(CppTools::Constants::CPP_SETTINGS_ID);
143
    TextEditor::TextEditorSettings::instance()->initializeEditor(editor);
con's avatar
con committed
144

145
    // method combo box sorting
146 147
    connect(this, SIGNAL(outlineSortingChanged(bool)),
            editor, SLOT(setSortedOutline(bool)));
148 149
}

150
void CppEditorPlugin::setSortedOutline(bool sorted)
151
{
152 153
    m_sortedOutline = sorted;
    emit outlineSortingChanged(sorted);
154 155
}

156
bool CppEditorPlugin::sortedOutline() const
157
{
158
    return m_sortedOutline;
con's avatar
con committed
159 160
}

161
CppQuickFixAssistProvider *CppEditorPlugin::quickFixProvider() const
Leandro Melo's avatar
Leandro Melo committed
162 163 164
{
    return m_quickFixProvider;
}
165

166
bool CppEditorPlugin::initialize(const QStringList & /*arguments*/, QString *errorMessage)
con's avatar
con committed
167
{
hjk's avatar
hjk committed
168
    if (!Core::ICore::mimeDatabase()->addMimeTypes(QLatin1String(":/cppeditor/CppEditor.mimetypes.xml"), errorMessage))
con's avatar
con committed
169 170
        return false;

171
    addAutoReleasedObject(new CppEditorFactory(this));
172
    addAutoReleasedObject(new CppHoverHandler);
173
    addAutoReleasedObject(new CppOutlineWidgetFactory);
174
    addAutoReleasedObject(new CppTypeHierarchyFactory);
175
    addAutoReleasedObject(new CppSnippetProvider);
176

Leandro Melo's avatar
Leandro Melo committed
177 178
    m_quickFixProvider = new CppQuickFixAssistProvider;
    addAutoReleasedObject(m_quickFixProvider);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
179
    CppEditor::Internal::registerQuickFixes(this);
Roberto Raggi's avatar
Roberto Raggi committed
180

hjk's avatar
hjk committed
181
    QObject *core = Core::ICore::instance();
con's avatar
con committed
182 183
    CppFileWizard::BaseFileWizardParameters wizardParameters(Core::IWizard::FileWizard);

184
    wizardParameters.setCategory(QLatin1String(Constants::WIZARD_CATEGORY));
185 186
    wizardParameters.setDisplayCategory(QCoreApplication::translate(Constants::WIZARD_CATEGORY,
                                                                    Constants::WIZARD_TR_CATEGORY));
187
    wizardParameters.setDisplayName(tr("C++ Class"));
Friedemann Kleint's avatar
Friedemann Kleint committed
188 189
    wizardParameters.setId(QLatin1String("A.Class"));
    wizardParameters.setKind(Core::IWizard::ClassWizard);
190
    wizardParameters.setDescription(tr("Creates a C++ header and a source file for a new class that you can add to a C++ project."));
Friedemann Kleint's avatar
Friedemann Kleint committed
191
    addAutoReleasedObject(new CppClassWizard(wizardParameters, core));
con's avatar
con committed
192

Friedemann Kleint's avatar
Friedemann Kleint committed
193
    wizardParameters.setKind(Core::IWizard::FileWizard);
194
    wizardParameters.setDescription(tr("Creates a C++ source file that you can add to a C++ project."));
195
    wizardParameters.setDisplayName(tr("C++ Source File"));
Friedemann Kleint's avatar
Friedemann Kleint committed
196
    wizardParameters.setId(QLatin1String("B.Source"));
197
    addAutoReleasedObject(new CppFileWizard(wizardParameters, Source, core));
con's avatar
con committed
198

199
    wizardParameters.setDescription(tr("Creates a C++ header file that you can add to a C++ project."));
200
    wizardParameters.setDisplayName(tr("C++ Header File"));
Friedemann Kleint's avatar
Friedemann Kleint committed
201 202
    wizardParameters.setId(QLatin1String("C.Header"));
    addAutoReleasedObject(new CppFileWizard(wizardParameters, Header, core));
con's avatar
con committed
203

204
    Core::Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
205

Eike Ziller's avatar
Eike Ziller committed
206
    Core::ActionContainer *contextMenu= Core::ActionManager::createMenu(CppEditor::Constants::M_CONTEXT);
con's avatar
con committed
207

con's avatar
con committed
208
    Core::Command *cmd;
Eike Ziller's avatar
Eike Ziller committed
209
    Core::ActionContainer *cppToolsMenu = Core::ActionManager::actionContainer(Core::Id(CppTools::Constants::M_TOOLS_CPP));
con's avatar
con committed
210

Eike Ziller's avatar
Eike Ziller committed
211
    cmd = Core::ActionManager::command(Core::Id(CppTools::Constants::SWITCH_HEADER_SOURCE));
212 213
    contextMenu->addAction(cmd);

Eike Ziller's avatar
Eike Ziller committed
214
    cmd = Core::ActionManager::command(TextEditor::Constants::FOLLOW_SYMBOL_UNDER_CURSOR);
mae's avatar
mae committed
215
    contextMenu->addAction(cmd);
216
    cppToolsMenu->addAction(cmd);
con's avatar
con committed
217

218
    QAction *switchDeclarationDefinition = new QAction(tr("Switch Between Method Declaration/Definition"), this);
Eike Ziller's avatar
Eike Ziller committed
219
    cmd = Core::ActionManager::registerAction(switchDeclarationDefinition,
220
        Constants::SWITCH_DECLARATION_DEFINITION, context, true);
221
    cmd->setDefaultKeySequence(QKeySequence(tr("Shift+F2")));
con's avatar
con committed
222 223
    connect(switchDeclarationDefinition, SIGNAL(triggered()),
            this, SLOT(switchDeclarationDefinition()));
mae's avatar
mae committed
224
    contextMenu->addAction(cmd);
225
    cppToolsMenu->addAction(cmd);
con's avatar
con committed
226

227 228 229 230
    cmd = Core::ActionManager::command(TextEditor::Constants::FOLLOW_SYMBOL_UNDER_CURSOR_IN_NEXT_SPLIT);
    cppToolsMenu->addAction(cmd);

    QAction *openDeclarationDefinitionInNextSplit =
231
            new QAction(tr("Open Method Declaration/Definition in Next Split"), this);
232 233
    cmd = Core::ActionManager::registerAction(openDeclarationDefinitionInNextSplit,
        Constants::OPEN_DECLARATION_DEFINITION_IN_NEXT_SPLIT, context, true);
234 235 236
    cmd->setDefaultKeySequence(QKeySequence(Utils::HostOsInfo::isMacHost()
                                            ? tr("Meta+E, Shift+F2")
                                            : tr("Ctrl+E, Shift+F2")));
237 238 239 240
    connect(openDeclarationDefinitionInNextSplit, SIGNAL(triggered()),
            this, SLOT(openDeclarationDefinitionInNextSplit()));
    cppToolsMenu->addAction(cmd);

241
    m_findUsagesAction = new QAction(tr("Find Usages"), this);
Eike Ziller's avatar
Eike Ziller committed
242
    cmd = Core::ActionManager::registerAction(m_findUsagesAction, Constants::FIND_USAGES, context);
243
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+U")));
244
    connect(m_findUsagesAction, SIGNAL(triggered()), this, SLOT(findUsages()));
245
    contextMenu->addAction(cmd);
246
    cppToolsMenu->addAction(cmd);
247

248
    m_openTypeHierarchyAction = new QAction(tr("Open Type Hierarchy"), this);
Eike Ziller's avatar
Eike Ziller committed
249
    cmd = Core::ActionManager::registerAction(m_openTypeHierarchyAction, Constants::OPEN_TYPE_HIERARCHY, context);
Eike Ziller's avatar
Eike Ziller committed
250
    cmd->setDefaultKeySequence(QKeySequence(Core::UseMacShortcuts ? tr("Meta+Shift+T") : tr("Ctrl+Shift+T")));
251 252 253 254
    connect(m_openTypeHierarchyAction, SIGNAL(triggered()), this, SLOT(openTypeHierarchy()));
    contextMenu->addAction(cmd);
    cppToolsMenu->addAction(cmd);

255
    // Refactoring sub-menu
256
    Core::Context globalContext(Core::Constants::C_GLOBAL);
257
    Core::Command *sep = contextMenu->addSeparator(globalContext);
258
    sep->action()->setObjectName(QLatin1String(Constants::M_REFACTORING_MENU_INSERTION_POINT));
259
    contextMenu->addSeparator(globalContext);
260 261 262

    m_renameSymbolUnderCursorAction = new QAction(tr("Rename Symbol Under Cursor"),
                                                  this);
Eike Ziller's avatar
Eike Ziller committed
263
    cmd = Core::ActionManager::registerAction(m_renameSymbolUnderCursorAction,
264 265
                             Constants::RENAME_SYMBOL_UNDER_CURSOR,
                             context);
266
    cmd->setDefaultKeySequence(QKeySequence(tr("CTRL+SHIFT+R")));
267 268 269 270 271
    connect(m_renameSymbolUnderCursorAction, SIGNAL(triggered()),
            this, SLOT(renameSymbolUnderCursor()));
    cppToolsMenu->addAction(cmd);

    // Update context in global context
272
    cppToolsMenu->addSeparator(globalContext);
273
    m_updateCodeModelAction = new QAction(tr("Update Code Model"), this);
Eike Ziller's avatar
Eike Ziller committed
274
    cmd = Core::ActionManager::registerAction(m_updateCodeModelAction, Core::Id(Constants::UPDATE_CODEMODEL), globalContext);
275
    CppTools::CppModelManagerInterface *cppModelManager = CppTools::CppModelManagerInterface::instance();
276 277
    connect(m_updateCodeModelAction, SIGNAL(triggered()), cppModelManager, SLOT(updateModifiedSourceFiles()));
    cppToolsMenu->addAction(cmd);
278

279
    m_actionHandler = new TextEditor::TextEditorActionHandler(CppEditor::Constants::C_CPPEDITOR,
con's avatar
con committed
280 281
        TextEditor::TextEditorActionHandler::Format
        | TextEditor::TextEditorActionHandler::UnCommentSelection
282 283
        | TextEditor::TextEditorActionHandler::UnCollapseAll
        | TextEditor::TextEditorActionHandler::FollowSymbolUnderCursor);
con's avatar
con committed
284

285
    m_actionHandler->initializeActions();
286

287
    contextMenu->addSeparator(context);
288

Eike Ziller's avatar
Eike Ziller committed
289
    cmd = Core::ActionManager::command(TextEditor::Constants::AUTO_INDENT_SELECTION);
mae's avatar
mae committed
290
    contextMenu->addAction(cmd);
291

Eike Ziller's avatar
Eike Ziller committed
292
    cmd = Core::ActionManager::command(TextEditor::Constants::UN_COMMENT_SELECTION);
mae's avatar
mae committed
293
    contextMenu->addAction(cmd);
294

hjk's avatar
hjk committed
295
    connect(Core::ICore::progressManager(), SIGNAL(taskStarted(QString)),
296
            this, SLOT(onTaskStarted(QString)));
hjk's avatar
hjk committed
297
    connect(Core::ICore::progressManager(), SIGNAL(allTasksFinished(QString)),
298
            this, SLOT(onAllTasksFinished(QString)));
299

hjk's avatar
hjk committed
300
    connect(Core::ICore::editorManager(), SIGNAL(currentEditorChanged(Core::IEditor*)), SLOT(currentEditorChanged(Core::IEditor*)));
301

302
    readSettings();
con's avatar
con committed
303 304 305
    return true;
}

306
void CppEditorPlugin::readSettings()
307
{
hjk's avatar
hjk committed
308
    m_sortedOutline = Core::ICore::settings()->value(QLatin1String("CppTools/SortedMethodOverview"), false).toBool();
309 310
}

311
void CppEditorPlugin::writeSettings()
312
{
hjk's avatar
hjk committed
313
    Core::ICore::settings()->setValue(QLatin1String("CppTools/SortedMethodOverview"), m_sortedOutline);
314 315
}

316
void CppEditorPlugin::extensionsInitialized()
con's avatar
con committed
317 318 319
{
}

320
ExtensionSystem::IPlugin::ShutdownFlag CppEditorPlugin::aboutToShutdown()
321 322
{
    writeSettings();
323
    return SynchronousShutdown;
324 325
}

326
void CppEditorPlugin::switchDeclarationDefinition()
con's avatar
con committed
327
{
328
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(Core::EditorManager::currentEditor()->widget());
329
    if (editor)
330 331 332
        editor->switchDeclarationDefinition(/*inNextSplit*/ false);
}

333
void CppEditorPlugin::openDeclarationDefinitionInNextSplit()
334 335 336 337
{
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(Core::EditorManager::currentEditor()->widget());
    if (editor)
        editor->switchDeclarationDefinition(/*inNextSplit*/ true);
con's avatar
con committed
338 339
}

340
void CppEditorPlugin::renameSymbolUnderCursor()
341
{
342
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(Core::EditorManager::currentEditor()->widget());
343 344 345 346
    if (editor)
        editor->renameSymbolUnderCursor();
}

347
void CppEditorPlugin::findUsages()
348
{
349
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(Core::EditorManager::currentEditor()->widget());
350 351 352 353
    if (editor)
        editor->findUsages();
}

354
void CppEditorPlugin::onTaskStarted(const QString &type)
355
{
356
    if (type == QLatin1String(CppTools::Constants::TASK_INDEX)) {
357 358
        m_renameSymbolUnderCursorAction->setEnabled(false);
        m_findUsagesAction->setEnabled(false);
359
        m_updateCodeModelAction->setEnabled(false);
360
        m_openTypeHierarchyAction->setEnabled(false);
361
    }
362 363
}

364
void CppEditorPlugin::onAllTasksFinished(const QString &type)
365
{
366
    if (type == QLatin1String(CppTools::Constants::TASK_INDEX)) {
367 368
        m_renameSymbolUnderCursorAction->setEnabled(true);
        m_findUsagesAction->setEnabled(true);
369
        m_updateCodeModelAction->setEnabled(true);
370
        m_openTypeHierarchyAction->setEnabled(true);
371
    }
372 373
}

374
void CppEditorPlugin::currentEditorChanged(Core::IEditor *editor)
375 376 377 378
{
    if (! editor)
        return;

379
    if (CPPEditorWidget *textEditor = qobject_cast<CPPEditorWidget *>(editor->widget()))
380
        textEditor->semanticRehighlight(/*force = */ true);
381 382
}

383
void CppEditorPlugin::openTypeHierarchy()
384
{
385
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(Core::EditorManager::currentEditor()->widget());
386 387
    if (editor) {
        Core::NavigationWidget *navigation = Core::NavigationWidget::instance();
388
        navigation->activateSubWidget(Core::Id(Constants::TYPE_HIERARCHY_ID));
389 390 391 392
        emit typeHierarchyRequested();
    }
}

393
Q_EXPORT_PLUGIN(CppEditorPlugin)