1 //===--- BackgroundIndexLoader.h - Load shards from index storage-*- C++-*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_BACKGROUNDINDEXLOADER_H 10 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_BACKGROUNDINDEXLOADER_H 11 12 #include "index/Background.h" 13 #include "support/Path.h" 14 #include "llvm/ADT/ArrayRef.h" 15 #include <memory> 16 #include <vector> 17 18 namespace clang { 19 namespace clangd { 20 21 /// Represents a shard loaded from storage, stores contents in \p Shard and 22 /// metadata about the source file that generated this shard. 23 struct LoadedShard { 24 /// Path of the source file that produced this shard. 25 Path AbsolutePath; 26 /// Digest of the source file contents that produced this shard. 27 FileDigest Digest = {}; 28 /// Whether the RefSlab in Shard should be used for updating symbol reference 29 /// counts when building an index. 30 bool CountReferences = false; 31 /// Whether the indexing action producing that shard had errors. 32 bool HadErrors = false; 33 /// Path to a TU that is depending on this shard. 34 Path DependentTU; 35 /// Will be nullptr when index storage couldn't provide a valid shard for 36 /// AbsolutePath. 37 std::unique_ptr<IndexFileIn> Shard; 38 }; 39 40 /// Loads all shards for the TU \p MainFile from \p Storage. 41 std::vector<LoadedShard> 42 loadIndexShards(llvm::ArrayRef<Path> MainFiles, 43 BackgroundIndexStorage::Factory &IndexStorageFactory, 44 const GlobalCompilationDatabase &CDB); 45 46 } // namespace clangd 47 } // namespace clang 48 49 #endif 50