kbobyrev created this revision.
kbobyrev added reviewers: ioeric, ilya-biryukov, sammccall.
kbobyrev added a project: clang-tools-extra.
Herald added subscribers: kadircet, arphaman, jkorous, MaskRay.
As discussed during https://reviews.llvm.org/D51860 review, it is better to use
`llvm::Optional` here as it has clear semantics which reflect intended behavior.
https://reviews.llvm.org/D52028
Files:
clang-tools-extra/clangd/FindSymbols.cpp
clang-tools-extra/clangd/index/Index.h
clang-tools-extra/clangd/index/MemIndex.cpp
clang-tools-extra/clangd/index/dex/Dex.cpp
clang-tools-extra/unittests/clangd/DexTests.cpp
clang-tools-extra/unittests/clangd/IndexTests.cpp
Index: clang-tools-extra/unittests/clangd/IndexTests.cpp
===================================================================
--- clang-tools-extra/unittests/clangd/IndexTests.cpp
+++ clang-tools-extra/unittests/clangd/IndexTests.cpp
@@ -78,10 +78,11 @@
auto I = MemIndex::build(generateNumSymbols(0, 100), RefSlab());
FuzzyFindRequest Req;
Req.Query = "5";
- Req.MaxCandidateCount = 3;
+ Req.Limit = 3;
bool Incomplete;
auto Matches = match(*I, Req, &Incomplete);
- EXPECT_EQ(Matches.size(), Req.MaxCandidateCount);
+ EXPECT_TRUE(Req.Limit);
+ EXPECT_EQ(Matches.size(), *Req.Limit);
EXPECT_TRUE(Incomplete);
}
@@ -91,7 +92,7 @@
RefSlab());
FuzzyFindRequest Req;
Req.Query = "lol";
- Req.MaxCandidateCount = 2;
+ Req.Limit = 2;
EXPECT_THAT(match(*I, Req),
UnorderedElementsAre("LaughingOutLoud", "LittleOldLady"));
}
Index: clang-tools-extra/unittests/clangd/DexTests.cpp
===================================================================
--- clang-tools-extra/unittests/clangd/DexTests.cpp
+++ clang-tools-extra/unittests/clangd/DexTests.cpp
@@ -482,7 +482,7 @@
URISchemes);
FuzzyFindRequest Req;
Req.Query = "lol";
- Req.MaxCandidateCount = 2;
+ Req.Limit = 2;
EXPECT_THAT(match(*I, Req),
UnorderedElementsAre("LaughingOutLoud", "LittleOldLady"));
}
@@ -498,17 +498,19 @@
FuzzyFindRequest Req;
Req.Query = "2";
Dex I(Symbols, URISchemes);
+ EXPECT_FALSE(Req.Limit);
EXPECT_THAT(match(I, Req), ElementsAre("2", "2"));
}
TEST(DexTest, DexLimitedNumMatches) {
auto I = Dex::build(generateNumSymbols(0, 100), URISchemes);
FuzzyFindRequest Req;
Req.Query = "5";
- Req.MaxCandidateCount = 3;
+ Req.Limit = 3;
bool Incomplete;
auto Matches = match(*I, Req, &Incomplete);
- EXPECT_EQ(Matches.size(), Req.MaxCandidateCount);
+ EXPECT_TRUE(Req.Limit);
+ EXPECT_EQ(Matches.size(), *Req.Limit);
EXPECT_TRUE(Incomplete);
}
@@ -518,7 +520,7 @@
URISchemes);
FuzzyFindRequest Req;
Req.Query = "lol";
- Req.MaxCandidateCount = 2;
+ Req.Limit = 2;
EXPECT_THAT(match(*I, Req),
UnorderedElementsAre("LaughingOutLoud", "LittleOldLady"));
}
@@ -596,7 +598,7 @@
FuzzyFindRequest Req;
Req.Query = "abc";
// The best candidate can change depending on the proximity paths.
- Req.MaxCandidateCount = 1;
+ Req.Limit = 1;
// FuzzyFind request comes from the file which is far from the root: expect
// CloseSymbol to come out.
Index: clang-tools-extra/clangd/index/dex/Dex.cpp
===================================================================
--- clang-tools-extra/clangd/index/dex/Dex.cpp
+++ clang-tools-extra/clangd/index/dex/Dex.cpp
@@ -179,16 +179,17 @@
// FIXME(kbobyrev): Pre-scoring retrieval threshold should be adjusted as
// using 100x of the requested number might not be good in practice, e.g.
// when the requested number of items is small.
- const size_t ItemsToRetrieve = 100 * Req.MaxCandidateCount;
- auto Root = createLimit(move(QueryIterator), ItemsToRetrieve);
+ auto Root = Req.Limit ? createLimit(move(QueryIterator), *Req.Limit * 100)
+ : move(QueryIterator);
using IDAndScore = std::pair<DocID, float>;
std::vector<IDAndScore> IDAndScores = consume(*Root);
auto Compare = [](const IDAndScore &LHS, const IDAndScore &RHS) {
return LHS.second > RHS.second;
};
- TopN<IDAndScore, decltype(Compare)> Top(Req.MaxCandidateCount, Compare);
+ TopN<IDAndScore, decltype(Compare)> Top(
+ Req.Limit ? *Req.Limit : std::numeric_limits<size_t>::max(), Compare);
for (const auto &IDAndScore : IDAndScores) {
const DocID SymbolDocID = IDAndScore.first;
const auto *Sym = Symbols[SymbolDocID];
@@ -205,7 +206,7 @@
More = true;
}
- // Apply callback to the top Req.MaxCandidateCount items in the descending
+ // Apply callback to the top Req.Limit items in the descending
// order of cumulative score.
for (const auto &Item : std::move(Top).items())
Callback(*Symbols[Item.first]);
Index: clang-tools-extra/clangd/index/MemIndex.cpp
===================================================================
--- clang-tools-extra/clangd/index/MemIndex.cpp
+++ clang-tools-extra/clangd/index/MemIndex.cpp
@@ -29,7 +29,8 @@
assert(!StringRef(Req.Query).contains("::") &&
"There must be no :: in query.");
- TopN<std::pair<float, const Symbol *>> Top(Req.MaxCandidateCount);
+ TopN<std::pair<float, const Symbol *>> Top(
+ Req.Limit ? *Req.Limit : std::numeric_limits<size_t>::max());
FuzzyMatcher Filter(Req.Query);
bool More = false;
for (const auto Pair : Index) {
Index: clang-tools-extra/clangd/index/Index.h
===================================================================
--- clang-tools-extra/clangd/index/Index.h
+++ clang-tools-extra/clangd/index/Index.h
@@ -437,19 +437,17 @@
std::vector<std::string> Scopes;
/// \brief The number of top candidates to return. The index may choose to
/// return more than this, e.g. if it doesn't know which candidates are best.
- // FIXME: Use llvm::Optional; semantically, the absence of MaxCandidateCount
- // is equivalent to setting this field to default value as below.
- uint32_t MaxCandidateCount = std::numeric_limits<uint32_t>::max();
+ llvm::Optional<uint32_t> Limit;
/// If set to true, only symbols for completion support will be considered.
bool RestrictForCodeCompletion = false;
/// Contextually relevant files (e.g. the file we're code-completing in).
/// Paths should be absolute.
std::vector<std::string> ProximityPaths;
bool operator==(const FuzzyFindRequest &Req) const {
- return std::tie(Query, Scopes, MaxCandidateCount, RestrictForCodeCompletion,
+ return std::tie(Query, Scopes, Limit, RestrictForCodeCompletion,
ProximityPaths) ==
- std::tie(Req.Query, Req.Scopes, Req.MaxCandidateCount,
+ std::tie(Req.Query, Req.Scopes, Req.Limit,
Req.RestrictForCodeCompletion, Req.ProximityPaths);
}
bool operator!=(const FuzzyFindRequest &Req) const { return !(*this == Req); }
@@ -476,7 +474,8 @@
/// each matched symbol before returning.
/// If returned Symbols are used outside Callback, they must be deep-copied!
///
- /// Returns true if there may be more results (limited by MaxCandidateCount).
+ /// Returns true if there may be more results (limited by
+ /// FuzzyFindRequest.Limit).
virtual bool
fuzzyFind(const FuzzyFindRequest &Req,
llvm::function_ref<void(const Symbol &)> Callback) const = 0;
Index: clang-tools-extra/clangd/FindSymbols.cpp
===================================================================
--- clang-tools-extra/clangd/FindSymbols.cpp
+++ clang-tools-extra/clangd/FindSymbols.cpp
@@ -117,8 +117,9 @@
if (IsGlobalQuery || !Names.first.empty())
Req.Scopes = {Names.first};
if (Limit)
- Req.MaxCandidateCount = Limit;
- TopN<ScoredSymbolInfo, ScoredSymbolGreater> Top(Req.MaxCandidateCount);
+ Req.Limit = Limit;
+ TopN<ScoredSymbolInfo, ScoredSymbolGreater> Top(
+ Req.Limit ? *Req.Limit : std::numeric_limits<size_t>::max());
FuzzyMatcher Filter(Req.Query);
Index->fuzzyFind(Req, [HintPath, &Top, &Filter](const Symbol &Sym) {
// Prefer the definition over e.g. a function declaration in a header
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
