cppmodelmanager.h 11.2 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
{
    Q_OBJECT

82 83 84
public:
    typedef CPlusPlus::Document Document;

con's avatar
con committed
85
public:
86
    CppModelManager(QObject *parent = 0);
con's avatar
con committed
87 88
    virtual ~CppModelManager();

89 90
    static CppModelManager *instance();

dt's avatar
dt committed
91
    virtual QFuture<void> updateSourceFiles(const QStringList &sourceFiles);
92
    virtual WorkingCopy workingCopy() const;
93 94 95 96

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

99
    virtual CPlusPlus::Snapshot snapshot() const;
100 101
    virtual Document::Ptr document(const QString &fileName) const;
    bool replaceDocument(Document::Ptr newDoc);
con's avatar
con committed
102 103
    virtual void GC();

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

Roberto Raggi's avatar
Roberto Raggi committed
106 107 108
    CppEditorSupport *editorSupport(TextEditor::ITextEditor *editor) const
    { return m_editorSupport.value(editor); }

con's avatar
con committed
109 110
    void emitDocumentUpdated(CPlusPlus::Document::Ptr doc);

Roberto Raggi's avatar
Roberto Raggi committed
111 112 113
    void stopEditorSelectionsUpdate()
    { m_updateEditorSelectionsTimer->stop(); }

114 115 116
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);

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

119 120
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
121
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
122

Christian Kamm's avatar
Christian Kamm committed
123
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
124
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
125

126
    virtual void setExtraDiagnostics(const QString &fileName, int key,
127 128
                                     const QList<Document::DiagnosticMessage> &diagnostics);
    virtual QList<Document::DiagnosticMessage> extraDiagnostics(
129 130
            const QString &fileName, int key = AllExtraDiagnostics) const;

131 132
    void finishedRefreshingSourceFiles(const QStringList &files);

133
    virtual CppCompletionSupport *completionSupport(Core::IEditor *editor) const;
134
    virtual void setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider);
135

136
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;
137
    virtual void setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory);
138

139 140
    virtual void setIndexingSupport(CppIndexingSupport *indexingSupport);
    virtual CppIndexingSupport *indexingSupport();
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

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

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

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

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
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:
187
    void updateEditor(Document::Ptr doc);
188

189
    void replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot);
190 191
    WorkingCopy buildWorkingCopyList();

192
    void ensureUpdated();
193 194 195 196
    QStringList internalProjectFiles() const;
    QStringList internalIncludePaths() const;
    QStringList internalFrameworkPaths() const;
    QByteArray internalDefinedMacros() const;
197

198 199
    void dumpModelManagerConfiguration();

200 201 202 203
private:
    static QMutex m_modelManagerMutex;
    static CppModelManager *m_modelManagerInstance;

con's avatar
con committed
204
private:
205
    CPlusPlus::Snapshot m_snapshot;
con's avatar
con committed
206

207 208
    // cache
    bool m_dirty;
con's avatar
con committed
209
    QStringList m_projectFiles;
210 211 212
    QStringList m_includePaths;
    QStringList m_frameworkPaths;
    QByteArray m_definedMacros;
con's avatar
con committed
213 214 215 216

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

217 218
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

con's avatar
con committed
219 220 221
    // project integration
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;

222 223
    mutable QMutex m_mutex;
    mutable QMutex m_protectSnapshot;
224

Roberto Raggi's avatar
Roberto Raggi committed
225
    struct Editor {
226
        Editor()
227 228 229
            : revision(-1)
            , updateSelections(true)
        {}
230
        int revision;
231
        bool updateSelections;
232
        QPointer<TextEditor::ITextEditor> textEditor;
Roberto Raggi's avatar
Roberto Raggi committed
233
        QList<QTextEdit::ExtraSelection> selections;
234
        QList<TextEditor::BaseTextEditorWidget::BlockRange> ifdefedOutBlocks;
Roberto Raggi's avatar
Roberto Raggi committed
235 236 237 238 239
    };

    QList<Editor> m_todo;

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

Roberto Raggi's avatar
Roberto Raggi committed
241
    CppFindReferences *m_findReferences;
242
    bool m_indexerEnabled;
243

244 245
    mutable QMutex m_protectExtraDiagnostics;
    QHash<QString, QHash<int, QList<Document::DiagnosticMessage> > > m_extraDiagnostics;
246

247
    QMap<QString, QList<CPlusPlus::ProjectPart::Ptr> > m_srcToProjectPart;
248

249 250
    CppCompletionAssistProvider *m_completionAssistProvider;
    CppCompletionAssistProvider *m_completionFallback;
251 252
    CppHighlightingSupportFactory *m_highlightingFactory;
    CppHighlightingSupportFactory *m_highlightingFallback;
253
    CppIndexingSupport *m_indexingSupporter;
254
    CppIndexingSupport *m_internalIndexingSupport;
con's avatar
con committed
255
};
256

257
class CPPTOOLS_EXPORT CppPreprocessor: public CPlusPlus::Client
258
{
259 260
    Q_DISABLE_COPY(CppPreprocessor)

261
public:
262
    CppPreprocessor(QPointer<CppModelManager> modelManager, bool dumpFileNameWhileParsing = false);
263 264 265
    virtual ~CppPreprocessor();

    void setRevision(unsigned revision);
266
    void setWorkingCopy(const CPlusPlus::CppModelManagerInterface::WorkingCopy &workingCopy);
267 268
    void setIncludePaths(const QStringList &includePaths);
    void setFrameworkPaths(const QStringList &frameworkPaths);
269
    void addFrameworkPath(const QString &frameworkPath);
270 271 272 273
    void setProjectFiles(const QStringList &files);
    void setTodo(const QStringList &files);

    void run(const QString &fileName);
274
    void removeFromCache(const QString &fileName);
275 276

    void resetEnvironment();
277
    static QString cleanPath(const QString &path);
278 279 280 281

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

282 283 284
    CppModelManager *modelManager() const
    { return m_modelManager.data(); }

285 286 287 288 289
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
290
    QString tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision);
291 292 293

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

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

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

} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H