[clangd] Add CompileFlags.Compiler option to override argv0

This is separate from --query-driver but can combine with it.

Fixes https://github.com/clangd/clangd/issues/642

Differential Revision: https://reviews.llvm.org/D116196
This commit is contained in:
Sam McCall 2021-12-23 01:26:49 +01:00
parent f4ef79306c
commit f2b3e25f86
4 changed files with 27 additions and 2 deletions

View File

@ -253,6 +253,16 @@ struct FragmentCompiler {
} }
void compile(Fragment::CompileFlagsBlock &&F) { void compile(Fragment::CompileFlagsBlock &&F) {
if (F.Compiler)
Out.Apply.push_back(
[Compiler(std::move(**F.Compiler))](const Params &, Config &C) {
C.CompileFlags.Edits.push_back(
[Compiler](std::vector<std::string> &Args) {
if (!Args.empty())
Args.front() = Compiler;
});
});
if (!F.Remove.empty()) { if (!F.Remove.empty()) {
auto Remove = std::make_shared<ArgStripper>(); auto Remove = std::make_shared<ArgStripper>();
for (auto &A : F.Remove) for (auto &A : F.Remove)

View File

@ -134,6 +134,16 @@ struct Fragment {
/// ///
/// This section modifies how the compile command is constructed. /// This section modifies how the compile command is constructed.
struct CompileFlagsBlock { struct CompileFlagsBlock {
/// Override the compiler executable name to simulate.
///
/// The name can affect how flags are parsed (clang++ vs clang).
/// If the executable name is in the --query-driver allowlist, then it will
/// be invoked to extract include paths.
///
/// (That this simply replaces argv[0], and may mangle commands that use
/// more complicated drivers like ccache).
llvm::Optional<Located<std::string>> Compiler;
/// List of flags to append to the compile command. /// List of flags to append to the compile command.
std::vector<Located<std::string>> Add; std::vector<Located<std::string>> Add;
/// List of flags to remove from the compile command. /// List of flags to remove from the compile command.

View File

@ -90,6 +90,10 @@ private:
void parse(Fragment::CompileFlagsBlock &F, Node &N) { void parse(Fragment::CompileFlagsBlock &F, Node &N) {
DictParser Dict("CompileFlags", this); DictParser Dict("CompileFlags", this);
Dict.handle("Compiler", [&](Node &N) {
if (auto Value = scalarValue(N, "Compiler"))
F.Compiler = std::move(*Value);
});
Dict.handle("Add", [&](Node &N) { Dict.handle("Add", [&](Node &N) {
if (auto Values = scalarValues(N)) if (auto Values = scalarValues(N))
F.Add = std::move(*Values); F.Add = std::move(*Values);

View File

@ -121,14 +121,15 @@ TEST_F(ConfigCompileTests, Condition) {
} }
TEST_F(ConfigCompileTests, CompileCommands) { TEST_F(ConfigCompileTests, CompileCommands) {
Frag.CompileFlags.Compiler.emplace("tpc.exe");
Frag.CompileFlags.Add.emplace_back("-foo"); Frag.CompileFlags.Add.emplace_back("-foo");
Frag.CompileFlags.Remove.emplace_back("--include-directory="); Frag.CompileFlags.Remove.emplace_back("--include-directory=");
std::vector<std::string> Argv = {"clang", "-I", "bar/", "--", "a.cc"}; std::vector<std::string> Argv = {"clang", "-I", "bar/", "--", "a.cc"};
EXPECT_TRUE(compileAndApply()); EXPECT_TRUE(compileAndApply());
EXPECT_THAT(Conf.CompileFlags.Edits, SizeIs(2)); EXPECT_THAT(Conf.CompileFlags.Edits, SizeIs(3));
for (auto &Edit : Conf.CompileFlags.Edits) for (auto &Edit : Conf.CompileFlags.Edits)
Edit(Argv); Edit(Argv);
EXPECT_THAT(Argv, ElementsAre("clang", "-foo", "--", "a.cc")); EXPECT_THAT(Argv, ElementsAre("tpc.exe", "-foo", "--", "a.cc"));
} }
TEST_F(ConfigCompileTests, CompilationDatabase) { TEST_F(ConfigCompileTests, CompilationDatabase) {