cpptoolsplugin.cpp 14.3 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
#ifdef Q_OS_WIN
#include <utils/winutils.h>
#endif
58

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

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

69 70 71
namespace CppTools {
namespace Internal {

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

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

77 78
CppToolsPlugin::CppToolsPlugin() :
    m_fileSettings(new CppFileSettings)
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
bool CppToolsPlugin::initialize(const QStringList &arguments, QString *error)
con's avatar
con committed
110
{
111 112
    Q_UNUSED(arguments)
    Q_UNUSED(error)
113

114 115
    m_settings = new CppToolsSettings(this); // force registration of cpp tools settings

con's avatar
con committed
116
    // Objects
117
    CppModelManager *modelManager = CppModelManager::instance();
hjk's avatar
hjk committed
118
    connect(VcsManager::instance(), SIGNAL(repositoryChanged(QString)),
119
            modelManager, SLOT(updateModifiedSourceFiles()));
hjk's avatar
hjk committed
120
    connect(DocumentManager::instance(), SIGNAL(filesChangedInternally(QStringList)),
121
            modelManager, SLOT(updateSourceFiles(QStringList)));
Roberto Raggi's avatar
Roberto Raggi committed
122

123 124 125 126 127
    CppLocatorData *locatorData = new CppLocatorData(modelManager);
    addAutoReleasedObject(locatorData);
    addAutoReleasedObject(new CppLocatorFilter(locatorData));
    addAutoReleasedObject(new CppClassesFilter(locatorData));
    addAutoReleasedObject(new CppFunctionsFilter(locatorData));
128
    addAutoReleasedObject(new CppCurrentDocumentFilter(modelManager));
129
    addAutoReleasedObject(new CppFileSettingsPage(m_fileSettings));
130
    addAutoReleasedObject(new SymbolsFindFilter(modelManager));
131 132
    addAutoReleasedObject(new CppCodeStyleSettingsPage);

con's avatar
con committed
133
    // Menus
hjk's avatar
hjk committed
134 135
    ActionContainer *mtools = ActionManager::actionContainer(Core::Constants::M_TOOLS);
    ActionContainer *mcpptools = ActionManager::createMenu(CppTools::Constants::M_TOOLS_CPP);
con's avatar
con committed
136 137 138 139 140 141
    QMenu *menu = mcpptools->menu();
    menu->setTitle(tr("&C++"));
    menu->setEnabled(true);
    mtools->addMenu(mcpptools);

    // Actions
hjk's avatar
hjk committed
142
    Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
143 144

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

150
    QAction *openInNextSplitAction = new QAction(tr("Open Corresponding Header/Source in Next Split"), this);
hjk's avatar
hjk committed
151
    command = ActionManager::registerAction(openInNextSplitAction, Constants::OPEN_HEADER_SOURCE_IN_NEXT_SPLIT, context, true);
152 153 154
    command->setDefaultKeySequence(QKeySequence(Utils::HostOsInfo::isMacHost()
                                                ? tr("Meta+E, F4")
                                                : tr("Ctrl+E, F4")));
155 156 157
    mcpptools->addAction(command);
    connect(openInNextSplitAction, SIGNAL(triggered()), this, SLOT(switchHeaderSourceInNextSplit()));

con's avatar
con committed
158 159 160 161 162
    return true;
}

void CppToolsPlugin::extensionsInitialized()
{
163 164
    // The Cpp editor plugin, which is loaded later on, registers the Cpp mime types,
    // so, apply settings here
hjk's avatar
hjk committed
165
    m_fileSettings->fromSettings(ICore::settings());
166 167
    if (!m_fileSettings->applySuffixesToMimeDB())
        qWarning("Unable to apply cpp suffixes to mime database (cpp mime types not found).\n");
con's avatar
con committed
168 169
}

170
ExtensionSystem::IPlugin::ShutdownFlag CppToolsPlugin::aboutToShutdown()
171
{
172
    return SynchronousShutdown;
173 174
}

con's avatar
con committed
175 176
void CppToolsPlugin::switchHeaderSource()
{
177
    QString otherFile = correspondingHeaderOrSource(
hjk's avatar
hjk committed
178
                EditorManager::currentDocument()->filePath());
179
    if (!otherFile.isEmpty())
hjk's avatar
hjk committed
180
        EditorManager::openEditor(otherFile);
181 182 183 184 185
}

void CppToolsPlugin::switchHeaderSourceInNextSplit()
{
    QString otherFile = correspondingHeaderOrSource(
hjk's avatar
hjk committed
186
                EditorManager::currentDocument()->filePath());
187
    if (!otherFile.isEmpty())
hjk's avatar
hjk committed
188
        EditorManager::openEditor(otherFile, Id(), EditorManager::OpenInOtherSplit);
con's avatar
con committed
189 190
}

191
static QStringList findFilesInProject(const QString &name,
192
                                   const ProjectExplorer::Project *project)
con's avatar
con committed
193 194
{
    if (debug)
195 196 197
        qDebug() << Q_FUNC_INFO << name << project;

    if (!project)
198
        return QStringList();
199 200 201 202 203

    QString pattern = QString(1, QLatin1Char('/'));
    pattern += name;
    const QStringList projectFiles = project->files(ProjectExplorer::Project::AllFiles);
    const QStringList::const_iterator pcend = projectFiles.constEnd();
204
    QStringList candidateList;
205 206
    for (QStringList::const_iterator it = projectFiles.constBegin(); it != pcend; ++it) {
        if (it->endsWith(pattern))
207
            candidateList.append(*it);
con's avatar
con committed
208
    }
209
    return candidateList;
con's avatar
con committed
210 211 212 213
}

// Return the suffixes that should be checked when trying to find a
// source belonging to a header and vice versa
214
static QStringList matchingCandidateSuffixes(ProjectFile::Kind kind)
con's avatar
con committed
215
{
216 217 218 219 220 221
    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
222 223 224 225
        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();
226 227
    case ProjectFile::CSource:
    case ProjectFile::ObjCSource:
hjk's avatar
hjk committed
228
        return MimeDatabase::findByType(QLatin1String(Constants::C_HEADER_MIMETYPE)).suffixes();
229 230 231 232
    case ProjectFile::CXXSource:
    case ProjectFile::ObjCXXSource:
    case ProjectFile::CudaSource:
    case ProjectFile::OpenCLSource:
hjk's avatar
hjk committed
233
        return MimeDatabase::findByType(QLatin1String(Constants::CPP_HEADER_MIMETYPE)).suffixes();
234 235
    default:
        return QStringList();
con's avatar
con committed
236 237 238
    }
}

239 240 241 242 243 244 245 246 247 248 249 250 251
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;
}

252 253 254 255 256 257 258 259
static QStringList baseDirWithAllDirectories(const QDir &baseDir, const QStringList &directories)
{
    QStringList result;
    foreach (const QString &dir, directories)
        result << QDir::cleanPath(baseDir.absoluteFilePath(dir));
    return result;
}

260 261 262 263 264 265 266 267 268
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;
}

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
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();
}

298 299 300
} // namespace Internal

QString correspondingHeaderOrSource(const QString &fileName, bool *wasHeader)
con's avatar
con committed
301
{
302
    using namespace Internal;
303

304
    const QFileInfo fi(fileName);
305 306
    ProjectFile::Kind kind = ProjectFile::classify(fileName);
    const bool isHeader = ProjectFile::isHeader(kind);
307
    if (wasHeader)
308 309
        *wasHeader = isHeader;
    if (m_headerSourceMapping.contains(fi.absoluteFilePath()))
310
        return m_headerSourceMapping.value(fi.absoluteFilePath());
con's avatar
con committed
311 312

    if (debug)
313
        qDebug() << Q_FUNC_INFO << fileName <<  kind;
con's avatar
con committed
314

315
    if (kind == ProjectFile::Unclassified)
con's avatar
con committed
316 317
        return QString();

318
    const QString baseName = fi.completeBaseName();
319
    const QString privateHeaderSuffix = QLatin1String("_p");
320
    const QStringList suffixes = matchingCandidateSuffixes(kind);
con's avatar
con committed
321

322
    QStringList candidateFileNames = baseNameWithAllSuffixes(baseName, suffixes);
323
    if (isHeader) {
con's avatar
con committed
324 325 326
        if (baseName.endsWith(privateHeaderSuffix)) {
            QString sourceBaseName = baseName;
            sourceBaseName.truncate(sourceBaseName.size() - privateHeaderSuffix.size());
327
            candidateFileNames += baseNameWithAllSuffixes(sourceBaseName, suffixes);
con's avatar
con committed
328 329
        }
    } else {
330 331 332 333 334 335
        QString privateHeaderBaseName = baseName;
        privateHeaderBaseName.append(privateHeaderSuffix);
        candidateFileNames += baseNameWithAllSuffixes(privateHeaderBaseName, suffixes);
    }

    const QDir absoluteDir = fi.absoluteDir();
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
    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);

    // 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;
#ifdef Q_OS_WIN
            const QString normalized = Utils::normalizePathName(candidateFilePath);
#else
            const QString normalized = candidateFilePath;
#endif
            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();
            }
358
        }
359 360
    }

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    // 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
381
    }
382

con's avatar
con committed
383 384 385
    return QString();
}

386
} // namespace CppTools
con's avatar
con committed
387

388
Q_EXPORT_PLUGIN(CppTools::Internal::CppToolsPlugin)