clang-tools  14.0.0git
CompileCommands.cpp
Go to the documentation of this file.
1 //===--- CompileCommands.cpp ----------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "CompileCommands.h"
10 #include "Config.h"
11 #include "support/Logger.h"
12 #include "support/Trace.h"
13 #include "clang/Driver/Driver.h"
14 #include "clang/Driver/Options.h"
15 #include "clang/Driver/ToolChain.h"
16 #include "clang/Frontend/CompilerInvocation.h"
17 #include "clang/Tooling/ArgumentsAdjusters.h"
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/Option/ArgList.h"
23 #include "llvm/Option/Option.h"
24 #include "llvm/Support/Allocator.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/FileSystem.h"
27 #include "llvm/Support/FileUtilities.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/Path.h"
30 #include "llvm/Support/Program.h"
31 #include <iterator>
32 #include <string>
33 #include <vector>
34 
35 namespace clang {
36 namespace clangd {
37 namespace {
38 
39 // Query apple's `xcrun` launcher, which is the source of truth for "how should"
40 // clang be invoked on this system.
41 llvm::Optional<std::string> queryXcrun(llvm::ArrayRef<llvm::StringRef> Argv) {
42  auto Xcrun = llvm::sys::findProgramByName("xcrun");
43  if (!Xcrun) {
44  log("Couldn't find xcrun. Hopefully you have a non-apple toolchain...");
45  return llvm::None;
46  }
47  llvm::SmallString<64> OutFile;
48  llvm::sys::fs::createTemporaryFile("clangd-xcrun", "", OutFile);
49  llvm::FileRemover OutRemover(OutFile);
50  llvm::Optional<llvm::StringRef> Redirects[3] = {
51  /*stdin=*/{""}, /*stdout=*/{OutFile}, /*stderr=*/{""}};
52  vlog("Invoking {0} to find clang installation", *Xcrun);
53  int Ret = llvm::sys::ExecuteAndWait(*Xcrun, Argv,
54  /*Env=*/llvm::None, Redirects,
55  /*SecondsToWait=*/10);
56  if (Ret != 0) {
57  log("xcrun exists but failed with code {0}. "
58  "If you have a non-apple toolchain, this is OK. "
59  "Otherwise, try xcode-select --install.",
60  Ret);
61  return llvm::None;
62  }
63 
64  auto Buf = llvm::MemoryBuffer::getFile(OutFile);
65  if (!Buf) {
66  log("Can't read xcrun output: {0}", Buf.getError().message());
67  return llvm::None;
68  }
69  StringRef Path = Buf->get()->getBuffer().trim();
70  if (Path.empty()) {
71  log("xcrun produced no output");
72  return llvm::None;
73  }
74  return Path.str();
75 }
76 
77 // Resolve symlinks if possible.
78 std::string resolve(std::string Path) {
79  llvm::SmallString<128> Resolved;
80  if (llvm::sys::fs::real_path(Path, Resolved)) {
81  log("Failed to resolve possible symlink {0}", Path);
82  return Path;
83  }
84  return std::string(Resolved.str());
85 }
86 
87 // Get a plausible full `clang` path.
88 // This is used in the fallback compile command, or when the CDB returns a
89 // generic driver with no path.
90 std::string detectClangPath() {
91  // The driver and/or cc1 sometimes depend on the binary name to compute
92  // useful things like the standard library location.
93  // We need to emulate what clang on this system is likely to see.
94  // cc1 in particular looks at the "real path" of the running process, and
95  // so if /usr/bin/clang is a symlink, it sees the resolved path.
96  // clangd doesn't have that luxury, so we resolve symlinks ourselves.
97 
98  // On Mac, `which clang` is /usr/bin/clang. It runs `xcrun clang`, which knows
99  // where the real clang is kept. We need to do the same thing,
100  // because cc1 (not the driver!) will find libc++ relative to argv[0].
101 #ifdef __APPLE__
102  if (auto MacClang = queryXcrun({"xcrun", "--find", "clang"}))
103  return resolve(std::move(*MacClang));
104 #endif
105  // On other platforms, just look for compilers on the PATH.
106  for (const char *Name : {"clang", "gcc", "cc"})
107  if (auto PathCC = llvm::sys::findProgramByName(Name))
108  return resolve(std::move(*PathCC));
109  // Fallback: a nonexistent 'clang' binary next to clangd.
110  static int StaticForMainAddr;
111  std::string ClangdExecutable =
112  llvm::sys::fs::getMainExecutable("clangd", (void *)&StaticForMainAddr);
113  SmallString<128> ClangPath;
114  ClangPath = llvm::sys::path::parent_path(ClangdExecutable);
115  llvm::sys::path::append(ClangPath, "clang");
116  return std::string(ClangPath.str());
117 }
118 
119 // On mac, /usr/bin/clang sets SDKROOT and then invokes the real clang.
120 // The effect of this is to set -isysroot correctly. We do the same.
121 const llvm::Optional<std::string> detectSysroot() {
122 #ifndef __APPLE__
123  return llvm::None;
124 #endif
125 
126  // SDKROOT overridden in environment, respect it. Driver will set isysroot.
127  if (::getenv("SDKROOT"))
128  return llvm::None;
129  return queryXcrun({"xcrun", "--show-sdk-path"});
130 }
131 
132 std::string detectStandardResourceDir() {
133  static int StaticForMainAddr; // Just an address in this process.
134  return CompilerInvocation::GetResourcesPath("clangd",
135  (void *)&StaticForMainAddr);
136 }
137 
138 // The path passed to argv[0] is important:
139 // - its parent directory is Driver::Dir, used for library discovery
140 // - its basename affects CLI parsing (clang-cl) and other settings
141 // Where possible it should be an absolute path with sensible directory, but
142 // with the original basename.
143 static std::string resolveDriver(llvm::StringRef Driver, bool FollowSymlink,
144  llvm::Optional<std::string> ClangPath) {
145  auto SiblingOf = [&](llvm::StringRef AbsPath) {
146  llvm::SmallString<128> Result = llvm::sys::path::parent_path(AbsPath);
147  llvm::sys::path::append(Result, llvm::sys::path::filename(Driver));
148  return Result.str().str();
149  };
150 
151  // First, eliminate relative paths.
152  std::string Storage;
153  if (!llvm::sys::path::is_absolute(Driver)) {
154  // If it's working-dir relative like bin/clang, we can't resolve it.
155  // FIXME: we could if we had the working directory here.
156  // Let's hope it's not a symlink.
157  if (llvm::any_of(Driver,
158  [](char C) { return llvm::sys::path::is_separator(C); }))
159  return Driver.str();
160  // If the driver is a generic like "g++" with no path, add clang dir.
161  if (ClangPath &&
162  (Driver == "clang" || Driver == "clang++" || Driver == "gcc" ||
163  Driver == "g++" || Driver == "cc" || Driver == "c++")) {
164  return SiblingOf(*ClangPath);
165  }
166  // Otherwise try to look it up on PATH. This won't change basename.
167  auto Absolute = llvm::sys::findProgramByName(Driver);
168  if (Absolute && llvm::sys::path::is_absolute(*Absolute))
169  Driver = Storage = std::move(*Absolute);
170  else if (ClangPath) // If we don't find it, use clang dir again.
171  return SiblingOf(*ClangPath);
172  else // Nothing to do: can't find the command and no detected dir.
173  return Driver.str();
174  }
175 
176  // Now we have an absolute path, but it may be a symlink.
177  assert(llvm::sys::path::is_absolute(Driver));
178  if (FollowSymlink) {
179  llvm::SmallString<256> Resolved;
180  if (!llvm::sys::fs::real_path(Driver, Resolved))
181  return SiblingOf(Resolved);
182  }
183  return Driver.str();
184 }
185 
186 } // namespace
187 
189  CommandMangler Result;
190  Result.ClangPath = detectClangPath();
191  Result.ResourceDir = detectStandardResourceDir();
192  Result.Sysroot = detectSysroot();
193  return Result;
194 }
195 
197 
198 void CommandMangler::adjust(std::vector<std::string> &Cmd,
199  llvm::StringRef File) const {
200  trace::Span S("AdjustCompileFlags");
201  // Most of the modifications below assumes the Cmd starts with a driver name.
202  // We might consider injecting a generic driver name like "cc" or "c++", but
203  // a Cmd missing the driver is probably rare enough in practice and errnous.
204  if (Cmd.empty())
205  return;
206  auto &OptTable = clang::driver::getDriverOptTable();
207  // OriginalArgs needs to outlive ArgList.
208  llvm::SmallVector<const char *, 16> OriginalArgs;
209  OriginalArgs.reserve(Cmd.size());
210  for (const auto &S : Cmd)
211  OriginalArgs.push_back(S.c_str());
212  bool IsCLMode = driver::IsClangCL(driver::getDriverMode(
213  OriginalArgs[0], llvm::makeArrayRef(OriginalArgs).slice(1)));
214  // ParseArgs propagates missig arg/opt counts on error, but preserves
215  // everything it could parse in ArgList. So we just ignore those counts.
216  unsigned IgnoredCount;
217  // Drop the executable name, as ParseArgs doesn't expect it. This means
218  // indices are actually of by one between ArgList and OriginalArgs.
219  llvm::opt::InputArgList ArgList;
220  ArgList = OptTable.ParseArgs(
221  llvm::makeArrayRef(OriginalArgs).drop_front(), IgnoredCount, IgnoredCount,
222  /*FlagsToInclude=*/
223  IsCLMode ? (driver::options::CLOption | driver::options::CoreOption)
224  : /*everything*/ 0,
225  /*FlagsToExclude=*/driver::options::NoDriverOption |
226  (IsCLMode ? 0 : driver::options::CLOption));
227 
228  llvm::SmallVector<unsigned, 1> IndicesToDrop;
229  // Having multiple architecture options (e.g. when building fat binaries)
230  // results in multiple compiler jobs, which clangd cannot handle. In such
231  // cases strip all the `-arch` options and fallback to default architecture.
232  // As there are no signals to figure out which one user actually wants. They
233  // can explicitly specify one through `CompileFlags.Add` if need be.
234  unsigned ArchOptCount = 0;
235  for (auto *Input : ArgList.filtered(driver::options::OPT_arch)) {
236  ++ArchOptCount;
237  for (auto I = 0U; I <= Input->getNumValues(); ++I)
238  IndicesToDrop.push_back(Input->getIndex() + I);
239  }
240  // If there is a single `-arch` option, keep it.
241  if (ArchOptCount < 2)
242  IndicesToDrop.clear();
243 
244  // Strip all the inputs and `--`. We'll put the input for the requested file
245  // explicitly at the end of the flags. This ensures modifications done in the
246  // following steps apply in more cases (like setting -x, which only affects
247  // inputs that come after it).
248  for (auto *Input : ArgList.filtered(driver::options::OPT_INPUT))
249  IndicesToDrop.push_back(Input->getIndex());
250  // Anything after `--` is also treated as input, drop them as well.
251  if (auto *DashDash =
252  ArgList.getLastArgNoClaim(driver::options::OPT__DASH_DASH)) {
253  Cmd.resize(DashDash->getIndex() + 1); // +1 to account for Cmd[0].
254  }
255  llvm::sort(IndicesToDrop);
256  llvm::for_each(llvm::reverse(IndicesToDrop),
257  // +1 to account for the executable name in Cmd[0] that
258  // doesn't exist in ArgList.
259  [&Cmd](unsigned Idx) { Cmd.erase(Cmd.begin() + Idx + 1); });
260  // All the inputs are stripped, append the name for the requested file. Rest
261  // of the modifications should respect `--`.
262  Cmd.push_back("--");
263  Cmd.push_back(File.str());
264 
265  for (auto &Edit : Config::current().CompileFlags.Edits)
266  Edit(Cmd);
267 
268  // Check whether the flag exists, either as -flag or -flag=*
269  auto Has = [&](llvm::StringRef Flag) {
270  for (llvm::StringRef Arg : Cmd) {
271  if (Arg.consume_front(Flag) && (Arg.empty() || Arg[0] == '='))
272  return true;
273  }
274  return false;
275  };
276 
277  llvm::erase_if(Cmd, [](llvm::StringRef Elem) {
278  return Elem.startswith("--save-temps") || Elem.startswith("-save-temps");
279  });
280 
281  std::vector<std::string> ToAppend;
282  if (ResourceDir && !Has("-resource-dir"))
283  ToAppend.push_back(("-resource-dir=" + *ResourceDir));
284 
285  // Don't set `-isysroot` if it is already set or if `--sysroot` is set.
286  // `--sysroot` is a superset of the `-isysroot` argument.
287  if (Sysroot && !Has("-isysroot") && !Has("--sysroot")) {
288  ToAppend.push_back("-isysroot");
289  ToAppend.push_back(*Sysroot);
290  }
291 
292  if (!ToAppend.empty()) {
293  Cmd.insert(llvm::find(Cmd, "--"), std::make_move_iterator(ToAppend.begin()),
294  std::make_move_iterator(ToAppend.end()));
295  }
296 
297  if (!Cmd.empty()) {
298  bool FollowSymlink = !Has("-no-canonical-prefixes");
299  Cmd.front() =
300  (FollowSymlink ? ResolvedDrivers : ResolvedDriversNoFollow)
301  .get(Cmd.front(), [&, this] {
302  return resolveDriver(Cmd.front(), FollowSymlink, ClangPath);
303  });
304  }
305 }
306 
307 CommandMangler::operator clang::tooling::ArgumentsAdjuster() && {
308  // ArgumentsAdjuster is a std::function and so must be copyable.
309  return [Mangler = std::make_shared<CommandMangler>(std::move(*this))](
310  const std::vector<std::string> &Args, llvm::StringRef File) {
311  auto Result = Args;
312  Mangler->adjust(Result, File);
313  return Result;
314  };
315 }
316 
317 // ArgStripper implementation
318 namespace {
319 
320 // Determine total number of args consumed by this option.
321 // Return answers for {Exact, Prefix} match. 0 means not allowed.
322 std::pair<unsigned, unsigned> getArgCount(const llvm::opt::Option &Opt) {
323  constexpr static unsigned Rest = 10000; // Should be all the rest!
324  // Reference is llvm::opt::Option::acceptInternal()
325  using llvm::opt::Option;
326  switch (Opt.getKind()) {
327  case Option::FlagClass:
328  return {1, 0};
329  case Option::JoinedClass:
330  case Option::CommaJoinedClass:
331  return {1, 1};
332  case Option::GroupClass:
333  case Option::InputClass:
334  case Option::UnknownClass:
335  case Option::ValuesClass:
336  return {1, 0};
337  case Option::JoinedAndSeparateClass:
338  return {2, 2};
339  case Option::SeparateClass:
340  return {2, 0};
341  case Option::MultiArgClass:
342  return {1 + Opt.getNumArgs(), 0};
343  case Option::JoinedOrSeparateClass:
344  return {2, 1};
345  case Option::RemainingArgsClass:
346  return {Rest, 0};
347  case Option::RemainingArgsJoinedClass:
348  return {Rest, Rest};
349  }
350  llvm_unreachable("Unhandled option kind");
351 }
352 
353 // Flag-parsing mode, which affects which flags are available.
354 enum DriverMode : unsigned char {
355  DM_None = 0,
356  DM_GCC = 1, // Default mode e.g. when invoked as 'clang'
357  DM_CL = 2, // MS CL.exe compatible mode e.g. when invoked as 'clang-cl'
358  DM_CC1 = 4, // When invoked as 'clang -cc1' or after '-Xclang'
359  DM_All = 7
360 };
361 
362 // Examine args list to determine if we're in GCC, CL-compatible, or cc1 mode.
363 DriverMode getDriverMode(const std::vector<std::string> &Args) {
364  DriverMode Mode = DM_GCC;
365  llvm::StringRef Argv0 = Args.front();
366  if (Argv0.endswith_insensitive(".exe"))
367  Argv0 = Argv0.drop_back(strlen(".exe"));
368  if (Argv0.endswith_insensitive("cl"))
369  Mode = DM_CL;
370  for (const llvm::StringRef Arg : Args) {
371  if (Arg == "--driver-mode=cl") {
372  Mode = DM_CL;
373  break;
374  }
375  if (Arg == "-cc1") {
376  Mode = DM_CC1;
377  break;
378  }
379  }
380  return Mode;
381 }
382 
383 // Returns the set of DriverModes where an option may be used.
384 unsigned char getModes(const llvm::opt::Option &Opt) {
385  // Why is this so complicated?!
386  // Reference is clang::driver::Driver::getIncludeExcludeOptionFlagMasks()
387  unsigned char Result = DM_None;
388  if (Opt.hasFlag(driver::options::CC1Option))
389  Result |= DM_CC1;
390  if (!Opt.hasFlag(driver::options::NoDriverOption)) {
391  if (Opt.hasFlag(driver::options::CLOption)) {
392  Result |= DM_CL;
393  } else {
394  Result |= DM_GCC;
395  if (Opt.hasFlag(driver::options::CoreOption)) {
396  Result |= DM_CL;
397  }
398  }
399  }
400  return Result;
401 }
402 
403 } // namespace
404 
405 llvm::ArrayRef<ArgStripper::Rule> ArgStripper::rulesFor(llvm::StringRef Arg) {
406  // All the hard work is done once in a static initializer.
407  // We compute a table containing strings to look for and #args to skip.
408  // e.g. "-x" => {-x 2 args, -x* 1 arg, --language 2 args, --language=* 1 arg}
409  using TableTy =
410  llvm::StringMap<llvm::SmallVector<Rule, 4>, llvm::BumpPtrAllocator>;
411  static TableTy *Table = [] {
412  auto &DriverTable = driver::getDriverOptTable();
413  using DriverID = clang::driver::options::ID;
414 
415  // Collect sets of aliases, so we can treat -foo and -foo= as synonyms.
416  // Conceptually a double-linked list: PrevAlias[I] -> I -> NextAlias[I].
417  // If PrevAlias[I] is INVALID, then I is canonical.
418  DriverID PrevAlias[DriverID::LastOption] = {DriverID::OPT_INVALID};
419  DriverID NextAlias[DriverID::LastOption] = {DriverID::OPT_INVALID};
420  auto AddAlias = [&](DriverID Self, DriverID T) {
421  if (NextAlias[T]) {
422  PrevAlias[NextAlias[T]] = Self;
423  NextAlias[Self] = NextAlias[T];
424  }
425  PrevAlias[Self] = T;
426  NextAlias[T] = Self;
427  };
428  // Also grab prefixes for each option, these are not fully exposed.
429  const char *const *Prefixes[DriverID::LastOption] = {nullptr};
430 #define PREFIX(NAME, VALUE) static const char *const NAME[] = VALUE;
431 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
432  HELP, METAVAR, VALUES) \
433  if (DriverID::OPT_##ALIAS != DriverID::OPT_INVALID && ALIASARGS == nullptr) \
434  AddAlias(DriverID::OPT_##ID, DriverID::OPT_##ALIAS); \
435  Prefixes[DriverID::OPT_##ID] = PREFIX;
436 #include "clang/Driver/Options.inc"
437 #undef OPTION
438 #undef PREFIX
439 
440  auto Result = std::make_unique<TableTy>();
441  // Iterate over distinct options (represented by the canonical alias).
442  // Every spelling of this option will get the same set of rules.
443  for (unsigned ID = 1 /*Skip INVALID */; ID < DriverID::LastOption; ++ID) {
444  if (PrevAlias[ID] || ID == DriverID::OPT_Xclang)
445  continue; // Not canonical, or specially handled.
446  llvm::SmallVector<Rule> Rules;
447  // Iterate over each alias, to add rules for parsing it.
448  for (unsigned A = ID; A != DriverID::OPT_INVALID; A = NextAlias[A]) {
449  if (Prefixes[A] == nullptr) // option groups.
450  continue;
451  auto Opt = DriverTable.getOption(A);
452  // Exclude - and -foo pseudo-options.
453  if (Opt.getName().empty())
454  continue;
455  auto Modes = getModes(Opt);
456  std::pair<unsigned, unsigned> ArgCount = getArgCount(Opt);
457  // Iterate over each spelling of the alias, e.g. -foo vs --foo.
458  for (auto *Prefix = Prefixes[A]; *Prefix != nullptr; ++Prefix) {
459  llvm::SmallString<64> Buf(*Prefix);
460  Buf.append(Opt.getName());
461  llvm::StringRef Spelling = Result->try_emplace(Buf).first->getKey();
462  Rules.emplace_back();
463  Rule &R = Rules.back();
464  R.Text = Spelling;
465  R.Modes = Modes;
466  R.ExactArgs = ArgCount.first;
467  R.PrefixArgs = ArgCount.second;
468  // Concrete priority is the index into the option table.
469  // Effectively, earlier entries take priority over later ones.
470  assert(ID < std::numeric_limits<decltype(R.Priority)>::max() &&
471  "Rules::Priority overflowed by options table");
472  R.Priority = ID;
473  }
474  }
475  // Register the set of rules under each possible name.
476  for (const auto &R : Rules)
477  Result->find(R.Text)->second.append(Rules.begin(), Rules.end());
478  }
479 #ifndef NDEBUG
480  // Dump the table and various measures of its size.
481  unsigned RuleCount = 0;
482  dlog("ArgStripper Option spelling table");
483  for (const auto &Entry : *Result) {
484  dlog("{0}", Entry.first());
485  RuleCount += Entry.second.size();
486  for (const auto &R : Entry.second)
487  dlog(" {0} #={1} *={2} Mode={3}", R.Text, R.ExactArgs, R.PrefixArgs,
488  int(R.Modes));
489  }
490  dlog("Table spellings={0} rules={1} string-bytes={2}", Result->size(),
491  RuleCount, Result->getAllocator().getBytesAllocated());
492 #endif
493  // The static table will never be destroyed.
494  return Result.release();
495  }();
496 
497  auto It = Table->find(Arg);
498  return (It == Table->end()) ? llvm::ArrayRef<Rule>() : It->second;
499 }
500 
501 void ArgStripper::strip(llvm::StringRef Arg) {
502  auto OptionRules = rulesFor(Arg);
503  if (OptionRules.empty()) {
504  // Not a recognized flag. Strip it literally.
505  Storage.emplace_back(Arg);
506  Rules.emplace_back();
507  Rules.back().Text = Storage.back();
508  Rules.back().ExactArgs = 1;
509  if (Rules.back().Text.consume_back("*"))
510  Rules.back().PrefixArgs = 1;
511  Rules.back().Modes = DM_All;
512  Rules.back().Priority = -1; // Max unsigned = lowest priority.
513  } else {
514  Rules.append(OptionRules.begin(), OptionRules.end());
515  }
516 }
517 
518 const ArgStripper::Rule *ArgStripper::matchingRule(llvm::StringRef Arg,
519  unsigned Mode,
520  unsigned &ArgCount) const {
521  const ArgStripper::Rule *BestRule = nullptr;
522  for (const Rule &R : Rules) {
523  // Rule can fail to match if...
524  if (!(R.Modes & Mode))
525  continue; // not applicable to current driver mode
526  if (BestRule && BestRule->Priority < R.Priority)
527  continue; // lower-priority than best candidate.
528  if (!Arg.startswith(R.Text))
529  continue; // current arg doesn't match the prefix string
530  bool PrefixMatch = Arg.size() > R.Text.size();
531  // Can rule apply as an exact/prefix match?
532  if (unsigned Count = PrefixMatch ? R.PrefixArgs : R.ExactArgs) {
533  BestRule = &R;
534  ArgCount = Count;
535  }
536  // Continue in case we find a higher-priority rule.
537  }
538  return BestRule;
539 }
540 
541 void ArgStripper::process(std::vector<std::string> &Args) const {
542  if (Args.empty())
543  return;
544 
545  // We're parsing the args list in some mode (e.g. gcc-compatible) but may
546  // temporarily switch to another mode with the -Xclang flag.
547  DriverMode MainMode = getDriverMode(Args);
548  DriverMode CurrentMode = MainMode;
549 
550  // Read and write heads for in-place deletion.
551  unsigned Read = 0, Write = 0;
552  bool WasXclang = false;
553  while (Read < Args.size()) {
554  unsigned ArgCount = 0;
555  if (matchingRule(Args[Read], CurrentMode, ArgCount)) {
556  // Delete it and its args.
557  if (WasXclang) {
558  assert(Write > 0);
559  --Write; // Drop previous -Xclang arg
560  CurrentMode = MainMode;
561  WasXclang = false;
562  }
563  // Advance to last arg. An arg may be foo or -Xclang foo.
564  for (unsigned I = 1; Read < Args.size() && I < ArgCount; ++I) {
565  ++Read;
566  if (Read < Args.size() && Args[Read] == "-Xclang")
567  ++Read;
568  }
569  } else {
570  // No match, just copy the arg through.
571  WasXclang = Args[Read] == "-Xclang";
572  CurrentMode = WasXclang ? DM_CC1 : MainMode;
573  if (Write != Read)
574  Args[Write] = std::move(Args[Read]);
575  ++Write;
576  }
577  ++Read;
578  }
579  Args.resize(Write);
580 }
581 
582 std::string printArgv(llvm::ArrayRef<llvm::StringRef> Args) {
583  std::string Buf;
584  llvm::raw_string_ostream OS(Buf);
585  bool Sep = false;
586  for (llvm::StringRef Arg : Args) {
587  if (Sep)
588  OS << ' ';
589  Sep = true;
590  if (llvm::all_of(Arg, llvm::isPrint) &&
591  Arg.find_first_of(" \t\n\"\\") == llvm::StringRef::npos) {
592  OS << Arg;
593  continue;
594  }
595  OS << '"';
596  OS.write_escaped(Arg, /*UseHexEscapes=*/true);
597  OS << '"';
598  }
599  return std::move(OS.str());
600 }
601 
602 std::string printArgv(llvm::ArrayRef<std::string> Args) {
603  std::vector<llvm::StringRef> Refs(Args.size());
604  llvm::copy(Args, Refs.begin());
605  return printArgv(Refs);
606 }
607 
608 } // namespace clangd
609 } // namespace clang
dlog
#define dlog(...)
Definition: Logger.h:102
clang::clangd::Edit
A set of edits generated for a single file.
Definition: SourceCode.h:183
clang::clangd::printArgv
std::string printArgv(llvm::ArrayRef< llvm::StringRef > Args)
Definition: CompileCommands.cpp:582
Refs
RefSlab Refs
Definition: SymbolCollectorTests.cpp:311
clang::clangd::Path
std::string Path
A typedef to represent a file path.
Definition: Path.h:26
clang::clangd::Config::Edits
std::vector< llvm::unique_function< void(std::vector< std::string > &) const > > Edits
Edits to apply to the compile command, in sequence.
Definition: Config.h:65
clang::clangd::ArgStripper::strip
void strip(llvm::StringRef Arg)
Definition: CompileCommands.cpp:501
clang::clangd::ArgStripper::process
void process(std::vector< std::string > &Args) const
Definition: CompileCommands.cpp:541
Trace.h
clang::clangd::CommandMangler
Definition: CompileCommands.h:29
clang::clangd::CommandMangler::ResourceDir
llvm::Optional< std::string > ResourceDir
Definition: CompileCommands.h:33
ns1::ns2::A
@ A
Definition: CategoricalFeature.h:3
clang::clangd::CommandMangler::detect
static CommandMangler detect()
Definition: CompileCommands.cpp:188
CompileCommands.h
Logger.h
Args
llvm::json::Object Args
Definition: Trace.cpp:139
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::clangd::CommandMangler::adjust
void adjust(std::vector< std::string > &Cmd, llvm::StringRef File) const
Definition: CompileCommands.cpp:198
clang::clangd::vlog
void vlog(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:73
clang::clangd::CommandMangler::Sysroot
llvm::Optional< std::string > Sysroot
Definition: CompileCommands.h:35
Argv0
const char * Argv0
Definition: Modularize.cpp:333
clang::clangd::DocumentHighlightKind::Write
@ Write
clang::clangd::log
void log(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:68
Entry
Definition: Modularize.cpp:428
Config.h
ID
static char ID
Definition: Logger.cpp:74
clang::clangd::RefSlab::begin
const_iterator begin() const
Definition: Ref.h:121
clang::clangd::CommandMangler::ClangPath
llvm::Optional< std::string > ClangPath
Definition: CompileCommands.h:31
C
const Criteria C
Definition: FunctionCognitiveComplexityCheck.cpp:93
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
OS
llvm::raw_string_ostream OS
Definition: TraceTests.cpp:163
clang::clangd::Config::current
static const Config & current()
Returns the Config of the current Context, or an empty configuration.
Definition: Config.cpp:17
clang::clangd::DocumentHighlightKind::Read
@ Read
clang::clangd::CommandMangler::forTests
static CommandMangler forTests()
Definition: CompileCommands.cpp:196
clang::clangd::trace::Span
Records an event whose duration is the lifetime of the Span object.
Definition: Trace.h:143