1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
#ifndef CLANGBACKEND_TRANSLATIONUNIT_H
#define CLANGBACKEND_TRANSLATIONUNIT_H
#include <utf8stringvector.h>
#include <clang-c/Index.h>
#include <QtGlobal>
#include <chrono>
#include <memory>
#include <QSet>
class Utf8String;
namespace ClangBackEnd {
class TranslationUnitData;
class CodeCompleter;
class UnsavedFile;
class UnsavedFiles;
class ProjectPart;
class DiagnosticContainer;
class DiagnosticSet;
class FileContainer;
class HighlightingMarks;
class TranslationUnits;
class CommandLineArguments;
class Cursor;
class SourceLocation;
class SourceRange;
class SkippedSourceRanges;
using time_point = std::chrono::steady_clock::time_point;
class TranslationUnit
{
public:
enum FileExistsCheck {
CheckIfFileExists,
DoNotCheckIfFileExists
};
TranslationUnit() = default;
TranslationUnit(const Utf8String &filePath,
const ProjectPart &projectPart,
const Utf8StringVector &fileArguments,
TranslationUnits &translationUnits,
FileExistsCheck fileExistsCheck = CheckIfFileExists);
~TranslationUnit();
TranslationUnit(const TranslationUnit &cxTranslationUnit);
TranslationUnit &operator=(const TranslationUnit &cxTranslationUnit);
TranslationUnit(TranslationUnit &&cxTranslationUnit);
TranslationUnit &operator=(TranslationUnit &&cxTranslationUnit);
bool isNull() const;
void setIsUsedByCurrentEditor(bool isUsedByCurrentEditor);
bool isUsedByCurrentEditor() const;
void setIsVisibleInEditor(bool isVisibleInEditor);
bool isVisibleInEditor() const;
void reset();
void reparse() const;
CXIndex index() const;
CXTranslationUnit cxTranslationUnit() const;
CXTranslationUnit cxTranslationUnitWithoutReparsing() const;
UnsavedFile &unsavedFile() const;
CXUnsavedFile * cxUnsavedFiles() const;
uint unsavedFilesCount() const;
const Utf8String &filePath() const;
const Utf8String &projectPartId() const;
FileContainer fileContainer() const;
const ProjectPart &projectPart() const;
void setDocumentRevision(uint revision);
uint documentRevision() const;
const time_point &lastProjectPartChangeTimePoint() const;
bool isNeedingReparse() const;
bool hasNewDiagnostics() const;
bool hasNewHighlightingMarks() const;
DiagnosticSet diagnostics() const;
QVector<DiagnosticContainer> mainFileDiagnostics() const;
const QSet<Utf8String> &dependedFilePaths() const;
void setDirtyIfProjectPartIsOutdated();
void setDirtyIfDependencyIsMet(const Utf8String &filePath);
CommandLineArguments commandLineArguments() const;
SourceLocation sourceLocationAtWithoutReparsing(uint line, uint column) const;
SourceLocation sourceLocationAt(uint line, uint column) const;
SourceLocation sourceLocationAt(const Utf8String &filePath, uint line, uint column) const;
SourceRange sourceRange(uint fromLine, uint fromColumn, uint toLine, uint toColumn) const;
Cursor cursorAt(uint line, uint column) const;
Cursor cursorAt(const Utf8String &filePath, uint line, uint column) const;
Cursor cursor() const;
HighlightingMarks highlightingMarks() const;
HighlightingMarks highlightingMarksInRange(const SourceRange &range) const;
SkippedSourceRanges skippedSourceRanges() const;
private:
void setDirty();
void checkIfNull() const;
void checkIfFileExists() const;
void updateLastProjectPartChangeTimePoint() const;
void removeTranslationUnitIfProjectPartWasChanged() const;
bool projectPartIsOutdated() const;
bool isMainFileAndExistsOrIsOtherFile(const Utf8String &filePath) const;
void createTranslationUnitIfNeeded() const;
void checkTranslationUnitErrorCode(CXErrorCode errorCode) const;
void reparseTranslationUnit() const;
void reparseTranslationUnitIfFilesAreChanged() const;
void updateIncludeFilePaths() const;
static uint defaultOptions();
static void includeCallback(CXFile included_file,
CXSourceLocation * /*inclusion_stack*/,
unsigned /*include_len*/,
CXClientData clientData);
UnsavedFiles &unsavedFiles() const;
private:
mutable std::shared_ptr<TranslationUnitData> d;
};
bool operator==(const TranslationUnit &first, const TranslationUnit &second);
void PrintTo(const TranslationUnit &translationUnit, ::std::ostream *os);
} // namespace ClangBackEnd
#endif // CLANGBACKEND_TRANSLATIONUNIT_H
|
