hokein updated this revision to Diff 56121.
hokein added a comment.
Fix a nit.
http://reviews.llvm.org/D19816
Files:
include-fixer/find-all-symbols/CMakeLists.txt
include-fixer/find-all-symbols/FindAllSymbols.cpp
include-fixer/find-all-symbols/FindAllSymbols.h
include-fixer/find-all-symbols/HeaderMapCollector.h
include-fixer/find-all-symbols/PragmaCommentHandler.cpp
include-fixer/find-all-symbols/PragmaCommentHandler.h
include-fixer/find-all-symbols/tool/FindAllSymbolsMain.cpp
unittests/include-fixer/find-all-symbols/FindAllSymbolsTests.cpp
Index: unittests/include-fixer/find-all-symbols/FindAllSymbolsTests.cpp
===================================================================
--- unittests/include-fixer/find-all-symbols/FindAllSymbolsTests.cpp
+++ unittests/include-fixer/find-all-symbols/FindAllSymbolsTests.cpp
@@ -8,11 +8,14 @@
//===----------------------------------------------------------------------===//
#include "FindAllSymbols.h"
+#include "HeaderMapCollector.h"
+#include "PragmaCommentHandler.h"
#include "SymbolInfo.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/FileSystemOptions.h"
#include "clang/Basic/VirtualFileSystem.h"
+#include "clang/Frontend/CompilerInstance.h"
#include "clang/Frontend/PCHContainerOperations.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/IntrusiveRefCntPtr.h"
@@ -62,6 +65,41 @@
std::vector<SymbolInfo> Symbols;
};
+class TestFindAllSymbolsAction : public clang::ASTFrontendAction {
+public:
+ TestFindAllSymbolsAction(FindAllSymbols::ResultReporter *Reporter)
+ : MatchFinder(), Collector(), Handler(&Collector),
+ Matcher(Reporter, &Collector) {
+ Matcher.registerMatchers(&MatchFinder);
+ }
+
+ std::unique_ptr<clang::ASTConsumer>
+ CreateASTConsumer(clang::CompilerInstance &Compiler,
+ StringRef InFile) override {
+ Compiler.getPreprocessor().addCommentHandler(&Handler);
+ return MatchFinder.newASTConsumer();
+ }
+
+private:
+ ast_matchers::MatchFinder MatchFinder;
+ HeaderMapCollector Collector;
+ PragmaCommentHandler Handler;
+ FindAllSymbols Matcher;
+};
+
+class TestFindAllSymbolsActionFactory
+ : public clang::tooling::FrontendActionFactory {
+public:
+ TestFindAllSymbolsActionFactory(MockReporter *Reporter)
+ : Reporter(Reporter) {}
+ clang::FrontendAction *create() override {
+ return new TestFindAllSymbolsAction(Reporter);
+ }
+
+private:
+ MockReporter *const Reporter;
+};
+
class FindAllSymbolsTest : public ::testing::Test {
public:
bool hasSymbol(const SymbolInfo &Symbol) {
@@ -73,18 +111,16 @@
}
bool runFindAllSymbols(StringRef Code) {
- FindAllSymbols matcher(&Reporter);
- clang::ast_matchers::MatchFinder MatchFinder;
- matcher.registerMatchers(&MatchFinder);
-
llvm::IntrusiveRefCntPtr<vfs::InMemoryFileSystem> InMemoryFileSystem(
new vfs::InMemoryFileSystem);
llvm::IntrusiveRefCntPtr<FileManager> Files(
new FileManager(FileSystemOptions(), InMemoryFileSystem));
std::string FileName = "symbol.cc";
- std::unique_ptr<clang::tooling::FrontendActionFactory> Factory =
- clang::tooling::newFrontendActionFactory(&MatchFinder);
+
+ std::unique_ptr<clang::tooling::FrontendActionFactory> Factory(
+ new TestFindAllSymbolsActionFactory(&Reporter));
+
tooling::ToolInvocation Invocation(
{std::string("find_all_symbols"), std::string("-fsyntax-only"),
FileName},
@@ -371,5 +407,20 @@
}
}
+TEST_F(FindAllSymbolsTest, IWYUPrivatePragmaTest) {
+ static const char Code[] = R"(
+ // IWYU pragma: private, include "bar.h"
+ struct Bar {
+ };
+ )";
+ runFindAllSymbols(Code);
+
+ {
+ SymbolInfo Symbol =
+ CreateSymbolInfo("Bar", SymbolInfo::Class, "bar.h", 3, {});
+ EXPECT_TRUE(hasSymbol(Symbol));
+ }
+}
+
} // namespace find_all_symbols
} // namespace clang
Index: include-fixer/find-all-symbols/tool/FindAllSymbolsMain.cpp
===================================================================
--- include-fixer/find-all-symbols/tool/FindAllSymbolsMain.cpp
+++ include-fixer/find-all-symbols/tool/FindAllSymbolsMain.cpp
@@ -8,8 +8,14 @@
//===----------------------------------------------------------------------===//
#include "FindAllSymbols.h"
+#include "HeaderMapCollector.h"
+#include "PragmaCommentHandler.h"
#include "SymbolInfo.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/ASTMatchers/ASTMatchers.h"
+#include "clang/Frontend/CompilerInstance.h"
+#include "clang/Frontend/FrontendActions.h"
+#include "clang/Lex/Preprocessor.h"
#include "clang/Tooling/CommonOptionsParser.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/ArrayRef.h"
@@ -82,6 +88,31 @@
std::map<std::string, std::set<SymbolInfo>> Symbols;
};
+class FindAllSymbolsAction : public clang::ASTFrontendAction {
+public:
+ FindAllSymbolsAction()
+ : Reporter(), MatchFinder(), Collector(), Handler(&Collector),
+ Matcher(&Reporter, &Collector) {
+ Matcher.registerMatchers(&MatchFinder);
+ }
+
+ std::unique_ptr<clang::ASTConsumer>
+ CreateASTConsumer(clang::CompilerInstance &Compiler,
+ StringRef InFile) override {
+ Compiler.getPreprocessor().addCommentHandler(&Handler);
+ return MatchFinder.newASTConsumer();
+ }
+
+ void EndSourceFileAction() override { Reporter.Write(OutputDir); }
+
+private:
+ YamlReporter Reporter;
+ clang::ast_matchers::MatchFinder MatchFinder;
+ HeaderMapCollector Collector;
+ PragmaCommentHandler Handler;
+ FindAllSymbols Matcher;
+};
+
bool Merge(llvm::StringRef MergeDir, llvm::StringRef OutputFile) {
std::error_code EC;
std::set<SymbolInfo> UniqueSymbols;
@@ -142,11 +173,8 @@
return 0;
}
- clang::find_all_symbols::YamlReporter Reporter;
- clang::find_all_symbols::FindAllSymbols Matcher(&Reporter);
- clang::ast_matchers::MatchFinder MatchFinder;
- Matcher.registerMatchers(&MatchFinder);
- Tool.run(newFrontendActionFactory(&MatchFinder).get());
- Reporter.Write(OutputDir);
+ Tool.run(
+ newFrontendActionFactory<clang::find_all_symbols::FindAllSymbolsAction>()
+ .get());
return 0;
}
Index: include-fixer/find-all-symbols/PragmaCommentHandler.h
===================================================================
--- /dev/null
+++ include-fixer/find-all-symbols/PragmaCommentHandler.h
@@ -0,0 +1,40 @@
+//===-- PragmaCommentHandler.h - find all symbols----------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_FIND_ALL_SYMBOLS_PRAGMA_COMMENT_HANDLER_H
+#define LLVM_CLANG_TOOLS_EXTRA_FIND_ALL_SYMBOLS_PRAGMA_COMMENT_HANDLER_H
+
+#include "clang/Basic/SourceLocation.h"
+#include "clang/Lex/Preprocessor.h"
+#include <map>
+
+namespace clang {
+namespace find_all_symbols {
+
+class HeaderMapCollector;
+
+/// \brief PragmaCommentHandler handle all pragma comment. It supports a way for
+/// clients to control their include path.
+///
+/// Currently it only supports IWYU private pragma:
+/// https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-private
+class PragmaCommentHandler : public clang::CommentHandler {
+public:
+ PragmaCommentHandler(HeaderMapCollector *Collector) : Collector(Collector) {}
+
+ bool HandleComment(Preprocessor &PP, SourceRange Range) override;
+
+private:
+ HeaderMapCollector *const Collector;
+};
+
+} // namespace find_all_symbols
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_FIND_ALL_SYMBOLS_PRAGMA_COMMENT_HANDLER_H
Index: include-fixer/find-all-symbols/PragmaCommentHandler.cpp
===================================================================
--- /dev/null
+++ include-fixer/find-all-symbols/PragmaCommentHandler.cpp
@@ -0,0 +1,36 @@
+//===-- PragmaCommentHandler.cpp - find all symbols -----------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "PragmaCommentHandler.h"
+#include "FindAllSymbols.h"
+#include "HeaderMapCollector.h"
+#include "clang/Lex/Preprocessor.h"
+#include "llvm/Support/Regex.h"
+
+namespace clang {
+namespace find_all_symbols {
+namespace {
+const char IWYUPragma[] = "// IWYU pragma: private, include (.*)";
+} // namespace
+
+bool PragmaCommentHandler::HandleComment(Preprocessor &PP, SourceRange Range) {
+ StringRef Text =
+ Lexer::getSourceText(CharSourceRange::getCharRange(Range),
+ PP.getSourceManager(), PP.getLangOpts());
+ SmallVector<StringRef, 4> Matches;
+ if (!llvm::Regex(IWYUPragma).match(Text, &Matches))
+ return false;
+ Collector->addHeaderMapping(
+ PP.getSourceManager().getFilename(Range.getBegin()),
+ Matches[1].trim("\"<>"));
+ return false;
+}
+
+} // namespace find_all_symbols
+} // namespace clang
Index: include-fixer/find-all-symbols/HeaderMapCollector.h
===================================================================
--- /dev/null
+++ include-fixer/find-all-symbols/HeaderMapCollector.h
@@ -0,0 +1,38 @@
+//===-- HeaderMapCoolector.h - find all symbols------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_FIND_ALL_SYMBOLS_HEADER_MAP_COLLECTOR_H
+#define LLVM_CLANG_TOOLS_EXTRA_FIND_ALL_SYMBOLS_HEADER_MAP_COLLECTOR_H
+
+#include "llvm/ADT/StringMap.h"
+#include <string>
+
+namespace clang {
+namespace find_all_symbols {
+
+/// \brief HeaderMappCollector collects all remapping header files.
+class HeaderMapCollector {
+public:
+ typedef llvm::StringMap<std::string> HeaderMap;
+
+ void addHeaderMapping(llvm::StringRef OrignalHeaderPath,
+ llvm::StringRef MappingHeaderPath) {
+ HeaderMappingTable[OrignalHeaderPath] = MappingHeaderPath;
+ };
+ const HeaderMap &getHeaderMappingTable() { return HeaderMappingTable; };
+
+private:
+ /// A string-to-string map saving the mapping relationship.
+ HeaderMap HeaderMappingTable;
+};
+
+} // namespace find_all_symbols
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_FIND_ALL_SYMBOLS_HEADER_MAP_COLLECTOR_H
Index: include-fixer/find-all-symbols/FindAllSymbols.h
===================================================================
--- include-fixer/find-all-symbols/FindAllSymbols.h
+++ include-fixer/find-all-symbols/FindAllSymbols.h
@@ -12,11 +12,16 @@
#include "SymbolInfo.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "llvm/ADT/StringRef.h"
+
+#include <map>
#include <string>
namespace clang {
namespace find_all_symbols {
+class HeaderMapCollector;
+
/// \brief FindAllSymbols collects all classes, free standing functions and
/// global variables with some extra information such as the path of the header
/// file, the namespaces they are contained in, the type of variables and the
@@ -39,15 +44,18 @@
const SymbolInfo &Symbol) = 0;
};
- explicit FindAllSymbols(ResultReporter *Reporter) : Reporter(Reporter) {}
+ explicit FindAllSymbols(ResultReporter *Reporter,
+ HeaderMapCollector *Collector)
+ : Reporter(Reporter), Collector(Collector) {}
void registerMatchers(clang::ast_matchers::MatchFinder *MatchFinder);
void
run(const clang::ast_matchers::MatchFinder::MatchResult &result) override;
private:
ResultReporter *const Reporter;
+ HeaderMapCollector *const Collector;
};
} // namespace find_all_symbols
Index: include-fixer/find-all-symbols/FindAllSymbols.cpp
===================================================================
--- include-fixer/find-all-symbols/FindAllSymbols.cpp
+++ include-fixer/find-all-symbols/FindAllSymbols.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "FindAllSymbols.h"
+#include "HeaderMapCollector.h"
#include "SymbolInfo.h"
#include "clang/AST/Decl.h"
#include "clang/AST/DeclCXX.h"
@@ -43,8 +44,9 @@
}
}
-bool SetCommonInfo(const MatchFinder::MatchResult &Result,
- const NamedDecl *ND, SymbolInfo *Symbol) {
+bool SetCommonInfo(const MatchFinder::MatchResult &Result, const NamedDecl *ND,
+ SymbolInfo *Symbol,
+ const HeaderMapCollector::HeaderMap &HeaderMappingTable) {
SetContext(ND, Symbol);
Symbol->Name = ND->getNameAsString();
@@ -64,6 +66,13 @@
if (FilePath.empty())
return false;
+ // Check pragma remapping header.
+ auto Iter = HeaderMappingTable.find(FilePath);
+ if (Iter != HeaderMappingTable.end()) {
+ Symbol->FilePath = Iter->second;
+ return true;
+ }
+
llvm::SmallString<128> AbsolutePath;
if (llvm::sys::path::is_absolute(FilePath)) {
AbsolutePath = FilePath;
@@ -174,7 +183,7 @@
const SourceManager *SM = Result.SourceManager;
SymbolInfo Symbol;
- if (!SetCommonInfo(Result, ND, &Symbol))
+ if (!SetCommonInfo(Result, ND, &Symbol, Collector->getHeaderMappingTable()))
return;
if (const auto *VD = llvm::dyn_cast<VarDecl>(ND)) {
Index: include-fixer/find-all-symbols/CMakeLists.txt
===================================================================
--- include-fixer/find-all-symbols/CMakeLists.txt
+++ include-fixer/find-all-symbols/CMakeLists.txt
@@ -4,6 +4,7 @@
add_clang_library(findAllSymbols
FindAllSymbols.cpp
+ PragmaCommentHandler.cpp
SymbolInfo.cpp
LINK_LIBS
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
