diff options
Diffstat (limited to 'src/tools/clangbackend/ipcsource/clangdocument.cpp')
| -rw-r--r-- | src/tools/clangbackend/ipcsource/clangdocument.cpp | 400 |
1 files changed, 400 insertions, 0 deletions
diff --git a/src/tools/clangbackend/ipcsource/clangdocument.cpp b/src/tools/clangbackend/ipcsource/clangdocument.cpp new file mode 100644 index 0000000000..6cce9bc9b7 --- /dev/null +++ b/src/tools/clangbackend/ipcsource/clangdocument.cpp @@ -0,0 +1,400 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** 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 +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +****************************************************************************/ + +#include "clangdocument.h" + +#include "clangdocuments.h" +#include "clangstring.h" +#include "clangunsavedfilesshallowarguments.h" +#include "codecompleter.h" +#include "projectpart.h" +#include "translationunitfilenotexitexception.h" +#include "translationunitisnullexception.h" +#include "translationunitparseerrorexception.h" +#include "translationunitreparseerrorexception.h" +#include "clangtranslationunitcore.h" +#include "clangtranslationunitupdater.h" +#include "unsavedfiles.h" +#include "unsavedfile.h" + +#include <utf8string.h> + +#include <QDebug> +#include <QFileInfo> +#include <QLoggingCategory> + +#include <ostream> + +namespace ClangBackEnd { + +class DocumentData +{ +public: + DocumentData(const Utf8String &filePath, + const ProjectPart &projectPart, + const Utf8StringVector &fileArguments, + Documents &documents); + ~DocumentData(); + +public: + Documents &documents; + + const Utf8String filePath; + const Utf8StringVector fileArguments; + + ProjectPart projectPart; + time_point lastProjectPartChangeTimePoint; + + CXTranslationUnit translationUnit = nullptr; + CXIndex index = nullptr; + + QSet<Utf8String> dependedFilePaths; + + uint documentRevision = 0; + time_point needsToBeReparsedChangeTimePoint; + bool hasParseOrReparseFailed = false; + bool needsToBeReparsed = false; + bool isUsedByCurrentEditor = false; + bool isVisibleInEditor = false; +}; + +DocumentData::DocumentData(const Utf8String &filePath, + const ProjectPart &projectPart, + const Utf8StringVector &fileArguments, + Documents &documents) + : documents(documents), + filePath(filePath), + fileArguments(fileArguments), + projectPart(projectPart), + lastProjectPartChangeTimePoint(std::chrono::steady_clock::now()), + needsToBeReparsedChangeTimePoint(lastProjectPartChangeTimePoint) +{ + dependedFilePaths.insert(filePath); +} + +DocumentData::~DocumentData() +{ + clang_disposeTranslationUnit(translationUnit); + clang_disposeIndex(index); +} + +Document::Document(const Utf8String &filePath, + const ProjectPart &projectPart, + const Utf8StringVector &fileArguments, + Documents &documents, + FileExistsCheck fileExistsCheck) + : d(std::make_shared<DocumentData>(filePath, + projectPart, + fileArguments, + documents)) +{ + if (fileExistsCheck == CheckIfFileExists) + checkIfFileExists(); +} + +Document::~Document() = default; +Document::Document(const Document &) = default; +Document &Document::operator=(const Document &) = default; + +Document::Document(Document &&other) + : d(std::move(other.d)) +{ +} + +Document &Document::operator=(Document &&other) +{ + d = std::move(other.d); + + return *this; +} + +void Document::reset() +{ + d.reset(); +} + +bool Document::isNull() const +{ + return !d; +} + +bool Document::isIntact() const +{ + return !isNull() + && fileExists() + && !d->hasParseOrReparseFailed; +} + +Utf8String Document::filePath() const +{ + checkIfNull(); + + return d->filePath; +} + +Utf8StringVector Document::fileArguments() const +{ + checkIfNull(); + + return d->fileArguments; +} + +FileContainer Document::fileContainer() const +{ + checkIfNull(); + + return FileContainer(d->filePath, + d->projectPart.projectPartId(), + Utf8String(), + false, + d->documentRevision); +} + +Utf8String Document::projectPartId() const +{ + checkIfNull(); + + return d->projectPart.projectPartId(); +} + +const ProjectPart &Document::projectPart() const +{ + checkIfNull(); + + return d->projectPart; +} + +const time_point Document::lastProjectPartChangeTimePoint() const +{ + checkIfNull(); + + return d->lastProjectPartChangeTimePoint; +} + +bool Document::isProjectPartOutdated() const +{ + checkIfNull(); + + return d->projectPart.lastChangeTimePoint() >= d->lastProjectPartChangeTimePoint; +} + +uint Document::documentRevision() const +{ + checkIfNull(); + + return d->documentRevision; +} + +void Document::setDocumentRevision(uint revision) +{ + checkIfNull(); + + d->documentRevision = revision; +} + +bool Document::isUsedByCurrentEditor() const +{ + checkIfNull(); + + return d->isUsedByCurrentEditor; +} + +void Document::setIsUsedByCurrentEditor(bool isUsedByCurrentEditor) +{ + checkIfNull(); + + d->isUsedByCurrentEditor = isUsedByCurrentEditor; +} + +bool Document::isVisibleInEditor() const +{ + checkIfNull(); + + return d->isVisibleInEditor; +} + +void Document::setIsVisibleInEditor(bool isVisibleInEditor) +{ + checkIfNull(); + + d->isVisibleInEditor = isVisibleInEditor; +} + +time_point Document::isNeededReparseChangeTimePoint() const +{ + checkIfNull(); + + return d->needsToBeReparsedChangeTimePoint; +} + +bool Document::isNeedingReparse() const +{ + checkIfNull(); + + return d->needsToBeReparsed; +} + +void Document::setDirtyIfProjectPartIsOutdated() +{ + if (isProjectPartOutdated()) + setDirty(); +} + +void Document::setDirtyIfDependencyIsMet(const Utf8String &filePath) +{ + if (d->dependedFilePaths.contains(filePath) && isMainFileAndExistsOrIsOtherFile(filePath)) + setDirty(); +} + +TranslationUnitUpdateInput Document::createUpdateInput() const +{ + TranslationUnitUpdateInput updateInput; + updateInput.parseNeeded = isProjectPartOutdated(); + updateInput.reparseNeeded = isNeedingReparse(); + updateInput.needsToBeReparsedChangeTimePoint = d->needsToBeReparsedChangeTimePoint; + updateInput.filePath = filePath(); + updateInput.fileArguments = fileArguments(); + updateInput.unsavedFiles = d->documents.unsavedFiles(); + updateInput.projectId = projectPart().projectPartId(); + updateInput.projectArguments = projectPart().arguments(); + + return updateInput; +} + +TranslationUnitUpdater Document::createUpdater() const +{ + const TranslationUnitUpdateInput updateInput = createUpdateInput(); + TranslationUnitUpdater updater(d->index, d->translationUnit, updateInput); + + return updater; +} + +void Document::setHasParseOrReparseFailed(bool hasFailed) +{ + d->hasParseOrReparseFailed = hasFailed; +} + +void Document::incorporateUpdaterResult(const TranslationUnitUpdateResult &result) const +{ + d->hasParseOrReparseFailed = result.hasParseOrReparseFailed; + if (d->hasParseOrReparseFailed) { + d->needsToBeReparsed = false; + return; + } + + if (result.parseTimePointIsSet) + d->lastProjectPartChangeTimePoint = result.parseTimePoint; + + if (result.parseTimePointIsSet || result.reparsed) + d->dependedFilePaths = result.dependedOnFilePaths; + + d->documents.addWatchedFiles(d->dependedFilePaths); + + if (result.reparsed + && result.needsToBeReparsedChangeTimePoint == d->needsToBeReparsedChangeTimePoint) { + d->needsToBeReparsed = false; + } +} + +TranslationUnitCore Document::translationUnitCore() const +{ + checkIfNull(); + + return TranslationUnitCore(d->filePath, d->index, d->translationUnit); +} + +void Document::parse() const +{ + checkIfNull(); + + const TranslationUnitUpdateInput updateInput = createUpdateInput(); + TranslationUnitUpdateResult result = translationUnitCore().parse(updateInput); + + incorporateUpdaterResult(result); +} + +void Document::reparse() const +{ + checkIfNull(); + + const TranslationUnitUpdateInput updateInput = createUpdateInput(); + TranslationUnitUpdateResult result = translationUnitCore().reparse(updateInput); + + incorporateUpdaterResult(result); +} + +const QSet<Utf8String> Document::dependedFilePaths() const +{ + checkIfNull(); + checkIfFileExists(); + + return d->dependedFilePaths; +} + +void Document::setDirty() +{ + d->needsToBeReparsedChangeTimePoint = std::chrono::steady_clock::now(); + d->needsToBeReparsed = true; +} + +void Document::checkIfNull() const +{ + if (isNull()) + throw TranslationUnitIsNullException(); +} + +void Document::checkIfFileExists() const +{ + if (!fileExists()) + throw TranslationUnitFileNotExitsException(d->filePath); +} + +bool Document::fileExists() const +{ + return QFileInfo::exists(d->filePath.toString()); +} + +bool Document::isMainFileAndExistsOrIsOtherFile(const Utf8String &filePath) const +{ + if (filePath == d->filePath) + return QFileInfo::exists(d->filePath); + + return true; +} + +bool operator==(const Document &first, const Document &second) +{ + return first.filePath() == second.filePath() && first.projectPartId() == second.projectPartId(); +} + +void PrintTo(const Document &document, ::std::ostream *os) +{ + *os << "Document(" + << document.filePath().constData() << ", " + << document.projectPartId().constData() << ", " + << document.documentRevision() << ")"; +} + +} // namespace ClangBackEnd |