Skip to content

Commit

Permalink
[clangd] Add CompileFlags.Compiler option to override argv0
Browse files Browse the repository at this point in the history
This is separate from --query-driver but can combine with it.

Fixes clangd/clangd#642

Differential Revision: https://reviews.llvm.org/D116196
  • Loading branch information
sam-mccall committed Jan 4, 2022
1 parent f4ef793 commit f2b3e25
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 2 deletions.
10 changes: 10 additions & 0 deletions clang-tools-extra/clangd/ConfigCompile.cpp
Expand Up @@ -253,6 +253,16 @@ struct FragmentCompiler {
}

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()) {
auto Remove = std::make_shared<ArgStripper>();
for (auto &A : F.Remove)
Expand Down
10 changes: 10 additions & 0 deletions clang-tools-extra/clangd/ConfigFragment.h
Expand Up @@ -134,6 +134,16 @@ struct Fragment {
///
/// This section modifies how the compile command is constructed.
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.
std::vector<Located<std::string>> Add;
/// List of flags to remove from the compile command.
Expand Down
4 changes: 4 additions & 0 deletions clang-tools-extra/clangd/ConfigYAML.cpp
Expand Up @@ -90,6 +90,10 @@ class Parser {

void parse(Fragment::CompileFlagsBlock &F, Node &N) {
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) {
if (auto Values = scalarValues(N))
F.Add = std::move(*Values);
Expand Down
5 changes: 3 additions & 2 deletions clang-tools-extra/clangd/unittests/ConfigCompileTests.cpp
Expand Up @@ -121,14 +121,15 @@ TEST_F(ConfigCompileTests, Condition) {
}

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

TEST_F(ConfigCompileTests, CompilationDatabase) {
Expand Down

0 comments on commit f2b3e25

Please sign in to comment.