cppmodelmanager.h 9.89 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34 35 36
#ifndef CPPMODELMANAGER_H
#define CPPMODELMANAGER_H

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

namespace Core {
class ICore;
class IEditor;
}

namespace TextEditor {
class ITextEditor;
Roberto Raggi's avatar
Roberto Raggi committed
67
class BaseTextEditor;
con's avatar
con committed
68 69 70 71 72 73
}

namespace ProjectExplorer {
class ProjectExplorerPlugin;
}

74 75 76 77
namespace CPlusPlus {
    class ParseManager;
}

con's avatar
con committed
78
namespace CppTools {
79

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

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

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

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

95 96
    static CppModelManager *instance();

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

    virtual QList<ProjectInfo> projectInfos() const;
    virtual ProjectInfo projectInfo(ProjectExplorer::Project *project) const;
    virtual void updateProjectInfo(const ProjectInfo &pinfo);

104 105
    virtual QStringList includesInPath(const QString &path) const;

106
    virtual CPlusPlus::Snapshot snapshot() const;
con's avatar
con committed
107 108 109 110 111 112
    virtual void GC();

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

    inline Core::ICore *core() const { return m_core; }

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

Roberto Raggi's avatar
Roberto Raggi committed
115 116 117
    CppEditorSupport *editorSupport(TextEditor::ITextEditor *editor) const
    { return m_editorSupport.value(editor); }

con's avatar
con committed
118 119
    void emitDocumentUpdated(CPlusPlus::Document::Ptr doc);

Roberto Raggi's avatar
Roberto Raggi committed
120 121 122
    void stopEditorSelectionsUpdate()
    { m_updateEditorSelectionsTimer->stop(); }

123 124 125
    virtual void addEditorSupport(AbstractEditorSupport *editorSupport);
    virtual void removeEditorSupport(AbstractEditorSupport *editorSupport);

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

128 129
    virtual void renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                              const QString &replacement = QString());
130
    virtual void findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context);
Roberto Raggi's avatar
Roberto Raggi committed
131

Christian Kamm's avatar
Christian Kamm committed
132 133
    virtual void findMacroUsages(const CPlusPlus::Macro &macro);

134
    virtual QList<LanguageUtils::FakeMetaObject::ConstPtr> exportedQmlObjects() const;
135

136 137 138
    void setHeaderSuffixes(const QStringList &suffixes)
    { m_headerSuffixes = suffixes; }

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

private Q_SLOTS:
    // this should be executed in the GUI thread.
    void onDocumentUpdated(CPlusPlus::Document::Ptr doc);
    void onAboutToRemoveProject(ProjectExplorer::Project *project);
153
    void onAboutToUnloadSession();
154
    void onProjectAdded(ProjectExplorer::Project *project);
Roberto Raggi's avatar
Roberto Raggi committed
155 156
    void postEditorUpdate();
    void updateEditorSelections();
con's avatar
con committed
157 158

private:
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

191
    void setIncludesInPaths(const QMap<QString, QStringList> &includesInPaths);
192 193 194 195

    static void updateIncludesInPaths(QFutureInterface<void> &future,
                                      CppModelManager *manager,
                                      QStringList paths,
196
                                      QStringList frameworkPaths,
197 198
                                      QStringList suffixes);

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 204

private:
    Core::ICore *m_core;
205
    CPlusPlus::Snapshot m_snapshot;
con's avatar
con committed
206

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

214 215 216
    QMap<QString, QStringList> m_includesInPaths;
    QStringList m_headerSuffixes;

con's avatar
con committed
217 218 219
    // editor integration
    QMap<TextEditor::ITextEditor *, CppEditorSupport *> m_editorSupport;

220 221
    QSet<AbstractEditorSupport *> m_addtionalEditorSupport;

con's avatar
con committed
222 223 224
    // project integration
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projects;

225
    mutable QMutex mutex;
226
    mutable QMutex protectSnapshot;
227

Roberto Raggi's avatar
Roberto Raggi committed
228
    struct Editor {
229 230 231
        Editor()
                : revision(-1) {}
        int revision;
232
        QPointer<TextEditor::ITextEditor> textEditor;
Roberto Raggi's avatar
Roberto Raggi committed
233
        QList<QTextEdit::ExtraSelection> selections;
234
        QList<TextEditor::BaseTextEditor::BlockRange> ifdefedOutBlocks;
Roberto Raggi's avatar
Roberto Raggi committed
235 236 237 238 239
    };

    QList<Editor> m_todo;

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

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

    CppFindReferences *m_findReferences;
245
    bool m_indexerEnabled;
con's avatar
con committed
246
};
247 248
#endif

249
class CPPTOOLS_EXPORT CppPreprocessor: public CPlusPlus::Client
250 251 252 253 254 255 256 257 258 259
{
public:
#ifndef ICHECK_BUILD
    CppPreprocessor(QPointer<CppModelManager> modelManager);
#else
    CppPreprocessor(QPointer<CPlusPlus::ParseManager> modelManager);
#endif
    virtual ~CppPreprocessor();

    void setRevision(unsigned revision);
260
    void setWorkingCopy(const CPlusPlus::CppModelManagerInterface::WorkingCopy &workingCopy);
261 262
    void setIncludePaths(const QStringList &includePaths);
    void setFrameworkPaths(const QStringList &frameworkPaths);
263
    void addFrameworkPath(const QString &frameworkPath);
264 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; }

public: // attributes
275
    CPlusPlus::Snapshot snapshot;
276 277 278 279 280 281

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
282
    QString tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision);
283 284 285

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

286 287
    virtual void macroAdded(const CPlusPlus::Macro &macro);
    virtual void passedMacroDefinitionCheck(unsigned offset, const CPlusPlus::Macro &macro);
288 289
    virtual void failedMacroDefinitionCheck(unsigned offset, const QByteArray &name);
    virtual void startExpandingMacro(unsigned offset,
290
                                     const CPlusPlus::Macro &macro,
291 292
                                     const QByteArray &originalText,
                                     bool inCondition,
293 294
                                     const QVector<CPlusPlus::MacroArgumentReference> &actuals);
    virtual void stopExpandingMacro(unsigned offset, const CPlusPlus::Macro &macro);
295 296 297 298 299 300 301 302 303
    virtual void startSkippingBlocks(unsigned offset);
    virtual void stopSkippingBlocks(unsigned offset);
    virtual void sourceNeeded(QString &fileName, IncludeType type,
                              unsigned line);

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

} // namespace Internal
} // namespace CppTools

#endif // CPPMODELMANAGER_H