cppmodelmanager.h 7.06 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 "cppmodelmanagerinterface.h"
35

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

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

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

namespace TextEditor {
45
class BaseTextEditorWidget;
46
} // namespace TextEditor
con's avatar
con committed
47 48

namespace CppTools {
49

50
class CppEditorSupport;
51 52
class CppHighlightingSupportFactory;

con's avatar
con committed
53 54
namespace Internal {

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

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

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

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

68 69
    static CppModelManager *instance();

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

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

79
    virtual CPlusPlus::Snapshot snapshot() const;
80 81
    virtual Document::Ptr document(const QString &fileName) const;
    bool replaceDocument(Document::Ptr newDoc);
con's avatar
con committed
82 83
    virtual void GC();

84
    virtual bool isCppEditor(Core::IEditor *editor) const;
con's avatar
con committed
85 86 87

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

88 89
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);
90
    virtual CppEditorSupport *cppEditorSupport(TextEditor::BaseTextEditor *editor);
91
    virtual void deleteEditorSupport(TextEditor::BaseTextEditor *textEditor);
92

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

95 96
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
97
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
98

Christian Kamm's avatar
Christian Kamm committed
99
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
100
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
101

102
    virtual void setExtraDiagnostics(const QString &fileName, const QString &key,
103
                                     const QList<Document::DiagnosticMessage> &diagnostics);
104

105 106
    void finishedRefreshingSourceFiles(const QStringList &files);

107
    virtual CppCompletionSupport *completionSupport(Core::IEditor *editor) const;
108
    virtual void setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider);
109

110
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;
111
    virtual void setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory);
112

113 114
    virtual void setIndexingSupport(CppIndexingSupport *indexingSupport);
    virtual CppIndexingSupport *indexingSupport();
115

116 117 118 119 120 121 122 123 124 125 126 127
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

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

128 129 130 131 132 133
    // Use this *only* for auto tests
    void setIncludePaths(const QStringList &includePaths)
    {
        m_includePaths = includePaths;
    }

134 135 136 137 138 139 140 141 142 143 144 145
    QStringList frameworkPaths()
    {
        ensureUpdated();
        return m_frameworkPaths;
    }

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

146 147 148 149 150 151 152 153 154 155
Q_SIGNALS:
    void aboutToRemoveFiles(const QStringList &files);

public Q_SLOTS:
    virtual void updateModifiedSourceFiles();

private Q_SLOTS:
    // this should be executed in the GUI thread.
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
    void onAboutToUnloadSession();
156
    void onCoreAboutToClose();
157 158 159
    void onProjectAdded(ProjectExplorer::Project *project);

private:
160
    void replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot);
161 162
    WorkingCopy buildWorkingCopyList();

163
    void ensureUpdated();
164 165 166 167
    QStringList internalProjectFiles() const;
    QStringList internalIncludePaths() const;
    QStringList internalFrameworkPaths() const;
    QByteArray internalDefinedMacros() const;
168

169 170
    void dumpModelManagerConfiguration();

171 172 173 174
private:
    static QMutex m_modelManagerMutex;
    static CppModelManager *m_modelManagerInstance;

con's avatar
con committed
175
private:
176 177
    // snapshot
    mutable QMutex m_snapshotMutex;
178
    CPlusPlus::Snapshot m_snapshot;
179

180
    bool m_enableGC;
con's avatar
con committed
181

182 183 184 185 186
    // project integration
    mutable QMutex m_projectMutex;
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;
    QMap<QString, QList<CppTools::ProjectPart::Ptr> > m_srcToProjectPart;
    // cached/calculated from the projects and/or their project-parts
187
    bool m_dirty;
con's avatar
con committed
188
    QStringList m_projectFiles;
189 190 191
    QStringList m_includePaths;
    QStringList m_frameworkPaths;
    QByteArray m_definedMacros;
con's avatar
con committed
192 193

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

197 198
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

Roberto Raggi's avatar
Roberto Raggi committed
199
    CppFindReferences *m_findReferences;
200
    bool m_indexerEnabled;
201

202 203
    CppCompletionAssistProvider *m_completionAssistProvider;
    CppCompletionAssistProvider *m_completionFallback;
204 205
    CppHighlightingSupportFactory *m_highlightingFactory;
    CppHighlightingSupportFactory *m_highlightingFallback;
206
    CppIndexingSupport *m_indexingSupporter;
207
    CppIndexingSupport *m_internalIndexingSupport;
con's avatar
con committed
208
};
209

con's avatar
con committed
210 211 212 213
} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H