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

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"
42
#include "cpphighlighterfactory.h"
con's avatar
con committed
43

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

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

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

60
using namespace Core;
61
using namespace CppEditor;
con's avatar
con committed
62 63
using namespace CppEditor::Internal;

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

66 67
enum { QUICKFIX_INTERVAL = 20 };

68
//////////////////////////// CppEditorFactory /////////////////////////////
con's avatar
con committed
69

70
CppEditorFactory::CppEditorFactory(CppEditorPlugin *owner) :
con's avatar
con committed
71 72
    m_owner(owner)
{
73 74 75 76 77 78
    setId(CppEditor::Constants::CPPEDITOR_ID);
    setDisplayName(qApp->translate("OpenWith::Editors", CppEditor::Constants::CPPEDITOR_DISPLAY_NAME));
    addMimeType(CppEditor::Constants::C_SOURCE_MIMETYPE);
    addMimeType(CppEditor::Constants::C_HEADER_MIMETYPE);
    addMimeType(CppEditor::Constants::CPP_SOURCE_MIMETYPE);
    addMimeType(CppEditor::Constants::CPP_HEADER_MIMETYPE);
79

80
    if (!Utils::HostOsInfo::isMacHost() && !Utils::HostOsInfo::isWindowsHost()) {
81 82
        FileIconProvider *iconProvider = FileIconProvider::instance();
        MimeDatabase *mimeDatabase = ICore::mimeDatabase();
83 84 85 86 87 88 89
        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
90 91
}

92
IEditor *CppEditorFactory::createEditor(QWidget *parent)
con's avatar
con committed
93
{
94
    CPPEditorWidget *editor = new CPPEditorWidget(parent);
con's avatar
con committed
95 96
    editor->setRevisionsVisible(true);
    m_owner->initializeEditor(editor);
97
    return editor->editor();
con's avatar
con committed
98 99
}

100
///////////////////////////////// CppEditorPlugin //////////////////////////////////
con's avatar
con committed
101

102
CppEditorPlugin *CppEditorPlugin::m_instance = 0;
con's avatar
con committed
103

104
CppEditorPlugin::CppEditorPlugin() :
con's avatar
con committed
105
    m_actionHandler(0),
106
    m_sortedOutline(false),
107 108
    m_renameSymbolUnderCursorAction(0),
    m_findUsagesAction(0),
109
    m_updateCodeModelAction(0),
Leandro Melo's avatar
Leandro Melo committed
110 111
    m_openTypeHierarchyAction(0),
    m_quickFixProvider(0)
con's avatar
con committed
112 113 114 115
{
    m_instance = this;
}

116
CppEditorPlugin::~CppEditorPlugin()
con's avatar
con committed
117 118 119 120 121
{
    delete m_actionHandler;
    m_instance = 0;
}

122
CppEditorPlugin *CppEditorPlugin::instance()
con's avatar
con committed
123 124 125 126
{
    return m_instance;
}

127
void CppEditorPlugin::initializeEditor(CPPEditorWidget *editor)
con's avatar
con committed
128 129 130
{
    m_actionHandler->setupActions(editor);

Orgad Shaneh's avatar
Orgad Shaneh committed
131
    editor->setLanguageSettingsId(CppTools::Constants::CPP_SETTINGS_ID);
132
    TextEditor::TextEditorSettings::instance()->initializeEditor(editor);
con's avatar
con committed
133

134
    // method combo box sorting
135 136
    connect(this, SIGNAL(outlineSortingChanged(bool)),
            editor, SLOT(setSortedOutline(bool)));
137 138
}

139
void CppEditorPlugin::setSortedOutline(bool sorted)
140
{
141 142
    m_sortedOutline = sorted;
    emit outlineSortingChanged(sorted);
143 144
}

145
bool CppEditorPlugin::sortedOutline() const
146
{
147
    return m_sortedOutline;
con's avatar
con committed
148 149
}

150
CppQuickFixAssistProvider *CppEditorPlugin::quickFixProvider() const
Leandro Melo's avatar
Leandro Melo committed
151 152 153
{
    return m_quickFixProvider;
}
154

155
bool CppEditorPlugin::initialize(const QStringList & /*arguments*/, QString *errorMessage)
con's avatar
con committed
156
{
157
    if (!ICore::mimeDatabase()->addMimeTypes(QLatin1String(":/cppeditor/CppEditor.mimetypes.xml"), errorMessage))
con's avatar
con committed
158 159
        return false;

160
    addAutoReleasedObject(new CppEditorFactory(this));
161
    addAutoReleasedObject(new CppHoverHandler);
162
    addAutoReleasedObject(new CppOutlineWidgetFactory);
163
    addAutoReleasedObject(new CppTypeHierarchyFactory);
164
    addAutoReleasedObject(new CppSnippetProvider);
165
    addAutoReleasedObject(new CppHighlighterFactory);
166

Leandro Melo's avatar
Leandro Melo committed
167 168
    m_quickFixProvider = new CppQuickFixAssistProvider;
    addAutoReleasedObject(m_quickFixProvider);
Nikolai Kosjar's avatar
Nikolai Kosjar committed
169
    CppEditor::Internal::registerQuickFixes(this);
Roberto Raggi's avatar
Roberto Raggi committed
170

171 172
    QObject *core = ICore::instance();
    CppFileWizard::BaseFileWizardParameters wizardParameters(IWizard::FileWizard);
con's avatar
con committed
173

174
    wizardParameters.setCategory(QLatin1String(Constants::WIZARD_CATEGORY));
175 176
    wizardParameters.setDisplayCategory(QCoreApplication::translate(Constants::WIZARD_CATEGORY,
                                                                    Constants::WIZARD_TR_CATEGORY));
177
    wizardParameters.setDisplayName(tr("C++ Class"));
Friedemann Kleint's avatar
Friedemann Kleint committed
178
    wizardParameters.setId(QLatin1String("A.Class"));
179
    wizardParameters.setKind(IWizard::ClassWizard);
180
    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
181
    addAutoReleasedObject(new CppClassWizard(wizardParameters, core));
con's avatar
con committed
182

183
    wizardParameters.setKind(IWizard::FileWizard);
184
    wizardParameters.setDescription(tr("Creates a C++ source file that you can add to a C++ project."));
185
    wizardParameters.setDisplayName(tr("C++ Source File"));
Friedemann Kleint's avatar
Friedemann Kleint committed
186
    wizardParameters.setId(QLatin1String("B.Source"));
187
    addAutoReleasedObject(new CppFileWizard(wizardParameters, Source, core));
con's avatar
con committed
188

189
    wizardParameters.setDescription(tr("Creates a C++ header file that you can add to a C++ project."));
190
    wizardParameters.setDisplayName(tr("C++ Header File"));
Friedemann Kleint's avatar
Friedemann Kleint committed
191 192
    wizardParameters.setId(QLatin1String("C.Header"));
    addAutoReleasedObject(new CppFileWizard(wizardParameters, Header, core));
con's avatar
con committed
193

194
    Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
195

196
    ActionContainer *contextMenu = ActionManager::createMenu(CppEditor::Constants::M_CONTEXT);
con's avatar
con committed
197

198 199
    Command *cmd;
    ActionContainer *cppToolsMenu = ActionManager::actionContainer(CppTools::Constants::M_TOOLS_CPP);
con's avatar
con committed
200

201
    cmd = ActionManager::command(CppTools::Constants::SWITCH_HEADER_SOURCE);
202 203
    contextMenu->addAction(cmd);

204
    cmd = ActionManager::command(TextEditor::Constants::FOLLOW_SYMBOL_UNDER_CURSOR);
mae's avatar
mae committed
205
    contextMenu->addAction(cmd);
206
    cppToolsMenu->addAction(cmd);
con's avatar
con committed
207

208
    QAction *switchDeclarationDefinition = new QAction(tr("Switch Between Method Declaration/Definition"), this);
209
    cmd = ActionManager::registerAction(switchDeclarationDefinition,
210
        Constants::SWITCH_DECLARATION_DEFINITION, context, true);
211
    cmd->setDefaultKeySequence(QKeySequence(tr("Shift+F2")));
con's avatar
con committed
212 213
    connect(switchDeclarationDefinition, SIGNAL(triggered()),
            this, SLOT(switchDeclarationDefinition()));
mae's avatar
mae committed
214
    contextMenu->addAction(cmd);
215
    cppToolsMenu->addAction(cmd);
con's avatar
con committed
216

217
    cmd = ActionManager::command(TextEditor::Constants::FOLLOW_SYMBOL_UNDER_CURSOR_IN_NEXT_SPLIT);
218 219 220
    cppToolsMenu->addAction(cmd);

    QAction *openDeclarationDefinitionInNextSplit =
221
            new QAction(tr("Open Method Declaration/Definition in Next Split"), this);
222
    cmd = ActionManager::registerAction(openDeclarationDefinitionInNextSplit,
223
        Constants::OPEN_DECLARATION_DEFINITION_IN_NEXT_SPLIT, context, true);
224 225 226
    cmd->setDefaultKeySequence(QKeySequence(Utils::HostOsInfo::isMacHost()
                                            ? tr("Meta+E, Shift+F2")
                                            : tr("Ctrl+E, Shift+F2")));
227 228 229 230
    connect(openDeclarationDefinitionInNextSplit, SIGNAL(triggered()),
            this, SLOT(openDeclarationDefinitionInNextSplit()));
    cppToolsMenu->addAction(cmd);

231
    m_findUsagesAction = new QAction(tr("Find Usages"), this);
232
    cmd = ActionManager::registerAction(m_findUsagesAction, Constants::FIND_USAGES, context);
233
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+U")));
234
    connect(m_findUsagesAction, SIGNAL(triggered()), this, SLOT(findUsages()));
235
    contextMenu->addAction(cmd);
236
    cppToolsMenu->addAction(cmd);
237

238
    m_openTypeHierarchyAction = new QAction(tr("Open Type Hierarchy"), this);
239 240
    cmd = ActionManager::registerAction(m_openTypeHierarchyAction, Constants::OPEN_TYPE_HIERARCHY, context);
    cmd->setDefaultKeySequence(QKeySequence(UseMacShortcuts ? tr("Meta+Shift+T") : tr("Ctrl+Shift+T")));
241 242 243 244
    connect(m_openTypeHierarchyAction, SIGNAL(triggered()), this, SLOT(openTypeHierarchy()));
    contextMenu->addAction(cmd);
    cppToolsMenu->addAction(cmd);

245
    // Refactoring sub-menu
246 247
    Context globalContext(Core::Constants::C_GLOBAL);
    Command *sep = contextMenu->addSeparator(globalContext);
248
    sep->action()->setObjectName(QLatin1String(Constants::M_REFACTORING_MENU_INSERTION_POINT));
249
    contextMenu->addSeparator(globalContext);
250 251 252

    m_renameSymbolUnderCursorAction = new QAction(tr("Rename Symbol Under Cursor"),
                                                  this);
253
    cmd = ActionManager::registerAction(m_renameSymbolUnderCursorAction,
254 255
                             Constants::RENAME_SYMBOL_UNDER_CURSOR,
                             context);
256
    cmd->setDefaultKeySequence(QKeySequence(tr("CTRL+SHIFT+R")));
257 258 259 260 261
    connect(m_renameSymbolUnderCursorAction, SIGNAL(triggered()),
            this, SLOT(renameSymbolUnderCursor()));
    cppToolsMenu->addAction(cmd);

    // Update context in global context
262
    cppToolsMenu->addSeparator(globalContext);
263
    m_updateCodeModelAction = new QAction(tr("Update Code Model"), this);
264
    cmd = ActionManager::registerAction(m_updateCodeModelAction, Constants::UPDATE_CODEMODEL, globalContext);
265
    CppTools::CppModelManagerInterface *cppModelManager = CppTools::CppModelManagerInterface::instance();
266 267
    connect(m_updateCodeModelAction, SIGNAL(triggered()), cppModelManager, SLOT(updateModifiedSourceFiles()));
    cppToolsMenu->addAction(cmd);
268

269
    m_actionHandler = new TextEditor::TextEditorActionHandler(CppEditor::Constants::C_CPPEDITOR,
con's avatar
con committed
270 271
        TextEditor::TextEditorActionHandler::Format
        | TextEditor::TextEditorActionHandler::UnCommentSelection
272 273
        | TextEditor::TextEditorActionHandler::UnCollapseAll
        | TextEditor::TextEditorActionHandler::FollowSymbolUnderCursor);
con's avatar
con committed
274

275
    m_actionHandler->initializeActions();
276

277
    contextMenu->addSeparator(context);
278

279
    cmd = ActionManager::command(TextEditor::Constants::AUTO_INDENT_SELECTION);
mae's avatar
mae committed
280
    contextMenu->addAction(cmd);
281

282
    cmd = ActionManager::command(TextEditor::Constants::UN_COMMENT_SELECTION);
mae's avatar
mae committed
283
    contextMenu->addAction(cmd);
284

285
    connect(ProgressManager::instance(), SIGNAL(taskStarted(QString)),
286
            this, SLOT(onTaskStarted(QString)));
287
    connect(ProgressManager::instance(), SIGNAL(allTasksFinished(QString)),
288
            this, SLOT(onAllTasksFinished(QString)));
289

290 291
    connect(EditorManager::instance(), SIGNAL(currentEditorChanged(Core::IEditor*)),
            SLOT(currentEditorChanged(Core::IEditor*)));
292

293
    readSettings();
con's avatar
con committed
294 295 296
    return true;
}

297
void CppEditorPlugin::readSettings()
298
{
299
    m_sortedOutline = ICore::settings()->value(QLatin1String("CppTools/SortedMethodOverview"), false).toBool();
300 301
}

302
void CppEditorPlugin::writeSettings()
303
{
304
    ICore::settings()->setValue(QLatin1String("CppTools/SortedMethodOverview"), m_sortedOutline);
305 306
}

307
void CppEditorPlugin::extensionsInitialized()
con's avatar
con committed
308 309 310
{
}

311
ExtensionSystem::IPlugin::ShutdownFlag CppEditorPlugin::aboutToShutdown()
312 313
{
    writeSettings();
314
    return SynchronousShutdown;
315 316
}

317
void CppEditorPlugin::switchDeclarationDefinition()
con's avatar
con committed
318
{
319
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(EditorManager::currentEditor()->widget());
320
    if (editor)
321 322 323
        editor->switchDeclarationDefinition(/*inNextSplit*/ false);
}

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

331
void CppEditorPlugin::renameSymbolUnderCursor()
332
{
333
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(EditorManager::currentEditor()->widget());
334 335 336 337
    if (editor)
        editor->renameSymbolUnderCursor();
}

338
void CppEditorPlugin::findUsages()
339
{
340
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(EditorManager::currentEditor()->widget());
341 342 343 344
    if (editor)
        editor->findUsages();
}

345
void CppEditorPlugin::onTaskStarted(const QString &type)
346
{
347
    if (type == QLatin1String(CppTools::Constants::TASK_INDEX)) {
348 349
        m_renameSymbolUnderCursorAction->setEnabled(false);
        m_findUsagesAction->setEnabled(false);
350
        m_updateCodeModelAction->setEnabled(false);
351
        m_openTypeHierarchyAction->setEnabled(false);
352
    }
353 354
}

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

365
void CppEditorPlugin::currentEditorChanged(IEditor *editor)
366
{
367
    if (!editor)
368 369
        return;

370
    if (CPPEditorWidget *textEditor = qobject_cast<CPPEditorWidget *>(editor->widget()))
371
        textEditor->semanticRehighlight(/*force = */ true);
372 373
}

374
void CppEditorPlugin::openTypeHierarchy()
375
{
376
    CPPEditorWidget *editor = qobject_cast<CPPEditorWidget*>(EditorManager::currentEditor()->widget());
377
    if (editor) {
378 379
        NavigationWidget *navigation = NavigationWidget::instance();
        navigation->activateSubWidget(Constants::TYPE_HIERARCHY_ID);
380 381 382 383
        emit typeHierarchyRequested();
    }
}

384
Q_EXPORT_PLUGIN(CppEditorPlugin)