ccls/src/indexer.cc

1615 lines
49 KiB
C++
Raw Normal View History

2017-02-22 08:52:00 +00:00
#include "indexer.h"
2017-02-17 09:57:44 +00:00
#include "clang_utils.h"
2017-04-22 07:39:55 +00:00
#include "libclangmm/Cursor.h"
#include "libclangmm/Index.h"
#include "libclangmm/TranslationUnit.h"
#include "libclangmm/Utility.h"
2017-04-08 22:54:36 +00:00
#include "platform.h"
#include "serializer.h"
#include "timer.h"
2017-04-22 07:39:55 +00:00
#include <algorithm>
#include <chrono>
// TODO: See if we can use clang_indexLoc_getFileLocation to get a type ref on |Foobar| in DISALLOW_COPY(Foobar)
namespace {
2017-04-12 07:57:12 +00:00
const bool kIndexStdDeclarations = true;
void AddFuncRef(std::vector<IndexFuncRef>* result, IndexFuncRef ref) {
if (!result->empty() && (*result)[result->size() - 1] == ref)
return;
result->push_back(ref);
}
Range Resolve(const CXSourceRange& range, CXFile* cx_file = nullptr) {
2017-05-10 06:13:13 +00:00
CXSourceLocation start = clang_getRangeStart(range);
CXSourceLocation end = clang_getRangeEnd(range);
unsigned int start_line, start_column;
clang_getSpellingLocation(start, cx_file, &start_line, &start_column, nullptr);
2017-05-10 06:13:13 +00:00
unsigned int end_line, end_column;
clang_getSpellingLocation(end, nullptr, &end_line, &end_column, nullptr);
return Range(
Position((int16_t)start_line, (int16_t)start_column) /*start*/,
Position((int16_t)end_line, (int16_t)end_column) /*end*/);
2017-05-10 06:13:13 +00:00
}
Range ResolveSpelling(const CXCursor& cx_cursor, CXFile* cx_file = nullptr) {
2017-05-10 06:13:13 +00:00
CXSourceRange cx_range = clang_Cursor_getSpellingNameRange(cx_cursor, 0, 0);
return Resolve(cx_range, cx_file);
2017-05-10 06:13:13 +00:00
}
Range ResolveExtent(const CXCursor& cx_cursor, CXFile* cx_file = nullptr) {
2017-05-10 06:13:13 +00:00
CXSourceRange cx_range = clang_getCursorExtent(cx_cursor);
return Resolve(cx_range, cx_file);
2017-05-10 06:13:13 +00:00
}
struct NamespaceHelper {
std::unordered_map<std::string, std::string> container_usr_to_qualified_name;
void RegisterQualifiedName(std::string usr,
const CXIdxContainerInfo* container,
std::string qualified_name) {
if (container) {
std::string container_usr = clang::Cursor(container->cursor).get_usr();
auto it = container_usr_to_qualified_name.find(container_usr);
if (it != container_usr_to_qualified_name.end()) {
container_usr_to_qualified_name[usr] =
it->second + qualified_name + "::";
return;
}
}
container_usr_to_qualified_name[usr] = qualified_name + "::";
}
std::string QualifiedName(const CXIdxContainerInfo* container,
std::string unqualified_name) {
if (container) {
std::string container_usr = clang::Cursor(container->cursor).get_usr();
auto it = container_usr_to_qualified_name.find(container_usr);
if (it != container_usr_to_qualified_name.end())
return it->second + unqualified_name;
// Anonymous namespaces are not processed by indexDeclaration. If we
// encounter one insert it into map.
if (container->cursor.kind == CXCursor_Namespace) {
// assert(clang::Cursor(container->cursor).get_spelling() == "");
container_usr_to_qualified_name[container_usr] = "::";
return "::" + unqualified_name;
}
}
return unqualified_name;
}
};
struct IndexParam {
// Only use this when strictly needed (ie, primary translation unit is
// needed). Most logic should get the IndexFile instance via
// |file_consumer|.
//
// This can be null if we're not generating an index for the primary
// translation unit.
IndexFile* primary_file = nullptr;
clang::TranslationUnit* tu = nullptr;
FileConsumer* file_consumer = nullptr;
NamespaceHelper ns;
IndexParam(clang::TranslationUnit* tu, FileConsumer* file_consumer) : tu(tu), file_consumer(file_consumer) {}
};
IndexFile* ConsumeFile(IndexParam* param, CXFile file) {
bool is_first_ownership = false;
IndexFile* db = param->file_consumer->TryConsumeFile(file, &is_first_ownership);
// Mark dependency in primary file. If primary_file is null that means we're
// doing a re-index in which case the dependency has already been established
// in a previous index run.
if (is_first_ownership && param->primary_file)
param->primary_file->dependencies.push_back(db->path);
if (is_first_ownership) {
// Report skipped source range list.
CXSourceRangeList* skipped = clang_getSkippedRanges(param->tu->cx_tu, file);
for (unsigned i = 0; i < skipped->count; ++i) {
Range range = Resolve(skipped->ranges[i]);
// clang_getSkippedRanges reports start one token after the '#', move it
// back so it starts at the '#'
range.start.column -= 1;
db->skipped_by_preprocessor.push_back(range);
}
clang_disposeSourceRangeList(skipped);
}
return db;
}
bool IsLocalSemanticContainer(CXCursorKind kind) {
switch (kind) {
case CXCursor_Namespace:
case CXCursor_TranslationUnit:
case CXCursor_StructDecl:
case CXCursor_UnionDecl:
case CXCursor_ClassDecl:
case CXCursor_EnumDecl:
return false;
default:
return true;
}
}
2017-05-23 06:47:27 +00:00
// Returns true if the given entity kind can be called implicitly, ie, without
// actually being written in the source code.
bool CanBeCalledImplicitly(CXIdxEntityKind kind) {
switch (kind) {
case CXIdxEntity_CXXConstructor:
case CXIdxEntity_CXXConversionFunction:
case CXIdxEntity_CXXDestructor:
return true;
default:
return false;
}
}
// Returns true if the cursor spelling contains the given string. This is
// useful to check for implicit function calls.
bool CursorSpellingContainsString(CXCursor cursor, CXTranslationUnit cx_tu, std::string scanning_for) {
CXSourceRange range = clang_Cursor_getSpellingNameRange(cursor, 0, 0);
CXToken* tokens;
unsigned num_tokens;
2017-05-23 06:47:27 +00:00
clang_tokenize(cx_tu, range, &tokens, &num_tokens);
bool result = false;
for (unsigned i = 0; i < num_tokens; ++i) {
2017-05-23 06:47:27 +00:00
CXString name = clang_getTokenSpelling(cx_tu, tokens[i]);
if (strcmp(clang_getCString(name), scanning_for.c_str()) == 0) {
result = true;
break;
}
clang_disposeString(name);
}
clang_disposeTokens(cx_tu, tokens, num_tokens);
return result;
}
// Returns the document content for the given range. May not work perfectly
// when there are tabs instead of spaces.
std::string GetDocumentContentInRange(CXTranslationUnit cx_tu, CXSourceRange range) {
std::string result;
CXToken* tokens;
unsigned num_tokens;
clang_tokenize(cx_tu, range, &tokens, &num_tokens);
optional<Range> previous_token_range;
for (unsigned i = 0; i < num_tokens; ++i) {
// Add whitespace between the previous token and this one.
Range token_range = Resolve(clang_getTokenExtent(cx_tu, tokens[i]));
if (previous_token_range) {
// Insert newlines.
int16_t line_delta = token_range.start.line - previous_token_range->end.line;
assert(line_delta >= 0);
if (line_delta > 0) {
result.append((size_t)line_delta, '\n');
// Reset column so we insert starting padding.
previous_token_range->end.column = 0;
}
// Insert spaces.
int16_t column_delta = token_range.start.column - previous_token_range->end.column;
assert(column_delta >= 0);
result.append((size_t)column_delta, ' ');
}
previous_token_range = token_range;
// Add token content.
CXString spelling = clang_getTokenSpelling(cx_tu, tokens[i]);
result += clang_getCString(spelling);
clang_disposeString(spelling);
}
clang_disposeTokens(cx_tu, tokens, num_tokens);
return result;
}
} // namespace
2017-06-15 03:12:52 +00:00
// static
int IndexFile::kCurrentVersion = 4;
IndexFile::IndexFile(const std::string& path) : id_cache(path), path(path) {
2017-02-26 19:45:59 +00:00
// TODO: Reconsider if we should still be reusing the same id_cache.
2017-02-25 23:59:09 +00:00
// Preallocate any existing resolved ids.
2017-02-28 06:41:42 +00:00
for (const auto& entry : id_cache.usr_to_type_id)
types.push_back(IndexType(entry.second, entry.first));
2017-02-28 06:41:42 +00:00
for (const auto& entry : id_cache.usr_to_func_id)
funcs.push_back(IndexFunc(entry.second, entry.first));
2017-02-28 06:41:42 +00:00
for (const auto& entry : id_cache.usr_to_var_id)
vars.push_back(IndexVar(entry.second, entry.first));
2017-02-25 23:59:09 +00:00
}
2017-02-19 02:34:51 +00:00
2017-02-20 00:56:56 +00:00
// TODO: Optimize for const char*?
IndexTypeId IndexFile::ToTypeId(const std::string& usr) {
2017-02-28 06:41:42 +00:00
auto it = id_cache.usr_to_type_id.find(usr);
if (it != id_cache.usr_to_type_id.end())
2017-02-17 09:57:44 +00:00
return it->second;
IndexTypeId id(types.size());
types.push_back(IndexType(id, usr));
2017-02-28 06:41:42 +00:00
id_cache.usr_to_type_id[usr] = id;
id_cache.type_id_to_usr[id] = usr;
2017-02-17 09:57:44 +00:00
return id;
2017-02-16 09:35:30 +00:00
}
IndexFuncId IndexFile::ToFuncId(const std::string& usr) {
2017-02-28 06:41:42 +00:00
auto it = id_cache.usr_to_func_id.find(usr);
if (it != id_cache.usr_to_func_id.end())
2017-02-17 09:57:44 +00:00
return it->second;
2017-02-16 09:35:30 +00:00
IndexFuncId id(funcs.size());
funcs.push_back(IndexFunc(id, usr));
2017-02-28 06:41:42 +00:00
id_cache.usr_to_func_id[usr] = id;
id_cache.func_id_to_usr[id] = usr;
2017-02-17 09:57:44 +00:00
return id;
}
IndexVarId IndexFile::ToVarId(const std::string& usr) {
2017-02-28 06:41:42 +00:00
auto it = id_cache.usr_to_var_id.find(usr);
if (it != id_cache.usr_to_var_id.end())
2017-02-17 09:57:44 +00:00
return it->second;
2017-02-16 09:35:30 +00:00
IndexVarId id(vars.size());
vars.push_back(IndexVar(id, usr));
2017-02-28 06:41:42 +00:00
id_cache.usr_to_var_id[usr] = id;
id_cache.var_id_to_usr[id] = usr;
2017-02-17 09:57:44 +00:00
return id;
}
IndexTypeId IndexFile::ToTypeId(const CXCursor& cursor) {
2017-02-20 00:56:56 +00:00
return ToTypeId(clang::Cursor(cursor).get_usr());
}
IndexFuncId IndexFile::ToFuncId(const CXCursor& cursor) {
2017-02-20 00:56:56 +00:00
return ToFuncId(clang::Cursor(cursor).get_usr());
}
IndexVarId IndexFile::ToVarId(const CXCursor& cursor) {
2017-02-20 00:56:56 +00:00
return ToVarId(clang::Cursor(cursor).get_usr());
}
IndexType* IndexFile::Resolve(IndexTypeId id) {
2017-02-25 23:59:09 +00:00
return &types[id.id];
2017-02-17 09:57:44 +00:00
}
IndexFunc* IndexFile::Resolve(IndexFuncId id) {
2017-02-25 23:59:09 +00:00
return &funcs[id.id];
2017-02-17 09:57:44 +00:00
}
IndexVar* IndexFile::Resolve(IndexVarId id) {
2017-02-25 23:59:09 +00:00
return &vars[id.id];
2017-02-17 09:57:44 +00:00
}
std::string IndexFile::ToString() {
return Serialize(*this);
2017-02-17 09:57:44 +00:00
}
IndexType::IndexType(IndexTypeId id, const std::string& usr)
2017-03-22 17:16:09 +00:00
: def(usr), id(id) {
2017-02-24 08:39:25 +00:00
assert(usr.size() > 0);
2017-03-17 07:58:41 +00:00
// std::cerr << "Creating type with usr " << usr << std::endl;
2017-02-24 08:39:25 +00:00
}
void RemoveItem(std::vector<Range>& ranges, Range to_remove) {
auto it = std::find(ranges.begin(), ranges.end(), to_remove);
if (it != ranges.end())
ranges.erase(it);
}
2017-05-27 19:56:39 +00:00
template <typename T>
void UniqueAdd(std::vector<T>& values, T value) {
if (std::find(values.begin(), values.end(), value) == values.end())
values.push_back(value);
2017-02-24 08:39:25 +00:00
}
2017-02-20 06:40:55 +00:00
2017-04-05 08:06:18 +00:00
IdCache::IdCache(const std::string& primary_file)
: primary_file(primary_file) {}
2017-02-27 07:32:10 +00:00
2017-03-17 07:58:41 +00:00
template <typename T>
2017-02-21 05:16:45 +00:00
bool Contains(const std::vector<T>& vec, const T& element) {
for (const T& entry : vec) {
if (entry == element)
return true;
}
return false;
}
2017-03-17 07:58:41 +00:00
int abortQuery(CXClientData client_data, void* reserved) {
2017-02-20 00:56:56 +00:00
// 0 -> continue
return 0;
}
2017-03-17 07:58:41 +00:00
void diagnostic(CXClientData client_data,
CXDiagnosticSet diagnostics,
void* reserved) {
IndexParam* param = static_cast<IndexParam*>(client_data);
for (unsigned i = 0; i < clang_getNumDiagnosticsInSet(diagnostics); ++i) {
CXDiagnostic diagnostic = clang_getDiagnosticInSet(diagnostics, i);
// Skip diagnostics in system headers.
CXSourceLocation diag_loc = clang_getDiagnosticLocation(diagnostic);
if (clang_Location_isInSystemHeader(diag_loc))
continue;
// Get db so we can attribute diagnostic to the right indexed file.
CXFile file;
unsigned int line, column;
clang_getSpellingLocation(diag_loc, &file, &line, &column, nullptr);
IndexFile* db = ConsumeFile(param, file);
if (!db)
continue;
// Build diagnostic.
optional<lsDiagnostic> ls_diagnostic =
BuildAndDisposeDiagnostic(diagnostic, db->path);
if (ls_diagnostic)
db->diagnostics_.push_back(*ls_diagnostic);
}
2017-03-11 02:24:51 +00:00
}
2017-02-20 00:56:56 +00:00
2017-03-17 07:58:41 +00:00
CXIdxClientFile enteredMainFile(CXClientData client_data,
CXFile mainFile,
void* reserved) {
2017-02-20 00:56:56 +00:00
return nullptr;
}
2017-03-17 07:58:41 +00:00
CXIdxClientFile ppIncludedFile(CXClientData client_data,
const CXIdxIncludedFileInfo* file) {
2017-05-21 03:46:15 +00:00
IndexParam* param = static_cast<IndexParam*>(client_data);
// file->hashLoc only has the position of the hash. We don't have the full
// range for the include.
CXSourceLocation hash_loc = clang_indexLoc_getCXSourceLocation(file->hashLoc);
CXFile cx_file;
unsigned int line;
clang_getSpellingLocation(hash_loc, &cx_file, &line, nullptr, nullptr);
IndexFile* db = ConsumeFile(param, cx_file);
if (!db)
return nullptr;
IndexInclude include;
include.line = line;
include.resolved_path = FileName(file->file);
db->includes.push_back(include);
2017-02-20 00:56:56 +00:00
return nullptr;
}
2017-03-17 07:58:41 +00:00
CXIdxClientASTFile importedASTFile(CXClientData client_data,
const CXIdxImportedASTFileInfo*) {
2017-02-20 00:56:56 +00:00
return nullptr;
}
2017-03-17 07:58:41 +00:00
CXIdxClientContainer startedTranslationUnit(CXClientData client_data,
void* reserved) {
2017-02-20 00:56:56 +00:00
return nullptr;
}
2017-03-17 07:58:41 +00:00
clang::VisiterResult DumpVisitor(clang::Cursor cursor,
clang::Cursor parent,
int* level) {
2017-02-20 06:40:55 +00:00
for (int i = 0; i < *level; ++i)
2017-03-05 19:48:05 +00:00
std::cerr << " ";
2017-03-17 07:58:41 +00:00
std::cerr << clang::ToString(cursor.get_kind()) << " "
<< cursor.get_spelling() << std::endl;
2017-02-20 06:40:55 +00:00
*level += 1;
cursor.VisitChildren(&DumpVisitor, level);
*level -= 1;
return clang::VisiterResult::Continue;
}
void Dump(clang::Cursor cursor) {
int level = 0;
cursor.VisitChildren(&DumpVisitor, &level);
}
2017-02-20 02:00:58 +00:00
struct FindChildOfKindParam {
CXCursorKind target_kind;
2017-02-22 01:06:43 +00:00
optional<clang::Cursor> result;
2017-02-20 02:00:58 +00:00
FindChildOfKindParam(CXCursorKind target_kind) : target_kind(target_kind) {}
};
2017-03-17 07:58:41 +00:00
clang::VisiterResult FindChildOfKindVisitor(clang::Cursor cursor,
clang::Cursor parent,
FindChildOfKindParam* param) {
2017-02-20 02:00:58 +00:00
if (cursor.get_kind() == param->target_kind) {
param->result = cursor;
return clang::VisiterResult::Break;
}
return clang::VisiterResult::Recurse;
}
2017-03-17 07:58:41 +00:00
optional<clang::Cursor> FindChildOfKind(clang::Cursor cursor,
CXCursorKind kind) {
2017-02-20 02:00:58 +00:00
FindChildOfKindParam param(kind);
cursor.VisitChildren(&FindChildOfKindVisitor, &param);
return param.result;
}
2017-03-17 07:58:41 +00:00
clang::VisiterResult FindTypeVisitor(clang::Cursor cursor,
clang::Cursor parent,
optional<clang::Cursor>* result) {
2017-02-20 19:08:27 +00:00
switch (cursor.get_kind()) {
2017-03-17 07:58:41 +00:00
case CXCursor_TypeRef:
case CXCursor_TemplateRef:
*result = cursor;
return clang::VisiterResult::Break;
2017-05-21 23:48:21 +00:00
default:
break;
2017-02-20 19:08:27 +00:00
}
return clang::VisiterResult::Recurse;
}
2017-02-22 01:06:43 +00:00
optional<clang::Cursor> FindType(clang::Cursor cursor) {
optional<clang::Cursor> result;
2017-02-20 19:08:27 +00:00
cursor.VisitChildren(&FindTypeVisitor, &result);
return result;
}
2017-02-20 00:56:56 +00:00
bool IsTypeDefinition(const CXIdxContainerInfo* container) {
if (!container)
return false;
switch (container->cursor.kind) {
2017-03-17 07:58:41 +00:00
case CXCursor_EnumDecl:
case CXCursor_UnionDecl:
case CXCursor_StructDecl:
case CXCursor_ClassDecl:
return true;
default:
return false;
2017-02-20 00:56:56 +00:00
}
}
struct VisitDeclForTypeUsageParam {
IndexFile* db;
int has_processed_any = false;
2017-02-22 01:06:43 +00:00
optional<clang::Cursor> previous_cursor;
optional<IndexTypeId> initial_type;
VisitDeclForTypeUsageParam(IndexFile* db) : db(db) {}
};
2017-03-17 07:58:41 +00:00
void VisitDeclForTypeUsageVisitorHandler(clang::Cursor cursor,
VisitDeclForTypeUsageParam* param) {
param->has_processed_any = true;
IndexFile* db = param->db;
2017-03-17 07:58:41 +00:00
std::string referenced_usr =
cursor.get_referenced()
.template_specialization_to_template_definition()
.get_usr();
// TODO: things in STL cause this to be empty. Figure out why and document it.
if (referenced_usr == "")
return;
IndexTypeId ref_type_id = db->ToTypeId(referenced_usr);
2017-03-05 22:49:23 +00:00
if (!param->initial_type)
param->initial_type = ref_type_id;
IndexType* ref_type_def = db->Resolve(ref_type_id);
// TODO: Should we even be visiting this if the file is not from the main
// def? Try adding assert on |loc| later.
2017-05-10 06:13:13 +00:00
Range loc = ResolveSpelling(cursor.cx_cursor);
UniqueAdd(ref_type_def->uses, loc);
2017-02-20 19:08:27 +00:00
}
2017-03-17 07:58:41 +00:00
clang::VisiterResult VisitDeclForTypeUsageVisitor(
clang::Cursor cursor,
clang::Cursor parent,
VisitDeclForTypeUsageParam* param) {
switch (cursor.get_kind()) {
2017-03-17 07:58:41 +00:00
case CXCursor_TemplateRef:
case CXCursor_TypeRef:
if (param->previous_cursor) {
VisitDeclForTypeUsageVisitorHandler(param->previous_cursor.value(),
param);
}
2017-03-17 07:58:41 +00:00
param->previous_cursor = cursor;
2017-05-21 23:48:21 +00:00
return clang::VisiterResult::Continue;
// We do not want to recurse for everything, since if we do that we will end
// up visiting method definition bodies/etc. Instead, we only recurse for
2017-03-17 07:58:41 +00:00
// things that can logically appear as part of an inline variable
// initializer,
// ie,
//
// class Foo {
// int x = (Foo)3;
// }
2017-03-17 07:58:41 +00:00
case CXCursor_CallExpr:
case CXCursor_CStyleCastExpr:
case CXCursor_CXXStaticCastExpr:
case CXCursor_CXXReinterpretCastExpr:
return clang::VisiterResult::Recurse;
2017-05-21 23:48:21 +00:00
default:
return clang::VisiterResult::Continue;
}
return clang::VisiterResult::Continue;
}
2017-03-17 07:58:41 +00:00
// Finds the cursor associated with the declaration type of |cursor|. This
// strips
2017-03-05 22:49:23 +00:00
// qualifies from |cursor| (ie, Foo* => Foo) and removes template arguments
// (ie, Foo<A,B> => Foo<*,*>).
optional<IndexTypeId> ResolveToDeclarationType(IndexFile* db,
clang::Cursor cursor) {
clang::Cursor declaration = cursor.get_declaration();
2017-03-05 22:49:23 +00:00
declaration = declaration.template_specialization_to_template_definition();
std::string usr = declaration.get_usr();
if (usr != "")
return db->ToTypeId(usr);
return nullopt;
}
2017-03-17 07:58:41 +00:00
// Add usages to any seen TypeRef or TemplateRef under the given |decl_cursor|.
2017-04-03 01:34:15 +00:00
// This returns the first seen TypeRef or TemplateRef value, which can be
// useful if trying to figure out ie, what a using statement refers to. If
// trying to generally resolve a cursor to a type, use
// ResolveToDeclarationType, which works in more scenarios.
optional<IndexTypeId> AddDeclTypeUsages(
IndexFile* db,
2017-03-17 07:58:41 +00:00
clang::Cursor decl_cursor,
const CXIdxContainerInfo* semantic_container,
const CXIdxContainerInfo* lexical_container) {
2017-03-17 07:58:41 +00:00
// std::cerr << std::endl << "AddDeclUsages " << decl_cursor.get_spelling() <<
// std::endl;
// Dump(decl_cursor);
//
// The general AST format for definitions follows this pattern:
//
// template<typename A, typename B>
// struct Container;
//
// struct S1;
// struct S2;
//
// Container<Container<S1, S2>, S2> foo;
//
// =>
//
// VarDecl
// TemplateRef Container
// TemplateRef Container
// TypeRef struct S1
// TypeRef struct S2
// TypeRef struct S2
//
2017-03-05 22:49:23 +00:00
//
// Here is another example:
//
// enum A {};
// enum B {};
2017-03-14 04:31:53 +00:00
//
2017-03-05 22:49:23 +00:00
// template<typename T>
// struct Foo {
// struct Inner {};
// };
2017-03-14 04:31:53 +00:00
//
2017-03-05 22:49:23 +00:00
// Foo<A>::Inner a;
// Foo<B> b;
2017-03-14 04:31:53 +00:00
//
2017-03-05 22:49:23 +00:00
// =>
//
// EnumDecl A
// EnumDecl B
// ClassTemplate Foo
// TemplateTypeParameter T
// StructDecl Inner
// VarDecl a
// TemplateRef Foo
// TypeRef enum A
// TypeRef struct Foo<enum A>::Inner
// CallExpr Inner
// VarDecl b
// TemplateRef Foo
// TypeRef enum B
// CallExpr Foo
//
//
// Determining the actual type of the variable/declaration from just the
// children is tricky. Doing so would require looking up the template
// definition associated with a TemplateRef, figuring out how many children
// it has, and then skipping that many TypeRef values. This also has to work
// with the example below (skipping the last TypeRef). As a result, we
// determine variable types using |ResolveToDeclarationType|.
//
//
// We skip the last type reference for methods/variables which are defined
// out-of-line w.r.t. the parent type.
//
// S1* Foo::foo() {}
2017-02-22 01:06:43 +00:00
//
// The above example looks like this in the AST:
//
// CXXMethod foo
// TypeRef struct S1
// TypeRef class Foo
// CompoundStmt
// ...
//
// The second TypeRef is an uninteresting usage.
bool process_last_type_ref = true;
2017-03-17 07:58:41 +00:00
if (IsTypeDefinition(semantic_container) &&
!IsTypeDefinition(lexical_container)) {
//
2017-03-17 07:58:41 +00:00
// In some code, such as the following example, we receive a cursor which is
// not
// a definition and is not associated with a definition due to an error
// condition.
// In this case, it is the Foo::Foo constructor.
//
// struct Foo {};
//
// template<class T>
// Foo::Foo() {}
//
if (!decl_cursor.is_definition()) {
// TODO: I don't think this resolution ever works.
clang::Cursor def = decl_cursor.get_definition();
if (def.get_kind() != CXCursor_FirstInvalid) {
2017-03-17 07:58:41 +00:00
std::cerr << "Successful resolution of decl usage to definition"
<< std::endl;
decl_cursor = def;
}
}
process_last_type_ref = false;
}
2017-02-20 19:08:27 +00:00
VisitDeclForTypeUsageParam param(db);
decl_cursor.VisitChildren(&VisitDeclForTypeUsageVisitor, &param);
// VisitDeclForTypeUsageVisitor guarantees that if there are multiple TypeRef
// children, the first one will always be visited.
if (param.previous_cursor && process_last_type_ref) {
VisitDeclForTypeUsageVisitorHandler(param.previous_cursor.value(), &param);
2017-03-17 07:58:41 +00:00
} else {
// If we are not processing the last type ref, it *must* be a TypeRef or
// TemplateRef.
2017-03-05 22:49:23 +00:00
//
2017-03-17 07:58:41 +00:00
// We will not visit every child if the is_interseting is false, so
// previous_cursor
2017-03-05 22:49:23 +00:00
// may not point to the last TemplateRef.
assert(param.previous_cursor.has_value() == false ||
2017-03-17 07:58:41 +00:00
(param.previous_cursor.value().get_kind() == CXCursor_TypeRef ||
param.previous_cursor.value().get_kind() == CXCursor_TemplateRef));
}
2017-02-20 19:08:27 +00:00
return param.initial_type;
}
2017-02-20 19:08:27 +00:00
2017-03-17 07:58:41 +00:00
// Various versions of LLVM (ie, 4.0) will not visit inline variable references
// for template arguments.
clang::VisiterResult AddDeclInitializerUsagesVisitor(clang::Cursor cursor,
clang::Cursor parent,
IndexFile* db) {
2017-03-14 04:31:53 +00:00
/*
2017-03-17 07:58:41 +00:00
We need to index the |DeclRefExpr| below (ie, |var| inside of
Foo<int>::var).
2017-03-14 04:31:53 +00:00
template<typename T>
struct Foo {
static constexpr int var = 3;
};
int a = Foo<int>::var;
=>
VarDecl a
UnexposedExpr var
DeclRefExpr var
TemplateRef Foo
*/
switch (cursor.get_kind()) {
2017-05-21 23:48:21 +00:00
case CXCursor_DeclRefExpr: {
2017-03-17 07:58:41 +00:00
if (cursor.get_referenced().get_kind() != CXCursor_VarDecl)
break;
// TODO: when we resolve the template type to the definition, we get a
// different USR.
// clang::Cursor ref =
// cursor.get_referenced().template_specialization_to_template_definition().get_type().strip_qualifiers().get_usr();
// std::string ref_usr =
// cursor.get_referenced().template_specialization_to_template_definition().get_type().strip_qualifiers().get_usr();
std::string ref_usr =
cursor.get_referenced()
.template_specialization_to_template_definition()
.get_usr();
// std::string ref_usr = ref.get_usr();
if (ref_usr == "")
break;
2017-05-10 06:13:13 +00:00
Range loc = ResolveSpelling(cursor.cx_cursor);
2017-03-17 07:58:41 +00:00
// std::cerr << "Adding usage to id=" << ref_id.id << " usr=" << ref_usr
// << " at " << loc.ToString() << std::endl;
2017-04-08 23:16:30 +00:00
IndexVarId ref_id = db->ToVarId(ref_usr);
IndexVar* ref_def = db->Resolve(ref_id);
UniqueAdd(ref_def->uses, loc);
2017-03-14 04:31:53 +00:00
break;
2017-05-21 23:48:21 +00:00
}
default:
break;
2017-03-14 04:31:53 +00:00
}
return clang::VisiterResult::Recurse;
}
void AddDeclInitializerUsages(IndexFile* db, clang::Cursor decl_cursor) {
2017-03-14 04:31:53 +00:00
decl_cursor.VisitChildren(&AddDeclInitializerUsagesVisitor, db);
}
2017-04-05 08:06:18 +00:00
bool AreEqualLocations(CXIdxLoc loc, CXCursor cursor) {
// clang_getCursorExtent
// clang_Cursor_getSpellingNameRange
return clang_equalLocations(
clang_indexLoc_getCXSourceLocation(loc),
//clang_getRangeStart(clang_getCursorExtent(cursor)));
clang_getRangeStart(clang_Cursor_getSpellingNameRange(cursor, 0, 0)));
}
clang::VisiterResult VisitMacroDefinitionAndExpansions(clang::Cursor cursor, clang::Cursor parent, IndexParam* param) {
switch (cursor.get_kind()) {
case CXCursor_MacroDefinition:
2017-05-21 23:48:21 +00:00
case CXCursor_MacroExpansion: {
// Resolve location, find IndexFile instance.
CXSourceRange cx_source_range = clang_Cursor_getSpellingNameRange(cursor.cx_cursor, 0, 0);
CXSourceLocation start = clang_getRangeStart(cx_source_range);
if (clang_Location_isInSystemHeader(start))
break;
CXFile file;
Range decl_loc_spelling = Resolve(cx_source_range, &file);
IndexFile* db = ConsumeFile(param, file);
if (!db)
break;
// TODO: Considering checking clang_Cursor_isMacroFunctionLike, but the
// only real difference will be that we show 'callers' instead of 'refs'
// (especially since macros cannot have overrides)
std::string decl_usr;
if (cursor.get_kind() == CXCursor_MacroDefinition)
decl_usr = cursor.get_usr();
else
decl_usr = cursor.get_referenced().get_usr();
IndexVarId var_id = db->ToVarId(decl_usr);
IndexVar* var_def = db->Resolve(var_id);
UniqueAdd(var_def->uses, decl_loc_spelling);
if (cursor.get_kind() == CXCursor_MacroDefinition) {
var_def->def.short_name = cursor.get_display_name();
var_def->def.detailed_name = var_def->def.short_name;
var_def->def.is_local = false;
2017-06-29 06:28:29 +00:00
var_def->def.is_macro = true;
var_def->def.definition_spelling = decl_loc_spelling;
var_def->def.definition_extent = ResolveExtent(cursor.cx_cursor);;
}
2017-05-21 23:48:21 +00:00
break;
}
default:
break;
}
return clang::VisiterResult::Continue;
}
2017-02-20 00:56:56 +00:00
void indexDeclaration(CXClientData client_data, const CXIdxDeclInfo* decl) {
2017-04-12 07:57:12 +00:00
if (!kIndexStdDeclarations && clang_Location_isInSystemHeader(clang_indexLoc_getCXSourceLocation(decl->loc)))
2017-03-06 06:47:37 +00:00
return;
2017-02-21 07:33:05 +00:00
2017-04-05 08:06:18 +00:00
assert(AreEqualLocations(decl->loc, decl->cursor));
2017-04-08 22:54:36 +00:00
CXFile file;
clang_getSpellingLocation(clang_indexLoc_getCXSourceLocation(decl->loc), &file, nullptr, nullptr, nullptr);
2017-02-20 00:56:56 +00:00
IndexParam* param = static_cast<IndexParam*>(client_data);
IndexFile* db = ConsumeFile(param, file);
2017-04-08 22:54:36 +00:00
if (!db)
return;
NamespaceHelper* ns = &param->ns;
2017-02-20 00:56:56 +00:00
2017-03-29 06:33:38 +00:00
//std::cerr << "DECL kind=" << decl->entityInfo->kind << " at " << db->id_cache.Resolve(decl->cursor, false).ToPrettyString(&db->id_cache) << std::endl;
2017-03-14 04:31:53 +00:00
2017-02-20 00:56:56 +00:00
switch (decl->entityInfo->kind) {
2017-03-17 07:58:41 +00:00
case CXIdxEntity_CXXNamespace: {
ns->RegisterQualifiedName(decl->entityInfo->USR, decl->semanticContainer,
decl->entityInfo->name);
break;
2017-03-17 07:58:41 +00:00
}
2017-03-17 07:58:41 +00:00
case CXIdxEntity_EnumConstant:
case CXIdxEntity_Field:
case CXIdxEntity_Variable:
case CXIdxEntity_CXXStaticVariable: {
2017-05-10 06:13:13 +00:00
Range decl_loc_spelling = ResolveSpelling(decl->cursor);
2017-04-03 01:34:15 +00:00
2017-03-17 07:58:41 +00:00
clang::Cursor decl_cursor = decl->cursor;
2017-03-14 04:31:53 +00:00
2017-03-17 07:58:41 +00:00
// Do not index implicit template instantiations.
if (decl_cursor !=
decl_cursor.template_specialization_to_template_definition())
break;
2017-02-20 00:56:56 +00:00
2017-03-17 07:58:41 +00:00
std::string decl_usr = decl_cursor.get_usr();
2017-02-20 19:08:27 +00:00
IndexVarId var_id = db->ToVarId(decl->entityInfo->USR);
2017-05-27 17:03:49 +00:00
IndexVar* var = db->Resolve(var_id);
2017-02-20 00:56:56 +00:00
2017-03-17 07:58:41 +00:00
// TODO: Eventually run with this if. Right now I want to iron out bugs
// this may shadow.
// TODO: Verify this gets called multiple times
// if (!decl->isRedeclaration) {
2017-05-27 17:03:49 +00:00
var->def.short_name = decl->entityInfo->name;
std::string type_name = clang::ToString(clang_getTypeSpelling(clang_getCursorType(decl->cursor)));
2017-05-27 17:03:49 +00:00
var->def.detailed_name = type_name + " " + ns->QualifiedName(decl->semanticContainer, var->def.short_name);
2017-05-27 17:03:49 +00:00
var->def.is_local = !decl->semanticContainer || IsLocalSemanticContainer(decl->semanticContainer->cursor.kind);
//}
2017-04-05 08:06:18 +00:00
if (decl->isDefinition) {
2017-05-27 17:03:49 +00:00
var->def.definition_spelling = ResolveSpelling(decl->cursor);
var->def.definition_extent = ResolveExtent(decl->cursor);;
2017-04-05 08:06:18 +00:00
}
else {
2017-05-27 17:03:49 +00:00
var->def.declaration = ResolveSpelling(decl->cursor);
2017-04-05 08:06:18 +00:00
}
2017-05-27 17:03:49 +00:00
UniqueAdd(var->uses, decl_loc_spelling);
2017-03-17 07:58:41 +00:00
// std::cerr << std::endl << "Visiting declaration" << std::endl;
// Dump(decl_cursor);
AddDeclInitializerUsages(db, decl_cursor);
2017-05-27 17:03:49 +00:00
var = db->Resolve(var_id);
2017-03-17 07:58:41 +00:00
// Declaring variable type information. Note that we do not insert an
// interesting reference for parameter declarations - that is handled when
// the function declaration is encountered since we won't receive ParmDecl
// declarations for unnamed parameters.
// TODO: See if we can remove this function call.
2017-03-17 07:58:41 +00:00
AddDeclTypeUsages(
db, decl_cursor,
decl->semanticContainer, decl->lexicalContainer);
2017-04-03 01:34:15 +00:00
// We don't need to assign declaring type multiple times if this variable
// has already been seen.
if (!decl->isRedeclaration) {
optional<IndexTypeId> var_type = ResolveToDeclarationType(db, decl_cursor);
2017-04-03 01:34:15 +00:00
if (var_type.has_value()) {
// Don't treat enum definition variables as instantiations.
bool is_enum_member = decl->semanticContainer && decl->semanticContainer->cursor.kind == CXCursor_EnumDecl;
if (!is_enum_member)
2017-04-21 07:03:33 +00:00
db->Resolve(var_type.value())->instances.push_back(var_id);
2017-04-03 01:34:15 +00:00
2017-05-27 17:03:49 +00:00
var->def.variable_type = var_type.value();
2017-04-03 01:34:15 +00:00
}
}
// TODO: Refactor handlers so more things are under 'if (!decl->isRedeclaration)'
2017-03-17 07:58:41 +00:00
if (decl->isDefinition && IsTypeDefinition(decl->semanticContainer)) {
IndexTypeId declaring_type_id =
2017-04-03 01:34:15 +00:00
db->ToTypeId(decl->semanticContainer->cursor);
IndexType* declaring_type_def = db->Resolve(declaring_type_id);
2017-05-27 17:03:49 +00:00
var->def.declaring_type = declaring_type_id;
2017-03-17 07:58:41 +00:00
declaring_type_def->def.vars.push_back(var_id);
2017-02-21 05:16:45 +00:00
}
2017-03-17 07:58:41 +00:00
break;
}
2017-02-21 05:16:45 +00:00
2017-03-17 07:58:41 +00:00
case CXIdxEntity_Function:
case CXIdxEntity_CXXConstructor:
case CXIdxEntity_CXXDestructor:
case CXIdxEntity_CXXInstanceMethod:
case CXIdxEntity_CXXStaticMethod:
case CXIdxEntity_CXXConversionFunction: {
2017-05-27 20:10:06 +00:00
Range decl_spelling = ResolveSpelling(decl->cursor);
Range decl_extent = ResolveExtent(decl->cursor);
2017-04-03 01:34:15 +00:00
2017-03-17 07:58:41 +00:00
clang::Cursor decl_cursor = decl->cursor;
2017-05-27 19:56:39 +00:00
clang::Cursor decl_cursor_resolved = decl_cursor.template_specialization_to_template_definition();
bool is_template_specialization = decl_cursor != decl_cursor_resolved;
2017-03-17 07:58:41 +00:00
2017-05-27 19:56:39 +00:00
IndexFuncId func_id = db->ToFuncId(decl_cursor_resolved.cx_cursor);
2017-05-27 17:03:49 +00:00
IndexFunc* func = db->Resolve(func_id);
2017-03-17 07:58:41 +00:00
// We don't actually need to know the return type, but we need to mark it
// as an interesting usage.
AddDeclTypeUsages(db, decl_cursor,
2017-03-17 07:58:41 +00:00
decl->semanticContainer, decl->lexicalContainer);
2017-05-27 19:56:39 +00:00
// Add definition or declaration. This is a bit tricky because we treat
// template specializations as declarations, even though they are
// technically definitions.
// TODO: Support multiple function definitions, which is common for
// template specializations.
if (decl->isDefinition && !is_template_specialization) {
2017-05-31 00:54:19 +00:00
//assert(!func->def.definition_spelling);
//assert(!func->def.definition_extent);
2017-05-27 20:10:06 +00:00
func->def.definition_spelling = decl_spelling;
func->def.definition_extent = decl_extent;
2017-04-05 08:06:18 +00:00
}
else {
IndexFunc::Declaration declaration;
declaration.spelling = decl_spelling;
declaration.extent = decl_extent;
declaration.content = GetDocumentContentInRange(param->tu->cx_tu, clang_getCursorExtent(decl->cursor));
// Add parameters.
for (clang::Cursor arg : decl_cursor.get_arguments()) {
switch (arg.get_kind()) {
case CXCursor_ParmDecl: {
Range param_spelling = ResolveSpelling(arg.cx_cursor);
// If the name is empty (which is common for parameters), clang
// will report a range with length 1, which is not correct.
if (param_spelling.start.column == (param_spelling.end.column - 1) &&
arg.get_display_name().empty()) {
param_spelling.end.column -= 1;
}
declaration.param_spellings.push_back(param_spelling);
break;
}
default:
break;
}
}
func->declarations.push_back(declaration);
2017-04-05 08:06:18 +00:00
}
2017-03-17 07:58:41 +00:00
2017-05-27 19:56:39 +00:00
// Emit definition data for the function. We do this even if it isn't a
// definition because there can be, for example, interfaces, or a class
// declaration that doesn't have a definition yet. If we never end up
// indexing the definition, then there will not be any (ie) outline
// information.
if (!is_template_specialization) {
2017-05-27 17:03:49 +00:00
func->def.short_name = decl->entityInfo->name;
// Build detailed name. The type desc looks like void (void *). We
// insert the qualified name before the first '('.
2017-05-27 17:03:49 +00:00
std::string qualified_name = ns->QualifiedName(decl->semanticContainer, func->def.short_name);
std::string type_desc = decl_cursor.get_type_description();
size_t offset = type_desc.find('(');
type_desc.insert(offset, qualified_name);
2017-05-27 17:03:49 +00:00
func->def.detailed_name = type_desc;
2017-03-17 07:58:41 +00:00
// Add function usage information. We only want to do it once per
// definition/declaration. Do it on definition since there should only
// ever be one of those in the entire program.
2017-03-17 07:58:41 +00:00
if (IsTypeDefinition(decl->semanticContainer)) {
IndexTypeId declaring_type_id =
2017-03-17 07:58:41 +00:00
db->ToTypeId(decl->semanticContainer->cursor);
IndexType* declaring_type_def = db->Resolve(declaring_type_id);
2017-05-27 17:03:49 +00:00
func->def.declaring_type = declaring_type_id;
2017-03-17 07:58:41 +00:00
// Mark a type reference at the ctor/dtor location.
2017-05-27 19:56:39 +00:00
if (decl->entityInfo->kind == CXIdxEntity_CXXConstructor)
2017-05-27 20:10:06 +00:00
UniqueAdd(declaring_type_def->uses, decl_spelling);
if (decl->entityInfo->kind == CXIdxEntity_CXXDestructor) {
2017-05-27 20:10:06 +00:00
Range dtor_type_range = decl_spelling;
dtor_type_range.start.column += 1; // Don't count the leading ~
UniqueAdd(declaring_type_def->uses, dtor_type_range);
}
2017-05-27 19:56:39 +00:00
// Add function to declaring type.
UniqueAdd(declaring_type_def->def.funcs, func_id);
2017-03-17 07:58:41 +00:00
}
2017-02-20 07:06:38 +00:00
// Process inheritance.
if (clang_CXXMethod_isVirtual(decl->cursor)) {
CXCursor* overridden;
unsigned int num_overridden;
clang_getOverriddenCursors(decl->cursor, &overridden,
&num_overridden);
// FIXME if it ever shows up. Methods should only ever have 1 base
// type, though.
if (num_overridden > 1)
2017-05-27 17:03:49 +00:00
std::cerr << "[indexer]: warning: multiple base overrides for " << func->def.detailed_name << std::endl;
for (unsigned i = 0; i < num_overridden; ++i) {
clang::Cursor parent = overridden[i];
IndexFuncId parent_id = db->ToFuncId(parent.get_usr());
IndexFunc* parent_def = db->Resolve(parent_id);
2017-05-27 17:03:49 +00:00
func = db->Resolve(func_id); // ToFuncId invalidated func_def
2017-05-27 17:03:49 +00:00
func->def.base = parent_id;
parent_def->derived.push_back(func_id);
}
2017-02-20 07:06:38 +00:00
clang_disposeOverriddenCursors(overridden);
}
2017-02-20 07:06:38 +00:00
}
2017-03-17 07:58:41 +00:00
break;
}
2017-02-20 02:35:56 +00:00
2017-03-17 07:58:41 +00:00
case CXIdxEntity_Typedef:
case CXIdxEntity_CXXTypeAlias: {
2017-05-10 06:13:13 +00:00
Range decl_loc_spelling = ResolveSpelling(decl->cursor);
2017-04-03 01:34:15 +00:00
2017-03-17 07:58:41 +00:00
// Note we want to fetch the first TypeRef. Running
// ResolveCursorType(decl->cursor) would return
// the type of the typedef/using, not the type of the referenced type.
optional<IndexTypeId> alias_of =
AddDeclTypeUsages(db, decl->cursor,
2017-03-17 07:58:41 +00:00
decl->semanticContainer, decl->lexicalContainer);
2017-02-20 02:35:56 +00:00
IndexTypeId type_id = db->ToTypeId(decl->entityInfo->USR);
2017-05-27 17:03:49 +00:00
IndexType* type = db->Resolve(type_id);
2017-02-20 00:56:56 +00:00
2017-03-17 07:58:41 +00:00
if (alias_of)
2017-05-27 17:03:49 +00:00
type->def.alias_of = alias_of.value();
2017-02-21 06:11:47 +00:00
2017-05-27 17:03:49 +00:00
type->def.short_name = decl->entityInfo->name;
type->def.detailed_name =
ns->QualifiedName(decl->semanticContainer, type->def.short_name);
2017-03-17 07:58:41 +00:00
2017-05-27 17:03:49 +00:00
type->def.definition_spelling = ResolveSpelling(decl->cursor);
type->def.definition_extent = ResolveExtent(decl->cursor);
UniqueAdd(type->uses, decl_loc_spelling);
2017-03-17 07:58:41 +00:00
break;
2017-02-21 06:11:47 +00:00
}
2017-03-17 07:58:41 +00:00
case CXIdxEntity_Enum:
case CXIdxEntity_Union:
case CXIdxEntity_Struct:
case CXIdxEntity_CXXClass: {
2017-05-10 06:13:13 +00:00
Range decl_loc_spelling = ResolveSpelling(decl->cursor);
2017-04-03 01:34:15 +00:00
IndexTypeId type_id = db->ToTypeId(decl->entityInfo->USR);
2017-05-27 17:03:49 +00:00
IndexType* type = db->Resolve(type_id);
2017-03-17 07:58:41 +00:00
// TODO: Eventually run with this if. Right now I want to iron out bugs
// this may shadow.
// TODO: For type section, verify if this ever runs for non definitions?
// if (!decl->isRedeclaration) {
// name can be null in an anonymous struct (see
// tests/types/anonymous_struct.cc).
if (decl->entityInfo->name) {
ns->RegisterQualifiedName(decl->entityInfo->USR,
decl->semanticContainer,
decl->entityInfo->name);
2017-05-27 17:03:49 +00:00
type->def.short_name = decl->entityInfo->name;
2017-03-17 07:58:41 +00:00
} else {
2017-05-27 17:03:49 +00:00
type->def.short_name = "<anonymous>";
2017-03-17 07:58:41 +00:00
}
2017-05-27 17:03:49 +00:00
type->def.detailed_name =
ns->QualifiedName(decl->semanticContainer, type->def.short_name);
2017-03-17 07:58:41 +00:00
// }
assert(decl->isDefinition);
2017-05-27 17:03:49 +00:00
type->def.definition_spelling = ResolveSpelling(decl->cursor);
type->def.definition_extent = ResolveExtent(decl->cursor);
UniqueAdd(type->uses, decl_loc_spelling);
2017-03-17 07:58:41 +00:00
// type_def->alias_of
// type_def->funcs
// type_def->types
// type_def->uses
// type_def->vars
// Add type-level inheritance information.
CXIdxCXXClassDeclInfo const* class_info =
clang_index_getCXXClassDeclInfo(decl);
if (class_info) {
for (unsigned int i = 0; i < class_info->numBases; ++i) {
const CXIdxBaseClassInfo* base_class = class_info->bases[i];
AddDeclTypeUsages(db, base_class->cursor,
2017-03-17 07:58:41 +00:00
decl->semanticContainer, decl->lexicalContainer);
optional<IndexTypeId> parent_type_id =
2017-03-17 07:58:41 +00:00
ResolveToDeclarationType(db, base_class->cursor);
2017-04-03 01:34:15 +00:00
// type_def ptr could be invalidated by ResolveToDeclarationType.
2017-05-27 17:03:49 +00:00
type = db->Resolve(type_id);
2017-03-17 07:58:41 +00:00
if (parent_type_id) {
IndexType* parent_type_def =
2017-03-17 07:58:41 +00:00
db->Resolve(parent_type_id.value());
parent_type_def->derived.push_back(type_id);
2017-05-27 17:03:49 +00:00
type->def.parents.push_back(parent_type_id.value());
2017-03-17 07:58:41 +00:00
}
2017-02-21 05:32:40 +00:00
}
}
2017-03-17 07:58:41 +00:00
break;
2017-02-20 00:56:56 +00:00
}
2017-03-17 07:58:41 +00:00
default:
std::cerr
<< "!! Unhandled indexDeclaration: "
<< clang::Cursor(decl->cursor).ToString() << " at "
2017-05-10 06:13:13 +00:00
<< ResolveSpelling(decl->cursor).start.ToString()
2017-03-17 07:58:41 +00:00
<< std::endl;
std::cerr << " entityInfo->kind = " << decl->entityInfo->kind
<< std::endl;
std::cerr << " entityInfo->USR = " << decl->entityInfo->USR
<< std::endl;
if (decl->declAsContainer)
std::cerr << " declAsContainer = "
<< clang::Cursor(decl->declAsContainer->cursor).ToString()
<< std::endl;
if (decl->semanticContainer)
std::cerr << " semanticContainer = "
<< clang::Cursor(decl->semanticContainer->cursor).ToString()
<< std::endl;
if (decl->lexicalContainer)
std::cerr << " lexicalContainer = "
<< clang::Cursor(decl->lexicalContainer->cursor).get_usr()
<< std::endl;
break;
2017-02-20 00:56:56 +00:00
}
}
2017-04-08 18:36:32 +00:00
bool IsFunctionCallContext(CXCursorKind kind) {
2017-02-20 00:56:56 +00:00
switch (kind) {
2017-03-17 07:58:41 +00:00
case CXCursor_FunctionDecl:
2017-04-08 18:36:32 +00:00
case CXCursor_CXXMethod:
case CXCursor_Constructor:
case CXCursor_Destructor:
case CXCursor_ConversionFunction:
case CXCursor_FunctionTemplate:
case CXCursor_OverloadedDeclRef:
// TODO: we need to test lambdas
case CXCursor_LambdaExpr:
2017-03-17 07:58:41 +00:00
return true;
2017-05-21 23:48:21 +00:00
default:
break;
2017-02-20 00:56:56 +00:00
}
return false;
}
2017-03-17 07:58:41 +00:00
void indexEntityReference(CXClientData client_data,
const CXIdxEntityRefInfo* ref) {
2017-04-08 22:54:36 +00:00
// Don't index references from or to system headers.
if (clang_Location_isInSystemHeader(clang_indexLoc_getCXSourceLocation(ref->loc)) ||
clang_Location_isInSystemHeader(clang_getCursorLocation(ref->referencedEntity->cursor)))
return;
2017-04-05 08:06:18 +00:00
//assert(AreEqualLocations(ref->loc, ref->cursor));
2017-04-03 01:34:15 +00:00
// if (clang_Location_isInSystemHeader(clang_getCursorLocation(ref->cursor)) ||
// clang_Location_isInSystemHeader(
// clang_getCursorLocation(ref->referencedEntity->cursor)))
// return;
2017-04-08 22:54:36 +00:00
// TODO: Use clang_getFileUniqueID
CXFile file;
clang_getSpellingLocation(clang_indexLoc_getCXSourceLocation(ref->loc), &file, nullptr, nullptr, nullptr);
2017-04-08 18:36:32 +00:00
IndexParam* param = static_cast<IndexParam*>(client_data);
IndexFile* db = ConsumeFile(param, file);
2017-04-08 22:54:36 +00:00
if (!db)
return;
2017-04-08 18:36:32 +00:00
// ref->cursor mainFile=0
// ref->loc mainFile=1
// ref->referencedEntity mainFile=1
//
// Regardless, we need to do more advanced location processing to handle multiple output IndexFile instances.
2017-04-08 18:36:32 +00:00
//bool mainFile = clang_Location_isFromMainFile(clang_indexLoc_getCXSourceLocation(ref->loc));
//Range loc_spelling = param->db->id_cache.ForceResolveSpelling(ref->cursor, false /*interesting*/);
//std::cerr << "mainFile: " << mainFile << ", loc: " << loc_spelling.ToString() << std::endl;
2017-04-03 01:34:15 +00:00
// Don't index references that are not from the main file.
2017-04-08 22:54:36 +00:00
//if (!clang_Location_isFromMainFile(clang_getCursorLocation(ref->cursor)))
// return;
2017-03-06 06:47:37 +00:00
2017-04-08 18:36:32 +00:00
2017-02-20 00:56:56 +00:00
clang::Cursor cursor(ref->cursor);
2017-03-17 07:58:41 +00:00
// std::cerr << "REF kind=" << ref->referencedEntity->kind << " at " <<
// db->id_cache.Resolve(cursor, false).ToPrettyString(&db->id_cache) <<
// std::endl;
2017-03-14 04:31:53 +00:00
2017-02-20 00:56:56 +00:00
switch (ref->referencedEntity->kind) {
case CXIdxEntity_CXXNamespaceAlias:
2017-03-17 07:58:41 +00:00
case CXIdxEntity_CXXNamespace: {
// We don't index namespace usages.
break;
2017-02-20 00:56:56 +00:00
}
2017-03-17 07:58:41 +00:00
case CXIdxEntity_EnumConstant:
case CXIdxEntity_CXXStaticVariable:
case CXIdxEntity_Variable:
case CXIdxEntity_Field: {
2017-05-10 06:13:13 +00:00
Range loc_spelling = ResolveSpelling(ref->cursor);
2017-04-03 01:34:15 +00:00
2017-03-17 07:58:41 +00:00
clang::Cursor referenced = ref->referencedEntity->cursor;
referenced = referenced.template_specialization_to_template_definition();
IndexVarId var_id = db->ToVarId(referenced.get_usr());
2017-05-27 17:03:49 +00:00
IndexVar* var = db->Resolve(var_id);
UniqueAdd(var->uses, loc_spelling);
2017-03-17 07:58:41 +00:00
break;
2017-02-20 00:56:56 +00:00
}
2017-03-17 07:58:41 +00:00
case CXIdxEntity_CXXConversionFunction:
case CXIdxEntity_CXXStaticMethod:
case CXIdxEntity_CXXInstanceMethod:
case CXIdxEntity_Function:
case CXIdxEntity_CXXConstructor:
case CXIdxEntity_CXXDestructor: {
// TODO: Redirect container to constructor for the following example, ie,
// we should be inserting an outgoing function call from the Foo
// ctor.
//
// int Gen() { return 5; }
// class Foo {
// int x = Gen();
// }
// TODO: search full history?
2017-05-10 06:13:13 +00:00
Range loc_spelling = ResolveSpelling(ref->cursor);
2017-04-03 01:34:15 +00:00
IndexFuncId called_id = db->ToFuncId(ref->referencedEntity->USR);
2017-05-27 17:03:49 +00:00
IndexFunc* called = db->Resolve(called_id);
2017-05-23 06:47:27 +00:00
// libclang doesn't provide a nice api to check if the given function
// call is implicit. ref->kind should probably work (it's either direct
// or implicit), but libclang only supports implicit for objective-c.
bool is_implicit = CanBeCalledImplicitly(ref->referencedEntity->kind) &&
2017-05-27 17:03:49 +00:00
!CursorSpellingContainsString(ref->cursor, param->tu->cx_tu, called->def.short_name);
2017-05-23 06:47:27 +00:00
2017-04-08 18:36:32 +00:00
if (IsFunctionCallContext(ref->container->cursor.kind)) {
IndexFuncId caller_id = db->ToFuncId(ref->container->cursor);
2017-05-27 17:03:49 +00:00
IndexFunc* caller = db->Resolve(caller_id);
2017-05-23 06:47:27 +00:00
// Calling db->ToFuncId invalidates the FuncDef* ptrs.
2017-05-27 17:03:49 +00:00
called = db->Resolve(called_id);
2017-03-17 07:58:41 +00:00
2017-05-27 17:03:49 +00:00
AddFuncRef(&caller->def.callees, IndexFuncRef(called_id, loc_spelling, is_implicit));
AddFuncRef(&called->callers, IndexFuncRef(caller_id, loc_spelling, is_implicit));
2017-03-17 07:58:41 +00:00
} else {
2017-05-27 17:03:49 +00:00
AddFuncRef(&called->callers, IndexFuncRef(loc_spelling, is_implicit));
2017-03-17 07:58:41 +00:00
}
break;
}
2017-02-17 09:57:44 +00:00
2017-03-17 07:58:41 +00:00
case CXIdxEntity_Typedef:
case CXIdxEntity_CXXTypeAlias:
case CXIdxEntity_Enum:
case CXIdxEntity_Union:
case CXIdxEntity_Struct:
case CXIdxEntity_CXXClass: {
2017-05-27 17:03:49 +00:00
clang::Cursor referenced_cursor = ref->referencedEntity->cursor;
referenced_cursor = referenced_cursor.template_specialization_to_template_definition();
IndexTypeId referenced_id = db->ToTypeId(referenced_cursor.get_usr());
2017-03-17 07:58:41 +00:00
2017-05-27 17:03:49 +00:00
IndexType* referenced = db->Resolve(referenced_id);
2017-03-17 07:58:41 +00:00
//
// The following will generate two TypeRefs to Foo, both located at the
// same spot (line 3, column 3). One of the parents will be set to
// CXIdxEntity_Variable, the other will be CXIdxEntity_Function. There
2017-05-27 17:03:49 +00:00
// does not appear to be a good way to disambiguate these references, as
// using parent type alone breaks other indexing tasks.
2017-03-17 07:58:41 +00:00
//
// To work around this, we check to see if the usage location has been
// inserted into all_uses previously.
//
// struct Foo {};
// void Make() {
// Foo f;
// }
//
2017-05-27 17:03:49 +00:00
UniqueAdd(referenced->uses, ResolveSpelling(ref->cursor));
2017-03-17 07:58:41 +00:00
break;
2017-02-26 01:08:05 +00:00
}
2017-02-20 00:56:56 +00:00
2017-03-17 07:58:41 +00:00
default:
std::cerr
<< "!! Unhandled indexEntityReference: " << cursor.ToString()
<< " at "
2017-05-10 06:13:13 +00:00
<< ResolveSpelling(ref->cursor).start.ToString()
2017-03-17 07:58:41 +00:00
<< std::endl;
std::cerr << " ref->referencedEntity->kind = "
<< ref->referencedEntity->kind << std::endl;
if (ref->parentEntity)
std::cerr << " ref->parentEntity->kind = "
<< ref->parentEntity->kind << std::endl;
std::cerr
<< " ref->loc = "
2017-05-10 06:13:13 +00:00
<< ResolveSpelling(ref->cursor).start.ToString()
2017-03-17 07:58:41 +00:00
<< std::endl;
std::cerr << " ref->kind = " << ref->kind << std::endl;
if (ref->parentEntity)
std::cerr << " parentEntity = "
<< clang::Cursor(ref->parentEntity->cursor).ToString()
<< std::endl;
if (ref->referencedEntity)
std::cerr << " referencedEntity = "
<< clang::Cursor(ref->referencedEntity->cursor).ToString()
<< std::endl;
if (ref->container)
std::cerr << " container = "
<< clang::Cursor(ref->container->cursor).ToString()
<< std::endl;
break;
2017-02-20 00:56:56 +00:00
}
}
2017-02-17 09:57:44 +00:00
std::vector<std::unique_ptr<IndexFile>> Parse(
Config* config, FileConsumer::SharedState* file_consumer_shared,
std::string file,
std::vector<std::string> args,
const std::string& file_contents_path,
const optional<std::string>& file_contents,
PerformanceImportFile* perf,
clang::Index* index,
2017-04-20 07:25:38 +00:00
bool dump_ast) {
if (!config->enableIndexing)
return {};
2017-04-19 00:05:14 +00:00
file = NormalizePath(file);
2017-03-11 02:24:51 +00:00
Timer timer;
//clang::Index index(0 /*excludeDeclarationsFromPCH*/,
// 0 /*displayDiagnostics*/);
2017-04-14 22:58:07 +00:00
std::vector<CXUnsavedFile> unsaved_files;
if (file_contents) {
CXUnsavedFile unsaved;
unsaved.Filename = file_contents_path.c_str();
unsaved.Contents = file_contents->c_str();
unsaved.Length = (unsigned long)file_contents->size();
unsaved_files.push_back(unsaved);
}
clang::TranslationUnit tu(index, file, args, unsaved_files, CXTranslationUnit_KeepGoing | CXTranslationUnit_DetailedPreprocessingRecord);
if (tu.did_fail) {
std::cerr << "!! Failed creating translation unit for " << file << std::endl;
return {};
}
2017-02-16 09:35:30 +00:00
perf->index_parse = timer.ElapsedMicrosecondsAndReset();
2017-02-27 07:28:33 +00:00
if (dump_ast)
2017-02-21 06:11:47 +00:00
Dump(tu.document_cursor());
2017-02-20 00:56:56 +00:00
IndexerCallbacks callbacks[] = {
2017-03-17 07:58:41 +00:00
{&abortQuery, &diagnostic, &enteredMainFile, &ppIncludedFile,
&importedASTFile, &startedTranslationUnit, &indexDeclaration,
&indexEntityReference}
2017-02-20 00:56:56 +00:00
};
FileConsumer file_consumer(file_consumer_shared, file);
IndexParam param(&tu, &file_consumer);
2017-03-06 06:47:37 +00:00
CXFile cx_file = clang_getFile(tu.cx_tu, file.c_str());
param.primary_file = ConsumeFile(&param, cx_file);
//std::cerr << "!! [START] Indexing " << file << std::endl;
CXIndexAction index_action = clang_IndexAction_create(index->cx_index);
2017-02-20 00:56:56 +00:00
clang_indexTranslationUnit(index_action, &param, callbacks, sizeof(callbacks),
2017-04-03 01:34:15 +00:00
CXIndexOpt_IndexFunctionLocalSymbols | CXIndexOpt_SkipParsedBodiesInSession | CXIndexOpt_IndexImplicitTemplateInstantiations,
2017-03-17 07:58:41 +00:00
tu.cx_tu);
2017-02-20 00:56:56 +00:00
clang_IndexAction_dispose(index_action);
//std::cerr << "!! [END] Indexing " << file << std::endl;
tu.document_cursor().VisitChildren(&VisitMacroDefinitionAndExpansions, &param);
perf->index_build = timer.ElapsedMicrosecondsAndReset();
2017-02-20 00:56:56 +00:00
2017-04-08 22:54:36 +00:00
auto result = param.file_consumer->TakeLocalState();
for (auto& entry : result) {
entry->last_modification_time = GetLastModificationTime(entry->path);
entry->import_file = file;
entry->args = args;
2017-04-08 22:54:36 +00:00
}
2017-04-19 00:05:14 +00:00
2017-04-08 22:54:36 +00:00
return result;
2017-03-22 17:16:09 +00:00
}
void IndexInit() {
clang_enableStackTraces();
clang_toggleCrashRecovery(1);
2017-04-18 23:49:55 +00:00
}