cppmodelmanager.h 11.1 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"
Wolfgang Beck's avatar
Wolfgang Beck committed
36 37 38
#ifndef ICHECK_BUILD
#  include <projectexplorer/project.h>
#endif
con's avatar
con committed
39
#include <cplusplus/CppDocument.h>
40
#include <cplusplus/PreprocessorClient.h>
Wolfgang Beck's avatar
Wolfgang Beck committed
41 42 43
#ifndef ICHECK_BUILD
#  include <texteditor/basetexteditor.h>
#endif
44 45 46
#include <cplusplus/PreprocessorEnvironment.h>
#include <cplusplus/pp-engine.h>
#ifdef ICHECK_BUILD
Wolfgang Beck's avatar
Wolfgang Beck committed
47 48
#  include "parsemanager.h"
#else
49 50 51 52 53 54
#  include <QHash>
#  include <QFutureInterface>
#  include <QFutureSynchronizer>
#  include <QMutex>
#  include <QTimer>
#  include <QTextEdit> // for QTextEdit::ExtraSelection
55
#endif
con's avatar
con committed
56 57 58 59 60 61 62

namespace Core {
class IEditor;
}

namespace TextEditor {
class ITextEditor;
63
class BaseTextEditorWidget;
con's avatar
con committed
64 65 66 67 68 69
}

namespace ProjectExplorer {
class ProjectExplorerPlugin;
}

70 71 72 73
namespace CPlusPlus {
    class ParseManager;
}

con's avatar
con committed
74
namespace CppTools {
75

76 77 78
class CppCompletionSupportFactory;
class CppHighlightingSupportFactory;

con's avatar
con committed
79 80 81
namespace Internal {

class CppEditorSupport;
82
class CppPreprocessor;
Roberto Raggi's avatar
Roberto Raggi committed
83
class CppFindReferences;
con's avatar
con committed
84

85
#ifndef ICHECK_BUILD
86
class CPPTOOLS_EXPORT CppModelManager : public CPlusPlus::CppModelManagerInterface
con's avatar
con committed
87 88 89 90 91 92 93
{
    Q_OBJECT

public:
    CppModelManager(QObject *parent);
    virtual ~CppModelManager();

94 95
    static CppModelManager *instance();

dt's avatar
dt committed
96
    virtual QFuture<void> updateSourceFiles(const QStringList &sourceFiles);
97
    virtual WorkingCopy workingCopy() const;
98 99 100 101

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

104
    virtual CPlusPlus::Snapshot snapshot() const;
con's avatar
con committed
105 106 107 108
    virtual void GC();

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

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

Roberto Raggi's avatar
Roberto Raggi committed
111 112 113
    CppEditorSupport *editorSupport(TextEditor::ITextEditor *editor) const
    { return m_editorSupport.value(editor); }

con's avatar
con committed
114 115
    void emitDocumentUpdated(CPlusPlus::Document::Ptr doc);

Roberto Raggi's avatar
Roberto Raggi committed
116 117 118
    void stopEditorSelectionsUpdate()
    { m_updateEditorSelectionsTimer->stop(); }

119 120 121
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);

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

124 125
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
126
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
127

Christian Kamm's avatar
Christian Kamm committed
128
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);
129
    virtual void renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement);
Christian Kamm's avatar
Christian Kamm committed
130

131 132 133 134 135
    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;

136 137
    void finishedRefreshingSourceFiles(const QStringList &files);

138
    virtual CppCompletionSupport *completionSupport(Core::IEditor *editor) const;
139
    virtual void setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider);
140

141
    virtual CppHighlightingSupport *highlightingSupport(Core::IEditor *editor) const;
142
    virtual void setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory);
143

con's avatar
con committed
144 145 146 147 148 149 150 151
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);
152
    virtual void updateModifiedSourceFiles();
con's avatar
con committed
153 154 155 156

private Q_SLOTS:
    // this should be executed in the GUI thread.
    void onDocumentUpdated(CPlusPlus::Document::Ptr doc);
157
    void onExtraDiagnosticsUpdated(const QString &fileName);
con's avatar
con committed
158
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
159
    void onAboutToUnloadSession();
160
    void onProjectAdded(ProjectExplorer::Project *project);
Roberto Raggi's avatar
Roberto Raggi committed
161 162
    void postEditorUpdate();
    void updateEditorSelections();
con's avatar
con committed
163 164

private:
165 166
    void updateEditor(CPlusPlus::Document::Ptr doc);

167
    WorkingCopy buildWorkingCopyList();
168

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
    QStringList projectFiles()
    {
        ensureUpdated();
        return m_projectFiles;
    }

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

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

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

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

con's avatar
con committed
199
    static void parse(QFutureInterface<void> &future,
200 201
                      CppPreprocessor *preproc,
                      QStringList files);
con's avatar
con committed
202 203

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

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

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

216 217
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

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

221
    mutable QMutex mutex;
222
    mutable QMutex protectSnapshot;
223

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

    QList<Editor> m_todo;

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

    QFutureSynchronizer<void> m_synchronizer;
241
    unsigned m_revision;
Roberto Raggi's avatar
Roberto Raggi committed
242 243

    CppFindReferences *m_findReferences;
244
    bool m_indexerEnabled;
245
    bool m_dumpFileNameWhileParsing;
246 247 248

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

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

252 253
    CppCompletionAssistProvider *m_completionAssistProvider;
    CppCompletionAssistProvider *m_completionFallback;
254 255
    CppHighlightingSupportFactory *m_highlightingFactory;
    CppHighlightingSupportFactory *m_highlightingFallback;
con's avatar
con committed
256
};
257 258
#endif

259
class CPPTOOLS_EXPORT CppPreprocessor: public CPlusPlus::Client
260 261 262
{
public:
#ifndef ICHECK_BUILD
263
    CppPreprocessor(QPointer<CppModelManager> modelManager, bool dumpFileNameWhileParsing = false);
264 265 266 267 268 269
#else
    CppPreprocessor(QPointer<CPlusPlus::ParseManager> modelManager);
#endif
    virtual ~CppPreprocessor();

    void setRevision(unsigned revision);
270
    void setWorkingCopy(const CPlusPlus::CppModelManagerInterface::WorkingCopy &workingCopy);
271 272
    void setIncludePaths(const QStringList &includePaths);
    void setFrameworkPaths(const QStringList &frameworkPaths);
273
    void addFrameworkPath(const QString &frameworkPath);
274 275 276 277 278 279 280 281 282 283
    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; }

284 285 286
    CppModelManager *modelManager() const
    { return m_modelManager.data(); }

287
public: // attributes
288
    CPlusPlus::Snapshot snapshot;
289 290 291 292 293 294

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
295
    QString tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision);
296 297 298

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

299
    virtual void macroAdded(const CPlusPlus::Macro &macro);
300 301
    virtual void passedMacroDefinitionCheck(unsigned offset, unsigned line,
                                            const CPlusPlus::Macro &macro);
302
    virtual void failedMacroDefinitionCheck(unsigned offset, const CPlusPlus::ByteArrayRef &name);
303 304
    virtual void notifyMacroReference(unsigned offset, unsigned line,
                                      const CPlusPlus::Macro &macro);
305
    virtual void startExpandingMacro(unsigned offset,
306
                                     unsigned line,
307 308 309
                                     const CPlusPlus::Macro &macro,
                                     const QVector<CPlusPlus::MacroArgumentReference> &actuals);
    virtual void stopExpandingMacro(unsigned offset, const CPlusPlus::Macro &macro);
310 311
    virtual void startSkippingBlocks(unsigned offset);
    virtual void stopSkippingBlocks(unsigned offset);
312
    virtual void sourceNeeded(unsigned line, QString &fileName, IncludeType type);
313 314 315 316 317

private:
#ifndef ICHECK_BUILD
    QPointer<CppModelManager> m_modelManager;
#endif
318
    bool m_dumpFileNameWhileParsing;
319 320
    CPlusPlus::Environment env;
    CPlusPlus::Preprocessor preprocess;
321 322
    QStringList m_includePaths;
    QStringList m_systemIncludePaths;
323
    CPlusPlus::CppModelManagerInterface::WorkingCopy m_workingCopy;
324 325 326
    QStringList m_projectFiles;
    QStringList m_frameworkPaths;
    QSet<QString> m_included;
327
    CPlusPlus::Document::Ptr m_currentDoc;
328 329 330
    QSet<QString> m_todo;
    QSet<QString> m_processed;
    unsigned m_revision;
Roberto Raggi's avatar
Roberto Raggi committed
331
    QHash<QString, QString> m_fileNameCache;
332
};
con's avatar
con committed
333 334 335 336 337

} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H