cppmodelmanager.h 8.53 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 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 "cppmodelmanagerinterface.h"
34

35
#include <projectexplorer/project.h>
36 37
#include <texteditor/basetexteditor.h>

38 39
#include <QHash>
#include <QMutex>
40
#include <QTimer>
con's avatar
con committed
41

42
namespace Core { class IEditor; }
43
namespace TextEditor { class BaseTextEditorWidget; }
con's avatar
con committed
44 45

namespace CppTools {
46

47
class CppEditorSupport;
48

con's avatar
con committed
49 50
namespace Internal {

Roberto Raggi's avatar
Roberto Raggi committed
51
class CppFindReferences;
52
class CppSourceProcessor;
con's avatar
con committed
53

54
class CppModelManager : public CppTools::CppModelManagerInterface
con's avatar
con committed
55 56 57
{
    Q_OBJECT

58 59 60
public:
    typedef CPlusPlus::Document Document;

con's avatar
con committed
61
public:
62
    CppModelManager(QObject *parent = 0);
con's avatar
con committed
63 64
    virtual ~CppModelManager();

65 66
    static CppModelManager *instance();

67 68
    virtual QFuture<void> updateSourceFiles(const QStringList &sourceFiles,
        ProgressNotificationMode mode = ReservedProgressNotification);
69
    virtual WorkingCopy workingCopy() const;
70
    virtual QByteArray codeModelConfiguration() const;
71 72 73

    virtual QList<ProjectInfo> projectInfos() const;
    virtual ProjectInfo projectInfo(ProjectExplorer::Project *project) const;
74
    virtual QFuture<void> updateProjectInfo(const ProjectInfo &newProjectInfo);
75

76 77
    /// \return The project part with the given project file
    virtual ProjectPart::Ptr projectPartForProjectFile(const QString &projectFile) const;
78 79 80 81 82 83 84
    /// \return All project parts that mention the given file name as one of the sources/headers.
    virtual QList<ProjectPart::Ptr> projectPart(const QString &fileName) const;
    /// This is a fall-back function: find all files that includes the file directly or indirectly,
    /// and return its \c ProjectPart list for use with this file.
    virtual QList<ProjectPart::Ptr> projectPartFromDependencies(const QString &fileName) const;
    /// \return A synthetic \c ProjectPart which consists of all defines/includes/frameworks from
    ///         all loaded projects.
85
    virtual ProjectPart::Ptr fallbackProjectPart() const;
86

87
    virtual CPlusPlus::Snapshot snapshot() const;
88 89
    virtual Document::Ptr document(const QString &fileName) const;
    bool replaceDocument(Document::Ptr newDoc);
con's avatar
con committed
90 91 92

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

93 94 95 96 97 98
    virtual bool isCppEditor(Core::IEditor *editor) const;

    virtual void addExtraEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeExtraEditorSupport(AbstractEditorSupport *editorSupport);
    virtual CppEditorSupport *cppEditorSupport(TextEditor::BaseTextEditor *textEditor);
    virtual void deleteCppEditorSupport(TextEditor::BaseTextEditor *textEditor);
99

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

102 103
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
104
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
105

Christian Kamm's avatar
Christian Kamm committed
106
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
107
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
108

109
    virtual bool setExtraDiagnostics(const QString &fileName, const QString &key,
110
                                     const QList<Document::DiagnosticMessage> &diagnostics);
111 112
    virtual void setIfdefedOutBlocks(const QString &fileName,
                                     const QList<TextEditor::BlockRange> &ifdeffedOutBlocks);
113

114 115
    void finishedRefreshingSourceFiles(const QStringList &files);

116
    virtual void addModelManagerSupport(ModelManagerSupport *modelManagerSupport);
117
    virtual ModelManagerSupport *modelManagerSupportForMimeType(const QString &mimeType) const;
118
    virtual CppCompletionAssistProvider *completionAssistProvider(const QString &mimeType) const;
119 120
    virtual CppHighlightingSupport *highlightingSupport(
            TextEditor::BaseTextDocument *baseTextDocument) const;
121

122 123
    virtual void setIndexingSupport(CppIndexingSupport *indexingSupport);
    virtual CppIndexingSupport *indexingSupport();
124

125 126 127 128 129 130 131 132 133 134 135 136
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

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

137 138 139 140 141 142
    // Use this *only* for auto tests
    void setIncludePaths(const QStringList &includePaths)
    {
        m_includePaths = includePaths;
    }

143 144 145 146 147 148 149 150 151 152 153 154
    QStringList frameworkPaths()
    {
        ensureUpdated();
        return m_frameworkPaths;
    }

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

155 156
    void enableGarbageCollector(bool enable);

157
    static QStringList timeStampModifiedFiles(const QList<Document::Ptr> &documentsToCheck);
158

159 160
    static CppSourceProcessor *createSourceProcessor();

161
signals:
162
    void gcFinished(); // Needed for tests.
163

164
public slots:
165
    virtual void updateModifiedSourceFiles();
166
    virtual void GC();
167

168 169
private slots:
    // This should be executed in the GUI thread.
170
    void onAboutToLoadSession();
171 172
    void onAboutToUnloadSession();
    void onProjectAdded(ProjectExplorer::Project *project);
173 174
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
    void onCoreAboutToClose();
175 176

private:
177
    void delayedGC();
178 179
    void recalculateFileToProjectParts();

180
    void replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot);
181 182 183
    void removeFilesFromSnapshot(const QSet<QString> &removedFiles);
    void removeProjectInfoFilesAndIncludesFromSnapshot(const ProjectInfo &projectInfo);

184 185
    QList<CppEditorSupport *> cppEditorSupportList() const;

186 187
    WorkingCopy buildWorkingCopyList();

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

194
    void dumpModelManagerConfiguration(const QString &logFileId);
195

196
private:
197 198
    static QMutex m_instanceMutex;
    static CppModelManager *m_instance;
199

con's avatar
con committed
200
private:
201
    // Snapshot
202
    mutable QMutex m_snapshotMutex;
203
    CPlusPlus::Snapshot m_snapshot;
204

205
    // Project integration
206
    mutable QMutex m_projectMutex;
207 208
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projectToProjectsInfo;
    QMap<QString, QList<CppTools::ProjectPart::Ptr> > m_fileToProjectParts;
209
    QMap<QString, CppTools::ProjectPart::Ptr> m_projectFileToProjectPart;
210
    // The members below are cached/(re)calculated from the projects and/or their project parts
211
    bool m_dirty;
con's avatar
con committed
212
    QStringList m_projectFiles;
213 214 215
    QStringList m_includePaths;
    QStringList m_frameworkPaths;
    QByteArray m_definedMacros;
con's avatar
con committed
216

217 218 219 220
    // Editor integration
    mutable QMutex m_cppEditorSupportsMutex;
    QMap<TextEditor::BaseTextEditor *, CppEditorSupport *> m_cppEditorSupports;
    QSet<AbstractEditorSupport *> m_extraEditorSupports;
221

222
    // Completion & highlighting
223
    QHash<QString, ModelManagerSupport *> m_idTocodeModelSupporter;
224
    QScopedPointer<ModelManagerSupport> m_modelManagerSupportFallback;
225 226

    // Indexing
227
    CppIndexingSupport *m_indexingSupporter;
228
    CppIndexingSupport *m_internalIndexingSupport;
229 230 231 232 233
    bool m_indexerEnabled;

    CppFindReferences *m_findReferences;

    bool m_enableGC;
234
    QTimer *m_delayedGcTimer;
con's avatar
con committed
235
};
236

con's avatar
con committed
237 238 239 240
} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H