cppmodelmanager.h 10.1 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 "cppmodelmanagerinterface.h"
36

37
#include <projectexplorer/project.h>
38 39
#include <texteditor/basetexteditor.h>

40 41
#include <cplusplus/PreprocessorEnvironment.h>
#include <cplusplus/pp-engine.h>
42 43 44 45 46

#include <QHash>
#include <QMutex>
#include <QTimer>
#include <QTextEdit> // for QTextEdit::ExtraSelection
con's avatar
con committed
47

48
namespace Core { class IEditor; }
con's avatar
con committed
49 50 51

namespace TextEditor {
class ITextEditor;
52
class BaseTextEditorWidget;
53
} // namespace TextEditor
con's avatar
con committed
54

55
namespace ProjectExplorer { class ProjectExplorerPlugin; }
con's avatar
con committed
56

57
namespace CPlusPlus { class ParseManager; }
58

con's avatar
con committed
59
namespace CppTools {
60

61
class CppCompletionSupportFactory;
62
class CppEditorSupport;
63 64
class CppHighlightingSupportFactory;

con's avatar
con committed
65 66
namespace Internal {

67
class CppPreprocessor;
Roberto Raggi's avatar
Roberto Raggi committed
68
class CppFindReferences;
con's avatar
con committed
69

70
class CPPTOOLS_EXPORT CppModelManager : public CppTools::CppModelManagerInterface
con's avatar
con committed
71 72 73
{
    Q_OBJECT

74 75 76
public:
    typedef CPlusPlus::Document Document;

con's avatar
con committed
77
public:
78
    CppModelManager(QObject *parent = 0);
con's avatar
con committed
79 80
    virtual ~CppModelManager();

81 82
    static CppModelManager *instance();

dt's avatar
dt committed
83
    virtual QFuture<void> updateSourceFiles(const QStringList &sourceFiles);
84
    virtual WorkingCopy workingCopy() const;
85 86 87 88

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

91
    virtual CPlusPlus::Snapshot snapshot() const;
92 93
    virtual Document::Ptr document(const QString &fileName) const;
    bool replaceDocument(Document::Ptr newDoc);
con's avatar
con committed
94 95
    virtual void GC();

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

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

100 101
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);
102
    virtual CppEditorSupport *cppEditorSupport(TextEditor::BaseTextEditor *editor);
103

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

106 107
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
108
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
109

Christian Kamm's avatar
Christian Kamm committed
110
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
111
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
112

113
    virtual void setExtraDiagnostics(const QString &fileName, const QString &key,
114
                                     const QList<Document::DiagnosticMessage> &diagnostics);
115

116 117
    void finishedRefreshingSourceFiles(const QStringList &files);

118
    virtual CppCompletionSupport *completionSupport(Core::IEditor *editor) const;
119
    virtual void setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider);
120

121
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;
122
    virtual void setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory);
123

124 125
    virtual void setIndexingSupport(CppIndexingSupport *indexingSupport);
    virtual CppIndexingSupport *indexingSupport();
126

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

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

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

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

151 152 153 154 155 156 157 158 159 160 161 162 163
Q_SIGNALS:
    void projectPathChanged(const QString &projectPath);

    void aboutToRemoveFiles(const QStringList &files);

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

private Q_SLOTS:
    // this should be executed in the GUI thread.
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
    void onAboutToUnloadSession();
164
    void onCoreAboutToClose();
165 166 167
    void onProjectAdded(ProjectExplorer::Project *project);

private:
168
    void replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot);
169 170
    WorkingCopy buildWorkingCopyList();

171
    void ensureUpdated();
172 173 174 175
    QStringList internalProjectFiles() const;
    QStringList internalIncludePaths() const;
    QStringList internalFrameworkPaths() const;
    QByteArray internalDefinedMacros() const;
176

177 178
    void dumpModelManagerConfiguration();

179 180 181 182
private:
    static QMutex m_modelManagerMutex;
    static CppModelManager *m_modelManagerInstance;

con's avatar
con committed
183
private:
184
    CPlusPlus::Snapshot m_snapshot;
185
    bool m_enableGC;
con's avatar
con committed
186

187 188
    // cache
    bool m_dirty;
con's avatar
con committed
189
    QStringList m_projectFiles;
190 191 192
    QStringList m_includePaths;
    QStringList m_frameworkPaths;
    QByteArray m_definedMacros;
con's avatar
con committed
193 194

    // editor integration
195 196
    mutable QMutex m_editorSupportMutex;
    QMap<TextEditor::BaseTextEditor *, CppEditorSupport *> m_editorSupport;
con's avatar
con committed
197

198 199
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

con's avatar
con committed
200 201 202
    // project integration
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;

203 204
    mutable QMutex m_mutex;
    mutable QMutex m_protectSnapshot;
205

Roberto Raggi's avatar
Roberto Raggi committed
206
    CppFindReferences *m_findReferences;
207
    bool m_indexerEnabled;
208

209
    QMap<QString, QList<CppTools::ProjectPart::Ptr> > m_srcToProjectPart;
210

211 212
    CppCompletionAssistProvider *m_completionAssistProvider;
    CppCompletionAssistProvider *m_completionFallback;
213 214
    CppHighlightingSupportFactory *m_highlightingFactory;
    CppHighlightingSupportFactory *m_highlightingFallback;
215
    CppIndexingSupport *m_indexingSupporter;
216
    CppIndexingSupport *m_internalIndexingSupport;
con's avatar
con committed
217
};
218

219
class CPPTOOLS_EXPORT CppPreprocessor: public CPlusPlus::Client
220
{
221 222
    Q_DISABLE_COPY(CppPreprocessor)

223
public:
224
    CppPreprocessor(QPointer<CppModelManager> modelManager, bool dumpFileNameWhileParsing = false);
225 226 227
    virtual ~CppPreprocessor();

    void setRevision(unsigned revision);
228
    void setWorkingCopy(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy);
229 230
    void setIncludePaths(const QStringList &includePaths);
    void setFrameworkPaths(const QStringList &frameworkPaths);
231
    void addFrameworkPath(const QString &frameworkPath);
232 233 234 235
    void setProjectFiles(const QStringList &files);
    void setTodo(const QStringList &files);

    void run(const QString &fileName);
236
    void removeFromCache(const QString &fileName);
237 238

    void resetEnvironment();
239
    static QString cleanPath(const QString &path);
240 241 242 243

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

244 245 246
    CppModelManager *modelManager() const
    { return m_modelManager.data(); }

247 248 249
protected:
    CPlusPlus::Document::Ptr switchDocument(CPlusPlus::Document::Ptr doc);

250 251 252 253
    void getFileContents(const QString &absoluteFilePath, QString *contents, unsigned *revision) const;
    bool checkFile(const QString &absoluteFilePath) const;
    QString resolveFile(const QString &fileName, IncludeType type);
    QString resolveFile_helper(const QString &fileName, IncludeType type);
254 255 256

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

257
    virtual void macroAdded(const CPlusPlus::Macro &macro);
258 259
    virtual void passedMacroDefinitionCheck(unsigned offset, unsigned line,
                                            const CPlusPlus::Macro &macro);
260
    virtual void failedMacroDefinitionCheck(unsigned offset, const CPlusPlus::ByteArrayRef &name);
261 262
    virtual void notifyMacroReference(unsigned offset, unsigned line,
                                      const CPlusPlus::Macro &macro);
263
    virtual void startExpandingMacro(unsigned offset,
264
                                     unsigned line,
265 266 267
                                     const CPlusPlus::Macro &macro,
                                     const QVector<CPlusPlus::MacroArgumentReference> &actuals);
    virtual void stopExpandingMacro(unsigned offset, const CPlusPlus::Macro &macro);
268
    virtual void markAsIncludeGuard(const QByteArray &macroName);
269 270
    virtual void startSkippingBlocks(unsigned offset);
    virtual void stopSkippingBlocks(unsigned offset);
271
    virtual void sourceNeeded(unsigned line, const QString &fileName, IncludeType type);
272 273

private:
274
    CPlusPlus::Snapshot m_snapshot;
275
    QPointer<CppModelManager> m_modelManager;
276
    bool m_dumpFileNameWhileParsing;
277 278
    CPlusPlus::Environment m_env;
    CPlusPlus::Preprocessor m_preprocess;
279
    QStringList m_includePaths;
280
    CppTools::CppModelManagerInterface::WorkingCopy m_workingCopy;
281 282
    QStringList m_frameworkPaths;
    QSet<QString> m_included;
283
    CPlusPlus::Document::Ptr m_currentDoc;
284 285 286
    QSet<QString> m_todo;
    QSet<QString> m_processed;
    unsigned m_revision;
Roberto Raggi's avatar
Roberto Raggi committed
287
    QHash<QString, QString> m_fileNameCache;
288
};
con's avatar
con committed
289 290 291 292 293

} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H