sammccall created this revision.
sammccall added a reviewer: hokein.
Herald added subscribers: cfe-commits, usaxena95, kadircet, arphaman, jkorous,
MaskRay, ilya-biryukov.
Herald added a project: clang.
While here, add documentation to CompileFlags and CompileFlags.Add.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D83705
Files:
clang-tools-extra/clangd/CompileCommands.h
clang-tools-extra/clangd/ConfigCompile.cpp
clang-tools-extra/clangd/ConfigFragment.h
clang-tools-extra/clangd/ConfigYAML.cpp
clang-tools-extra/clangd/unittests/ConfigCompileTests.cpp
Index: clang-tools-extra/clangd/unittests/ConfigCompileTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/ConfigCompileTests.cpp
+++ clang-tools-extra/clangd/unittests/ConfigCompileTests.cpp
@@ -91,10 +91,12 @@
TEST_F(ConfigCompileTests, CompileCommands) {
Frag.CompileFlags.Add.emplace_back("-foo");
- std::vector<std::string> Argv = {"clang", "a.cc"};
+ 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(1));
- Conf.CompileFlags.Edits.front()(Argv);
+ EXPECT_THAT(Conf.CompileFlags.Edits, SizeIs(2));
+ for (auto &Edit : Conf.CompileFlags.Edits)
+ Edit(Argv);
EXPECT_THAT(Argv, ElementsAre("clang", "a.cc", "-foo"));
}
Index: clang-tools-extra/clangd/ConfigYAML.cpp
===================================================================
--- clang-tools-extra/clangd/ConfigYAML.cpp
+++ clang-tools-extra/clangd/ConfigYAML.cpp
@@ -63,6 +63,10 @@
if (auto Values = scalarValues(N))
F.Add = std::move(*Values);
});
+ Dict.handle("Remove", [&](Node &N) {
+ if (auto Values = scalarValues(N))
+ F.Remove = std::move(*Values);
+ });
Dict.parse(N);
}
Index: clang-tools-extra/clangd/ConfigFragment.h
===================================================================
--- clang-tools-extra/clangd/ConfigFragment.h
+++ clang-tools-extra/clangd/ConfigFragment.h
@@ -117,9 +117,32 @@
};
IfBlock If;
+ /// Conditions in the CompileFlags block affect how a file is parsed.
+ ///
+ /// clangd emulates how clang would interpret a file.
+ /// By default, it behaves roughly like `clang $FILENAME`, but real projects
+ /// usually require setting the include path (with the `-I` flag), defining
+ /// preprocessor symbols, configuring warnings etc.
+ /// Often, a compilation database specifies these compile commands. clangd
+ /// searches for compile_commands.json in parents of the source file.
+ ///
+ /// This section modifies how the compile command is constructed.
struct CompileFlagsBlock {
+ /// List of flags to append to the compile command.
std::vector<Located<std::string>> Add;
- } CompileFlags;
+ /// List of flags to remove from the compile command.
+ ///
+ /// - If the value is a recognized clang flag (like "-I") then it will be
+ /// removed along with any arguments. Synonyms like --include-dir= wil
+ /// also be removed.
+ /// - Otherwise, if the value ends in * (like "-DFOO=*") then any argument
+ /// with the prefix wil be removed.
+ /// - Otherwise any argument exactly matching the value is removed.
+ ///
+ /// In all cases, -Xclang is also removed where needed.
+ std::vector<Located<std::string>> Remove;
+ };
+ CompileFlagsBlock CompileFlags;
};
} // namespace config
Index: clang-tools-extra/clangd/ConfigCompile.cpp
===================================================================
--- clang-tools-extra/clangd/ConfigCompile.cpp
+++ clang-tools-extra/clangd/ConfigCompile.cpp
@@ -23,6 +23,7 @@
//
//===----------------------------------------------------------------------===//
+#include "CompileCommands.h"
#include "Config.h"
#include "ConfigFragment.h"
#include "support/Logger.h"
@@ -122,6 +123,19 @@
}
void compile(Fragment::CompileFlagsBlock &&F) {
+ if (!F.Remove.empty()) {
+ auto Remove = std::make_shared<ArgStripper>();
+ for (auto &A : F.Remove)
+ Remove->strip(*A);
+ Out.Apply.push_back([Remove(std::shared_ptr<const ArgStripper>(
+ std::move(Remove)))](Config &C) {
+ C.CompileFlags.Edits.push_back(
+ [Remove](std::vector<std::string> &Args) {
+ Remove->process(Args);
+ });
+ });
+ }
+
if (!F.Add.empty()) {
std::vector<std::string> Add;
for (auto &A : F.Add)
Index: clang-tools-extra/clangd/CompileCommands.h
===================================================================
--- clang-tools-extra/clangd/CompileCommands.h
+++ clang-tools-extra/clangd/CompileCommands.h
@@ -66,6 +66,12 @@
// The table-building strategy may not make sense outside clangd.
class ArgStripper {
public:
+ ArgStripper() = default;
+ ArgStripper(ArgStripper &&) = default;
+ ArgStripper(const ArgStripper &) = delete;
+ ArgStripper &operator=(ArgStripper &&) = default;
+ ArgStripper &operator=(const ArgStripper &) = delete;
+
// Adds the arg to the set which should be removed.
// Recognized clang flags are stripped semantically. When "-I" is stripped:
// - so is its argument (either as -Ifoo or -I foo)
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
