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 
188 CommandMangler CommandMangler::detect() {
189   CommandMangler Result;
190   Result.ClangPath = detectClangPath();
191   Result.ResourceDir = detectStandardResourceDir();
192   Result.Sysroot = detectSysroot();
193   return Result;
194 }
195 
196 CommandMangler CommandMangler::forTests() { return CommandMangler(); }
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   // In some cases people may try to reuse the command from another file, e.g.
245   //   { File: "foo.h", CommandLine: "clang foo.cpp" }.
246   // We assume the intent is to parse foo.h the same way as foo.cpp, or as if
247   // it were being included from foo.cpp.
248   //
249   // We're going to rewrite the command to refer to foo.h, and this may change
250   // its semantics (e.g. by parsing the file as C). If we do this, we should
251   // use transferCompileCommand to adjust the argv.
252   // In practice only the extension of the file matters, so do this only when
253   // it differs.
254   llvm::StringRef FileExtension = llvm::sys::path::extension(File);
255   llvm::Optional<std::string> TransferFrom;
256   auto SawInput = [&](llvm::StringRef Input) {
257     if (llvm::sys::path::extension(Input) != FileExtension)
258       TransferFrom.emplace(Input);
259   };
260 
261   // Strip all the inputs and `--`. We'll put the input for the requested file
262   // explicitly at the end of the flags. This ensures modifications done in the
263   // following steps apply in more cases (like setting -x, which only affects
264   // inputs that come after it).
265   for (auto *Input : ArgList.filtered(driver::options::OPT_INPUT)) {
266     SawInput(Input->getValue(0));
267     IndicesToDrop.push_back(Input->getIndex());
268   }
269   // Anything after `--` is also treated as input, drop them as well.
270   if (auto *DashDash =
271           ArgList.getLastArgNoClaim(driver::options::OPT__DASH_DASH)) {
272     auto DashDashIndex = DashDash->getIndex() + 1; // +1 accounts for Cmd[0]
273     for (unsigned I = DashDashIndex; I < Cmd.size(); ++I)
274       SawInput(Cmd[I]);
275     Cmd.resize(DashDashIndex);
276   }
277   llvm::sort(IndicesToDrop);
278   llvm::for_each(llvm::reverse(IndicesToDrop),
279                  // +1 to account for the executable name in Cmd[0] that
280                  // doesn't exist in ArgList.
281                  [&Cmd](unsigned Idx) { Cmd.erase(Cmd.begin() + Idx + 1); });
282   // All the inputs are stripped, append the name for the requested file. Rest
283   // of the modifications should respect `--`.
284   Cmd.push_back("--");
285   Cmd.push_back(File.str());
286 
287   if (TransferFrom) {
288     tooling::CompileCommand TransferCmd;
289     TransferCmd.Filename = std::move(*TransferFrom);
290     TransferCmd.CommandLine = std::move(Cmd);
291     TransferCmd = transferCompileCommand(std::move(TransferCmd), File);
292     Cmd = std::move(TransferCmd.CommandLine);
293     assert(Cmd.size() >= 2 && Cmd.back() == File &&
294            Cmd[Cmd.size() - 2] == "--" &&
295            "TransferCommand should produce a command ending in -- filename");
296   }
297 
298   for (auto &Edit : Config::current().CompileFlags.Edits)
299     Edit(Cmd);
300 
301   // Check whether the flag exists, either as -flag or -flag=*
302   auto Has = [&](llvm::StringRef Flag) {
303     for (llvm::StringRef Arg : Cmd) {
304       if (Arg.consume_front(Flag) && (Arg.empty() || Arg[0] == '='))
305         return true;
306     }
307     return false;
308   };
309 
310   llvm::erase_if(Cmd, [](llvm::StringRef Elem) {
311     return Elem.startswith("--save-temps") || Elem.startswith("-save-temps");
312   });
313 
314   std::vector<std::string> ToAppend;
315   if (ResourceDir && !Has("-resource-dir"))
316     ToAppend.push_back(("-resource-dir=" + *ResourceDir));
317 
318   // Don't set `-isysroot` if it is already set or if `--sysroot` is set.
319   // `--sysroot` is a superset of the `-isysroot` argument.
320   if (Sysroot && !Has("-isysroot") && !Has("--sysroot")) {
321     ToAppend.push_back("-isysroot");
322     ToAppend.push_back(*Sysroot);
323   }
324 
325   if (!ToAppend.empty()) {
326     Cmd.insert(llvm::find(Cmd, "--"), std::make_move_iterator(ToAppend.begin()),
327                std::make_move_iterator(ToAppend.end()));
328   }
329 
330   if (!Cmd.empty()) {
331     bool FollowSymlink = !Has("-no-canonical-prefixes");
332     Cmd.front() =
333         (FollowSymlink ? ResolvedDrivers : ResolvedDriversNoFollow)
334             .get(Cmd.front(), [&, this] {
335               return resolveDriver(Cmd.front(), FollowSymlink, ClangPath);
336             });
337   }
338 }
339 
340 CommandMangler::operator clang::tooling::ArgumentsAdjuster() && {
341   // ArgumentsAdjuster is a std::function and so must be copyable.
342   return [Mangler = std::make_shared<CommandMangler>(std::move(*this))](
343              const std::vector<std::string> &Args, llvm::StringRef File) {
344     auto Result = Args;
345     Mangler->adjust(Result, File);
346     return Result;
347   };
348 }
349 
350 // ArgStripper implementation
351 namespace {
352 
353 // Determine total number of args consumed by this option.
354 // Return answers for {Exact, Prefix} match. 0 means not allowed.
355 std::pair<unsigned, unsigned> getArgCount(const llvm::opt::Option &Opt) {
356   constexpr static unsigned Rest = 10000; // Should be all the rest!
357   // Reference is llvm::opt::Option::acceptInternal()
358   using llvm::opt::Option;
359   switch (Opt.getKind()) {
360   case Option::FlagClass:
361     return {1, 0};
362   case Option::JoinedClass:
363   case Option::CommaJoinedClass:
364     return {1, 1};
365   case Option::GroupClass:
366   case Option::InputClass:
367   case Option::UnknownClass:
368   case Option::ValuesClass:
369     return {1, 0};
370   case Option::JoinedAndSeparateClass:
371     return {2, 2};
372   case Option::SeparateClass:
373     return {2, 0};
374   case Option::MultiArgClass:
375     return {1 + Opt.getNumArgs(), 0};
376   case Option::JoinedOrSeparateClass:
377     return {2, 1};
378   case Option::RemainingArgsClass:
379     return {Rest, 0};
380   case Option::RemainingArgsJoinedClass:
381     return {Rest, Rest};
382   }
383   llvm_unreachable("Unhandled option kind");
384 }
385 
386 // Flag-parsing mode, which affects which flags are available.
387 enum DriverMode : unsigned char {
388   DM_None = 0,
389   DM_GCC = 1, // Default mode e.g. when invoked as 'clang'
390   DM_CL = 2,  // MS CL.exe compatible mode e.g. when invoked as 'clang-cl'
391   DM_CC1 = 4, // When invoked as 'clang -cc1' or after '-Xclang'
392   DM_All = 7
393 };
394 
395 // Examine args list to determine if we're in GCC, CL-compatible, or cc1 mode.
396 DriverMode getDriverMode(const std::vector<std::string> &Args) {
397   DriverMode Mode = DM_GCC;
398   llvm::StringRef Argv0 = Args.front();
399   if (Argv0.endswith_insensitive(".exe"))
400     Argv0 = Argv0.drop_back(strlen(".exe"));
401   if (Argv0.endswith_insensitive("cl"))
402     Mode = DM_CL;
403   for (const llvm::StringRef Arg : Args) {
404     if (Arg == "--driver-mode=cl") {
405       Mode = DM_CL;
406       break;
407     }
408     if (Arg == "-cc1") {
409       Mode = DM_CC1;
410       break;
411     }
412   }
413   return Mode;
414 }
415 
416 // Returns the set of DriverModes where an option may be used.
417 unsigned char getModes(const llvm::opt::Option &Opt) {
418   // Why is this so complicated?!
419   // Reference is clang::driver::Driver::getIncludeExcludeOptionFlagMasks()
420   unsigned char Result = DM_None;
421   if (Opt.hasFlag(driver::options::CC1Option))
422     Result |= DM_CC1;
423   if (!Opt.hasFlag(driver::options::NoDriverOption)) {
424     if (Opt.hasFlag(driver::options::CLOption)) {
425       Result |= DM_CL;
426     } else {
427       Result |= DM_GCC;
428       if (Opt.hasFlag(driver::options::CoreOption)) {
429         Result |= DM_CL;
430       }
431     }
432   }
433   return Result;
434 }
435 
436 } // namespace
437 
438 llvm::ArrayRef<ArgStripper::Rule> ArgStripper::rulesFor(llvm::StringRef Arg) {
439   // All the hard work is done once in a static initializer.
440   // We compute a table containing strings to look for and #args to skip.
441   // e.g. "-x" => {-x 2 args, -x* 1 arg, --language 2 args, --language=* 1 arg}
442   using TableTy =
443       llvm::StringMap<llvm::SmallVector<Rule, 4>, llvm::BumpPtrAllocator>;
444   static TableTy *Table = [] {
445     auto &DriverTable = driver::getDriverOptTable();
446     using DriverID = clang::driver::options::ID;
447 
448     // Collect sets of aliases, so we can treat -foo and -foo= as synonyms.
449     // Conceptually a double-linked list: PrevAlias[I] -> I -> NextAlias[I].
450     // If PrevAlias[I] is INVALID, then I is canonical.
451     DriverID PrevAlias[DriverID::LastOption] = {DriverID::OPT_INVALID};
452     DriverID NextAlias[DriverID::LastOption] = {DriverID::OPT_INVALID};
453     auto AddAlias = [&](DriverID Self, DriverID T) {
454       if (NextAlias[T]) {
455         PrevAlias[NextAlias[T]] = Self;
456         NextAlias[Self] = NextAlias[T];
457       }
458       PrevAlias[Self] = T;
459       NextAlias[T] = Self;
460     };
461     // Also grab prefixes for each option, these are not fully exposed.
462     const char *const *Prefixes[DriverID::LastOption] = {nullptr};
463 #define PREFIX(NAME, VALUE) static const char *const NAME[] = VALUE;
464 #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
465                HELP, METAVAR, VALUES)                                          \
466   if (DriverID::OPT_##ALIAS != DriverID::OPT_INVALID && ALIASARGS == nullptr)  \
467     AddAlias(DriverID::OPT_##ID, DriverID::OPT_##ALIAS);                       \
468   Prefixes[DriverID::OPT_##ID] = PREFIX;
469 #include "clang/Driver/Options.inc"
470 #undef OPTION
471 #undef PREFIX
472 
473     auto Result = std::make_unique<TableTy>();
474     // Iterate over distinct options (represented by the canonical alias).
475     // Every spelling of this option will get the same set of rules.
476     for (unsigned ID = 1 /*Skip INVALID */; ID < DriverID::LastOption; ++ID) {
477       if (PrevAlias[ID] || ID == DriverID::OPT_Xclang)
478         continue; // Not canonical, or specially handled.
479       llvm::SmallVector<Rule> Rules;
480       // Iterate over each alias, to add rules for parsing it.
481       for (unsigned A = ID; A != DriverID::OPT_INVALID; A = NextAlias[A]) {
482         if (Prefixes[A] == nullptr) // option groups.
483           continue;
484         auto Opt = DriverTable.getOption(A);
485         // Exclude - and -foo pseudo-options.
486         if (Opt.getName().empty())
487           continue;
488         auto Modes = getModes(Opt);
489         std::pair<unsigned, unsigned> ArgCount = getArgCount(Opt);
490         // Iterate over each spelling of the alias, e.g. -foo vs --foo.
491         for (auto *Prefix = Prefixes[A]; *Prefix != nullptr; ++Prefix) {
492           llvm::SmallString<64> Buf(*Prefix);
493           Buf.append(Opt.getName());
494           llvm::StringRef Spelling = Result->try_emplace(Buf).first->getKey();
495           Rules.emplace_back();
496           Rule &R = Rules.back();
497           R.Text = Spelling;
498           R.Modes = Modes;
499           R.ExactArgs = ArgCount.first;
500           R.PrefixArgs = ArgCount.second;
501           // Concrete priority is the index into the option table.
502           // Effectively, earlier entries take priority over later ones.
503           assert(ID < std::numeric_limits<decltype(R.Priority)>::max() &&
504                  "Rules::Priority overflowed by options table");
505           R.Priority = ID;
506         }
507       }
508       // Register the set of rules under each possible name.
509       for (const auto &R : Rules)
510         Result->find(R.Text)->second.append(Rules.begin(), Rules.end());
511     }
512 #ifndef NDEBUG
513     // Dump the table and various measures of its size.
514     unsigned RuleCount = 0;
515     dlog("ArgStripper Option spelling table");
516     for (const auto &Entry : *Result) {
517       dlog("{0}", Entry.first());
518       RuleCount += Entry.second.size();
519       for (const auto &R : Entry.second)
520         dlog("  {0} #={1} *={2} Mode={3}", R.Text, R.ExactArgs, R.PrefixArgs,
521              int(R.Modes));
522     }
523     dlog("Table spellings={0} rules={1} string-bytes={2}", Result->size(),
524          RuleCount, Result->getAllocator().getBytesAllocated());
525 #endif
526     // The static table will never be destroyed.
527     return Result.release();
528   }();
529 
530   auto It = Table->find(Arg);
531   return (It == Table->end()) ? llvm::ArrayRef<Rule>() : It->second;
532 }
533 
534 void ArgStripper::strip(llvm::StringRef Arg) {
535   auto OptionRules = rulesFor(Arg);
536   if (OptionRules.empty()) {
537     // Not a recognized flag. Strip it literally.
538     Storage.emplace_back(Arg);
539     Rules.emplace_back();
540     Rules.back().Text = Storage.back();
541     Rules.back().ExactArgs = 1;
542     if (Rules.back().Text.consume_back("*"))
543       Rules.back().PrefixArgs = 1;
544     Rules.back().Modes = DM_All;
545     Rules.back().Priority = -1; // Max unsigned = lowest priority.
546   } else {
547     Rules.append(OptionRules.begin(), OptionRules.end());
548   }
549 }
550 
551 const ArgStripper::Rule *ArgStripper::matchingRule(llvm::StringRef Arg,
552                                                    unsigned Mode,
553                                                    unsigned &ArgCount) const {
554   const ArgStripper::Rule *BestRule = nullptr;
555   for (const Rule &R : Rules) {
556     // Rule can fail to match if...
557     if (!(R.Modes & Mode))
558       continue; // not applicable to current driver mode
559     if (BestRule && BestRule->Priority < R.Priority)
560       continue; // lower-priority than best candidate.
561     if (!Arg.startswith(R.Text))
562       continue; // current arg doesn't match the prefix string
563     bool PrefixMatch = Arg.size() > R.Text.size();
564     // Can rule apply as an exact/prefix match?
565     if (unsigned Count = PrefixMatch ? R.PrefixArgs : R.ExactArgs) {
566       BestRule = &R;
567       ArgCount = Count;
568     }
569     // Continue in case we find a higher-priority rule.
570   }
571   return BestRule;
572 }
573 
574 void ArgStripper::process(std::vector<std::string> &Args) const {
575   if (Args.empty())
576     return;
577 
578   // We're parsing the args list in some mode (e.g. gcc-compatible) but may
579   // temporarily switch to another mode with the -Xclang flag.
580   DriverMode MainMode = getDriverMode(Args);
581   DriverMode CurrentMode = MainMode;
582 
583   // Read and write heads for in-place deletion.
584   unsigned Read = 0, Write = 0;
585   bool WasXclang = false;
586   while (Read < Args.size()) {
587     unsigned ArgCount = 0;
588     if (matchingRule(Args[Read], CurrentMode, ArgCount)) {
589       // Delete it and its args.
590       if (WasXclang) {
591         assert(Write > 0);
592         --Write; // Drop previous -Xclang arg
593         CurrentMode = MainMode;
594         WasXclang = false;
595       }
596       // Advance to last arg. An arg may be foo or -Xclang foo.
597       for (unsigned I = 1; Read < Args.size() && I < ArgCount; ++I) {
598         ++Read;
599         if (Read < Args.size() && Args[Read] == "-Xclang")
600           ++Read;
601       }
602     } else {
603       // No match, just copy the arg through.
604       WasXclang = Args[Read] == "-Xclang";
605       CurrentMode = WasXclang ? DM_CC1 : MainMode;
606       if (Write != Read)
607         Args[Write] = std::move(Args[Read]);
608       ++Write;
609     }
610     ++Read;
611   }
612   Args.resize(Write);
613 }
614 
615 std::string printArgv(llvm::ArrayRef<llvm::StringRef> Args) {
616   std::string Buf;
617   llvm::raw_string_ostream OS(Buf);
618   bool Sep = false;
619   for (llvm::StringRef Arg : Args) {
620     if (Sep)
621       OS << ' ';
622     Sep = true;
623     if (llvm::all_of(Arg, llvm::isPrint) &&
624         Arg.find_first_of(" \t\n\"\\") == llvm::StringRef::npos) {
625       OS << Arg;
626       continue;
627     }
628     OS << '"';
629     OS.write_escaped(Arg, /*UseHexEscapes=*/true);
630     OS << '"';
631   }
632   return std::move(OS.str());
633 }
634 
635 std::string printArgv(llvm::ArrayRef<std::string> Args) {
636   std::vector<llvm::StringRef> Refs(Args.size());
637   llvm::copy(Args, Refs.begin());
638   return printArgv(Refs);
639 }
640 
641 } // namespace clangd
642 } // namespace clang
643