[clangd] Make binary index format the default, remove dead flag.

[ilya-biryukov]

clangd/indexer/IndexerMain.cpp

84 ↗

(On Diff #168255)

Maybe we should suggest a default extensions here? E.g. index.riff?

[hokein]

clangd/indexer/IndexerMain.cpp

58 ↗

(On Diff #168255)

If we remove the assume-header-dir, we probably remove FallbackDir too? I can't remember why we added this option, there is no usage internally either.

84 ↗

(On Diff #168255)

+1

[sammccall]

clangd/indexer/IndexerMain.cpp

84 ↗

(On Diff #168255)

I considered this but am not sure it's useful:

• means an unneccesary change to workflows if we change the format (happened once!)
• riff is associated with audio, and I'd expect OSes that care about extensions to draw the wrong conclusion :-)

[sammccall]

clangd/indexer/IndexerMain.cpp

58 ↗

(On Diff #168255)

It's used in our internal mr_indexer

84 ↗

(On Diff #168255)

Settled on clangd.dex which is at least easy to understand and only kind of misleading.

[sammccall]

example filename "clangd.dex"

[hokein]

looks good.

clang-tools-extra/trunk/clangd/indexer/IndexerMain.cpp

 //===--- IndexerMain.cpp -----------------------------------------*- C++-*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
-// GlobalSymbolBuilder is a tool to extract symbols from a whole project.
-// This tool is **experimental** only. Don't use it in production code.
+// clangd-indexer is a tool to gather index data (symbols, xrefs) from source.
 //
 //===----------------------------------------------------------------------===//
 
 #include "index/Index.h"
 #include "index/IndexAction.h"
 #include "index/Merge.h"
 #include "index/Serialization.h"
 #include "index/SymbolCollector.h"
 #include "clang/Tooling/CommonOptionsParser.h"
 #include "clang/Tooling/Execution.h"
 #include "clang/Tooling/Tooling.h"
 #include "llvm/Support/CommandLine.h"
-#include "llvm/Support/Path.h"
 #include "llvm/Support/Signals.h"
 
 using namespace llvm;
 using namespace clang::tooling;
 using clang::clangd::SymbolSlab;
 
 namespace clang {
 namespace clangd {
 namespace {
 
-static llvm::cl::opt<std::string> AssumedHeaderDir(
-    "assume-header-dir",
-    llvm::cl::desc("The index includes header that a symbol is defined in. "
-                   "If the absolute path cannot be determined (e.g. an "
-                   "in-memory VFS) then the relative path is resolved against "
-                   "this directory, which must be absolute. If this flag is "
-                   "not given, such headers will have relative paths."),
-    llvm::cl::init(""));
-
 static llvm::cl::opt<IndexFileFormat>
     Format("format", llvm::cl::desc("Format of the index to be written"),
            llvm::cl::values(clEnumValN(IndexFileFormat::YAML, "yaml",
                                        "human-readable YAML format"),
                             clEnumValN(IndexFileFormat::RIFF, "binary",
                                        "binary RIFF format")),
-           llvm::cl::init(IndexFileFormat::YAML));
+           llvm::cl::init(IndexFileFormat::RIFF));
 
 class IndexActionFactory : public tooling::FrontendActionFactory {
 public:
   IndexActionFactory(IndexFileIn &Result) : Result(Result) {}
 
   clang::FrontendAction *create() override {
     SymbolCollector::Options Opts;
-    Opts.FallbackDir = AssumedHeaderDir;
     return createStaticIndexingAction(
                Opts,
                [&](SymbolSlab S) {
                  // Merge as we go.
                  std::lock_guard<std::mutex> Lock(SymbolsMu);
                  for (const auto &Sym : S) {
                    if (const auto *Existing = Symbols.find(Sym.ID))
                      Symbols.insert(mergeSymbol(*Existing, Sym));

 } // namespace clangd
 } // namespace clang
 
 int main(int argc, const char **argv) {
   llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
 
   const char *Overview = R"(
   Creates an index of symbol information etc in a whole project.
-  This is **experimental** and not production-ready!
 
   Example usage for a project using CMake compile commands:
 
-  $ clangd-indexer --executor=all-TUs compile_commands.json > index.yaml
+  $ clangd-indexer --executor=all-TUs compile_commands.json > clangd.dex
 
   Example usage for file sequence index without flags:
 
-  $ clangd-indexer File1.cpp File2.cpp ... FileN.cpp > index.yaml
+  $ clangd-indexer File1.cpp File2.cpp ... FileN.cpp > clangd.dex
 
   Note: only symbols from header files will be indexed.
   )";
 
   auto Executor = clang::tooling::createExecutorFromCommandLineArgs(
       argc, argv, cl::GeneralCategory, Overview);
 
   if (!Executor) {
     llvm::errs() << llvm::toString(Executor.takeError()) << "\n";
     return 1;
   }
 
-  if (!clang::clangd::AssumedHeaderDir.empty() &&
-      !llvm::sys::path::is_absolute(clang::clangd::AssumedHeaderDir)) {
-    llvm::errs() << "--assume-header-dir must be an absolute path.\n";
-    return 1;
-  }
-
   // Collect symbols found in each translation unit, merging as we go.
   clang::clangd::IndexFileIn Data;
   auto Err = Executor->get()->execute(
       llvm::make_unique<clang::clangd::IndexActionFactory>(Data));
   if (Err) {
     llvm::errs() << llvm::toString(std::move(Err)) << "\n";
   }
 
   // Emit collected data.
   clang::clangd::IndexFileOut Out(Data);
   Out.Format = clang::clangd::Format;
   llvm::outs() << Out;
   return 0;
 }