r329580 - [Tooling] A CompilationDatabase wrapper that infers header commands.

Sam McCall via cfe-commits cfe-commits at lists.llvm.org
Tue Apr 10 03:40:22 PDT 2018


Apologies, missed this. r329685 should fix.

On Tue, Apr 10, 2018 at 12:53 AM Galina Kistanova <gkistanova at gmail.com>
wrote:

> Hello Sam,
>
> It looks like this commit added broken tests to one of our builders:
>
> http://lab.llvm.org:8011/builders/llvm-clang-x86_64-expensive-checks-win/builds/8957/steps/test-check-all/logs/stdio
>
> Failing Tests (5):
>     Clang-Unit :: Tooling/./ToolingTests.exe/InterpolateTest.Case
>     Clang-Unit :: Tooling/./ToolingTests.exe/InterpolateTest.Language
>     Clang-Unit :: Tooling/./ToolingTests.exe/InterpolateTest.Nearby
>     Clang-Unit :: Tooling/./ToolingTests.exe/InterpolateTest.Strip
> . . .
> Please have a look?
>
> The builder was red and did not send notifications.
>
> Thanks
>
> Galina
>
> On Mon, Apr 9, 2018 at 8:17 AM, Sam McCall via cfe-commits <
> cfe-commits at lists.llvm.org> wrote:
>
>> Author: sammccall
>> Date: Mon Apr  9 08:17:39 2018
>> New Revision: 329580
>>
>> URL: http://llvm.org/viewvc/llvm-project?rev=329580&view=rev
>> Log:
>> [Tooling] A CompilationDatabase wrapper that infers header commands.
>>
>> Summary:
>> The wrapper finds the closest matching compile command using filename
>> heuristics
>> and makes minimal tweaks so it can be used with the header.
>>
>> Subscribers: klimek, mgorny, cfe-commits
>>
>> Differential Revision: https://reviews.llvm.org/D45006
>>
>> Added:
>>     cfe/trunk/lib/Tooling/InterpolatingCompilationDatabase.cpp
>> Modified:
>>     cfe/trunk/include/clang/Tooling/CompilationDatabase.h
>>     cfe/trunk/lib/Tooling/CMakeLists.txt
>>     cfe/trunk/unittests/Tooling/CompilationDatabaseTest.cpp
>>
>> Modified: cfe/trunk/include/clang/Tooling/CompilationDatabase.h
>> URL:
>> http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Tooling/CompilationDatabase.h?rev=329580&r1=329579&r2=329580&view=diff
>>
>> ==============================================================================
>> --- cfe/trunk/include/clang/Tooling/CompilationDatabase.h (original)
>> +++ cfe/trunk/include/clang/Tooling/CompilationDatabase.h Mon Apr  9
>> 08:17:39 2018
>> @@ -213,6 +213,13 @@ private:
>>    std::vector<CompileCommand> CompileCommands;
>>  };
>>
>> +/// Returns a wrapped CompilationDatabase that defers to the provided
>> one,
>> +/// but getCompileCommands() will infer commands for unknown files.
>> +/// The return value of getAllFiles() or getAllCompileCommands() is
>> unchanged.
>> +/// See InterpolatingCompilationDatabase.cpp for details on heuristics.
>> +std::unique_ptr<CompilationDatabase>
>> +    inferMissingCompileCommands(std::unique_ptr<CompilationDatabase>);
>> +
>>  } // namespace tooling
>>  } // namespace clang
>>
>>
>> Modified: cfe/trunk/lib/Tooling/CMakeLists.txt
>> URL:
>> http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Tooling/CMakeLists.txt?rev=329580&r1=329579&r2=329580&view=diff
>>
>> ==============================================================================
>> --- cfe/trunk/lib/Tooling/CMakeLists.txt (original)
>> +++ cfe/trunk/lib/Tooling/CMakeLists.txt Mon Apr  9 08:17:39 2018
>> @@ -15,6 +15,7 @@ add_clang_library(clangTooling
>>    Execution.cpp
>>    FileMatchTrie.cpp
>>    FixIt.cpp
>> +  InterpolatingCompilationDatabase.cpp
>>    JSONCompilationDatabase.cpp
>>    Refactoring.cpp
>>    RefactoringCallbacks.cpp
>>
>> Added: cfe/trunk/lib/Tooling/InterpolatingCompilationDatabase.cpp
>> URL:
>> http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Tooling/InterpolatingCompilationDatabase.cpp?rev=329580&view=auto
>>
>> ==============================================================================
>> --- cfe/trunk/lib/Tooling/InterpolatingCompilationDatabase.cpp (added)
>> +++ cfe/trunk/lib/Tooling/InterpolatingCompilationDatabase.cpp Mon Apr  9
>> 08:17:39 2018
>> @@ -0,0 +1,458 @@
>> +//===- InterpolatingCompilationDatabase.cpp ---------------------*- C++
>> -*-===//
>> +//
>> +//                     The LLVM Compiler Infrastructure
>> +//
>> +// This file is distributed under the University of Illinois Open Source
>> +// License. See LICENSE.TXT for details.
>> +//
>>
>> +//===----------------------------------------------------------------------===//
>> +//
>> +// InterpolatingCompilationDatabase wraps another CompilationDatabase and
>> +// attempts to heuristically determine appropriate compile commands for
>> files
>> +// that are not included, such as headers or newly created files.
>> +//
>> +// Motivating cases include:
>> +//   Header files that live next to their implementation files. These
>> typically
>> +// share a base filename. (libclang/CXString.h, libclang/CXString.cpp).
>> +//   Some projects separate headers from includes. Filenames still
>> typically
>> +// match, maybe other path segments too. (include/llvm/IR/Use.h,
>> lib/IR/Use.cc).
>> +//   Matches are sometimes only approximate (Sema.h, SemaDecl.cpp). This
>> goes
>> +// for directories too (Support/Unix/Process.inc,
>> lib/Support/Process.cpp).
>> +//   Even if we can't find a "right" compile command, even a random one
>> from
>> +// the project will tend to get important flags like -I and -x right.
>> +//
>> +// We "borrow" the compile command for the closest available file:
>> +//   - points are awarded if the filename matches (ignoring extension)
>> +//   - points are awarded if the directory structure matches
>> +//   - ties are broken by length of path prefix match
>> +//
>> +// The compile command is adjusted, replacing the filename and removing
>> output
>> +// file arguments. The -x and -std flags may be affected too.
>> +//
>> +// Source language is a tricky issue: is it OK to use a .c file's command
>> +// for building a .cc file? What language is a .h file in?
>> +//   - We only consider compile commands for c-family languages as
>> candidates.
>> +//   - For files whose language is implied by the filename (e.g. .m,
>> .hpp)
>> +//     we prefer candidates from the same language.
>> +//     If we must cross languages, we drop any -x and -std flags.
>> +//   - For .h files, candidates from any c-family language are
>> acceptable.
>> +//     We use the candidate's language, inserting  e.g. -x c++-header.
>> +//
>> +// This class is only useful when wrapping databases that can enumerate
>> all
>> +// their compile commands. If getAllFilenames() is empty, no inference
>> occurs.
>> +//
>>
>> +//===----------------------------------------------------------------------===//
>> +
>> +#include "clang/Driver/Options.h"
>> +#include "clang/Driver/Types.h"
>> +#include "clang/Frontend/LangStandard.h"
>> +#include "clang/Tooling/CompilationDatabase.h"
>> +#include "llvm/ADT/DenseMap.h"
>> +#include "llvm/ADT/StringExtras.h"
>> +#include "llvm/ADT/StringSwitch.h"
>> +#include "llvm/Option/ArgList.h"
>> +#include "llvm/Option/OptTable.h"
>> +#include "llvm/Support/Debug.h"
>> +#include "llvm/Support/Path.h"
>> +#include "llvm/Support/StringSaver.h"
>> +#include "llvm/Support/raw_ostream.h"
>> +#include <memory>
>> +
>> +namespace clang {
>> +namespace tooling {
>> +namespace {
>> +using namespace llvm;
>> +namespace types = clang::driver::types;
>> +namespace path = llvm::sys::path;
>> +
>> +// The length of the prefix these two strings have in common.
>> +size_t matchingPrefix(StringRef L, StringRef R) {
>> +  size_t Limit = std::min(L.size(), R.size());
>> +  for (size_t I = 0; I < Limit; ++I)
>> +    if (L[I] != R[I])
>> +      return I;
>> +  return Limit;
>> +}
>> +
>> +// A comparator for searching SubstringWithIndexes with std::equal_range
>> etc.
>> +// Optionaly prefix semantics: compares equal if the key is a prefix.
>> +template <bool Prefix> struct Less {
>> +  bool operator()(StringRef Key, std::pair<StringRef, size_t> Value)
>> const {
>> +    StringRef V = Prefix ? Value.first.substr(0, Key.size()) :
>> Value.first;
>> +    return Key < V;
>> +  }
>> +  bool operator()(std::pair<StringRef, size_t> Value, StringRef Key)
>> const {
>> +    StringRef V = Prefix ? Value.first.substr(0, Key.size()) :
>> Value.first;
>> +    return V < Key;
>> +  }
>> +};
>> +
>> +// Infer type from filename. If we might have gotten it wrong, set
>> *Certain.
>> +// *.h will be inferred as a C header, but not certain.
>> +types::ID guessType(StringRef Filename, bool *Certain = nullptr) {
>> +  // path::extension is ".cpp", lookupTypeForExtension wants "cpp".
>> +  auto Lang =
>> +      types::lookupTypeForExtension(path::extension(Filename).substr(1));
>> +  if (Certain)
>> +    *Certain = Lang != types::TY_CHeader && Lang != types::TY_INVALID;
>> +  return Lang;
>> +}
>> +
>> +// Return Lang as one of the canonical supported types.
>> +// e.g. c-header --> c; fortran --> TY_INVALID
>> +static types::ID foldType(types::ID Lang) {
>> +  switch (Lang) {
>> +  case types::TY_C:
>> +  case types::TY_CHeader:
>> +    return types::TY_C;
>> +  case types::TY_ObjC:
>> +  case types::TY_ObjCHeader:
>> +    return types::TY_ObjC;
>> +  case types::TY_CXX:
>> +  case types::TY_CXXHeader:
>> +    return types::TY_CXX;
>> +  case types::TY_ObjCXX:
>> +  case types::TY_ObjCXXHeader:
>> +    return types::TY_ObjCXX;
>> +  default:
>> +    return types::TY_INVALID;
>> +  }
>> +}
>> +
>> +// A CompileCommand that can be applied to another file.
>> +struct TransferableCommand {
>> +  // Flags that should not apply to all files are stripped from
>> CommandLine.
>> +  CompileCommand Cmd;
>> +  // Language detected from -x or the filename.
>> +  types::ID Type = types::TY_INVALID;
>> +  // Standard specified by -std.
>> +  LangStandard::Kind Std = LangStandard::lang_unspecified;
>> +
>> +  TransferableCommand(CompileCommand C)
>> +      : Cmd(std::move(C)), Type(guessType(Cmd.Filename)) {
>> +    std::vector<std::string> NewArgs = {Cmd.CommandLine.front()};
>> +    // Parse the old args in order to strip out and record unwanted
>> flags.
>> +    auto OptTable = clang::driver::createDriverOptTable();
>> +    std::vector<const char *> Argv;
>> +    for (unsigned I = 1; I < Cmd.CommandLine.size(); ++I)
>> +      Argv.push_back(Cmd.CommandLine[I].c_str());
>> +    unsigned MissingI, MissingC;
>> +    auto ArgList = OptTable->ParseArgs(Argv, MissingI, MissingC);
>> +    for (const auto *Arg : ArgList) {
>> +      const auto &option = Arg->getOption();
>> +      // Strip input and output files.
>> +      if (option.matches(clang::driver::options::OPT_INPUT) ||
>> +          option.matches(clang::driver::options::OPT_o)) {
>> +        continue;
>> +      }
>> +      // Strip -x, but record the overridden language.
>> +      if (option.matches(clang::driver::options::OPT_x)) {
>> +        for (const char *Value : Arg->getValues())
>> +          Type = types::lookupTypeForTypeSpecifier(Value);
>> +        continue;
>> +      }
>> +      // Strip --std, but record the value.
>> +      if (option.matches(clang::driver::options::OPT_std_EQ)) {
>> +        for (const char *Value : Arg->getValues()) {
>> +          Std = llvm::StringSwitch<LangStandard::Kind>(Value)
>> +#define LANGSTANDARD(id, name, lang, desc, features)
>>        \
>> +  .Case(name, LangStandard::lang_##id)
>> +#define LANGSTANDARD_ALIAS(id, alias) .Case(alias,
>> LangStandard::lang_##id)
>> +#include "clang/Frontend/LangStandards.def"
>> +                    .Default(Std);
>> +        }
>> +        continue;
>> +      }
>> +      llvm::opt::ArgStringList ArgStrs;
>> +      Arg->render(ArgList, ArgStrs);
>> +      NewArgs.insert(NewArgs.end(), ArgStrs.begin(), ArgStrs.end());
>> +    }
>> +    Cmd.CommandLine = std::move(NewArgs);
>> +
>> +    if (Std != LangStandard::lang_unspecified) // -std take precedence
>> over -x
>> +      Type =
>> toType(LangStandard::getLangStandardForKind(Std).getLanguage());
>> +    Type = foldType(Type);
>> +  }
>> +
>> +  // Produce a CompileCommand for \p filename, based on this one.
>> +  CompileCommand transferTo(StringRef Filename) const {
>> +    CompileCommand Result = Cmd;
>> +    Result.Filename = Filename;
>> +    bool TypeCertain;
>> +    auto TargetType = guessType(Filename, &TypeCertain);
>> +    // If the filename doesn't determine the language (.h), transfer
>> with -x.
>> +    if (!TypeCertain) {
>> +      TargetType = types::onlyPrecompileType(TargetType) // header?
>> +                       ? types::lookupHeaderTypeForSourceType(Type)
>> +                       : Type;
>> +      Result.CommandLine.push_back("-x");
>> +      Result.CommandLine.push_back(types::getTypeName(TargetType));
>> +    }
>> +    // --std flag may only be transferred if the language is the same.
>> +    // We may consider "translating" these, e.g. c++11 -> c11.
>> +    if (Std != LangStandard::lang_unspecified && foldType(TargetType) ==
>> Type) {
>> +      Result.CommandLine.push_back("-std");
>> +      Result.CommandLine.push_back(
>> +          LangStandard::getLangStandardForKind(Std).getName());
>> +    }
>> +    Result.CommandLine.push_back(Filename);
>> +    return Result;
>> +  }
>> +
>> +private:
>> +  // Map the language from the --std flag to that of the -x flag.
>> +  static types::ID toType(InputKind::Language Lang) {
>> +    switch (Lang) {
>> +    case InputKind::C:
>> +      return types::TY_C;
>> +    case InputKind::CXX:
>> +      return types::TY_CXX;
>> +    case InputKind::ObjC:
>> +      return types::TY_ObjC;
>> +    case InputKind::ObjCXX:
>> +      return types::TY_ObjCXX;
>> +    default:
>> +      return types::TY_INVALID;
>> +    }
>> +  }
>> +};
>> +
>> +// CommandIndex does the real work: given a filename, it produces the
>> best
>> +// matching TransferableCommand by matching filenames. Basic strategy:
>> +// - Build indexes of each of the substrings we want to look up by.
>> +//   These indexes are just sorted lists of the substrings.
>> +// - Forward requests to the inner CDB. If it fails, we must pick a
>> proxy.
>> +// - Each criterion corresponds to a range lookup into the index, so we
>> only
>> +//   need O(log N) string comparisons to determine scores.
>> +// - We then break ties among the candidates with the highest score.
>> +class CommandIndex {
>> +public:
>> +  CommandIndex(std::vector<TransferableCommand> AllCommands)
>> +      : Commands(std::move(AllCommands)), Strings(Arena) {
>> +    // Sort commands by filename for determinism (index is a tiebreaker
>> later).
>> +    llvm::sort(
>> +        Commands.begin(), Commands.end(),
>> +        [](const TransferableCommand &Left, const TransferableCommand
>> &Right) {
>> +          return Left.Cmd.Filename < Right.Cmd.Filename;
>> +        });
>> +    for (size_t I = 0; I < Commands.size(); ++I) {
>> +      StringRef Path =
>> +          Strings.save(StringRef(Commands[I].Cmd.Filename).lower());
>> +      Paths.push_back({Path, I});
>> +      Stems.emplace_back(sys::path::stem(Path), I);
>> +      auto Dir = ++sys::path::rbegin(Path), DirEnd =
>> sys::path::rend(Path);
>> +      for (int J = 0; J < DirectorySegmentsIndexed && Dir != DirEnd;
>> ++J, ++Dir)
>> +        if (Dir->size() > ShortDirectorySegment) // not trivial ones
>> +          Components.emplace_back(*Dir, I);
>> +    }
>> +    llvm::sort(Paths.begin(), Paths.end());
>> +    llvm::sort(Stems.begin(), Stems.end());
>> +    llvm::sort(Components.begin(), Components.end());
>> +  }
>> +
>> +  bool empty() const { return Commands.empty(); }
>> +
>> +  // Returns the command that best fits OriginalFilename.
>> +  // Candidates with PreferLanguage will be chosen over others (unless
>> it's
>> +  // TY_INVALID, or all candidates are bad).
>> +  const TransferableCommand &chooseProxy(StringRef OriginalFilename,
>> +                                         types::ID PreferLanguage) const
>> {
>> +    assert(!empty() && "need at least one candidate!");
>> +    std::string Filename = OriginalFilename.lower();
>> +    auto Candidates = scoreCandidates(Filename);
>> +    std::pair<size_t, int> Best =
>> +        pickWinner(Candidates, Filename, PreferLanguage);
>> +
>> +    DEBUG_WITH_TYPE("interpolate",
>> +                    llvm::dbgs()
>> +                        << "interpolate: chose "
>> +                        << Commands[Best.first].Cmd.Filename << " as
>> proxy for "
>> +                        << OriginalFilename << " preferring "
>> +                        << (PreferLanguage == types::TY_INVALID
>> +                                ? "none"
>> +                                : types::getTypeName(PreferLanguage))
>> +                        << " score=" << Best.second << "\n");
>> +    return Commands[Best.first];
>> +  }
>> +
>> +private:
>> +  using SubstringAndIndex = std::pair<StringRef, size_t>;
>> +  // Directory matching parameters: we look at the last two segments of
>> the
>> +  // parent directory (usually the semantically significant ones in
>> practice).
>> +  // We search only the last four of each candidate (for efficiency).
>> +  constexpr static int DirectorySegmentsIndexed = 4;
>> +  constexpr static int DirectorySegmentsQueried = 2;
>> +  constexpr static int ShortDirectorySegment = 1; // Only look at longer
>> names.
>> +
>> +  // Award points to candidate entries that should be considered for the
>> file.
>> +  // Returned keys are indexes into paths, and the values are (nonzero)
>> scores.
>> +  DenseMap<size_t, int> scoreCandidates(StringRef Filename) const {
>> +    // Decompose Filename into the parts we care about.
>> +    // /some/path/complicated/project/Interesting.h
>> +    // [-prefix--][---dir---] [-dir-] [--stem---]
>> +    StringRef Stem = sys::path::stem(Filename);
>> +    llvm::SmallVector<StringRef, DirectorySegmentsQueried> Dirs;
>> +    llvm::StringRef Prefix;
>> +    auto Dir = ++sys::path::rbegin(Filename),
>> +         DirEnd = sys::path::rend(Filename);
>> +    for (int I = 0; I < DirectorySegmentsQueried && Dir != DirEnd; ++I,
>> ++Dir) {
>> +      if (Dir->size() > ShortDirectorySegment)
>> +        Dirs.push_back(*Dir);
>> +      Prefix = Filename.substr(0, Dir - DirEnd);
>> +    }
>> +
>> +    // Now award points based on lookups into our various indexes.
>> +    DenseMap<size_t, int> Candidates; // Index -> score.
>> +    auto Award = [&](int Points, ArrayRef<SubstringAndIndex> Range) {
>> +      for (const auto &Entry : Range)
>> +        Candidates[Entry.second] += Points;
>> +    };
>> +    // Award one point if the file's basename is a prefix of the
>> candidate,
>> +    // and another if it's an exact match (so exact matches get two
>> points).
>> +    Award(1, indexLookup</*Prefix=*/true>(Stem, Stems));
>> +    Award(1, indexLookup</*Prefix=*/false>(Stem, Stems));
>> +    // For each of the last few directories in the Filename, award a
>> point
>> +    // if it's present in the candidate.
>> +    for (StringRef Dir : Dirs)
>> +      Award(1, indexLookup</*Prefix=*/false>(Dir, Components));
>> +    // Award one more point if the whole rest of the path matches.
>> +    if (sys::path::root_directory(Prefix) != Prefix)
>> +      Award(1, indexLookup</*Prefix=*/true>(Prefix, Paths));
>> +    return Candidates;
>> +  }
>> +
>> +  // Pick a single winner from the set of scored candidates.
>> +  // Returns (index, score).
>> +  std::pair<size_t, int> pickWinner(const DenseMap<size_t, int>
>> &Candidates,
>> +                                    StringRef Filename,
>> +                                    types::ID PreferredLanguage) const {
>> +    struct ScoredCandidate {
>> +      size_t Index;
>> +      bool Preferred;
>> +      int Points;
>> +      size_t PrefixLength;
>> +    };
>> +    // Choose the best candidate by (preferred, points, prefix length,
>> alpha).
>> +    ScoredCandidate Best = {size_t(-1), false, 0, 0};
>> +    for (const auto &Candidate : Candidates) {
>> +      ScoredCandidate S;
>> +      S.Index = Candidate.first;
>> +      S.Preferred = PreferredLanguage == types::TY_INVALID ||
>> +                    PreferredLanguage == Commands[S.Index].Type;
>> +      S.Points = Candidate.second;
>> +      if (!S.Preferred && Best.Preferred)
>> +        continue;
>> +      if (S.Preferred == Best.Preferred) {
>> +        if (S.Points < Best.Points)
>> +          continue;
>> +        if (S.Points == Best.Points) {
>> +          S.PrefixLength = matchingPrefix(Filename,
>> Paths[S.Index].first);
>> +          if (S.PrefixLength < Best.PrefixLength)
>> +            continue;
>> +          // hidden heuristics should at least be deterministic!
>> +          if (S.PrefixLength == Best.PrefixLength)
>> +            if (S.Index > Best.Index)
>> +              continue;
>> +        }
>> +      }
>> +      // PrefixLength was only set above if actually needed for a
>> tiebreak.
>> +      // But it definitely needs to be set to break ties in the future.
>> +      S.PrefixLength = matchingPrefix(Filename, Paths[S.Index].first);
>> +      Best = S;
>> +    }
>> +    // Edge case: no candidate got any points.
>> +    // We ignore PreferredLanguage at this point (not ideal).
>> +    if (Best.Index == size_t(-1))
>> +      return {longestMatch(Filename, Paths).second, 0};
>> +    return {Best.Index, Best.Points};
>> +  }
>> +
>> +  // Returns the range within a sorted index that compares equal to Key.
>> +  // If Prefix is true, it's instead the range starting with Key.
>> +  template <bool Prefix>
>> +  ArrayRef<SubstringAndIndex>
>> +  indexLookup(StringRef Key, const std::vector<SubstringAndIndex> &Idx)
>> const {
>> +    // Use pointers as iteratiors to ease conversion of result to
>> ArrayRef.
>> +    auto Range =
>> +        std::equal_range(&Idx[0], &Idx[Idx.size()], Key, Less<Prefix>());
>> +    return {Range.first, Range.second};
>> +  }
>> +
>> +  // Performs a point lookup into a nonempty index, returning a longest
>> match.
>> +  SubstringAndIndex
>> +  longestMatch(StringRef Key, const std::vector<SubstringAndIndex> &Idx)
>> const {
>> +    assert(!Idx.empty());
>> +    // Longest substring match will be adjacent to a direct lookup.
>> +    auto It =
>> +        std::lower_bound(Idx.begin(), Idx.end(), SubstringAndIndex{Key,
>> 0});
>> +    if (It == Idx.begin())
>> +      return *It;
>> +    if (It == Idx.end())
>> +      return *--It;
>> +    // Have to choose between It and It-1
>> +    size_t Prefix = matchingPrefix(Key, It->first);
>> +    size_t PrevPrefix = matchingPrefix(Key, (It - 1)->first);
>> +    return Prefix > PrevPrefix ? *It : *--It;
>> +  }
>> +
>> +  std::vector<TransferableCommand> Commands; // Indexes point into this.
>> +  BumpPtrAllocator Arena;
>> +  StringSaver Strings;
>> +  // Indexes of candidates by certain substrings.
>> +  // String is lowercase and sorted, index points into OriginalPaths.
>> +  std::vector<SubstringAndIndex> Paths;      // Full path.
>> +  std::vector<SubstringAndIndex> Stems;      // Basename, without
>> extension.
>> +  std::vector<SubstringAndIndex> Components; // Last path components.
>> +};
>> +
>> +// The actual CompilationDatabase wrapper delegates to its inner
>> database.
>> +// If no match, looks up a command in CommandIndex and transfers it to
>> the file.
>> +class InterpolatingCompilationDatabase : public CompilationDatabase {
>> +public:
>> +  InterpolatingCompilationDatabase(std::unique_ptr<CompilationDatabase>
>> Inner)
>> +      : Inner(std::move(Inner)), Index(allCommands()) {}
>> +
>> +  std::vector<CompileCommand>
>> +  getCompileCommands(StringRef Filename) const override {
>> +    auto Known = Inner->getCompileCommands(Filename);
>> +    if (Index.empty() || !Known.empty())
>> +      return Known;
>> +    bool TypeCertain;
>> +    auto Lang = guessType(Filename, &TypeCertain);
>> +    if (!TypeCertain)
>> +      Lang = types::TY_INVALID;
>> +    return {Index.chooseProxy(Filename,
>> foldType(Lang)).transferTo(Filename)};
>> +  }
>> +
>> +  std::vector<std::string> getAllFiles() const override {
>> +    return Inner->getAllFiles();
>> +  }
>> +
>> +  std::vector<CompileCommand> getAllCompileCommands() const override {
>> +    return Inner->getAllCompileCommands();
>> +  }
>> +
>> +private:
>> +  std::vector<TransferableCommand> allCommands() {
>> +    std::vector<TransferableCommand> Result;
>> +    for (auto Command : Inner->getAllCompileCommands()) {
>> +      Result.emplace_back(std::move(Command));
>> +      if (Result.back().Type == types::TY_INVALID)
>> +        Result.pop_back();
>> +    }
>> +    return Result;
>> +  }
>> +
>> +  std::unique_ptr<CompilationDatabase> Inner;
>> +  CommandIndex Index;
>> +};
>> +
>> +} // namespace
>> +
>> +std::unique_ptr<CompilationDatabase>
>> +inferMissingCompileCommands(std::unique_ptr<CompilationDatabase> Inner) {
>> +  return
>> llvm::make_unique<InterpolatingCompilationDatabase>(std::move(Inner));
>> +}
>> +
>> +} // namespace tooling
>> +} // namespace clang
>>
>> Modified: cfe/trunk/unittests/Tooling/CompilationDatabaseTest.cpp
>> URL:
>> http://llvm.org/viewvc/llvm-project/cfe/trunk/unittests/Tooling/CompilationDatabaseTest.cpp?rev=329580&r1=329579&r2=329580&view=diff
>>
>> ==============================================================================
>> --- cfe/trunk/unittests/Tooling/CompilationDatabaseTest.cpp (original)
>> +++ cfe/trunk/unittests/Tooling/CompilationDatabaseTest.cpp Mon Apr  9
>> 08:17:39 2018
>> @@ -626,5 +626,115 @@ TEST(ParseFixedCompilationDatabase, Hand
>>    EXPECT_EQ(2, Argc);
>>  }
>>
>> +struct MemCDB : public CompilationDatabase {
>> +  using EntryMap = llvm::StringMap<SmallVector<CompileCommand, 1>>;
>> +  EntryMap Entries;
>> +  MemCDB(const EntryMap &E) : Entries(E) {}
>> +
>> +  std::vector<CompileCommand> getCompileCommands(StringRef F) const
>> override {
>> +    auto Ret = Entries.lookup(F);
>> +    return {Ret.begin(), Ret.end()};
>> +  }
>> +
>> +  std::vector<std::string> getAllFiles() const override {
>> +    std::vector<std::string> Result;
>> +    for (const auto &Entry : Entries)
>> +      Result.push_back(Entry.first());
>> +    return Result;
>> +  }
>> +};
>> +
>> +class InterpolateTest : public ::testing::Test {
>> +protected:
>> +  // Adds an entry to the underlying compilation database.
>> +  // A flag is injected: -D <File>, so the command used can be
>> identified.
>> +  void add(llvm::StringRef File, llvm::StringRef Flags = "") {
>> +    llvm::SmallVector<StringRef, 8> Argv = {"clang", File, "-D", File};
>> +    llvm::SplitString(Flags, Argv);
>> +    llvm::SmallString<32> Dir;
>> +    llvm::sys::path::system_temp_directory(false, Dir);
>> +    Entries[path(File)].push_back(
>> +        {Dir, path(File), {Argv.begin(), Argv.end()}, "foo.o"});
>> +  }
>> +
>> +  // Turn a unix path fragment (foo/bar.h) into a native path
>> (C:\tmp\foo\bar.h)
>> +  std::string path(llvm::SmallString<32> File) {
>> +    llvm::SmallString<32> Dir;
>> +    llvm::sys::path::system_temp_directory(false, Dir);
>> +    llvm::sys::path::native(File);
>> +    llvm::SmallString<64> Result;
>> +    llvm::sys::path::append(Result, Dir, File);
>> +    return Result.str();
>> +  }
>> +
>> +  // Look up the command from a relative path, and return it in string
>> form.
>> +  // The input file is not included in the returned command.
>> +  std::string getCommand(llvm::StringRef F) {
>> +    auto Results =
>> +        inferMissingCompileCommands(llvm::make_unique<MemCDB>(Entries))
>> +            ->getCompileCommands(path(F));
>> +    if (Results.empty())
>> +      return "none";
>> +    // drop the input file argument, so tests don't have to deal with
>> path().
>> +    EXPECT_EQ(Results[0].CommandLine.back(), path(F))
>> +        << "Last arg should be the file";
>> +    Results[0].CommandLine.pop_back();
>> +    return llvm::join(Results[0].CommandLine, " ");
>> +  }
>> +
>> +  MemCDB::EntryMap Entries;
>> +};
>> +
>> +TEST_F(InterpolateTest, Nearby) {
>> +  add("dir/foo.cpp");
>> +  add("dir/bar.cpp");
>> +  add("an/other/foo.cpp");
>> +
>> +  // great: dir and name both match (prefix or full, case insensitive)
>> +  EXPECT_EQ(getCommand("dir/f.cpp"), "clang -D dir/foo.cpp");
>> +  EXPECT_EQ(getCommand("dir/FOO.cpp"), "clang -D dir/foo.cpp");
>> +  // no name match. prefer matching dir, break ties by alpha
>> +  EXPECT_EQ(getCommand("dir/a.cpp"), "clang -D dir/bar.cpp");
>> +  // an exact name match beats one segment of directory match
>> +  EXPECT_EQ(getCommand("some/other/bar.h"),
>> +            "clang -D dir/bar.cpp -x c++-header");
>> +  // two segments of directory match beat a prefix name match
>> +  EXPECT_EQ(getCommand("an/other/b.cpp"), "clang -D an/other/foo.cpp");
>> +  // if nothing matches at all, we still get the closest alpha match
>> +  EXPECT_EQ(getCommand("below/some/obscure/path.cpp"),
>> +            "clang -D an/other/foo.cpp");
>> +}
>> +
>> +TEST_F(InterpolateTest, Language) {
>> +  add("dir/foo.cpp", "-std=c++17");
>> +  add("dir/baz.cee", "-x c");
>> +
>> +  // .h is ambiguous, so we add explicit language flags
>> +  EXPECT_EQ(getCommand("foo.h"),
>> +            "clang -D dir/foo.cpp -x c++-header -std c++17");
>> +  // and don't add -x if the inferred language is correct.
>> +  EXPECT_EQ(getCommand("foo.hpp"), "clang -D dir/foo.cpp -std c++17");
>> +  // respect -x if it's already there.
>> +  EXPECT_EQ(getCommand("baz.h"), "clang -D dir/baz.cee -x c-header");
>> +  // prefer a worse match with the right language
>> +  EXPECT_EQ(getCommand("foo.c"), "clang -D dir/baz.cee");
>> +  Entries.erase(path(StringRef("dir/baz.cee")));
>> +  // Now we transfer across languages, so drop -std too.
>> +  EXPECT_EQ(getCommand("foo.c"), "clang -D dir/foo.cpp");
>> +}
>> +
>> +TEST_F(InterpolateTest, Strip) {
>> +  add("dir/foo.cpp", "-o foo.o -Wall");
>> +  // the -o option and the input file are removed, but -Wall is
>> preserved.
>> +  EXPECT_EQ(getCommand("dir/bar.cpp"), "clang -D dir/foo.cpp -Wall");
>> +}
>> +
>> +TEST_F(InterpolateTest, Case) {
>> +  add("FOO/BAR/BAZ/SHOUT.cc");
>> +  add("foo/bar/baz/quiet.cc");
>> +  // Case mismatches are completely ignored, so we choose the name match.
>> +  EXPECT_EQ(getCommand("foo/bar/baz/shout.C"), "clang -D
>> FOO/BAR/BAZ/SHOUT.cc");
>> +}
>> +
>>  } // end namespace tooling
>>  } // end namespace clang
>>
>>
>> _______________________________________________
>> cfe-commits mailing list
>> cfe-commits at lists.llvm.org
>> http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20180410/0a57ec71/attachment-0001.html>


More information about the cfe-commits mailing list