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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/****************************************************************************
**
** Copyright (C) 2018 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 "indexdataconsumer.h"
#include "collectsymbolsaction.h"
#include <clang/AST/DeclVisitor.h>
#include <clang/Basic/SourceLocation.h>
#include <clang/Index/IndexSymbol.h>
#include <clang/Index/IndexingAction.h>
#include <llvm/ADT/ArrayRef.h>
#include <iostream>
namespace ClangBackEnd {
namespace {
bool hasSymbolRole(clang::index::SymbolRole role, clang::index::SymbolRoleSet roleSet)
{
return roleSet & static_cast<clang::index::SymbolRoleSet>(role);
}
Utils::SmallString symbolName(const clang::NamedDecl *declaration)
{
clang::DeclarationName declarationName(declaration->getIdentifier());
return declarationName.getAsString();
}
SourceLocationKind sourceLocationKind(clang::index::SymbolRoleSet roles)
{
if (hasSymbolRole(clang::index::SymbolRole::Definition, roles))
return SourceLocationKind::Definition;
else if (hasSymbolRole(clang::index::SymbolRole::Declaration, roles))
return SourceLocationKind::Declaration;
else if (hasSymbolRole(clang::index::SymbolRole::Reference, roles))
return SourceLocationKind::DeclarationReference;
return SourceLocationKind::None;
}
using SymbolKindAndTags = std::pair<SymbolKind, SymbolTags>;
class IndexingDeclVisitor : public clang::ConstDeclVisitor<IndexingDeclVisitor, SymbolKindAndTags>
{
public:
SymbolKindAndTags VisitEnumDecl(const clang::EnumDecl * /*declaration*/)
{
return {SymbolKind::Enumeration, {}};
}
SymbolKindAndTags VisitRecordDecl(const clang::RecordDecl *declaration)
{
SymbolKindAndTags result = {SymbolKind::Record, {}};
switch (declaration->getTagKind()) {
case clang::TTK_Struct: result.second.push_back(SymbolTag::Struct); break;
case clang::TTK_Interface: result.second.push_back(SymbolTag::MsvcInterface); break;
case clang::TTK_Union: result.second.push_back(SymbolTag::Union); break;
case clang::TTK_Class: result.second.push_back(SymbolTag::Class); break;
case clang::TTK_Enum: break; // this case can never happen in a record but it is there to silent the warning
}
return result;
}
SymbolKindAndTags VisitFunctionDecl(const clang::FunctionDecl*)
{
return {SymbolKind::Function, {}};
}
SymbolKindAndTags VisitVarDecl(const clang::VarDecl*)
{
return {SymbolKind::Variable, {}};
}
};
SymbolKindAndTags symbolKindAndTags(const clang::Decl *declaration)
{
static IndexingDeclVisitor visitor;
return visitor.Visit(declaration);
}
} // namespace
bool IndexDataConsumer::skipSymbol(clang::FileID fileId)
{
return isAlreadyParsed(fileId, m_symbolSourcesManager)
&& !m_symbolSourcesManager.dependentFilesModified();
}
bool IndexDataConsumer::isAlreadyParsed(clang::FileID fileId, SourcesManager &sourcesManager)
{
const clang::FileEntry *fileEntry = m_sourceManager->getFileEntryForID(fileId);
if (!fileEntry)
return false;
return sourcesManager.alreadyParsed(filePathId(fileEntry), fileEntry->getModificationTime());
}
bool IndexDataConsumer::handleDeclOccurence(const clang::Decl *declaration,
clang::index::SymbolRoleSet symbolRoles,
llvm::ArrayRef<clang::index::SymbolRelation> /*symbolRelations*/,
clang::SourceLocation sourceLocation,
IndexDataConsumer::ASTNodeInfo /*astNodeInfo*/)
{
const auto *namedDeclaration = clang::dyn_cast<clang::NamedDecl>(declaration);
if (namedDeclaration) {
if (!namedDeclaration->getIdentifier())
return true;
if (skipSymbol(m_sourceManager->getFileID(sourceLocation)))
return true;
SymbolIndex globalId = toSymbolIndex(declaration->getCanonicalDecl());
auto found = m_symbolEntries.find(globalId);
if (found == m_symbolEntries.end()) {
Utils::optional<Utils::PathString> usr = generateUSR(namedDeclaration);
if (usr) {
auto kindAndTags = symbolKindAndTags(declaration);
m_symbolEntries.emplace(std::piecewise_construct,
std::forward_as_tuple(globalId),
std::forward_as_tuple(std::move(*usr),
symbolName(namedDeclaration),
kindAndTags.first,
kindAndTags.second));
}
}
m_sourceLocationEntries.emplace_back(globalId,
filePathId(sourceLocation),
lineColum(sourceLocation),
sourceLocationKind(symbolRoles));
}
return true;
}
namespace {
SourceLocationKind macroSymbolType(clang::index::SymbolRoleSet roles)
{
if (roles & static_cast<clang::index::SymbolRoleSet>(clang::index::SymbolRole::Definition))
return SourceLocationKind::MacroDefinition;
if (roles & static_cast<clang::index::SymbolRoleSet>(clang::index::SymbolRole::Undefinition))
return SourceLocationKind::MacroUndefinition;
if (roles & static_cast<clang::index::SymbolRoleSet>(clang::index::SymbolRole::Reference))
return SourceLocationKind::MacroUsage;
return SourceLocationKind::None;
}
} // namespace
bool IndexDataConsumer::handleMacroOccurence(const clang::IdentifierInfo *identifierInfo,
const clang::MacroInfo *macroInfo,
clang::index::SymbolRoleSet roles,
clang::SourceLocation sourceLocation)
{
if (macroInfo && sourceLocation.isFileID()
&& !isAlreadyParsed(m_sourceManager->getFileID(sourceLocation), m_macroSourcesManager)
&& !isInSystemHeader(sourceLocation)) {
FilePathId fileId = filePathId(sourceLocation);
if (fileId.isValid()) {
auto macroName = identifierInfo->getName();
SymbolIndex globalId = toSymbolIndex(macroInfo);
auto found = m_symbolEntries.find(globalId);
if (found == m_symbolEntries.end()) {
Utils::optional<Utils::PathString> usr = generateUSR(macroName, sourceLocation);
if (usr) {
m_symbolEntries.emplace(std::piecewise_construct,
std::forward_as_tuple(globalId),
std::forward_as_tuple(std::move(*usr),
macroName,
SymbolKind::Macro));
}
}
m_sourceLocationEntries.emplace_back(globalId,
fileId,
lineColum(sourceLocation),
macroSymbolType(roles));
}
}
return true;
}
void IndexDataConsumer::finish()
{
m_macroSourcesManager.updateModifiedTimeStamps();
m_symbolSourcesManager.updateModifiedTimeStamps();
m_filePathIndices.clear();
}
} // namespace ClangBackEnd
|
