cpptoolsplugin.cpp 13.2 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 "cpptoolsconstants.h"
31
#include "cpptoolsplugin.h"
32
#include "cppfilesettingspage.h"
33
#include "cppcodestylesettingspage.h"
34
#include "cppclassesfilter.h"
35
#include "cppfunctionsfilter.h"
36
#include "cppcurrentdocumentfilter.h"
con's avatar
con committed
37
#include "cppmodelmanager.h"
con's avatar
con committed
38
#include "cpplocatorfilter.h"
39
#include "symbolsfindfilter.h"
40
#include "cpptoolssettings.h"
41
#include "cpptoolsreuse.h"
42
#include "cppprojectfile.h"
43
#include "cpplocatordata.h"
con's avatar
con committed
44

45
#include <coreplugin/actionmanager/actioncontainer.h>
46
47
48
49
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/coreconstants.h>
#include <coreplugin/documentmanager.h>
#include <coreplugin/icore.h>
50
#include <coreplugin/vcsmanager.h>
con's avatar
con committed
51
#include <cppeditor/cppeditorconstants.h>
52

53
#include <utils/hostosinfo.h>
54
#include <utils/qtcassert.h>
55

56
57
58
59
60
61
#include <QtPlugin>
#include <QFileInfo>
#include <QDir>
#include <QDebug>
#include <QMenu>
#include <QAction>
62
63

using namespace CPlusPlus;
con's avatar
con committed
64

65
66
67
namespace CppTools {
namespace Internal {

con's avatar
con committed
68
69
enum { debug = 0 };

70
static CppToolsPlugin *m_instance = 0;
71
static QHash<QString, QString> m_headerSourceMapping;
con's avatar
con committed
72

73
74
CppToolsPlugin::CppToolsPlugin() :
    m_fileSettings(new CppFileSettings)
con's avatar
con committed
75
76
77
78
79
80
81
{
    m_instance = this;
}

CppToolsPlugin::~CppToolsPlugin()
{
    m_instance = 0;
82
    delete CppModelManager::instance();
con's avatar
con committed
83
84
}

85
86
87
88
89
CppToolsPlugin *CppToolsPlugin::instance()
{
    return m_instance;
}

90
bool CppToolsPlugin::initialize(const QStringList &arguments, QString *error)
con's avatar
con committed
91
{
92
93
    Q_UNUSED(arguments)
    Q_UNUSED(error)
94

95
96
    m_settings = new CppToolsSettings(this); // force registration of cpp tools settings

con's avatar
con committed
97
    // Objects
98
    CppModelManager *modelManager = CppModelManager::instance();
hjk's avatar
hjk committed
99
    Core::VcsManager *vcsManager = Core::ICore::vcsManager();
100
    connect(vcsManager, SIGNAL(repositoryChanged(QString)),
101
            modelManager, SLOT(updateModifiedSourceFiles()));
102
    connect(Core::DocumentManager::instance(), SIGNAL(filesChangedInternally(QStringList)),
103
            modelManager, SLOT(updateSourceFiles(QStringList)));
Roberto Raggi's avatar
Roberto Raggi committed
104

105
106
107
108
109
    CppLocatorData *locatorData = new CppLocatorData(modelManager);
    addAutoReleasedObject(locatorData);
    addAutoReleasedObject(new CppLocatorFilter(locatorData));
    addAutoReleasedObject(new CppClassesFilter(locatorData));
    addAutoReleasedObject(new CppFunctionsFilter(locatorData));
110
    addAutoReleasedObject(new CppCurrentDocumentFilter(modelManager));
111
    addAutoReleasedObject(new CppFileSettingsPage(m_fileSettings));
112
    addAutoReleasedObject(new SymbolsFindFilter(modelManager));
113
114
    addAutoReleasedObject(new CppCodeStyleSettingsPage);

con's avatar
con committed
115
    // Menus
Eike Ziller's avatar
Eike Ziller committed
116
117
    Core::ActionContainer *mtools = Core::ActionManager::actionContainer(Core::Constants::M_TOOLS);
    Core::ActionContainer *mcpptools = Core::ActionManager::createMenu(CppTools::Constants::M_TOOLS_CPP);
con's avatar
con committed
118
119
120
121
122
123
    QMenu *menu = mcpptools->menu();
    menu->setTitle(tr("&C++"));
    menu->setEnabled(true);
    mtools->addMenu(mcpptools);

    // Actions
124
    Core::Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
125
126

    QAction *switchAction = new QAction(tr("Switch Header/Source"), this);
Eike Ziller's avatar
Eike Ziller committed
127
    Core::Command *command = Core::ActionManager::registerAction(switchAction, Constants::SWITCH_HEADER_SOURCE, context, true);
con's avatar
con committed
128
129
130
131
    command->setDefaultKeySequence(QKeySequence(Qt::Key_F4));
    mcpptools->addAction(command);
    connect(switchAction, SIGNAL(triggered()), this, SLOT(switchHeaderSource()));

132
    QAction *openInNextSplitAction = new QAction(tr("Open Corresponding Header/Source in Next Split"), this);
133
    command = Core::ActionManager::registerAction(openInNextSplitAction, Constants::OPEN_HEADER_SOURCE_IN_NEXT_SPLIT, context, true);
134
135
136
    command->setDefaultKeySequence(QKeySequence(Utils::HostOsInfo::isMacHost()
                                                ? tr("Meta+E, F4")
                                                : tr("Ctrl+E, F4")));
137
138
139
    mcpptools->addAction(command);
    connect(openInNextSplitAction, SIGNAL(triggered()), this, SLOT(switchHeaderSourceInNextSplit()));

con's avatar
con committed
140
141
142
143
144
    return true;
}

void CppToolsPlugin::extensionsInitialized()
{
145
146
    // The Cpp editor plugin, which is loaded later on, registers the Cpp mime types,
    // so, apply settings here
hjk's avatar
hjk committed
147
    m_fileSettings->fromSettings(Core::ICore::settings());
148
149
    if (!m_fileSettings->applySuffixesToMimeDB())
        qWarning("Unable to apply cpp suffixes to mime database (cpp mime types not found).\n");
con's avatar
con committed
150
151
}

152
ExtensionSystem::IPlugin::ShutdownFlag CppToolsPlugin::aboutToShutdown()
153
{
154
    return SynchronousShutdown;
155
156
}

con's avatar
con committed
157
158
void CppToolsPlugin::switchHeaderSource()
{
159
    QString otherFile = correspondingHeaderOrSource(
160
                Core::EditorManager::currentDocument()->filePath());
161
162
163
164
165
166
167
    if (!otherFile.isEmpty())
        Core::EditorManager::openEditor(otherFile);
}

void CppToolsPlugin::switchHeaderSourceInNextSplit()
{
    QString otherFile = correspondingHeaderOrSource(
168
                Core::EditorManager::currentDocument()->filePath());
169
    if (!otherFile.isEmpty())
Eike Ziller's avatar
Eike Ziller committed
170
        Core::EditorManager::openEditor(otherFile, Core::Id(), Core::EditorManager::OpenInOtherSplit);
con's avatar
con committed
171
172
}

173
static QStringList findFilesInProject(const QString &name,
174
                                   const ProjectExplorer::Project *project)
con's avatar
con committed
175
176
{
    if (debug)
177
178
179
        qDebug() << Q_FUNC_INFO << name << project;

    if (!project)
180
        return QStringList();
181
182
183
184
185

    QString pattern = QString(1, QLatin1Char('/'));
    pattern += name;
    const QStringList projectFiles = project->files(ProjectExplorer::Project::AllFiles);
    const QStringList::const_iterator pcend = projectFiles.constEnd();
186
    QStringList candidateList;
187
188
    for (QStringList::const_iterator it = projectFiles.constBegin(); it != pcend; ++it) {
        if (it->endsWith(pattern))
189
            candidateList.append(*it);
con's avatar
con committed
190
    }
191
    return candidateList;
con's avatar
con committed
192
193
194
195
}

// Return the suffixes that should be checked when trying to find a
// source belonging to a header and vice versa
196
static QStringList matchingCandidateSuffixes(ProjectFile::Kind kind)
con's avatar
con committed
197
{
198
199
200
201
202
203
204
205
206
    Core::MimeDatabase *md = Core::ICore::instance()->mimeDatabase();
    switch (kind) {
     // Note that C/C++ headers are undistinguishable
    case ProjectFile::CHeader:
    case ProjectFile::CXXHeader:
    case ProjectFile::ObjCHeader:
    case ProjectFile::ObjCXXHeader:
        return md->findByType(QLatin1String(Constants::C_SOURCE_MIMETYPE)).suffixes()
                + md->findByType(QLatin1String(Constants::CPP_SOURCE_MIMETYPE)).suffixes()
207
                + md->findByType(QLatin1String(Constants::OBJECTIVE_C_SOURCE_MIMETYPE)).suffixes()
208
209
210
211
212
213
214
215
216
217
218
                + md->findByType(QLatin1String(Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE)).suffixes();
    case ProjectFile::CSource:
    case ProjectFile::ObjCSource:
        return md->findByType(QLatin1String(Constants::C_HEADER_MIMETYPE)).suffixes();
    case ProjectFile::CXXSource:
    case ProjectFile::ObjCXXSource:
    case ProjectFile::CudaSource:
    case ProjectFile::OpenCLSource:
        return md->findByType(QLatin1String(Constants::CPP_HEADER_MIMETYPE)).suffixes();
    default:
        return QStringList();
con's avatar
con committed
219
220
221
    }
}

222
223
224
225
226
227
228
229
230
231
232
233
234
static QStringList baseNameWithAllSuffixes(const QString &baseName, const QStringList &suffixes)
{
    QStringList result;
    const QChar dot = QLatin1Char('.');
    foreach (const QString &suffix, suffixes) {
        QString fileName = baseName;
        fileName += dot;
        fileName += suffix;
        result += fileName;
    }
    return result;
}

235
236
237
238
239
240
241
242
243
static int commonStringLength(const QString &s1, const QString &s2)
{
    int length = qMin(s1.length(), s2.length());
    for (int i = 0; i < length; ++i)
        if (s1[i] != s2[i])
            return i;
    return length;
}

244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
static QString correspondingHeaderOrSourceInProject(const QFileInfo &fileInfo,
                                                    const QStringList &candidateFileNames,
                                                    const ProjectExplorer::Project *project)
{
    QString bestFileName;
    int compareValue = 0;
    const QString filePath = fileInfo.filePath();
    foreach (const QString &candidateFileName, candidateFileNames) {
        const QStringList projectFiles = findFilesInProject(candidateFileName, project);
        // Find the file having the most common path with fileName
        foreach (const QString &projectFile, projectFiles) {
            int value = commonStringLength(filePath, projectFile);
            if (value > compareValue) {
                compareValue = value;
                bestFileName = projectFile;
            }
        }
    }
    if (!bestFileName.isEmpty()) {
        const QFileInfo candidateFi(bestFileName);
        QTC_ASSERT(candidateFi.isFile(), return QString());
        m_headerSourceMapping[fileInfo.absoluteFilePath()] = candidateFi.absoluteFilePath();
        m_headerSourceMapping[candidateFi.absoluteFilePath()] = fileInfo.absoluteFilePath();
        return candidateFi.absoluteFilePath();
    }

    return QString();
}

273
274
275
} // namespace Internal

QString correspondingHeaderOrSource(const QString &fileName, bool *wasHeader)
con's avatar
con committed
276
{
277
    using namespace Internal;
278

279
    const QFileInfo fi(fileName);
280
281
    ProjectFile::Kind kind = ProjectFile::classify(fileName);
    const bool isHeader = ProjectFile::isHeader(kind);
282
    if (wasHeader)
283
284
        *wasHeader = isHeader;
    if (m_headerSourceMapping.contains(fi.absoluteFilePath()))
285
        return m_headerSourceMapping.value(fi.absoluteFilePath());
con's avatar
con committed
286
287

    if (debug)
288
        qDebug() << Q_FUNC_INFO << fileName <<  kind;
con's avatar
con committed
289

290
    if (kind == ProjectFile::Unclassified)
con's avatar
con committed
291
292
        return QString();

293
    const QString baseName = fi.completeBaseName();
294
    const QString privateHeaderSuffix = QLatin1String("_p");
295
    const QStringList suffixes = matchingCandidateSuffixes(kind);
con's avatar
con committed
296

297
    QStringList candidateFileNames = baseNameWithAllSuffixes(baseName, suffixes);
298
    if (isHeader) {
con's avatar
con committed
299
300
301
        if (baseName.endsWith(privateHeaderSuffix)) {
            QString sourceBaseName = baseName;
            sourceBaseName.truncate(sourceBaseName.size() - privateHeaderSuffix.size());
302
            candidateFileNames += baseNameWithAllSuffixes(sourceBaseName, suffixes);
con's avatar
con committed
303
304
        }
    } else {
305
306
307
308
309
310
311
312
        QString privateHeaderBaseName = baseName;
        privateHeaderBaseName.append(privateHeaderSuffix);
        candidateFileNames += baseNameWithAllSuffixes(privateHeaderBaseName, suffixes);
    }

    const QDir absoluteDir = fi.absoluteDir();

    // Try to find a file in the same directory first
313
314
    foreach (const QString &candidateFileName, candidateFileNames) {
        const QFileInfo candidateFi(absoluteDir, candidateFileName);
315
316
        if (candidateFi.isFile()) {
            m_headerSourceMapping[fi.absoluteFilePath()] = candidateFi.absoluteFilePath();
317
            if (!isHeader || !baseName.endsWith(privateHeaderSuffix))
318
                m_headerSourceMapping[candidateFi.absoluteFilePath()] = fi.absoluteFilePath();
319
            return candidateFi.absoluteFilePath();
320
        }
321
322
    }

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
    // Find files in the current project
    ProjectExplorer::Project *currentProject = ProjectExplorer::ProjectExplorerPlugin::currentProject();
    if (currentProject) {
        const QString path = correspondingHeaderOrSourceInProject(fi, candidateFileNames,
                                                                  currentProject);
        if (!path.isEmpty())
            return path;
    }

    // Find files in other projects
    CppModelManager *modelManager = CppModelManager::instance();
    QList<CppModelManagerInterface::ProjectInfo> projectInfos = modelManager->projectInfos();
    foreach (const CppModelManagerInterface::ProjectInfo &projectInfo, projectInfos) {
        const ProjectExplorer::Project *project = projectInfo.project().data();
        if (project == currentProject)
            continue; // We have already checked the current project.

        const QString path = correspondingHeaderOrSourceInProject(fi, candidateFileNames, project);
        if (!path.isEmpty())
            return path;
con's avatar
con committed
343
    }
344

con's avatar
con committed
345
346
347
    return QString();
}

348
} // namespace CppTools
con's avatar
con committed
349

350
Q_EXPORT_PLUGIN(CppTools::Internal::CppToolsPlugin)