Index: include/clang/Index/IndexingAction.h =================================================================== --- include/clang/Index/IndexingAction.h +++ include/clang/Index/IndexingAction.h @@ -12,6 +12,7 @@ #include "clang/Basic/LLVM.h" #include "clang/Lex/PPCallbacks.h" +#include "clang/Lex/Preprocessor.h" #include "llvm/ADT/ArrayRef.h" #include @@ -40,6 +41,7 @@ = SystemSymbolFilterKind::DeclarationsOnly; bool IndexFunctionLocals = false; bool IndexImplicitInstantiation = false; + bool IndexMacrosInPreprocessor = false; }; /// Creates a frontend action that indexes all symbols (macros and AST decls). @@ -50,13 +52,12 @@ std::unique_ptr WrappedAction); /// Recursively indexes all decls in the AST. -/// Note that this does not index macros. void indexASTUnit(ASTUnit &Unit, IndexDataConsumer &DataConsumer, IndexingOptions Opts); /// Recursively indexes \p Decls. -/// Note that this does not index macros. -void indexTopLevelDecls(ASTContext &Ctx, ArrayRef Decls, +void indexTopLevelDecls(ASTContext &Ctx, Preprocessor &PP, + ArrayRef Decls, IndexDataConsumer &DataConsumer, IndexingOptions Opts); /// Creates a PPCallbacks that indexes macros and feeds macros to \p Consumer. @@ -65,7 +66,6 @@ IndexingOptions Opts); /// Recursively indexes all top-level decls in the module. -/// FIXME: make this index macros as well. void indexModuleFile(serialization::ModuleFile &Mod, ASTReader &Reader, IndexDataConsumer &DataConsumer, IndexingOptions Opts); Index: lib/Index/IndexingAction.cpp =================================================================== --- lib/Index/IndexingAction.cpp +++ lib/Index/IndexingAction.cpp @@ -215,22 +215,38 @@ Unit.visitLocalTopLevelDecls(&IndexCtx, topLevelDeclVisitor); } +static void indexPreprocessorMacros(const Preprocessor &PP, + IndexDataConsumer &DataConsumer) { + for (const auto &M : PP.macros()) + if (MacroDirective *MD = M.second.getLatest()) + DataConsumer.handleMacroOccurence( + M.first, MD->getMacroInfo(), + static_cast(index::SymbolRole::Definition), + MD->getLocation()); +} + void index::indexASTUnit(ASTUnit &Unit, IndexDataConsumer &DataConsumer, IndexingOptions Opts) { IndexingContext IndexCtx(Opts, DataConsumer); IndexCtx.setASTContext(Unit.getASTContext()); DataConsumer.initialize(Unit.getASTContext()); + if (Opts.IndexMacrosInPreprocessor) + indexPreprocessorMacros(Unit.getPreprocessor(), DataConsumer); DataConsumer.setPreprocessor(Unit.getPreprocessorPtr()); indexTranslationUnit(Unit, IndexCtx); DataConsumer.finish(); } -void index::indexTopLevelDecls(ASTContext &Ctx, ArrayRef Decls, +void index::indexTopLevelDecls(ASTContext &Ctx, Preprocessor &PP, + ArrayRef Decls, IndexDataConsumer &DataConsumer, IndexingOptions Opts) { IndexingContext IndexCtx(Opts, DataConsumer); IndexCtx.setASTContext(Ctx); + if (Opts.IndexMacrosInPreprocessor) + indexPreprocessorMacros(PP, DataConsumer); + DataConsumer.initialize(Ctx); for (const Decl *D : Decls) IndexCtx.indexTopLevelDecl(D); @@ -251,6 +267,9 @@ IndexCtx.setASTContext(Ctx); DataConsumer.initialize(Ctx); + if (Opts.IndexMacrosInPreprocessor) + indexPreprocessorMacros(Reader.getPreprocessor(), DataConsumer); + for (const Decl *D : Reader.getModuleFileLevelDecls(Mod)) { IndexCtx.indexTopLevelDecl(D); } Index: unittests/CMakeLists.txt =================================================================== --- unittests/CMakeLists.txt +++ unittests/CMakeLists.txt @@ -31,3 +31,4 @@ add_subdirectory(libclang) endif() add_subdirectory(Rename) +add_subdirectory(Index) Index: unittests/Index/CMakeLists.txt =================================================================== --- /dev/null +++ unittests/Index/CMakeLists.txt @@ -0,0 +1,18 @@ +set(LLVM_LINK_COMPONENTS + ${LLVM_TARGETS_TO_BUILD} + Support + ) + +add_clang_unittest(IndexTests + IndexTests.cpp + ) + +target_link_libraries(IndexTests + PRIVATE + clangAST + clangBasic + clangFrontend + clangIndex + clangLex + clangTooling + ) Index: unittests/Index/IndexTests.cpp =================================================================== --- /dev/null +++ unittests/Index/IndexTests.cpp @@ -0,0 +1,136 @@ +//===--- IndexTests.cpp - Test indexing actions -----------------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "clang/AST/ASTConsumer.h" +#include "clang/AST/Decl.h" +#include "clang/Basic/VirtualFileSystem.h" +#include "clang/Frontend/CompilerInstance.h" +#include "clang/Frontend/FrontendAction.h" +#include "clang/Index/IndexDataConsumer.h" +#include "clang/Index/IndexSymbol.h" +#include "clang/Index/IndexingAction.h" +#include "clang/Lex/Preprocessor.h" +#include "clang/Tooling/Tooling.h" +#include "llvm/ADT/StringRef.h" +#include "gmock/gmock.h" +#include "gtest/gtest.h" +#include + +namespace clang { +namespace index { + +struct TestSymbol { + std::string QName; + SymbolRoleSet Roles; + SymbolInfo Info; + // FIXME: add more information. +}; + +llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const TestSymbol &S) { + return OS << S.QName; +} + +namespace { +class Indexer : public IndexDataConsumer { +public: + bool handleDeclOccurence(const Decl *D, SymbolRoleSet Roles, + ArrayRef, SourceLocation, + ASTNodeInfo) override { + llvm::errs() << "Handle decl: \n"; + const auto *ND = llvm::dyn_cast(D); + if (!ND) + return true; + llvm::errs() << "ND: " << ND->getQualifiedNameAsString() << "\n"; + TestSymbol S; + S.QName = ND->getQualifiedNameAsString(); + S.Roles = Roles; + S.Info = getSymbolInfo(ND); + Symbols.push_back(std::move(S)); + return true; + } + + bool handleMacroOccurence(const IdentifierInfo *Name, const MacroInfo *MI, + SymbolRoleSet Roles, SourceLocation) override { + TestSymbol S; + S.QName = Name->getName(); + S.Roles = Roles; + if (MI) + S.Info = getSymbolInfoForMacro(*MI); + Symbols.push_back(std::move(S)); + return true; + } + + std::vector Symbols; +}; + +class IndexAction : public ASTFrontendAction { +public: + IndexAction(std::shared_ptr Index, + IndexingOptions Opts = IndexingOptions()) + : Index(std::move(Index)), Opts(Opts) {} + +protected: + std::unique_ptr CreateASTConsumer(CompilerInstance &CI, + StringRef InFile) override { + class Consumer : public ASTConsumer { + std::shared_ptr Index; + std::shared_ptr PP; + IndexingOptions Opts; + + public: + Consumer(std::shared_ptr Index, std::shared_ptr PP, + IndexingOptions Opts) + : Index(std::move(Index)), PP(std::move(PP)), Opts(Opts) {} + + void HandleTranslationUnit(ASTContext &Ctx) override { + llvm::errs() << "Handle TU : " << Ctx.getTranslationUnitDecl() << "\n"; + Ctx.getTranslationUnitDecl()->dump(); + std::vector DeclsToIndex( + Ctx.getTranslationUnitDecl()->decls().begin(), + Ctx.getTranslationUnitDecl()->decls().end()); + indexTopLevelDecls(Ctx, *PP, DeclsToIndex, *Index, Opts); + } + }; + return llvm::make_unique(Index, CI.getPreprocessorPtr(), Opts); + } + +private: + std::shared_ptr Index; + IndexingOptions Opts; +}; + +using testing::Contains; +using testing::Not; +using testing::UnorderedElementsAre; + +MATCHER_P(QName, Name, "") { return arg.QName == Name; } + +TEST(IndexTest, Simple) { + auto Index = std::make_shared(); + tooling::runToolOnCode(new IndexAction(Index), "class X {}; void f() {}"); + EXPECT_THAT(Index->Symbols, UnorderedElementsAre(QName("X"), QName("f"))); +} + +TEST(IndexTest, IndexPreprocessorMacros) { + std::string Code = "#define INDEX_MAC 1"; + auto Index = std::make_shared(); + IndexingOptions Opts; + Opts.IndexMacrosInPreprocessor = true; + tooling::runToolOnCode(new IndexAction(Index, Opts), Code); + EXPECT_THAT(Index->Symbols, Contains(QName("INDEX_MAC"))); + + Opts.IndexMacrosInPreprocessor = false; + Index->Symbols.clear(); + tooling::runToolOnCode(new IndexAction(Index, Opts), Code); + EXPECT_THAT(Index->Symbols, UnorderedElementsAre()); +} + +} // namespace +} // namespace index +} // namespace clang