cpptoolsplugin.cpp 11.9 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 "cppcodestylesettingspage.h"
37
#include "cppclassesfilter.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"
Leandro Melo's avatar
Leandro Melo committed
44
#include "cppcompletionassist.h"
45 46
#include "cpptoolssettings.h"
#include "cppcodestylesettingsfactory.h"
47
#include "cppcodestylesettings.h"
con's avatar
con committed
48

49 50
#include <extensionsystem/pluginmanager.h>

con's avatar
con committed
51 52 53
#include <coreplugin/icore.h>
#include <coreplugin/mimedatabase.h>
#include <coreplugin/coreconstants.h>
54
#include <coreplugin/actionmanager/actionmanager.h>
55 56
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
57
#include <coreplugin/uniqueidmanager.h>
con's avatar
con committed
58
#include <coreplugin/editormanager/editormanager.h>
59
#include <coreplugin/progressmanager/progressmanager.h>
60
#include <coreplugin/vcsmanager.h>
61
#include <coreplugin/filemanager.h>
62
#include <texteditor/texteditorsettings.h>
63 64
#include <texteditor/tabsettings.h>
#include <texteditor/codestylepreferencesmanager.h>
con's avatar
con committed
65 66
#include <cppeditor/cppeditorconstants.h>

67 68 69 70 71 72 73 74
#include <QtCore/QtConcurrentRun>
#include <QtCore/QFutureSynchronizer>
#include <qtconcurrent/runextensions.h>

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

75
#include <QtCore/QtPlugin>
con's avatar
con committed
76 77 78
#include <QtCore/QFileInfo>
#include <QtCore/QDir>
#include <QtCore/QDebug>
79
#include <QtCore/QSettings>
con's avatar
con committed
80 81 82
#include <QtGui/QMenu>
#include <QtGui/QAction>

83 84
#include <sstream>

con's avatar
con committed
85
using namespace CppTools::Internal;
86
using namespace CPlusPlus;
con's avatar
con committed
87 88 89

enum { debug = 0 };

90
static CppToolsPlugin *m_instance = 0;
con's avatar
con committed
91

92 93 94
CppToolsPlugin::CppToolsPlugin() :
    m_modelManager(0),
    m_fileSettings(new CppFileSettings)
con's avatar
con committed
95 96 97 98 99 100 101 102 103 104
{
    m_instance = this;
}

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

105
bool CppToolsPlugin::initialize(const QStringList &arguments, QString *error)
con's avatar
con committed
106
{
107 108
    Q_UNUSED(arguments)
    Q_UNUSED(error)
109 110 111

    qRegisterMetaType<CppTools::CppCodeStyleSettings>("CppTools::CppCodeStyleSettings");

112 113
    Core::ICore *core = Core::ICore::instance();
    Core::ActionManager *am = core->actionManager();
con's avatar
con committed
114

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

con's avatar
con committed
117 118
    // Objects
    m_modelManager = new CppModelManager(this);
hjk's avatar
hjk committed
119
    Core::VcsManager *vcsManager = core->vcsManager();
120
    Core::FileManager *fileManager = core->fileManager();
121 122
    connect(vcsManager, SIGNAL(repositoryChanged(QString)),
            m_modelManager, SLOT(updateModifiedSourceFiles()));
123 124
    connect(fileManager, SIGNAL(filesChangedInternally(QStringList)),
            m_modelManager, SLOT(updateSourceFiles(QStringList)));
con's avatar
con committed
125
    addAutoReleasedObject(m_modelManager);
Roberto Raggi's avatar
Roberto Raggi committed
126

Leandro Melo's avatar
Leandro Melo committed
127
    addAutoReleasedObject(new CppCompletionAssistProvider);
128 129 130
    addAutoReleasedObject(new CppLocatorFilter(m_modelManager));
    addAutoReleasedObject(new CppClassesFilter(m_modelManager));
    addAutoReleasedObject(new CppFunctionsFilter(m_modelManager));
131
    addAutoReleasedObject(new CppCurrentDocumentFilter(m_modelManager, core->editorManager()));
132
    addAutoReleasedObject(new CompletionSettingsPage);
133
    addAutoReleasedObject(new CppFileSettingsPage(m_fileSettings));
134
    addAutoReleasedObject(new SymbolsFindFilter(m_modelManager));
135 136 137 138
    addAutoReleasedObject(new CppCodeStyleSettingsPage);

    TextEditor::CodeStylePreferencesManager::instance()->registerFactory(
                new CppTools::CppCodeStylePreferencesFactory());
con's avatar
con committed
139 140

    // Menus
141 142
    Core::ActionContainer *mtools = am->actionContainer(Core::Constants::M_TOOLS);
    Core::ActionContainer *mcpptools = am->createMenu(CppTools::Constants::M_TOOLS_CPP);
con's avatar
con committed
143 144 145 146 147 148
    QMenu *menu = mcpptools->menu();
    menu->setTitle(tr("&C++"));
    menu->setEnabled(true);
    mtools->addMenu(mcpptools);

    // Actions
149
    Core::Context context(CppEditor::Constants::C_CPPEDITOR);
con's avatar
con committed
150 151

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

    return true;
}

void CppToolsPlugin::extensionsInitialized()
{
162 163 164 165 166
    // 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");
con's avatar
con committed
167 168
}

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

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

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

189 190
    QFileInfo fileInSameDir(dir, name);
    if (project && !fileInSameDir.isFile()) {
con's avatar
con committed
191 192 193 194 195 196 197 198 199
        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();
    }
200
    return fileInSameDir;
con's avatar
con committed
201 202 203
}

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

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;
222 223
    if (typeName == QLatin1String(CppTools::Constants::OBJECTIVE_CPP_SOURCE_MIMETYPE))
        return ObjectiveCPP_SourceFile;
con's avatar
con committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237
    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
238 239 240
        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
241 242 243
    case C_SourceFile:
        return mimeDatase->findByType(QLatin1String(CppTools::Constants::C_HEADER_MIMETYPE)).suffixes();
    case CPP_SourceFile:
244
    case ObjectiveCPP_SourceFile:
con's avatar
con committed
245 246 247 248 249 250 251
        return mimeDatase->findByType(QLatin1String(CppTools::Constants::CPP_HEADER_MIMETYPE)).suffixes();
    }
    return QStringList();
}

QString CppToolsPlugin::correspondingHeaderOrSourceI(const QString &fileName) const
{
252
    const Core::ICore *core = Core::ICore::instance();
con's avatar
con committed
253 254
    const Core::MimeDatabase *mimeDatase = core->mimeDatabase();
    ProjectExplorer::ProjectExplorerPlugin *explorer =
255
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
256 257 258 259 260 261 262 263 264 265 266 267
    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();
268
    const QString baseName = fi.completeBaseName();
con's avatar
con committed
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
    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();
}

313
QString CppToolsPlugin::correspondingHeaderOrSource(const QString &fileName)
con's avatar
con committed
314
{
315
    const QString rc = m_instance->correspondingHeaderOrSourceI(fileName);
con's avatar
con committed
316 317 318 319 320 321
    if (debug)
        qDebug() << Q_FUNC_INFO << fileName << rc;
    return rc;
}

Q_EXPORT_PLUGIN(CppToolsPlugin)