cpptoolsplugin.cpp 15.8 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 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 "cppcodemodelsettingspage.h"
34
#include "cppcodestylesettingspage.h"
35
#include "cppclassesfilter.h"
36
#include "cppfunctionsfilter.h"
37
#include "cppcurrentdocumentfilter.h"
con's avatar
con committed
38
#include "cppmodelmanager.h"
con's avatar
con committed
39
#include "cpplocatorfilter.h"
40
#include "symbolsfindfilter.h"
41
#include "cpptoolssettings.h"
42
#include "cpptoolsreuse.h"
43
#include "cppprojectfile.h"
44
#include "cpplocatordata.h"
con's avatar
con committed
45

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

Orgad Shaneh's avatar
Orgad Shaneh committed
54
#include <utils/fileutils.h>
55
#include <utils/hostosinfo.h>
56
#include <utils/qtcassert.h>
57

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

hjk's avatar
hjk committed
65
using namespace Core;
66
using namespace CPlusPlus;
con's avatar
con committed
67

68 69 70
namespace CppTools {
namespace Internal {

con's avatar
con committed
71 72
enum { debug = 0 };

73
static CppToolsPlugin *m_instance = 0;
74
static QHash<QString, QString> m_headerSourceMapping;
con's avatar
con committed
75

76 77 78
CppToolsPlugin::CppToolsPlugin()
    : m_fileSettings(new CppFileSettings)
    , m_codeModelSettings(new CppCodeModelSettings)
con's avatar
con committed
79 80 81 82 83 84 85
{
    m_instance = this;
}

CppToolsPlugin::~CppToolsPlugin()
{
    m_instance = 0;
86
    delete CppModelManager::instance();
con's avatar
con committed
87 88
}

89 90 91 92 93
CppToolsPlugin *CppToolsPlugin::instance()
{
    return m_instance;
}

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
void CppToolsPlugin::clearHeaderSourceCache()
{
    m_headerSourceMapping.clear();
}

const QStringList &CppToolsPlugin::headerSearchPaths()
{
    return m_instance->m_fileSettings->headerSearchPaths;
}

const QStringList &CppToolsPlugin::sourceSearchPaths()
{
    return m_instance->m_fileSettings->sourceSearchPaths;
}

109 110 111 112 113 114 115 116 117 118 119
const QStringList &CppToolsPlugin::headerPrefixes()
{
    return m_instance->m_fileSettings->headerPrefixes;
}

const QStringList &CppToolsPlugin::sourcePrefixes()
{
    return m_instance->m_fileSettings->sourcePrefixes;
}


120
bool CppToolsPlugin::initialize(const QStringList &arguments, QString *error)
con's avatar
con committed
121
{
122 123
    Q_UNUSED(arguments)
    Q_UNUSED(error)
124

125 126
    m_settings = new CppToolsSettings(this); // force registration of cpp tools settings

con's avatar
con committed
127
    // Objects
128
    CppModelManager *modelManager = CppModelManager::instance();
hjk's avatar
hjk committed
129
    connect(VcsManager::instance(), SIGNAL(repositoryChanged(QString)),
130
            modelManager, SLOT(updateModifiedSourceFiles()));
hjk's avatar
hjk committed
131
    connect(DocumentManager::instance(), SIGNAL(filesChangedInternally(QStringList)),
132
            modelManager, SLOT(updateSourceFiles(QStringList)));
Roberto Raggi's avatar
Roberto Raggi committed
133

134 135 136 137 138
    CppLocatorData *locatorData = new CppLocatorData(modelManager);
    addAutoReleasedObject(locatorData);
    addAutoReleasedObject(new CppLocatorFilter(locatorData));
    addAutoReleasedObject(new CppClassesFilter(locatorData));
    addAutoReleasedObject(new CppFunctionsFilter(locatorData));
139
    addAutoReleasedObject(new CppCurrentDocumentFilter(modelManager, m_stringTable));
140
    addAutoReleasedObject(new CppFileSettingsPage(m_fileSettings));
141
    addAutoReleasedObject(new CppCodeModelSettingsPage(m_codeModelSettings));
142
    addAutoReleasedObject(new SymbolsFindFilter(modelManager));
143 144
    addAutoReleasedObject(new CppCodeStyleSettingsPage);

con's avatar
con committed
145
    // Menus
hjk's avatar
hjk committed
146 147
    ActionContainer *mtools = ActionManager::actionContainer(Core::Constants::M_TOOLS);
    ActionContainer *mcpptools = ActionManager::createMenu(CppTools::Constants::M_TOOLS_CPP);
con's avatar
con committed
148 149 150 151 152 153
    QMenu *menu = mcpptools->menu();
    menu->setTitle(tr("&C++"));
    menu->setEnabled(true);
    mtools->addMenu(mcpptools);

    // Actions
hjk's avatar
hjk committed
154
    Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
155 156

    QAction *switchAction = new QAction(tr("Switch Header/Source"), this);
hjk's avatar
hjk committed
157
    Command *command = ActionManager::registerAction(switchAction, Constants::SWITCH_HEADER_SOURCE, context, true);
con's avatar
con committed
158 159 160 161
    command->setDefaultKeySequence(QKeySequence(Qt::Key_F4));
    mcpptools->addAction(command);
    connect(switchAction, SIGNAL(triggered()), this, SLOT(switchHeaderSource()));

162
    QAction *openInNextSplitAction = new QAction(tr("Open Corresponding Header/Source in Next Split"), this);
hjk's avatar
hjk committed
163
    command = ActionManager::registerAction(openInNextSplitAction, Constants::OPEN_HEADER_SOURCE_IN_NEXT_SPLIT, context, true);
164 165 166
    command->setDefaultKeySequence(QKeySequence(Utils::HostOsInfo::isMacHost()
                                                ? tr("Meta+E, F4")
                                                : tr("Ctrl+E, F4")));
167 168 169
    mcpptools->addAction(command);
    connect(openInNextSplitAction, SIGNAL(triggered()), this, SLOT(switchHeaderSourceInNextSplit()));

con's avatar
con committed
170 171 172 173 174
    return true;
}

void CppToolsPlugin::extensionsInitialized()
{
175 176
    // The Cpp editor plugin, which is loaded later on, registers the Cpp mime types,
    // so, apply settings here
hjk's avatar
hjk committed
177
    m_fileSettings->fromSettings(ICore::settings());
178 179
    if (!m_fileSettings->applySuffixesToMimeDB())
        qWarning("Unable to apply cpp suffixes to mime database (cpp mime types not found).\n");
180
    m_codeModelSettings->fromSettings(ICore::settings());
con's avatar
con committed
181 182
}

183
ExtensionSystem::IPlugin::ShutdownFlag CppToolsPlugin::aboutToShutdown()
184
{
185
    return SynchronousShutdown;
186 187
}

188 189 190 191 192
QSharedPointer<CppCodeModelSettings> CppToolsPlugin::codeModelSettings() const
{
    return m_codeModelSettings;
}

193 194 195 196 197
StringTable &CppToolsPlugin::stringTable()
{
    return instance()->m_stringTable;
}

con's avatar
con committed
198 199
void CppToolsPlugin::switchHeaderSource()
{
200
    QString otherFile = correspondingHeaderOrSource(
hjk's avatar
hjk committed
201
                EditorManager::currentDocument()->filePath());
202
    if (!otherFile.isEmpty())
hjk's avatar
hjk committed
203
        EditorManager::openEditor(otherFile);
204 205 206 207 208
}

void CppToolsPlugin::switchHeaderSourceInNextSplit()
{
    QString otherFile = correspondingHeaderOrSource(
hjk's avatar
hjk committed
209
                EditorManager::currentDocument()->filePath());
210
    if (!otherFile.isEmpty())
hjk's avatar
hjk committed
211
        EditorManager::openEditor(otherFile, Id(), EditorManager::OpenInOtherSplit);
con's avatar
con committed
212 213
}

214
static QStringList findFilesInProject(const QString &name,
215
                                   const ProjectExplorer::Project *project)
con's avatar
con committed
216 217
{
    if (debug)
218 219 220
        qDebug() << Q_FUNC_INFO << name << project;

    if (!project)
221
        return QStringList();
222 223 224 225 226

    QString pattern = QString(1, QLatin1Char('/'));
    pattern += name;
    const QStringList projectFiles = project->files(ProjectExplorer::Project::AllFiles);
    const QStringList::const_iterator pcend = projectFiles.constEnd();
227
    QStringList candidateList;
228 229
    for (QStringList::const_iterator it = projectFiles.constBegin(); it != pcend; ++it) {
        if (it->endsWith(pattern))
230
            candidateList.append(*it);
con's avatar
con committed
231
    }
232
    return candidateList;
con's avatar
con committed
233 234 235 236
}

// Return the suffixes that should be checked when trying to find a
// source belonging to a header and vice versa
237
static QStringList matchingCandidateSuffixes(ProjectFile::Kind kind)
con's avatar
con committed
238
{
239 240 241 242 243 244
    switch (kind) {
     // Note that C/C++ headers are undistinguishable
    case ProjectFile::CHeader:
    case ProjectFile::CXXHeader:
    case ProjectFile::ObjCHeader:
    case ProjectFile::ObjCXXHeader:
hjk's avatar
hjk committed
245 246 247 248
        return MimeDatabase::findByType(QLatin1String(Constants::C_SOURCE_MIMETYPE)).suffixes()
                + MimeDatabase::findByType(QLatin1String(Constants::CPP_SOURCE_MIMETYPE)).suffixes()
                + MimeDatabase::findByType(QLatin1String(Constants::OBJECTIVE_C_SOURCE_MIMETYPE)).suffixes()
                + MimeDatabase::findByType(QLatin1String(Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE)).suffixes();
249 250
    case ProjectFile::CSource:
    case ProjectFile::ObjCSource:
hjk's avatar
hjk committed
251
        return MimeDatabase::findByType(QLatin1String(Constants::C_HEADER_MIMETYPE)).suffixes();
252 253 254 255
    case ProjectFile::CXXSource:
    case ProjectFile::ObjCXXSource:
    case ProjectFile::CudaSource:
    case ProjectFile::OpenCLSource:
hjk's avatar
hjk committed
256
        return MimeDatabase::findByType(QLatin1String(Constants::CPP_HEADER_MIMETYPE)).suffixes();
257 258
    default:
        return QStringList();
con's avatar
con committed
259 260 261
    }
}

262 263 264 265 266 267 268 269 270 271 272 273 274
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;
}

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
static QStringList baseNamesWithAllPrefixes(const QStringList &baseNames, bool isHeader)
{
    QStringList result;
    const QStringList &sourcePrefixes = m_instance->sourcePrefixes();
    const QStringList &headerPrefixes = m_instance->headerPrefixes();

    foreach (const QString &name, baseNames) {
        foreach (const QString &prefix, isHeader ? headerPrefixes : sourcePrefixes) {
            if (name.startsWith(prefix)) {
                QString nameWithoutPrefix = name.mid(prefix.size());
                result += nameWithoutPrefix;
                foreach (const QString &prefix, isHeader ? sourcePrefixes : headerPrefixes)
                    result += prefix + nameWithoutPrefix;
            }
        }
        foreach (const QString &prefix, isHeader ? sourcePrefixes : headerPrefixes)
            result += prefix + name;

    }
    return result;
}

297 298 299 300 301 302 303 304
static QStringList baseDirWithAllDirectories(const QDir &baseDir, const QStringList &directories)
{
    QStringList result;
    foreach (const QString &dir, directories)
        result << QDir::cleanPath(baseDir.absoluteFilePath(dir));
    return result;
}

305 306 307 308 309 310 311 312 313
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;
}

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
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();
}

343 344 345
} // namespace Internal

QString correspondingHeaderOrSource(const QString &fileName, bool *wasHeader)
con's avatar
con committed
346
{
347
    using namespace Internal;
348

349
    const QFileInfo fi(fileName);
350 351
    ProjectFile::Kind kind = ProjectFile::classify(fileName);
    const bool isHeader = ProjectFile::isHeader(kind);
352
    if (wasHeader)
353 354
        *wasHeader = isHeader;
    if (m_headerSourceMapping.contains(fi.absoluteFilePath()))
355
        return m_headerSourceMapping.value(fi.absoluteFilePath());
con's avatar
con committed
356 357

    if (debug)
358
        qDebug() << Q_FUNC_INFO << fileName <<  kind;
con's avatar
con committed
359

360
    if (kind == ProjectFile::Unclassified)
con's avatar
con committed
361 362
        return QString();

363
    const QString baseName = fi.completeBaseName();
364
    const QString privateHeaderSuffix = QLatin1String("_p");
365
    const QStringList suffixes = matchingCandidateSuffixes(kind);
con's avatar
con committed
366

367
    QStringList candidateFileNames = baseNameWithAllSuffixes(baseName, suffixes);
368
    if (isHeader) {
con's avatar
con committed
369 370 371
        if (baseName.endsWith(privateHeaderSuffix)) {
            QString sourceBaseName = baseName;
            sourceBaseName.truncate(sourceBaseName.size() - privateHeaderSuffix.size());
372
            candidateFileNames += baseNameWithAllSuffixes(sourceBaseName, suffixes);
con's avatar
con committed
373 374
        }
    } else {
375 376 377 378 379 380
        QString privateHeaderBaseName = baseName;
        privateHeaderBaseName.append(privateHeaderSuffix);
        candidateFileNames += baseNameWithAllSuffixes(privateHeaderBaseName, suffixes);
    }

    const QDir absoluteDir = fi.absoluteDir();
381 382 383 384 385 386
    QStringList candidateDirs(absoluteDir.absolutePath());
    // If directory is not root, try matching against its siblings
    const QStringList searchPaths = isHeader ? m_instance->sourceSearchPaths()
                                             : m_instance->headerSearchPaths();
    candidateDirs += baseDirWithAllDirectories(absoluteDir, searchPaths);

387 388
    candidateFileNames += baseNamesWithAllPrefixes(candidateFileNames, isHeader);

389 390 391 392
    // Try to find a file in the same or sibling directories first
    foreach (const QString &candidateDir, candidateDirs) {
        foreach (const QString &candidateFileName, candidateFileNames) {
            const QString candidateFilePath = candidateDir + QLatin1Char('/') + candidateFileName;
Orgad Shaneh's avatar
Orgad Shaneh committed
393
            const QString normalized = Utils::FileUtils::normalizePathName(candidateFilePath);
394 395 396 397 398 399 400
            const QFileInfo candidateFi(normalized);
            if (candidateFi.isFile()) {
                m_headerSourceMapping[fi.absoluteFilePath()] = candidateFi.absoluteFilePath();
                if (!isHeader || !baseName.endsWith(privateHeaderSuffix))
                    m_headerSourceMapping[candidateFi.absoluteFilePath()] = fi.absoluteFilePath();
                return candidateFi.absoluteFilePath();
            }
401
        }
402 403
    }

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
    // 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
424
    }
425

con's avatar
con committed
426 427 428
    return QString();
}

429
} // namespace CppTools
con's avatar
con committed
430

431
Q_EXPORT_PLUGIN(CppTools::Internal::CppToolsPlugin)