cppmodelmanager.h 10.9 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
hjk's avatar
hjk committed
3 4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** 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 82
{
    Q_OBJECT

public:
83
    CppModelManager(QObject *parent = 0);
con's avatar
con committed
84 85
    virtual ~CppModelManager();

86 87
    static CppModelManager *instance();

dt's avatar
dt committed
88
    virtual QFuture<void> updateSourceFiles(const QStringList &sourceFiles);
89
    virtual WorkingCopy workingCopy() const;
90 91 92 93

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

96
    virtual CPlusPlus::Snapshot snapshot() const;
con's avatar
con committed
97 98 99 100
    virtual void GC();

    QFuture<void> refreshSourceFiles(const QStringList &sourceFiles);

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

Roberto Raggi's avatar
Roberto Raggi committed
103 104 105
    CppEditorSupport *editorSupport(TextEditor::ITextEditor *editor) const
    { return m_editorSupport.value(editor); }

con's avatar
con committed
106 107
    void emitDocumentUpdated(CPlusPlus::Document::Ptr doc);

Roberto Raggi's avatar
Roberto Raggi committed
108 109 110
    void stopEditorSelectionsUpdate()
    { m_updateEditorSelectionsTimer->stop(); }

111 112 113
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);

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

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

Christian Kamm's avatar
Christian Kamm committed
120
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
121
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
122

123 124 125 126 127
    virtual void setExtraDiagnostics(const QString &fileName, int key,
                                     const QList<CPlusPlus::Document::DiagnosticMessage> &diagnostics);
    virtual QList<CPlusPlus::Document::DiagnosticMessage> extraDiagnostics(
            const QString &fileName, int key = AllExtraDiagnostics) const;

128 129
    void finishedRefreshingSourceFiles(const QStringList &files);

130
    virtual CppCompletionSupport *completionSupport(Core::IEditor *editor) const;
131
    virtual void setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider);
132

133
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;
134
    virtual void setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory);
135

con's avatar
con committed
136 137 138 139 140 141 142 143
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);
144
    virtual void updateModifiedSourceFiles();
con's avatar
con committed
145 146 147 148

private Q_SLOTS:
    // this should be executed in the GUI thread.
    void onDocumentUpdated(CPlusPlus::Document::Ptr doc);
149
    void onExtraDiagnosticsUpdated(const QString &fileName);
con's avatar
con committed
150
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
151
    void onAboutToUnloadSession();
152
    void onProjectAdded(ProjectExplorer::Project *project);
Roberto Raggi's avatar
Roberto Raggi committed
153 154
    void postEditorUpdate();
    void updateEditorSelections();
con's avatar
con committed
155 156

private:
157 158
    void updateEditor(CPlusPlus::Document::Ptr doc);

159
    WorkingCopy buildWorkingCopyList();
160

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

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

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

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

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

con's avatar
con committed
191
    static void parse(QFutureInterface<void> &future,
192 193
                      CppPreprocessor *preproc,
                      QStringList files);
con's avatar
con committed
194

195 196 197 198
private:
    static QMutex m_modelManagerMutex;
    static CppModelManager *m_modelManagerInstance;

con's avatar
con committed
199
private:
200
    CPlusPlus::Snapshot m_snapshot;
con's avatar
con committed
201

202 203
    // cache
    bool m_dirty;
con's avatar
con committed
204
    QStringList m_projectFiles;
205 206 207
    QStringList m_includePaths;
    QStringList m_frameworkPaths;
    QByteArray m_definedMacros;
con's avatar
con committed
208 209 210 211

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

212 213
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

con's avatar
con committed
214 215 216
    // project integration
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;

217
    mutable QMutex mutex;
218
    mutable QMutex protectSnapshot;
219

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

    QList<Editor> m_todo;

    QTimer *m_updateEditorSelectionsTimer;
Roberto Raggi's avatar
Roberto Raggi committed
235 236

    QFutureSynchronizer<void> m_synchronizer;
237
    unsigned m_revision;
Roberto Raggi's avatar
Roberto Raggi committed
238 239

    CppFindReferences *m_findReferences;
240
    bool m_indexerEnabled;
241
    bool m_dumpFileNameWhileParsing;
242 243 244

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

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

248 249
    CppCompletionAssistProvider *m_completionAssistProvider;
    CppCompletionAssistProvider *m_completionFallback;
250 251
    CppHighlightingSupportFactory *m_highlightingFactory;
    CppHighlightingSupportFactory *m_highlightingFallback;
con's avatar
con committed
252
};
253

254
class CPPTOOLS_EXPORT CppPreprocessor: public CPlusPlus::Client
255 256
{
public:
257
    CppPreprocessor(QPointer<CppModelManager> modelManager, bool dumpFileNameWhileParsing = false);
258 259 260
    virtual ~CppPreprocessor();

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

    void run(const QString &fileName);

    void resetEnvironment();

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

275 276 277
    CppModelManager *modelManager() const
    { return m_modelManager.data(); }

278
public: // attributes
279
    CPlusPlus::Snapshot snapshot;
280 281 282 283 284 285

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

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

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

private:
    QPointer<CppModelManager> m_modelManager;
307
    bool m_dumpFileNameWhileParsing;
308 309
    CPlusPlus::Environment env;
    CPlusPlus::Preprocessor preprocess;
310 311
    QStringList m_includePaths;
    QStringList m_systemIncludePaths;
312
    CPlusPlus::CppModelManagerInterface::WorkingCopy m_workingCopy;
313 314 315
    QStringList m_projectFiles;
    QStringList m_frameworkPaths;
    QSet<QString> m_included;
316
    CPlusPlus::Document::Ptr m_currentDoc;
317 318 319
    QSet<QString> m_todo;
    QSet<QString> m_processed;
    unsigned m_revision;
Roberto Raggi's avatar
Roberto Raggi committed
320
    QHash<QString, QString> m_fileNameCache;
321
};
con's avatar
con committed
322 323 324 325 326

} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H