builtineditordocumentparser.cpp 8.87 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5 6 7 8 9 10 11
**
** This file is part of Qt Creator.
**
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
27 28 29 30
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

31
#include "builtineditordocumentparser.h"
32
#include "cppsourceprocessor.h"
33
#include "editordocumenthandle.h"
34 35 36 37 38 39 40

#include <utils/qtcassert.h>

using namespace CPlusPlus;
using namespace CppTools;
using namespace CppTools::Internal;

41
BuiltinEditorDocumentParser::BuiltinEditorDocumentParser(const QString &filePath)
42
    : BaseEditorDocumentParser(filePath)
43
    , m_forceSnapshotInvalidation(false)
44
    , m_releaseSourceAndAST(true)
45
{
46
    qRegisterMetaType<CPlusPlus::Snapshot>("CPlusPlus::Snapshot");
47 48
}

49
void BuiltinEditorDocumentParser::update(WorkingCopy workingCopy)
50 51 52
{
    QMutexLocker locker(&m_mutex);

53
    if (filePath().isEmpty())
54 55
        return;

56
    bool invalidateSnapshot = false, invalidateConfig = false, editorDefinesChanged_ = false;
57

58
    CppModelManager *modelManager = CppModelManager::instance();
59
    QByteArray configFile = modelManager->codeModelConfiguration();
60
    ProjectPart::HeaderPaths headerPaths;
61
    QStringList precompiledHeaders;
62
    QString projectConfigFile;
63
    LanguageFeatures features = LanguageFeatures::defaultFeatures();
64

65
    m_projectPart = determineProjectPart();
66

67 68 69 70 71
    if (m_forceSnapshotInvalidation) {
        invalidateSnapshot = true;
        m_forceSnapshotInvalidation = false;
    }

72 73 74 75 76 77 78
    if (const ProjectPart::Ptr part = projectPart()) {
        configFile += part->toolchainDefines;
        configFile += part->projectDefines;
        headerPaths = part->headerPaths;
        projectConfigFile = part->projectConfigFile;
        if (usePrecompiledHeaders())
            precompiledHeaders = part->precompiledHeaders;
79
        features = part->languageFeatures;
80 81 82 83 84 85 86 87
    }

    if (configFile != m_configFile) {
        m_configFile = configFile;
        invalidateSnapshot = true;
        invalidateConfig = true;
    }

88
    if (editorDefinesChanged()) {
89
        invalidateSnapshot = true;
90 91
        editorDefinesChanged_ = true;
        resetEditorDefinesChanged();
92 93
    }

94 95
    if (headerPaths != m_headerPaths) {
        m_headerPaths = headerPaths;
96 97 98
        invalidateSnapshot = true;
    }

99 100 101 102 103
    if (projectConfigFile != m_projectConfigFile) {
        m_projectConfigFile = projectConfigFile;
        invalidateSnapshot = true;
    }

104 105 106 107 108
    if (precompiledHeaders != m_precompiledHeaders) {
        m_precompiledHeaders = precompiledHeaders;
        invalidateSnapshot = true;
    }

109 110 111 112 113 114 115 116 117 118 119 120
    unsigned rev = 0;
    if (Document::Ptr doc = document())
        rev = doc->revision();
    else
        invalidateSnapshot = true;

    Snapshot globalSnapshot = modelManager->snapshot();

    if (invalidateSnapshot) {
        m_snapshot = Snapshot();
    } else {
        // Remove changed files from the snapshot
121
        QSet<Utils::FileName> toRemove;
122
        foreach (const Document::Ptr &doc, m_snapshot) {
123
            const Utils::FileName fileName = Utils::FileName::fromString(doc->fileName());
124 125 126 127 128 129 130 131 132 133 134 135
            if (workingCopy.contains(fileName)) {
                if (workingCopy.get(fileName).second != doc->editorRevision())
                    addFileAndDependencies(&toRemove, fileName);
                continue;
            }
            Document::Ptr otherDoc = globalSnapshot.document(fileName);
            if (!otherDoc.isNull() && otherDoc->revision() != doc->revision())
                addFileAndDependencies(&toRemove, fileName);
        }

        if (!toRemove.isEmpty()) {
            invalidateSnapshot = true;
136
            foreach (const Utils::FileName &fileName, toRemove)
137 138 139 140 141 142 143 144 145 146 147
                m_snapshot.remove(fileName);
        }
    }

    // Update the snapshot
    if (invalidateSnapshot) {
        const QString configurationFileName = modelManager->configurationFileName();
        if (invalidateConfig)
            m_snapshot.remove(configurationFileName);
        if (!m_snapshot.contains(configurationFileName))
            workingCopy.insert(configurationFileName, m_configFile);
148
        m_snapshot.remove(filePath());
149

150
        static const QString editorDefinesFileName
151
            = CppModelManager::editorConfigurationFileName();
152
        if (editorDefinesChanged_) {
153
            m_snapshot.remove(editorDefinesFileName);
154
            workingCopy.insert(editorDefinesFileName, editorDefines());
155 156
        }

157 158
        CppSourceProcessor sourceProcessor(m_snapshot, [&](const Document::Ptr &doc) {
            const QString fileName = doc->fileName();
159
            const bool isInEditor = fileName == filePath();
160 161 162 163 164 165
            Document::Ptr otherDoc = modelManager->document(fileName);
            unsigned newRev = otherDoc.isNull() ? 1U : otherDoc->revision() + 1;
            if (isInEditor)
                newRev = qMax(rev + 1, newRev);
            doc->setRevision(newRev);
            modelManager->emitDocumentUpdated(doc);
166 167
            if (m_releaseSourceAndAST)
                doc->releaseSourceAndAST();
168
        });
169
        Snapshot globalSnapshot = modelManager->snapshot();
170
        globalSnapshot.remove(filePath());
171 172
        sourceProcessor.setGlobalSnapshot(globalSnapshot);
        sourceProcessor.setWorkingCopy(workingCopy);
173
        sourceProcessor.setHeaderPaths(m_headerPaths);
174
        sourceProcessor.setLanguageFeatures(features);
175
        sourceProcessor.run(configurationFileName);
176
        if (!m_projectConfigFile.isEmpty())
177
            sourceProcessor.run(m_projectConfigFile);
178
        if (usePrecompiledHeaders()) {
179
            foreach (const QString &precompiledHeader, m_precompiledHeaders)
180
                sourceProcessor.run(precompiledHeader);
181
        }
182
        if (!editorDefines().isEmpty())
183
            sourceProcessor.run(editorDefinesFileName);
184
        sourceProcessor.run(filePath(), usePrecompiledHeaders() ? m_precompiledHeaders
185
                                                                    : QStringList());
186
        m_snapshot = sourceProcessor.snapshot();
187 188
        Snapshot newSnapshot = m_snapshot.simplified(document());
        for (Snapshot::const_iterator i = m_snapshot.begin(), ei = m_snapshot.end(); i != ei; ++i) {
189
            if (Client::isInjectedFile(i.key().toString()))
190 191 192
                newSnapshot.insert(i.value());
        }
        m_snapshot = newSnapshot;
193
        m_snapshot.updateDependencyTable();
194 195

        emit finished(document(), m_snapshot);
196 197 198
    }
}

199
void BuiltinEditorDocumentParser::releaseResources()
200 201 202 203 204 205
{
    QMutexLocker locker(&m_mutex);
    m_snapshot = Snapshot();
    m_forceSnapshotInvalidation = true;
}

206
Document::Ptr BuiltinEditorDocumentParser::document() const
207 208
{
    QMutexLocker locker(&m_mutex);
209
    return m_snapshot.document(filePath());
210 211
}

212
Snapshot BuiltinEditorDocumentParser::snapshot() const
213 214 215 216 217
{
    QMutexLocker locker(&m_mutex);
    return m_snapshot;
}

218
ProjectPart::HeaderPaths BuiltinEditorDocumentParser::headerPaths() const
219 220
{
    QMutexLocker locker(&m_mutex);
221
    return m_headerPaths;
222
}
223

224
void BuiltinEditorDocumentParser::setReleaseSourceAndAST(bool onoff)
225 226 227 228 229
{
    QMutexLocker locker(&m_mutex);
    m_releaseSourceAndAST = onoff;
}

230 231 232 233 234 235 236
BuiltinEditorDocumentParser *BuiltinEditorDocumentParser::get(const QString &filePath)
{
    if (BaseEditorDocumentParser *b = BaseEditorDocumentParser::get(filePath))
        return qobject_cast<BuiltinEditorDocumentParser *>(b);
    return 0;
}

237 238
void BuiltinEditorDocumentParser::addFileAndDependencies(QSet<Utils::FileName> *toRemove,
                                                         const Utils::FileName &fileName) const
239 240
{
    toRemove->insert(fileName);
241 242 243
    if (fileName != Utils::FileName::fromString(filePath())) {
        Utils::FileNameList deps = m_snapshot.filesDependingOn(fileName);
        toRemove->unite(QSet<Utils::FileName>::fromList(deps));
244 245
    }
}