#include "query.h" #include "indexer.h" #include "serializer.h" #include "serializers/json.h" #include #include #include #include #include #include #include #include #include #include // Used by |HANDLE_MERGEABLE| so only |range| is needed. MAKE_HASHABLE(Range, t.start, t.end); MAKE_HASHABLE(Use, t.range); namespace { void AssignFileId(int file_id, SymbolRef& ref) { if (ref.kind == SymbolKind::File) ref.usr = file_id; } void AssignFileId(int file_id, Use& use) { if (use.kind == SymbolKind::File) use.usr = file_id; use.file_id = file_id; } template void AssignFileId(int file_id, T&) {} template void AssignFileId(int file_id, Maybe& x) { if (x) AssignFileId(file_id, *x); } template void AssignFileId(int file_id, std::vector& xs) { for (T& x : xs) AssignFileId(file_id, x); } void AddRange(int file_id, std::vector& into, const std::vector& from) { into.reserve(into.size() + from.size()); for (Use use : from) { use.file_id = file_id; into.push_back(use); } } void AddRange(int _, std::vector& into, const std::vector& from) { into.insert(into.end(), from.begin(), from.end()); } template void RemoveRange(std::vector& dest, const std::vector& to_remove) { if (to_remove.size()) { std::unordered_set to_remove_set(to_remove.begin(), to_remove.end()); dest.erase( std::remove_if(dest.begin(), dest.end(), [&](const T& t) { return to_remove_set.count(t) > 0; }), dest.end()); } } QueryFile::DefUpdate BuildFileDefUpdate(const IndexFile& indexed) { QueryFile::Def def; def.path = indexed.path; def.args = indexed.args; def.includes = indexed.includes; def.inactive_regions = indexed.skipped_by_preprocessor; def.dependencies = indexed.dependencies; // Convert enum to markdown compatible strings def.language = [&indexed]() { switch (indexed.language) { case LanguageId::C: return "c"; case LanguageId::Cpp: return "cpp"; case LanguageId::ObjC: return "objective-c"; case LanguageId::ObjCpp: return "objective-cpp"; default: return ""; } }(); auto add_all_symbols = [&](Use use, Usr usr, SymbolKind kind) { def.all_symbols.push_back(SymbolRef(use.range, usr, kind, use.role)); }; auto add_outline = [&](Use use, Usr usr, SymbolKind kind) { def.outline.push_back(SymbolRef(use.range, usr, kind, use.role)); }; for (auto& it : indexed.usr2type) { const IndexType& type = it.second; if (type.def.spell) add_all_symbols(*type.def.spell, type.usr, SymbolKind::Type); if (type.def.extent) add_outline(*type.def.extent, type.usr, SymbolKind::Type); for (Use decl : type.declarations) { add_all_symbols(decl, type.usr, SymbolKind::Type); // Constructor positions have references to the class, // which we do not want to show in textDocument/documentSymbol if (!(decl.role & Role::Reference)) add_outline(decl, type.usr, SymbolKind::Type); } for (Use use : type.uses) add_all_symbols(use, type.usr, SymbolKind::Type); } for (auto& it: indexed.usr2func) { const IndexFunc& func = it.second; if (func.def.spell) add_all_symbols(*func.def.spell, func.usr, SymbolKind::Func); if (func.def.extent) add_outline(*func.def.extent, func.usr, SymbolKind::Func); for (Use use : func.declarations) { add_all_symbols(use, func.usr, SymbolKind::Func); add_outline(use, func.usr, SymbolKind::Func); } for (Use use : func.uses) { // Make ranges of implicit function calls larger (spanning one more column // to the left/right). This is hacky but useful. e.g. // textDocument/definition on the space/semicolon in `A a;` or `return // 42;` will take you to the constructor. if (use.role & Role::Implicit) { if (use.range.start.column > 0) use.range.start.column--; use.range.end.column++; } add_all_symbols(use, func.usr, SymbolKind::Func); } } for (auto& it : indexed.usr2var) { const IndexVar& var = it.second; if (var.def.spell) add_all_symbols(*var.def.spell, var.usr, SymbolKind::Var); if (var.def.extent) add_outline(*var.def.extent, var.usr, SymbolKind::Var); for (Use decl : var.declarations) { add_all_symbols(decl, var.usr, SymbolKind::Var); add_outline(decl, var.usr, SymbolKind::Var); } for (Use use : var.uses) add_all_symbols(use, var.usr, SymbolKind::Var); } std::sort(def.outline.begin(), def.outline.end(), [](const SymbolRef& a, const SymbolRef& b) { return a.range.start < b.range.start; }); std::sort(def.all_symbols.begin(), def.all_symbols.end(), [](const SymbolRef& a, const SymbolRef& b) { return a.range.start < b.range.start; }); return QueryFile::DefUpdate(def, indexed.file_contents); } // Returns true if an element with the same file is found. template bool TryReplaceDef(std::forward_list& def_list, Q&& def) { for (auto& def1 : def_list) if (def1.file_id == def.file_id) { if (!def1.spell || def.spell) { def1 = std::move(def); } return true; } return false; } } // namespace // ---------------------- // INDEX THREAD FUNCTIONS // ---------------------- // static IndexUpdate IndexUpdate::CreateDelta(IndexFile* previous, IndexFile* current) { IndexUpdate r; static IndexFile empty(current->path, ""); if (!previous) previous = ∅ r.files_def_update = BuildFileDefUpdate(*current); for (auto& it : previous->usr2func) { auto& func = it.second; if (func.def.spell) r.funcs_removed.push_back(func.usr); r.funcs_declarations[func.usr].first = func.declarations; r.funcs_uses[func.usr].first = func.uses; r.funcs_derived[func.usr].first = func.derived; } for (auto& it : current->usr2func) { auto& func = it.second; if (func.def.detailed_name.size()) r.funcs_def_update.emplace_back(it.first, func.def); r.funcs_declarations[func.usr].second = func.declarations; r.funcs_uses[func.usr].second = func.uses; r.funcs_derived[func.usr].second = func.derived; } for (auto& it : previous->usr2type) { auto& type = it.second; if (type.def.spell) r.types_removed.push_back(type.usr); r.types_declarations[type.usr].first = type.declarations; r.types_uses[type.usr].first = type.uses; r.types_derived[type.usr].first = type.derived; r.types_instances[type.usr].first = type.instances; }; for (auto& it : current->usr2type) { auto& type = it.second; if (type.def.detailed_name.size()) r.types_def_update.emplace_back(it.first, type.def); r.types_declarations[type.usr].second = type.declarations; r.types_uses[type.usr].second = type.uses; r.types_derived[type.usr].second = type.derived; r.types_instances[type.usr].second = type.instances; }; for (auto& it : previous->usr2var) { auto& var = it.second; if (var.def.spell) r.vars_removed.push_back(var.usr); r.vars_declarations[var.usr].first = var.declarations; r.vars_uses[var.usr].first = var.uses; } for (auto& it : current->usr2var) { auto& var = it.second; if (var.def.detailed_name.size()) r.vars_def_update.emplace_back(it.first, var.def); r.vars_declarations[var.usr].second = var.declarations; r.vars_uses[var.usr].second = var.uses; } return r; } // ------------------------ // QUERYDB THREAD FUNCTIONS // ------------------------ void QueryDatabase::RemoveUsrs(SymbolKind usr_kind, const std::vector& to_remove) { switch (usr_kind) { case SymbolKind::Type: { for (Usr usr : to_remove) { QueryType& type = usr2type[usr]; if (type.symbol_idx >= 0) symbols[type.symbol_idx].kind = SymbolKind::Invalid; type.def.clear(); } break; } default: break; } } void QueryDatabase::RemoveUsrs( SymbolKind kind, int file_id, const std::vector& to_remove) { switch (kind) { case SymbolKind::Func: { for (auto usr : to_remove) { QueryFunc& func = Func(usr); func.def.remove_if([=](const QueryFunc::Def& def) { return def.file_id == file_id; }); } break; } case SymbolKind::Var: { for (auto usr : to_remove) { QueryVar& var = Var(usr); var.def.remove_if([=](const QueryVar::Def& def) { return def.file_id == file_id; }); } break; } default: assert(false); break; } } void QueryDatabase::ApplyIndexUpdate(IndexUpdate* u) { // This function runs on the querydb thread. // Example types: // storage_name => std::vector> // merge_update => QueryType::DerivedUpdate => // MergeableUpdate def => QueryType // def->def_var_name => std::vector #define HANDLE_MERGEABLE(update_var_name, def_var_name, storage_name) \ for (auto& it : u->update_var_name) { \ auto& entity = storage_name[it.first]; \ RemoveRange(entity.def_var_name, it.second.first); \ AssignFileId(u->file_id, it.second.second); \ AddRange(u->file_id, entity.def_var_name, it.second.second); \ } if (u->files_removed) files[name2file_id[LowerPathIfInsensitive(*u->files_removed)]].def = std::nullopt; u->file_id = u->files_def_update ? Update(std::move(*u->files_def_update)) : -1; RemoveUsrs(SymbolKind::Func, u->file_id, u->funcs_removed); Update(u->file_id, std::move(u->funcs_def_update)); HANDLE_MERGEABLE(funcs_declarations, declarations, usr2func); HANDLE_MERGEABLE(funcs_derived, derived, usr2func); HANDLE_MERGEABLE(funcs_uses, uses, usr2func); RemoveUsrs(SymbolKind::Type, u->types_removed); Update(u->file_id, std::move(u->types_def_update)); HANDLE_MERGEABLE(types_declarations, declarations, usr2type); HANDLE_MERGEABLE(types_derived, derived, usr2type); HANDLE_MERGEABLE(types_instances, instances, usr2type); HANDLE_MERGEABLE(types_uses, uses, usr2type); RemoveUsrs(SymbolKind::Var, u->file_id, u->vars_removed); Update(u->file_id, std::move(u->vars_def_update)); HANDLE_MERGEABLE(vars_declarations, declarations, usr2var); HANDLE_MERGEABLE(vars_uses, uses, usr2var); #undef HANDLE_MERGEABLE } int QueryDatabase::Update(QueryFile::DefUpdate&& u) { int id = files.size(); auto it = name2file_id.try_emplace(LowerPathIfInsensitive(u.value.path), id); if (it.second) files.emplace_back().id = id; QueryFile& existing = files[it.first->second]; existing.def = u.value; UpdateSymbols(&existing.symbol_idx, SymbolKind::File, it.first->second); return existing.id; } void QueryDatabase::Update(int file_id, std::vector>&& us) { for (auto& u : us) { auto& def = u.second; assert(!def.detailed_name.empty()); AssignFileId(file_id, def.spell); AssignFileId(file_id, def.extent); AssignFileId(file_id, def.callees); QueryFunc& existing = Func(u.first); existing.usr = u.first; if (!TryReplaceDef(existing.def, std::move(def))) { existing.def.push_front(std::move(def)); UpdateSymbols(&existing.symbol_idx, SymbolKind::Func, u.first); } } } void QueryDatabase::Update(int file_id, std::vector>&& us) { for (auto& u : us) { auto& def = u.second; assert(!def.detailed_name.empty()); AssignFileId(file_id, def.spell); AssignFileId(file_id, def.extent); QueryType& existing = Type(u.first); existing.usr = u.first; if (!TryReplaceDef(existing.def, std::move(def))) { existing.def.push_front(std::move(def)); UpdateSymbols(&existing.symbol_idx, SymbolKind::Type, u.first); } } } void QueryDatabase::Update(int file_id, std::vector>&& us) { for (auto& u : us) { auto& def = u.second; assert(!def.detailed_name.empty()); AssignFileId(file_id, def.spell); AssignFileId(file_id, def.extent); QueryVar& existing = Var(u.first); existing.usr = u.first; if (!TryReplaceDef(existing.def, std::move(def))) { existing.def.push_front(std::move(def)); if (!existing.def.front().is_local()) UpdateSymbols(&existing.symbol_idx, SymbolKind::Var, u.first); } } } void QueryDatabase::UpdateSymbols(int* symbol_idx, SymbolKind kind, Usr usr) { if (*symbol_idx < 0) { *symbol_idx = symbols.size(); symbols.push_back(SymbolIdx{usr, kind}); } } std::string_view QueryDatabase::GetSymbolName(int symbol_idx, bool qualified) { Usr usr = symbols[symbol_idx].usr; switch (symbols[symbol_idx].kind) { default: break; case SymbolKind::File: if (files[usr].def) return files[usr].def->path; break; case SymbolKind::Func: if (const auto* def = Func(usr).AnyDef()) return def->Name(qualified); break; case SymbolKind::Type: if (const auto* def = Type(usr).AnyDef()) return def->Name(qualified); break; case SymbolKind::Var: if (const auto* def = Var(usr).AnyDef()) return def->Name(qualified); break; } return ""; }