cppmodelmanager.h 10.9 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

con's avatar
con committed
30 31 32
#ifndef CPPMODELMANAGER_H
#define CPPMODELMANAGER_H

33
#include "cpptools_global.h"
34
#include "cpptoolsconstants.h"
35
#include "ModelManagerInterface.h"
36
#include <projectexplorer/project.h>
con's avatar
con committed
37
#include <cplusplus/CppDocument.h>
38
#include <cplusplus/PreprocessorClient.h>
39
#include <texteditor/basetexteditor.h>
40 41
#include <cplusplus/PreprocessorEnvironment.h>
#include <cplusplus/pp-engine.h>
42 43 44 45 46 47 48

#include <QHash>
#include <QFutureInterface>
#include <QFutureSynchronizer>
#include <QMutex>
#include <QTimer>
#include <QTextEdit> // for QTextEdit::ExtraSelection
con's avatar
con committed
49 50 51 52 53 54 55

namespace Core {
class IEditor;
}

namespace TextEditor {
class ITextEditor;
56
class BaseTextEditorWidget;
con's avatar
con committed
57 58 59 60 61 62
}

namespace ProjectExplorer {
class ProjectExplorerPlugin;
}

63 64 65 66
namespace CPlusPlus {
    class ParseManager;
}

con's avatar
con committed
67
namespace CppTools {
68

69 70 71
class CppCompletionSupportFactory;
class CppHighlightingSupportFactory;

con's avatar
con committed
72 73 74
namespace Internal {

class CppEditorSupport;
75
class CppPreprocessor;
Roberto Raggi's avatar
Roberto Raggi committed
76
class CppFindReferences;
con's avatar
con committed
77

78
class CPPTOOLS_EXPORT CppModelManager : public CPlusPlus::CppModelManagerInterface
con's avatar
con committed
79 80 81 82
{
    Q_OBJECT

public:
83
    CppModelManager(QObject *parent = 0);
con's avatar
con committed
84 85
    virtual ~CppModelManager();

86 87
    static CppModelManager *instance();

dt's avatar
dt committed
88
    virtual QFuture<void> updateSourceFiles(const QStringList &sourceFiles);
89
    virtual WorkingCopy workingCopy() const;
90 91 92 93

    virtual QList<ProjectInfo> projectInfos() const;
    virtual ProjectInfo projectInfo(ProjectExplorer::Project *project) const;
    virtual void updateProjectInfo(const ProjectInfo &pinfo);
94
    virtual QList<ProjectPart::Ptr> projectPart(const QString &fileName) const;
95

96
    virtual CPlusPlus::Snapshot snapshot() const;
con's avatar
con committed
97 98
    virtual void GC();

99
    virtual bool isCppEditor(Core::IEditor *editor) const;
con's avatar
con committed
100

Roberto Raggi's avatar
Roberto Raggi committed
101 102 103
    CppEditorSupport *editorSupport(TextEditor::ITextEditor *editor) const
    { return m_editorSupport.value(editor); }

con's avatar
con committed
104 105
    void emitDocumentUpdated(CPlusPlus::Document::Ptr doc);

Roberto Raggi's avatar
Roberto Raggi committed
106 107 108
    void stopEditorSelectionsUpdate()
    { m_updateEditorSelectionsTimer->stop(); }

109 110 111
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);

112
    virtual QList<int> references(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
113

114 115
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
116
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
117

Christian Kamm's avatar
Christian Kamm committed
118
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
119
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
120

121 122 123 124 125
    virtual void setExtraDiagnostics(const QString &fileName, int key,
                                     const QList<CPlusPlus::Document::DiagnosticMessage> &diagnostics);
    virtual QList<CPlusPlus::Document::DiagnosticMessage> extraDiagnostics(
            const QString &fileName, int key = AllExtraDiagnostics) const;

126 127
    void finishedRefreshingSourceFiles(const QStringList &files);

128
    virtual CppCompletionSupport *completionSupport(Core::IEditor *editor) const;
129
    virtual void setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider);
130

131
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;
132
    virtual void setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory);
133

134 135
    virtual void setIndexingSupport(CppIndexingSupport *indexingSupport);
    virtual CppIndexingSupport *indexingSupport();
136

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

    QStringList includePaths()
    {
        ensureUpdated();
        return m_includePaths;
    }

    QStringList frameworkPaths()
    {
        ensureUpdated();
        return m_frameworkPaths;
    }

    QByteArray definedMacros()
    {
        ensureUpdated();
        return m_definedMacros;
    }

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
Q_SIGNALS:
    void projectPathChanged(const QString &projectPath);

    void aboutToRemoveFiles(const QStringList &files);

public Q_SLOTS:
    void editorOpened(Core::IEditor *editor);
    void editorAboutToClose(Core::IEditor *editor);
    virtual void updateModifiedSourceFiles();

private Q_SLOTS:
    // this should be executed in the GUI thread.
    void onDocumentUpdated(CPlusPlus::Document::Ptr doc);
    void onExtraDiagnosticsUpdated(const QString &fileName);
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
    void onAboutToUnloadSession();
    void onProjectAdded(ProjectExplorer::Project *project);
    void postEditorUpdate();
    void updateEditorSelections();

private:
    void updateEditor(CPlusPlus::Document::Ptr doc);

    WorkingCopy buildWorkingCopyList();

186
    void ensureUpdated();
187 188 189 190
    QStringList internalProjectFiles() const;
    QStringList internalIncludePaths() const;
    QStringList internalFrameworkPaths() const;
    QByteArray internalDefinedMacros() const;
191

192 193
    void dumpModelManagerConfiguration();

194 195 196 197
private:
    static QMutex m_modelManagerMutex;
    static CppModelManager *m_modelManagerInstance;

con's avatar
con committed
198
private:
199
    CPlusPlus::Snapshot m_snapshot;
con's avatar
con committed
200

201 202
    // cache
    bool m_dirty;
con's avatar
con committed
203
    QStringList m_projectFiles;
204 205 206
    QStringList m_includePaths;
    QStringList m_frameworkPaths;
    QByteArray m_definedMacros;
con's avatar
con committed
207 208 209 210

    // editor integration
    QMap<TextEditor::ITextEditor *, CppEditorSupport *> m_editorSupport;

211 212
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

con's avatar
con committed
213 214 215
    // project integration
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;

216
    mutable QMutex mutex;
217
    mutable QMutex protectSnapshot;
218

Roberto Raggi's avatar
Roberto Raggi committed
219
    struct Editor {
220
        Editor()
221 222 223
            : revision(-1)
            , updateSelections(true)
        {}
224
        int revision;
225
        bool updateSelections;
226
        QPointer<TextEditor::ITextEditor> textEditor;
Roberto Raggi's avatar
Roberto Raggi committed
227
        QList<QTextEdit::ExtraSelection> selections;
228
        QList<TextEditor::BaseTextEditorWidget::BlockRange> ifdefedOutBlocks;
Roberto Raggi's avatar
Roberto Raggi committed
229 230 231 232 233
    };

    QList<Editor> m_todo;

    QTimer *m_updateEditorSelectionsTimer;
Roberto Raggi's avatar
Roberto Raggi committed
234

Roberto Raggi's avatar
Roberto Raggi committed
235
    CppFindReferences *m_findReferences;
236
    bool m_indexerEnabled;
237 238 239

    mutable QMutex protectExtraDiagnostics;
    QHash<QString, QHash<int, QList<CPlusPlus::Document::DiagnosticMessage> > > m_extraDiagnostics;
240 241

    QMap<QString, QList<ProjectPart::Ptr> > m_srcToProjectPart;
242

243 244
    CppCompletionAssistProvider *m_completionAssistProvider;
    CppCompletionAssistProvider *m_completionFallback;
245 246
    CppHighlightingSupportFactory *m_highlightingFactory;
    CppHighlightingSupportFactory *m_highlightingFallback;
247
    CppIndexingSupport *m_indexingSupporter;
248
    CppIndexingSupport *m_internalIndexingSupport;
con's avatar
con committed
249
};
250

251
class CPPTOOLS_EXPORT CppPreprocessor: public CPlusPlus::Client
252
{
253 254
    Q_DISABLE_COPY(CppPreprocessor)

255
public:
256
    CppPreprocessor(QPointer<CppModelManager> modelManager, bool dumpFileNameWhileParsing = false);
257 258 259
    virtual ~CppPreprocessor();

    void setRevision(unsigned revision);
260
    void setWorkingCopy(const CPlusPlus::CppModelManagerInterface::WorkingCopy &workingCopy);
261 262
    void setIncludePaths(const QStringList &includePaths);
    void setFrameworkPaths(const QStringList &frameworkPaths);
263
    void addFrameworkPath(const QString &frameworkPath);
264 265 266 267
    void setProjectFiles(const QStringList &files);
    void setTodo(const QStringList &files);

    void run(const QString &fileName);
268
    void removeFromCache(const QString &fileName);
269 270

    void resetEnvironment();
271
    static QString cleanPath(const QString &path);
272 273 274 275

    const QSet<QString> &todo() const
    { return m_todo; }

276 277 278
    CppModelManager *modelManager() const
    { return m_modelManager.data(); }

279 280 281 282 283
protected:
    CPlusPlus::Document::Ptr switchDocument(CPlusPlus::Document::Ptr doc);

    bool includeFile(const QString &absoluteFilePath, QString *result, unsigned *revision);
    QString tryIncludeFile(QString &fileName, IncludeType type, unsigned *revision);
Roberto Raggi's avatar
Roberto Raggi committed
284
    QString tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision);
285 286 287

    void mergeEnvironment(CPlusPlus::Document::Ptr doc);

288
    virtual void macroAdded(const CPlusPlus::Macro &macro);
289 290
    virtual void passedMacroDefinitionCheck(unsigned offset, unsigned line,
                                            const CPlusPlus::Macro &macro);
291
    virtual void failedMacroDefinitionCheck(unsigned offset, const CPlusPlus::ByteArrayRef &name);
292 293
    virtual void notifyMacroReference(unsigned offset, unsigned line,
                                      const CPlusPlus::Macro &macro);
294
    virtual void startExpandingMacro(unsigned offset,
295
                                     unsigned line,
296 297 298
                                     const CPlusPlus::Macro &macro,
                                     const QVector<CPlusPlus::MacroArgumentReference> &actuals);
    virtual void stopExpandingMacro(unsigned offset, const CPlusPlus::Macro &macro);
299
    virtual void markAsIncludeGuard(const QByteArray &macroName);
300 301
    virtual void startSkippingBlocks(unsigned offset);
    virtual void stopSkippingBlocks(unsigned offset);
302
    virtual void sourceNeeded(unsigned line, QString &fileName, IncludeType type);
303 304

private:
305
    CPlusPlus::Snapshot m_snapshot;
306
    QPointer<CppModelManager> m_modelManager;
307
    bool m_dumpFileNameWhileParsing;
308 309
    CPlusPlus::Environment m_env;
    CPlusPlus::Preprocessor m_preprocess;
310
    QStringList m_includePaths;
311
    CPlusPlus::CppModelManagerInterface::WorkingCopy m_workingCopy;
312 313
    QStringList m_frameworkPaths;
    QSet<QString> m_included;
314
    CPlusPlus::Document::Ptr m_currentDoc;
315 316 317
    QSet<QString> m_todo;
    QSet<QString> m_processed;
    unsigned m_revision;
Roberto Raggi's avatar
Roberto Raggi committed
318
    QHash<QString, QString> m_fileNameCache;
319
};
con's avatar
con committed
320 321 322 323 324

} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H