[include-fixer] Add Yaml database integration.

[bkramer]

Nice. Ship it!

include-fixer/YamlXrefsDB.h

25 ↗

(On Diff #55385)

StringRef instead of std::string.

[hokein]

Fix a nit.

clang-tools-extra/trunk/include-fixer/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   support
   )
 
 add_clang_library(clangIncludeFixer
   IncludeFixer.cpp
   InMemoryXrefsDB.cpp
+  YamlXrefsDB.cpp
 
   LINK_LIBS
   clangAST
   clangBasic
   clangFrontend
   clangLex
   clangParse
   clangSema
   clangTooling
   clangToolingCore
+  findAllSymbols
   )
 
 add_subdirectory(tool)
 add_subdirectory(find-all-symbols)

clang-tools-extra/trunk/include-fixer/YamlXrefsDB.h

+//===-- YamlXrefsDB.h -------------------------------------------*- 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_INCLUDE_FIXER_YAMLXREFSDB_H
+#define LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_YAMLXREFSDB_H
+
+#include "XrefsDB.h"
+#include "find-all-symbols/SymbolInfo.h"
+#include <map>
+#include <vector>
+
+namespace clang {
+namespace include_fixer {
+
+/// Yaml format database.
+class YamlXrefsDB : public XrefsDB {
+public:
+  YamlXrefsDB(llvm::StringRef FilePath);
+
+  std::vector<std::string> search(llvm::StringRef Identifier) override;
+
+private:
+  std::vector<clang::find_all_symbols::SymbolInfo> Symbols;
+};
+
+} // namespace include_fixer
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_YAMLXREFSDB_H

clang-tools-extra/trunk/include-fixer/YamlXrefsDB.cpp

+//===-- YamlXrefsDB.cpp ---------------------------------------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "YamlXrefsDB.h"
+
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/Support/FileSystem.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include <string>
+#include <vector>
+
+namespace clang {
+namespace include_fixer {
+
+YamlXrefsDB::YamlXrefsDB(llvm::StringRef FilePath) {
+  int ReadFD = 0;
+  if (llvm::sys::fs::openFileForRead(FilePath, ReadFD))
+    return;
+  auto Buffer = llvm::MemoryBuffer::getOpenFile(ReadFD, FilePath, -1);
+  if (!Buffer)
+    return;
+  Symbols = clang::find_all_symbols::ReadSymbolInfosFromYAML(
+      Buffer.get()->getBuffer());
+}
+
+std::vector<std::string> YamlXrefsDB::search(llvm::StringRef Identifier) {
+  llvm::SmallVector<llvm::StringRef, 16> Names;
+  std::vector<std::string> Results;
+
+  // The identifier may be fully qualified, so split it and get all the context
+  // names.
+  Identifier.split(Names, "::");
+  for (const auto &Symbol : Symbols) {
+    // Match the identifier name without qualifier.
+    if (Symbol.Name == Names.back()) {
+      bool IsMatched = true;
+      auto SymbolContext = Symbol.Contexts.begin();
+      // Match the remaining context names.
+      for (auto IdentiferContext = Names.rbegin() + 1;
+           IdentiferContext != Names.rend() &&
+           SymbolContext != Symbol.Contexts.end();
+           ++IdentiferContext, ++SymbolContext) {
+        if (SymbolContext->second != *IdentiferContext) {
+          IsMatched = false;
+          break;
+        }
+      }
+
+      if (IsMatched) {
+        Results.push_back("\"" + Symbol.FilePath + "\"");
+      }
+    }
+  }
+  return Results;
+}
+
+} // namespace include_fixer
+} // namespace clang

clang-tools-extra/trunk/include-fixer/tool/ClangIncludeFixer.cpp

 //===-- ClangIncludeFixer.cpp - Standalone include fixer ------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "InMemoryXrefsDB.h"
 #include "IncludeFixer.h"
+#include "YamlXrefsDB.h"
 #include "clang/Frontend/TextDiagnosticPrinter.h"
 #include "clang/Rewrite/Core/Rewriter.h"
 #include "clang/Tooling/CommonOptionsParser.h"
 #include "clang/Tooling/Tooling.h"
 #include "llvm/Support/CommandLine.h"
+
 using namespace clang;
 using namespace llvm;
 
 namespace {
 cl::OptionCategory IncludeFixerCategory("Tool options");
 
 enum DatabaseFormatTy {
   fixed, ///< Hard-coded mapping.
+  yaml,  ///< Yaml database created by find-all-symbols.
 };
 
 cl::opt<DatabaseFormatTy> DatabaseFormat(
     "db", cl::desc("Specify input format"),
-    cl::values(clEnumVal(fixed, "Hard-coded mapping"), clEnumValEnd),
+    cl::values(clEnumVal(fixed, "Hard-coded mapping"),
+               clEnumVal(yaml, "Yaml database created by find-all-symbols"),
+               clEnumValEnd),
     cl::init(fixed), cl::cat(IncludeFixerCategory));
 
 cl::opt<std::string> Input("input",
                            cl::desc("String to initialize the database"),
                            cl::cat(IncludeFixerCategory));
 
 cl::opt<bool>
     MinimizeIncludePaths("minimize-paths",
for (StringRef Pair : SemicolonSplits) {
       for (StringRef Header : CommaSplits)
         Headers.push_back(Header.trim());
       XrefsMap[Split.first.trim()] = std::move(Headers);
     }
     XrefsDB =
         llvm::make_unique<include_fixer::InMemoryXrefsDB>(std::move(XrefsMap));
     break;
   }
+  case yaml: {
+    XrefsDB = llvm::make_unique<include_fixer::YamlXrefsDB>(Input);
+    break;
+  }
   }
 
   // Now run our tool.
   std::vector<tooling::Replacement> Replacements;
   include_fixer::IncludeFixerActionFactory Factory(*XrefsDB, Replacements,
                                                    MinimizeIncludePaths);
 
   tool.run(&Factory); // Always succeeds.

clang-tools-extra/trunk/test/include-fixer/Inputs/fake_yaml_db.yaml

+---
+Name:           foo
+Contexts:
+  - ContextType:     Namespace
+    ContextName:     a
+  - ContextType:     Namespace
+    ContextName:     b
+FilePath:        foo.h
+LineNumber:      1
+Type:            Class
+...

clang-tools-extra/trunk/test/include-fixer/yamldb.cpp

+// REQUIRES: shell
+// RUN: sed -e 's#//.*$##' %s > %t.cpp
+// RUN: clang-include-fixer -db=yaml -input=%p/Inputs/fake_yaml_db.yaml %t.cpp --
+// RUN: FileCheck %s -input-file=%t.cpp
+
+// CHECK: #include "foo.h"
+// CHECK: b::a::foo f;
+
+b::a::foo f;