cpptoolsplugin.cpp 12 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

33
#include "cpptoolsplugin.h"
34
#include "completionsettingspage.h"
35
#include "cppfilesettingspage.h"
36
#include "cppclassesfilter.h"
con's avatar
con committed
37
#include "cppcodecompletion.h"
38
#include "cppfunctionsfilter.h"
39
#include "cppcurrentdocumentfilter.h"
con's avatar
con committed
40
41
#include "cppmodelmanager.h"
#include "cpptoolsconstants.h"
con's avatar
con committed
42
#include "cpplocatorfilter.h"
43
#include "symbolsfindfilter.h"
con's avatar
con committed
44

45
46
#include <extensionsystem/pluginmanager.h>

con's avatar
con committed
47
48
49
#include <coreplugin/icore.h>
#include <coreplugin/mimedatabase.h>
#include <coreplugin/coreconstants.h>
50
#include <coreplugin/actionmanager/actionmanager.h>
51
52
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
53
#include <coreplugin/uniqueidmanager.h>
con's avatar
con committed
54
#include <coreplugin/editormanager/editormanager.h>
55
#include <coreplugin/progressmanager/progressmanager.h>
56
#include <coreplugin/vcsmanager.h>
57
#include <coreplugin/filemanager.h>
58
#include <texteditor/texteditorsettings.h>
con's avatar
con committed
59
60
#include <cppeditor/cppeditorconstants.h>

61
62
63
64
65
66
67
68
#include <QtCore/QtConcurrentRun>
#include <QtCore/QFutureSynchronizer>
#include <qtconcurrent/runextensions.h>

#include <find/ifindfilter.h>
#include <find/searchresultwindow.h>
#include <utils/filesearch.h>

69
#include <QtCore/QtPlugin>
con's avatar
con committed
70
71
72
#include <QtCore/QFileInfo>
#include <QtCore/QDir>
#include <QtCore/QDebug>
73
#include <QtCore/QSettings>
con's avatar
con committed
74
75
76
#include <QtGui/QMenu>
#include <QtGui/QAction>

77
78
#include <sstream>

con's avatar
con committed
79
using namespace CppTools::Internal;
80
using namespace CPlusPlus;
con's avatar
con committed
81
82
83
84
85

enum { debug = 0 };

CppToolsPlugin *CppToolsPlugin::m_instance = 0;

86
87
88
CppToolsPlugin::CppToolsPlugin() :
    m_modelManager(0),
    m_fileSettings(new CppFileSettings)
con's avatar
con committed
89
90
91
92
93
94
95
96
97
98
{
    m_instance = this;
}

CppToolsPlugin::~CppToolsPlugin()
{
    m_instance = 0;
    m_modelManager = 0; // deleted automatically
}

99
bool CppToolsPlugin::initialize(const QStringList &arguments, QString *error)
con's avatar
con committed
100
{
101
102
    Q_UNUSED(arguments)
    Q_UNUSED(error)
103
104
    Core::ICore *core = Core::ICore::instance();
    Core::ActionManager *am = core->actionManager();
con's avatar
con committed
105
106
107

    // Objects
    m_modelManager = new CppModelManager(this);
hjk's avatar
hjk committed
108
    Core::VcsManager *vcsManager = core->vcsManager();
109
    Core::FileManager *fileManager = core->fileManager();
110
111
    connect(vcsManager, SIGNAL(repositoryChanged(QString)),
            m_modelManager, SLOT(updateModifiedSourceFiles()));
112
113
    connect(fileManager, SIGNAL(filesChangedInternally(QStringList)),
            m_modelManager, SLOT(updateSourceFiles(QStringList)));
con's avatar
con committed
114
    addAutoReleasedObject(m_modelManager);
Roberto Raggi's avatar
Roberto Raggi committed
115

116
117
    CppCodeCompletion *completion = new CppCodeCompletion(m_modelManager);
    addAutoReleasedObject(completion);
Roberto Raggi's avatar
Roberto Raggi committed
118

119
120
121
    addAutoReleasedObject(new CppLocatorFilter(m_modelManager));
    addAutoReleasedObject(new CppClassesFilter(m_modelManager));
    addAutoReleasedObject(new CppFunctionsFilter(m_modelManager));
122
    addAutoReleasedObject(new CppCurrentDocumentFilter(m_modelManager, core->editorManager()));
123
    addAutoReleasedObject(new CompletionSettingsPage);
124
    addAutoReleasedObject(new CppFileSettingsPage(m_fileSettings));
125
    addAutoReleasedObject(new SymbolsFindFilter(m_modelManager));
con's avatar
con committed
126
127

    // Menus
128
129
    Core::ActionContainer *mtools = am->actionContainer(Core::Constants::M_TOOLS);
    Core::ActionContainer *mcpptools = am->createMenu(CppTools::Constants::M_TOOLS_CPP);
con's avatar
con committed
130
131
132
133
134
135
    QMenu *menu = mcpptools->menu();
    menu->setTitle(tr("&C++"));
    menu->setEnabled(true);
    mtools->addMenu(mcpptools);

    // Actions
136
    Core::Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
137
138

    QAction *switchAction = new QAction(tr("Switch Header/Source"), this);
139
    Core::Command *command = am->registerAction(switchAction, Constants::SWITCH_HEADER_SOURCE, context, true);
con's avatar
con committed
140
141
142
143
    command->setDefaultKeySequence(QKeySequence(Qt::Key_F4));
    mcpptools->addAction(command);
    connect(switchAction, SIGNAL(triggered()), this, SLOT(switchHeaderSource()));

144
145
146
147
148
    // Set completion settings and keep them up to date
    TextEditor::TextEditorSettings *textEditorSettings = TextEditor::TextEditorSettings::instance();
    completion->setCompletionSettings(textEditorSettings->completionSettings());
    connect(textEditorSettings, SIGNAL(completionSettingsChanged(TextEditor::CompletionSettings)),
            completion, SLOT(setCompletionSettings(TextEditor::CompletionSettings)));
149

con's avatar
con committed
150
151
152
153
154
    return true;
}

void CppToolsPlugin::extensionsInitialized()
{
155
156
157
158
159
    // The Cpp editor plugin, which is loaded later on, registers the Cpp mime types,
    // so, apply settings here
    m_fileSettings->fromSettings(Core::ICore::instance()->settings());
    if (!m_fileSettings->applySuffixesToMimeDB())
        qWarning("Unable to apply cpp suffixes to mime database (cpp mime types not found).\n");
160
161
162
163
164

    // Initialize header suffixes
    const Core::MimeDatabase *mimeDatabase = Core::ICore::instance()->mimeDatabase();
    const Core::MimeType mimeType = mimeDatabase->findByType(QLatin1String("text/x-c++hdr"));
    m_modelManager->setHeaderSuffixes(mimeType.suffixes());
con's avatar
con committed
165
166
}

167
ExtensionSystem::IPlugin::ShutdownFlag CppToolsPlugin::aboutToShutdown()
168
{
169
    return SynchronousShutdown;
170
171
}

con's avatar
con committed
172
173
void CppToolsPlugin::switchHeaderSource()
{
174
    Core::EditorManager *editorManager = Core::EditorManager::instance();
175
    Core::IEditor *editor = editorManager->currentEditor();
con's avatar
con committed
176
    QString otherFile = correspondingHeaderOrSource(editor->file()->fileName());
177
    if (!otherFile.isEmpty())
178
        editorManager->openEditor(otherFile);
con's avatar
con committed
179
180
181
182
183
184
185
186
}

QFileInfo CppToolsPlugin::findFile(const QDir &dir, const QString &name,
                                   const ProjectExplorer::Project *project) const
{
    if (debug)
        qDebug() << Q_FUNC_INFO << dir << name;

187
188
    QFileInfo fileInSameDir(dir, name);
    if (project && !fileInSameDir.isFile()) {
con's avatar
con committed
189
190
191
192
193
194
195
196
197
        QString pattern = QString(1, QLatin1Char('/'));
        pattern += name;
        const QStringList projectFiles = project->files(ProjectExplorer::Project::AllFiles);
        const QStringList::const_iterator pcend = projectFiles.constEnd();
        for (QStringList::const_iterator it = projectFiles.constBegin(); it != pcend; ++it)
            if (it->endsWith(pattern))
                return QFileInfo(*it);
        return QFileInfo();
    }
198
    return fileInSameDir;
con's avatar
con committed
199
200
201
}

// Figure out file type
202
203
204
205
enum FileType {
    HeaderFile,
    C_SourceFile,
    CPP_SourceFile,
206
    ObjectiveCPP_SourceFile,
207
208
    UnknownType
};
con's avatar
con committed
209
210
211
212
213
214
215
216
217
218
219

static inline FileType fileType(const Core::MimeDatabase *mimeDatase, const  QFileInfo & fi)
{
    const Core::MimeType mimeType = mimeDatase->findByFile(fi);
    if (!mimeType)
        return UnknownType;
    const QString typeName = mimeType.type();
    if (typeName == QLatin1String(CppTools::Constants::C_SOURCE_MIMETYPE))
        return C_SourceFile;
    if (typeName == QLatin1String(CppTools::Constants::CPP_SOURCE_MIMETYPE))
        return CPP_SourceFile;
220
221
    if (typeName == QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE))
        return ObjectiveCPP_SourceFile;
con's avatar
con committed
222
223
224
225
226
227
228
229
230
231
232
233
234
235
    if (typeName == QLatin1String(CppTools::Constants::C_HEADER_MIMETYPE)
        || typeName == QLatin1String(CppTools::Constants::CPP_HEADER_MIMETYPE))
        return HeaderFile;
    return UnknownType;
}

// Return the suffixes that should be checked when trying to find a
// source belonging to a header and vice versa
static QStringList matchingCandidateSuffixes(const Core::MimeDatabase *mimeDatase, FileType type)
{
    switch (type) {
    case UnknownType:
        break;
    case HeaderFile: // Note that C/C++ headers are undistinguishable
236
237
238
        return mimeDatase->findByType(QLatin1String(CppTools::Constants::C_SOURCE_MIMETYPE)).suffixes()
               + mimeDatase->findByType(QLatin1String(CppTools::Constants::CPP_SOURCE_MIMETYPE)).suffixes()
               + mimeDatase->findByType(QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE)).suffixes();
con's avatar
con committed
239
240
241
    case C_SourceFile:
        return mimeDatase->findByType(QLatin1String(CppTools::Constants::C_HEADER_MIMETYPE)).suffixes();
    case CPP_SourceFile:
242
    case ObjectiveCPP_SourceFile:
con's avatar
con committed
243
244
245
246
247
248
249
        return mimeDatase->findByType(QLatin1String(CppTools::Constants::CPP_HEADER_MIMETYPE)).suffixes();
    }
    return QStringList();
}

QString CppToolsPlugin::correspondingHeaderOrSourceI(const QString &fileName) const
{
250
    const Core::ICore *core = Core::ICore::instance();
con's avatar
con committed
251
252
    const Core::MimeDatabase *mimeDatase = core->mimeDatabase();
    ProjectExplorer::ProjectExplorerPlugin *explorer =
253
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
254
255
256
257
258
259
260
261
262
263
264
265
    ProjectExplorer::Project *project = (explorer ? explorer->currentProject() : 0);

    const QFileInfo fi(fileName);
    const FileType type = fileType(mimeDatase, fi);

    if (debug)
        qDebug() << Q_FUNC_INFO << fileName <<  type;

    if (type == UnknownType)
        return QString();

    const QDir absoluteDir = fi.absoluteDir();
266
    const QString baseName = fi.completeBaseName();
con's avatar
con committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
    const QStringList suffixes = matchingCandidateSuffixes(mimeDatase, type);

    const QString privateHeaderSuffix = QLatin1String("_p");
    const QChar dot = QLatin1Char('.');
    // Check base matches 'source.h'-> 'source.cpp' and vice versa
    const QStringList::const_iterator scend = suffixes.constEnd();
    for (QStringList::const_iterator it = suffixes.constBegin(); it != scend; ++it) {
        QString candidate = baseName;
        candidate += dot;
        candidate += *it;
        const QFileInfo candidateFi = findFile(absoluteDir, candidate, project);
        if (candidateFi.isFile())
            return candidateFi.absoluteFilePath();
    }
    if (type == HeaderFile) {
        // 'source_p.h': try 'source.cpp'
        if (baseName.endsWith(privateHeaderSuffix)) {
            QString sourceBaseName = baseName;
            sourceBaseName.truncate(sourceBaseName.size() - privateHeaderSuffix.size());
            for (QStringList::const_iterator it = suffixes.constBegin(); it != scend; ++it) {
                QString candidate = sourceBaseName;
                candidate += dot;
                candidate += *it;
                const QFileInfo candidateFi = findFile(absoluteDir, candidate, project);
                if (candidateFi.isFile())
                    return candidateFi.absoluteFilePath();
            }
        }
    } else {
        // 'source.cpp': try 'source_p.h'
        const QStringList::const_iterator scend = suffixes.constEnd();
        for (QStringList::const_iterator it = suffixes.constBegin(); it != scend; ++it) {
            QString candidate = baseName;
            candidate += privateHeaderSuffix;
            candidate += dot;
            candidate += *it;
            const QFileInfo candidateFi = findFile(absoluteDir, candidate, project);
            if (candidateFi.isFile())
                return candidateFi.absoluteFilePath();
        }
    }
    return QString();
}

QString CppToolsPlugin::correspondingHeaderOrSource(const QString &fileName) const
{
    const QString rc = correspondingHeaderOrSourceI(fileName);
    if (debug)
        qDebug() << Q_FUNC_INFO << fileName << rc;
    return rc;
}

Q_EXPORT_PLUGIN(CppToolsPlugin)