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

35
#include "cppmodelmanagerinterface.h"
36

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

40 41
#include <QHash>
#include <QMutex>
42
#include <QTimer>
con's avatar
con committed
43

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

namespace CppTools {
48

49
class CppEditorSupport;
50 51
class CppHighlightingSupportFactory;

con's avatar
con committed
52 53
namespace Internal {

Roberto Raggi's avatar
Roberto Raggi committed
54
class CppFindReferences;
con's avatar
con committed
55

56
class CPPTOOLS_EXPORT CppModelManager : public CppTools::CppModelManagerInterface
con's avatar
con committed
57 58 59
{
    Q_OBJECT

60 61 62
public:
    typedef CPlusPlus::Document Document;

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

67 68
    static CppModelManager *instance();

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

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

78 79
    /// \return The project part with the given project file
    virtual ProjectPart::Ptr projectPartForProjectFile(const QString &projectFile) const;
80 81 82 83 84 85 86
    /// \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.
87
    virtual ProjectPart::Ptr fallbackProjectPart() const;
88

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

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

95 96 97 98 99 100
    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);
101

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

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

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

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

116 117
    void finishedRefreshingSourceFiles(const QStringList &files);

118
    virtual void addModelManagerSupport(ModelManagerSupport *modelManagerSupport);
119
    virtual ModelManagerSupport *modelManagerSupportForMimeType(const QString &mimeType) const;
120
    virtual CppCompletionAssistProvider *completionAssistProvider(Core::IEditor *editor) const;
121 122
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;

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

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

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

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

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

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

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

158
signals:
159
    void gcFinished(); // Needed for tests.
160

161
public slots:
162
    virtual void updateModifiedSourceFiles();
163
    virtual void GC();
164

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

private:
174
    void delayedGC();
175 176
    void recalculateFileToProjectParts();

177
    void replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot);
178 179 180
    void removeFilesFromSnapshot(const QSet<QString> &removedFiles);
    void removeProjectInfoFilesAndIncludesFromSnapshot(const ProjectInfo &projectInfo);

181 182
    WorkingCopy buildWorkingCopyList();

183
    void ensureUpdated();
184 185 186 187
    QStringList internalProjectFiles() const;
    QStringList internalIncludePaths() const;
    QStringList internalFrameworkPaths() const;
    QByteArray internalDefinedMacros() const;
188

189 190
    void dumpModelManagerConfiguration();

191
private:
192 193
    static QMutex m_instanceMutex;
    static CppModelManager *m_instance;
194

con's avatar
con committed
195
private:
196
    // Snapshot
197
    mutable QMutex m_snapshotMutex;
198
    CPlusPlus::Snapshot m_snapshot;
199

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

212 213 214 215
    // Editor integration
    mutable QMutex m_cppEditorSupportsMutex;
    QMap<TextEditor::BaseTextEditor *, CppEditorSupport *> m_cppEditorSupports;
    QSet<AbstractEditorSupport *> m_extraEditorSupports;
216

217
    // Completion & highlighting
218
    QHash<QString, ModelManagerSupport *> m_idTocodeModelSupporter;
219
    QScopedPointer<ModelManagerSupport> m_modelManagerSupportFallback;
220 221

    // Indexing
222
    CppIndexingSupport *m_indexingSupporter;
223
    CppIndexingSupport *m_internalIndexingSupport;
224 225 226 227 228
    bool m_indexerEnabled;

    CppFindReferences *m_findReferences;

    bool m_enableGC;
229
    QTimer *m_delayedGcTimer;
con's avatar
con committed
230
};
231

con's avatar
con committed
232 233 234 235
} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H