#pragma once #include "indexer.h" #include "serializer.h" #include #include struct QueryFile; struct QueryType; struct QueryFunc; struct QueryVar; struct QueryDatabase; using QueryFileId = Id; using QueryTypeId = Id; using QueryFuncId = Id; using QueryVarId = Id; struct IdMap; using Generation = uint32_t; // Example use: |WithGen>|, to mark an |Id| reference with // generation, so that by comparising the generation with that stored in the // referenced Query object, we can tell if the reference is stale (the // referenced object has been deleted or reused). template struct WithGen { Generation gen; T value; WithGen() : gen(-1) {} WithGen(const T& value) : gen(-1), value(value) {} WithGen(Generation gen, const T& value) : gen(gen), value(value) {} bool HasValue() const { return value.HasValue(); } explicit operator bool() const { return HasValue(); } bool operator==(const WithGen& o) const { return gen == o.gen && value == o.value; } }; template void Reflect(TVisitor& visitor, WithGen& value) { Reflect(visitor, value.value); } struct QueryLocation { QueryFileId path; Range range; QueryLocation() {} // Do not use, needed for reflect. QueryLocation(QueryFileId path, Range range) : path(path), range(range) {} QueryLocation OffsetStartColumn(int16_t offset) const { QueryLocation result = *this; result.range.start.column += offset; return result; } bool HasValue() const { return range.HasValue(); } bool operator==(const QueryLocation& other) const { return path == other.path && range == other.range; } bool operator!=(const QueryLocation& other) const { return !(*this == other); } bool operator<(const QueryLocation& o) const { if (path != o.path) return path < o.path; return range < o.range; } }; MAKE_REFLECT_STRUCT(QueryLocation, path, range); MAKE_HASHABLE(QueryLocation, t.path, t.range); namespace std { template <> struct hash<::SymbolKind> { size_t operator()(const ::SymbolKind& instance) const { return std::hash()(static_cast(instance)); } }; } // namespace std struct SymbolIdx { SymbolKind kind; RawId idx; SymbolIdx() : kind(SymbolKind::Invalid), idx(RawId(-1)) {} // Default ctor needed by stdlib. Do not use. SymbolIdx(SymbolKind kind, RawId idx) : kind(kind), idx(idx) {} bool operator==(const SymbolIdx& that) const { return kind == that.kind && idx == that.idx; } bool operator!=(const SymbolIdx& that) const { return !(*this == that); } bool operator<(const SymbolIdx& that) const { if (kind != that.kind) return kind < that.kind; return idx < that.idx; } }; MAKE_REFLECT_STRUCT(SymbolIdx, kind, idx); MAKE_HASHABLE(SymbolIdx, t.kind, t.idx); struct SymbolRef { SymbolIdx idx; SymbolRole role; QueryLocation loc; SymbolRef() {} // Do not use, needed for reflect. SymbolRef(SymbolIdx idx, SymbolRole role, QueryLocation loc) : idx(idx), role(role), loc(loc) {} bool operator==(const SymbolRef& that) const { return idx == that.idx && loc == that.loc; } bool operator!=(const SymbolRef& that) const { return !(*this == that); } bool operator<(const SymbolRef& that) const { if (idx != that.idx) return idx < that.idx; return loc < that.loc; } }; MAKE_REFLECT_STRUCT(SymbolRef, idx, loc); struct QueryFuncRef { // NOTE: id_ can be -1 if the function call is not coming from a function. QueryFuncId id_; QueryLocation loc; bool is_implicit = false; bool HasValue() const { return id_.HasValue(); } QueryFuncRef() {} // Do not use, needed for reflect. QueryFuncRef(QueryFuncId id, QueryLocation loc, bool is_implicit) : id_(id), loc(loc), is_implicit(is_implicit) {} bool operator==(const QueryFuncRef& that) const { return id_ == that.id_ && loc == that.loc && is_implicit == that.is_implicit; } bool operator!=(const QueryFuncRef& that) const { return !(*this == that); } bool operator<(const QueryFuncRef& that) const { if (id_ != that.id_) return id_ < that.id_; if (loc != that.loc) return loc < that.loc; return is_implicit < that.is_implicit; } }; MAKE_REFLECT_STRUCT(QueryFuncRef, id_, loc, is_implicit); // There are two sources of reindex updates: the (single) definition of a // symbol has changed, or one of many users of the symbol has changed. // // For simplicitly, if the single definition has changed, we update all of the // associated single-owner definition data. See |Update*DefId|. // // If one of the many symbol users submits an update, we store the update such // that it can be merged with other updates before actually being applied to // the main database. See |MergeableUpdate|. template struct MergeableUpdate { // The type/func/var which is getting new usages. TId id; // Entries to add and remove. std::vector to_add; std::vector to_remove; MergeableUpdate(TId id, const std::vector& to_add) : id(id), to_add(to_add) {} MergeableUpdate(TId id, const std::vector>& to_add) : id(id) { for (auto& x : to_add) this->to_add.push_back(x.value); } MergeableUpdate(TId id, const std::vector& to_add, const std::vector& to_remove) : id(id), to_add(to_add), to_remove(to_remove) {} MergeableUpdate(TId id, const std::vector>& to_add, const std::vector>& to_remove) : id(id) { for (auto& x : to_add) this->to_add.push_back(x.value); for (auto& x : to_remove) this->to_remove.push_back(x.value); } }; template void Reflect(TVisitor& visitor, MergeableUpdate& value) { REFLECT_MEMBER_START(); REFLECT_MEMBER(id); REFLECT_MEMBER(to_add); REFLECT_MEMBER(to_remove); REFLECT_MEMBER_END(); } template struct WithUsr { Usr usr; T value; WithUsr(Usr usr, const T& value) : usr(usr), value(value) {} }; template void Reflect(TVisitor& visitor, WithUsr& value) { REFLECT_MEMBER_START(); REFLECT_MEMBER(usr); REFLECT_MEMBER(value); REFLECT_MEMBER_END(); } template struct WithFileContent { T value; std::string file_content; WithFileContent(const T& value, const std::string& file_content) : value(value), file_content(file_content) {} }; template void Reflect(TVisitor& visitor, WithFileContent& value) { REFLECT_MEMBER_START(); REFLECT_MEMBER(value); REFLECT_MEMBER(file_content); REFLECT_MEMBER_END(); } struct QueryFile { struct Def { std::string path; // Language identifier std::string language; // Includes in the file. std::vector includes; // Outline of the file (ie, for code lens). std::vector outline; // Every symbol found in the file (ie, for goto definition) std::vector all_symbols; // Parts of the file which are disabled. std::vector inactive_regions; // Used by |$cquery/freshenIndex|. std::vector dependencies; }; using DefUpdate = WithFileContent; optional def; Maybe> symbol_idx; explicit QueryFile(const std::string& path) { def = Def(); def->path = path; } }; MAKE_REFLECT_STRUCT(QueryFile::Def, path, language, outline, all_symbols, inactive_regions, dependencies); struct QueryType { using Def = TypeDefDefinitionData, WithGen, WithGen, QueryLocation>; using DefUpdate = WithUsr; using DerivedUpdate = MergeableUpdate; using InstancesUpdate = MergeableUpdate; using UsesUpdate = MergeableUpdate; Usr usr; Generation gen; Maybe> symbol_idx; optional def; std::vector> derived; std::vector> instances; std::vector uses; explicit QueryType(const Usr& usr) : usr(usr), gen(0) {} }; struct QueryFunc { using Def = FuncDefDefinitionData, WithGen, WithGen, QueryFuncRef, QueryLocation>; using DefUpdate = WithUsr; using DeclarationsUpdate = MergeableUpdate; using DerivedUpdate = MergeableUpdate; using CallersUpdate = MergeableUpdate; Usr usr; Generation gen; Maybe> symbol_idx; optional def; std::vector declarations; std::vector> derived; std::vector callers; explicit QueryFunc(const Usr& usr) : usr(usr), gen(0) {} }; struct QueryVar { using Def = VarDefDefinitionData, WithGen, WithGen, QueryLocation>; using DefUpdate = WithUsr; using DeclarationsUpdate = MergeableUpdate; using UsesUpdate = MergeableUpdate; Usr usr; Generation gen; Maybe> symbol_idx; optional def; std::vector declarations; std::vector uses; explicit QueryVar(const Usr& usr) : usr(usr), gen(0) {} }; struct IndexUpdate { // Creates a new IndexUpdate based on the delta from previous to current. If // no delta computation should be done just pass null for previous. static IndexUpdate CreateDelta(const IdMap* previous_id_map, const IdMap* current_id_map, IndexFile* previous, IndexFile* current); // Merge |update| into this update; this can reduce overhead / index update // work can be parallelized. void Merge(const IndexUpdate& update); // Dump the update to a string. std::string ToString(); // File updates. std::vector files_removed; std::vector files_def_update; // Type updates. std::vector types_removed; std::vector types_def_update; std::vector types_derived; std::vector types_instances; std::vector types_uses; // Function updates. std::vector funcs_removed; std::vector funcs_def_update; std::vector funcs_declarations; std::vector funcs_derived; std::vector funcs_callers; // Variable updates. std::vector vars_removed; std::vector vars_def_update; std::vector vars_declarations; std::vector vars_uses; private: // Creates an index update assuming that |previous| is already // in the index, so only the delta between |previous| and |current| // will be applied. IndexUpdate(const IdMap& previous_id_map, const IdMap& current_id_map, IndexFile& previous, IndexFile& current); }; // NOTICE: We're not reflecting on files_removed or files_def_update, it is too // much output when logging MAKE_REFLECT_STRUCT(IndexUpdate, types_removed, types_def_update, types_derived, types_instances, types_uses, funcs_removed, funcs_def_update, funcs_declarations, funcs_derived, funcs_callers, vars_removed, vars_def_update, vars_declarations, vars_uses); struct NormalizedPath { explicit NormalizedPath(const std::string& path); bool operator==(const NormalizedPath& rhs) const; bool operator!=(const NormalizedPath& rhs) const; std::string path; }; MAKE_HASHABLE(NormalizedPath, t.path); // The query database is heavily optimized for fast queries. It is stored // in-memory. struct QueryDatabase { // All File/Func/Type/Var symbols. std::vector symbols; // Raw data storage. Accessible via SymbolIdx instances. std::vector files; std::vector types; std::vector funcs; std::vector vars; // Lookup symbol based on a usr. spp::sparse_hash_map usr_to_file; spp::sparse_hash_map usr_to_type; spp::sparse_hash_map usr_to_func; spp::sparse_hash_map usr_to_var; // Marks the given Usrs as invalid. void RemoveUsrs(SymbolKind usr_kind, const std::vector& to_remove); // Insert the contents of |update| into |db|. void ApplyIndexUpdate(IndexUpdate* update); void ImportOrUpdate(const std::vector& updates); void ImportOrUpdate(const std::vector& updates); void ImportOrUpdate(const std::vector& updates); void ImportOrUpdate(const std::vector& updates); void UpdateSymbols(Maybe>* symbol_idx, SymbolKind kind, RawId idx); std::string_view GetSymbolDetailedName(RawId symbol_idx) const; std::string_view GetSymbolShortName(RawId symbol_idx) const; // Query the indexing structure to look up symbol id for given Usr. Maybe GetQueryFileIdFromPath(const std::string& path); Maybe GetQueryTypeIdFromUsr(Usr usr); Maybe GetQueryFuncIdFromUsr(Usr usr); Maybe GetQueryVarIdFromUsr(Usr usr); }; template struct IndexToQuery; // clang-format off template <> struct IndexToQuery { using type = QueryFuncId; }; template <> struct IndexToQuery { using type = QueryTypeId; }; template <> struct IndexToQuery { using type = QueryVarId; }; template <> struct IndexToQuery { using type = QueryFuncRef; }; template <> struct IndexToQuery { using type = QueryLocation; }; template <> struct IndexToQuery { using type = QueryLocation; }; template struct IndexToQuery> { using type = optional::type>; }; template struct IndexToQuery> { using type = std::vector::type>; }; // clang-format on struct IdMap { const IdCache& local_ids; QueryFileId primary_file; IdMap(QueryDatabase* query_db, const IdCache& local_ids); // FIXME Too verbose // clang-format off QueryLocation ToQuery(Range range) const; QueryTypeId ToQuery(IndexTypeId id) const; QueryFuncId ToQuery(IndexFuncId id) const; QueryVarId ToQuery(IndexVarId id) const; WithGen ToQuery(IndexTypeId id, int) const; WithGen ToQuery(IndexFuncId id, int) const; WithGen ToQuery(IndexVarId id, int) const; QueryFuncRef ToQuery(IndexFuncRef ref) const; QueryLocation ToQuery(IndexFunc::Declaration decl) const; template Maybe::type> ToQuery(Maybe id) const { if (!id) return nullopt; return ToQuery(*id); } template Maybe::type>> ToQuery(Maybe id, int) const { if (!id) return nullopt; return ToQuery(*id, 0); } template std::vector::type> ToQuery(const std::vector& a) const { std::vector::type> ret; ret.reserve(a.size()); for (auto& x : a) ret.push_back(ToQuery(x)); return ret; } template std::vector::type>> ToQuery(std::vector a, int) const { std::vector::type>> ret; ret.reserve(a.size()); for (auto& x : a) ret.push_back(ToQuery(x, 0)); return ret; } // clang-format on SymbolIdx ToSymbol(IndexTypeId id) const; SymbolIdx ToSymbol(IndexFuncId id) const; SymbolIdx ToSymbol(IndexVarId id) const; private: spp::sparse_hash_map cached_type_ids_; spp::sparse_hash_map cached_func_ids_; spp::sparse_hash_map cached_var_ids_; };