| //===- ArgumentsAdjusters.cpp - Command line arguments adjuster -----------===// | |
| // | |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | |
| // See https://llvm.org/LICENSE.txt for license information. | |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | |
| // | |
| //===----------------------------------------------------------------------===// | |
| // | |
| // This file contains definitions of classes which implement ArgumentsAdjuster | |
| // interface. | |
| // | |
| //===----------------------------------------------------------------------===// | |
| #include "clang/Tooling/ArgumentsAdjusters.h" | |
| #include "clang/Basic/LLVM.h" | |
| #include "llvm/ADT/STLExtras.h" | |
| #include "llvm/ADT/StringRef.h" | |
| #include <cstddef> | |
| #include <vector> | |
| namespace clang { | |
| namespace tooling { | |
| static StringRef getDriverMode(const CommandLineArguments &Args) { | |
| for (StringRef ArgRef : Args) { | |
| if (ArgRef.consume_front("--driver-mode=")) { | |
| return ArgRef; | |
| } | |
| } | |
| return StringRef(); | |
| } | |
| /// Add -fsyntax-only option and drop options that triggers output generation. | |
| ArgumentsAdjuster getClangSyntaxOnlyAdjuster() { | |
| return [](const CommandLineArguments &Args, StringRef /*unused*/) { | |
| CommandLineArguments AdjustedArgs; | |
| bool HasSyntaxOnly = false; | |
| constexpr llvm::StringRef OutputCommands[] = { | |
| // FIXME: Add other options that generate output. | |
| "-save-temps", | |
| "--save-temps", | |
| }; | |
| for (size_t i = 0, e = Args.size(); i < e; ++i) { | |
| StringRef Arg = Args[i]; | |
| // Skip output commands. | |
| if (llvm::any_of(OutputCommands, [&Arg](llvm::StringRef OutputCommand) { | |
| return Arg.starts_with(OutputCommand); | |
| })) | |
| continue; | |
| if (Arg != "-c" && Arg != "-S" && | |
| !Arg.starts_with("-fcolor-diagnostics") && | |
| !Arg.starts_with("-fdiagnostics-color")) | |
| AdjustedArgs.push_back(Args[i]); | |
| // If we strip an option, make sure we strip any preceeding `-Xclang` | |
| // option as well. | |
| // FIXME: This should be added to most argument adjusters! | |
| else if (!AdjustedArgs.empty() && AdjustedArgs.back() == "-Xclang") | |
| AdjustedArgs.pop_back(); | |
| if (Arg == "-fsyntax-only") | |
| HasSyntaxOnly = true; | |
| } | |
| if (!HasSyntaxOnly) | |
| AdjustedArgs = | |
| getInsertArgumentAdjuster("-fsyntax-only")(AdjustedArgs, ""); | |
| return AdjustedArgs; | |
| }; | |
| } | |
| ArgumentsAdjuster getClangStripOutputAdjuster() { | |
| return [](const CommandLineArguments &Args, StringRef /*unused*/) { | |
| CommandLineArguments AdjustedArgs; | |
| for (size_t i = 0, e = Args.size(); i < e; ++i) { | |
| StringRef Arg = Args[i]; | |
| if (!Arg.starts_with("-o")) | |
| AdjustedArgs.push_back(Args[i]); | |
| if (Arg == "-o") { | |
| // Output is specified as -o foo. Skip the next argument too. | |
| ++i; | |
| } | |
| // Else, the output is specified as -ofoo. Just do nothing. | |
| } | |
| return AdjustedArgs; | |
| }; | |
| } | |
| ArgumentsAdjuster getClangStripDependencyFileAdjuster() { | |
| return [](const CommandLineArguments &Args, StringRef /*unused*/) { | |
| auto UsingClDriver = (getDriverMode(Args) == "cl"); | |
| CommandLineArguments AdjustedArgs; | |
| for (size_t i = 0, e = Args.size(); i < e; ++i) { | |
| StringRef Arg = Args[i]; | |
| // These flags take an argument: -MX foo. Skip the next argument also. | |
| if (!UsingClDriver && (Arg == "-MF" || Arg == "-MT" || Arg == "-MQ")) { | |
| ++i; | |
| continue; | |
| } | |
| // When not using the cl driver mode, dependency file generation options | |
| // begin with -M. These include -MM, -MF, -MG, -MP, -MT, -MQ, -MD, and | |
| // -MMD. | |
| if (!UsingClDriver && Arg.starts_with("-M")) | |
| continue; | |
| // Under MSVC's cl driver mode, dependency file generation is controlled | |
| // using /showIncludes | |
| if (Arg.starts_with("/showIncludes") || Arg.starts_with("-showIncludes")) | |
| continue; | |
| AdjustedArgs.push_back(Args[i]); | |
| } | |
| return AdjustedArgs; | |
| }; | |
| } | |
| ArgumentsAdjuster getInsertArgumentAdjuster(const CommandLineArguments &Extra, | |
| ArgumentInsertPosition Pos) { | |
| return [Extra, Pos](const CommandLineArguments &Args, StringRef /*unused*/) { | |
| CommandLineArguments Return(Args); | |
| CommandLineArguments::iterator I; | |
| if (Pos == ArgumentInsertPosition::END) { | |
| I = llvm::find(Return, "--"); | |
| } else { | |
| I = Return.begin(); | |
| ++I; // To leave the program name in place | |
| } | |
| Return.insert(I, Extra.begin(), Extra.end()); | |
| return Return; | |
| }; | |
| } | |
| ArgumentsAdjuster getInsertArgumentAdjuster(const char *Extra, | |
| ArgumentInsertPosition Pos) { | |
| return getInsertArgumentAdjuster(CommandLineArguments(1, Extra), Pos); | |
| } | |
| ArgumentsAdjuster combineAdjusters(ArgumentsAdjuster First, | |
| ArgumentsAdjuster Second) { | |
| if (!First) | |
| return Second; | |
| if (!Second) | |
| return First; | |
| return [First, Second](const CommandLineArguments &Args, StringRef File) { | |
| return Second(First(Args, File), File); | |
| }; | |
| } | |
| ArgumentsAdjuster getStripPluginsAdjuster() { | |
| return [](const CommandLineArguments &Args, StringRef /*unused*/) { | |
| CommandLineArguments AdjustedArgs; | |
| for (size_t I = 0, E = Args.size(); I != E; I++) { | |
| // According to https://clang.llvm.org/docs/ClangPlugins.html | |
| // plugin arguments are in the form: | |
| // -Xclang {-load, -plugin, -plugin-arg-<plugin-name>, -add-plugin} | |
| // -Xclang <arbitrary-argument> | |
| if (I + 4 < E && Args[I] == "-Xclang" && | |
| (Args[I + 1] == "-load" || Args[I + 1] == "-plugin" || | |
| llvm::StringRef(Args[I + 1]).starts_with("-plugin-arg-") || | |
| Args[I + 1] == "-add-plugin") && | |
| Args[I + 2] == "-Xclang") { | |
| I += 3; | |
| continue; | |
| } | |
| AdjustedArgs.push_back(Args[I]); | |
| } | |
| return AdjustedArgs; | |
| }; | |
| } | |
| } // end namespace tooling | |
| } // end namespace clang |