[clang][Index] Add a knob to index function parameters in declarations
Summary: Parameters in declarations are useful for clangd, so that we can provide symbol information for them as well. It also helps clangd to be consistent whether a function's definition is accessible or not. Reviewers: hokein, akyrtzi Subscribers: ilya-biryukov, ioeric, arphaman, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D57949 llvm-svn: 353695
This commit is contained in:
parent
cf13bfee00
commit
0468fc0b8d
|
@ -44,6 +44,8 @@ struct IndexingOptions {
|
|||
// callback is not available (e.g. after parsing has finished). Note that
|
||||
// macro references are not available in Proprocessor.
|
||||
bool IndexMacrosInPreprocessor = false;
|
||||
// Has no effect if IndexFunctionLocals are false.
|
||||
bool IndexParametersInDeclarations = false;
|
||||
};
|
||||
|
||||
/// Creates a frontend action that indexes all symbols (macros and AST decls).
|
||||
|
|
|
@ -88,12 +88,11 @@ public:
|
|||
/*isBase=*/false, isIBType);
|
||||
IndexCtx.indexNestedNameSpecifierLoc(D->getQualifierLoc(), Parent);
|
||||
if (IndexCtx.shouldIndexFunctionLocalSymbols()) {
|
||||
// Only index parameters in definitions, parameters in declarations are
|
||||
// not useful.
|
||||
if (const ParmVarDecl *Parm = dyn_cast<ParmVarDecl>(D)) {
|
||||
auto *DC = Parm->getDeclContext();
|
||||
if (auto *FD = dyn_cast<FunctionDecl>(DC)) {
|
||||
if (FD->isThisDeclarationADefinition())
|
||||
if (IndexCtx.shouldIndexParametersInDeclarations() ||
|
||||
FD->isThisDeclarationADefinition())
|
||||
IndexCtx.handleDecl(Parm);
|
||||
} else if (auto *MD = dyn_cast<ObjCMethodDecl>(DC)) {
|
||||
if (MD->isThisDeclarationADefinition())
|
||||
|
@ -102,7 +101,8 @@ public:
|
|||
IndexCtx.handleDecl(Parm);
|
||||
}
|
||||
} else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
|
||||
if (FD->isThisDeclarationADefinition()) {
|
||||
if (IndexCtx.shouldIndexParametersInDeclarations() ||
|
||||
FD->isThisDeclarationADefinition()) {
|
||||
for (auto PI : FD->parameters()) {
|
||||
IndexCtx.handleDecl(PI);
|
||||
}
|
||||
|
|
|
@ -40,6 +40,10 @@ bool IndexingContext::shouldIndexImplicitInstantiation() const {
|
|||
return IndexOpts.IndexImplicitInstantiation;
|
||||
}
|
||||
|
||||
bool IndexingContext::shouldIndexParametersInDeclarations() const {
|
||||
return IndexOpts.IndexParametersInDeclarations;
|
||||
}
|
||||
|
||||
bool IndexingContext::handleDecl(const Decl *D,
|
||||
SymbolRoleSet Roles,
|
||||
ArrayRef<SymbolRelation> Relations) {
|
||||
|
|
|
@ -61,6 +61,8 @@ public:
|
|||
|
||||
bool shouldIndexImplicitInstantiation() const;
|
||||
|
||||
bool shouldIndexParametersInDeclarations() const;
|
||||
|
||||
static bool isTemplateImplicitInstantiation(const Decl *D);
|
||||
|
||||
bool handleDecl(const Decl *D, SymbolRoleSet Roles = SymbolRoleSet(),
|
||||
|
|
|
@ -119,6 +119,21 @@ TEST(IndexTest, IndexPreprocessorMacros) {
|
|||
EXPECT_THAT(Index->Symbols, UnorderedElementsAre());
|
||||
}
|
||||
|
||||
TEST(IndexTest, IndexParametersInDecls) {
|
||||
std::string Code = "void foo(int bar);";
|
||||
auto Index = std::make_shared<Indexer>();
|
||||
IndexingOptions Opts;
|
||||
Opts.IndexFunctionLocals = true;
|
||||
Opts.IndexParametersInDeclarations = true;
|
||||
tooling::runToolOnCode(new IndexAction(Index, Opts), Code);
|
||||
EXPECT_THAT(Index->Symbols, Contains(QName("bar")));
|
||||
|
||||
Opts.IndexParametersInDeclarations = false;
|
||||
Index->Symbols.clear();
|
||||
tooling::runToolOnCode(new IndexAction(Index, Opts), Code);
|
||||
EXPECT_THAT(Index->Symbols, Not(Contains(QName("bar"))));
|
||||
}
|
||||
|
||||
} // namespace
|
||||
} // namespace index
|
||||
} // namespace clang
|
||||
|
|
Loading…
Reference in New Issue