forked from qt-creator/qt-creator
8d443b40b7
Change-Id: If2790263e9a314f27762c57cf6bf4ef67f93a84b Reviewed-by: David Schulz <david.schulz@qt.io>
134 lines
4.0 KiB
C++
134 lines
4.0 KiB
C++
/****************************************************************************
|
|
**
|
|
** 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.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "clangtranslationunitupdater.h"
|
|
|
|
#include "clangbackend_global.h"
|
|
#include "clangtranslationunit.h"
|
|
|
|
#include <utf8stringvector.h>
|
|
|
|
#include <clang-c/Index.h>
|
|
|
|
#include <QSet>
|
|
#include <QtGlobal>
|
|
|
|
#include <memory>
|
|
|
|
class Utf8String;
|
|
|
|
namespace ClangBackEnd {
|
|
|
|
class TranslationUnit;
|
|
class TranslationUnits;
|
|
class DocumentData;
|
|
class TranslationUnitUpdateResult;
|
|
class ProjectPart;
|
|
class FileContainer;
|
|
class Documents;
|
|
|
|
class Document
|
|
{
|
|
public:
|
|
enum FileExistsCheck {
|
|
CheckIfFileExists,
|
|
DoNotCheckIfFileExists
|
|
};
|
|
|
|
Document() = default;
|
|
Document(const Utf8String &filePath,
|
|
const ProjectPart &projectPart,
|
|
const Utf8StringVector &fileArguments,
|
|
Documents &documents,
|
|
FileExistsCheck fileExistsCheck = CheckIfFileExists);
|
|
~Document();
|
|
|
|
Document(const Document &cxTranslationUnit);
|
|
Document &operator=(const Document &cxTranslationUnit);
|
|
|
|
Document(Document &&cxTranslationUnit);
|
|
Document &operator=(Document &&cxTranslationUnit);
|
|
|
|
void reset();
|
|
|
|
bool isNull() const;
|
|
bool isIntact() const;
|
|
|
|
Utf8String filePath() const;
|
|
Utf8StringVector fileArguments() const;
|
|
FileContainer fileContainer() const;
|
|
|
|
Utf8String projectPartId() const;
|
|
const ProjectPart &projectPart() const;
|
|
const TimePoint lastProjectPartChangeTimePoint() const;
|
|
bool isProjectPartOutdated() const;
|
|
|
|
uint documentRevision() const;
|
|
void setDocumentRevision(uint revision);
|
|
|
|
bool isUsedByCurrentEditor() const;
|
|
void setIsUsedByCurrentEditor(bool isUsedByCurrentEditor);
|
|
|
|
bool isVisibleInEditor() const;
|
|
void setIsVisibleInEditor(bool isVisibleInEditor);
|
|
|
|
bool isNeedingReparse() const;
|
|
void setDirtyIfProjectPartIsOutdated();
|
|
void setDirtyIfDependencyIsMet(const Utf8String &filePath);
|
|
|
|
TranslationUnitUpdateInput createUpdateInput() const;
|
|
void incorporateUpdaterResult(const TranslationUnitUpdateResult &result) const;
|
|
|
|
TranslationUnit translationUnit(PreferredTranslationUnit preferredTranslationUnit
|
|
= PreferredTranslationUnit::RecentlyParsed) const;
|
|
TranslationUnits &translationUnits() const;
|
|
|
|
public: // for tests
|
|
void parse() const;
|
|
void reparse() const;
|
|
const QSet<Utf8String> dependedFilePaths() const;
|
|
TranslationUnitUpdater createUpdater() const;
|
|
void setHasParseOrReparseFailed(bool hasFailed);
|
|
TimePoint isNeededReparseChangeTimePoint() const;
|
|
|
|
private:
|
|
void setDirty();
|
|
|
|
void checkIfNull() const;
|
|
void checkIfFileExists() const;
|
|
|
|
bool fileExists() const;
|
|
bool isMainFileAndExistsOrIsOtherFile(const Utf8String &filePath) const;
|
|
|
|
private:
|
|
mutable std::shared_ptr<DocumentData> d;
|
|
};
|
|
|
|
bool operator==(const Document &first, const Document &second);
|
|
void PrintTo(const Document &document, ::std::ostream *os);
|
|
} // namespace ClangBackEnd
|