15#include "clang/Basic/TokenKinds.h"
16#include "clang/Frontend/CompilerInstance.h"
17#include "clang/Frontend/CompilerInvocation.h"
18#include "clang/Frontend/FrontendActions.h"
19#include "clang/Tooling/Inclusions/HeaderIncludes.h"
20#include "llvm/ADT/StringRef.h"
21#include "llvm/Support/Error.h"
22#include "llvm/Support/FormatVariadic.h"
23#include "llvm/Support/Path.h"
24#include "llvm/Testing/Support/Error.h"
25#include "gmock/gmock.h"
26#include "gtest/gtest.h"
33using ::testing::AllOf;
34using ::testing::Contains;
35using ::testing::ElementsAre;
36using ::testing::IsEmpty;
38using ::testing::UnorderedElementsAre;
40class HeadersTest :
public ::testing::Test {
46 FS.Files[
testPath(
"sub/EMPTY")] =
"";
50 std::unique_ptr<CompilerInstance> setupClang() {
51 auto Cmd = CDB.getCompileCommand(MainFile);
52 assert(
static_cast<bool>(Cmd));
55 PI.CompileCommand = *Cmd;
58 EXPECT_TRUE(
static_cast<bool>(
CI));
60 CI->getDiagnosticOpts().IgnoreWarnings =
true;
61 auto VFS = PI.TFS->view(Cmd->Directory);
63 std::move(
CI),
nullptr,
64 llvm::MemoryBuffer::getMemBuffer(FS.Files[MainFile], MainFile),
65 std::move(VFS), IgnoreDiags);
67 EXPECT_FALSE(
Clang->getFrontendOpts().Inputs.empty());
73 IncludeStructure &Includes) {
74 auto &SM =
Clang->getSourceManager();
76 EXPECT_THAT_EXPECTED(
Entry, llvm::Succeeded());
77 return Includes.getOrCreateID(*
Entry);
80 IncludeStructure collectIncludes() {
82 PreprocessOnlyAction
Action;
84 Action.BeginSourceFile(*Clang,
Clang->getFrontendOpts().Inputs[0]));
85 IncludeStructure Includes;
86 Includes.collect(*Clang);
87 EXPECT_FALSE(
Action.Execute());
95 const std::vector<Inclusion> &Inclusions = {}) {
97 PreprocessOnlyAction
Action;
99 Action.BeginSourceFile(*Clang,
Clang->getFrontendOpts().Inputs[0]));
101 if (Preferred.empty())
102 Preferred = Original;
103 auto ToHeaderFile = [](llvm::StringRef Header) {
104 return HeaderFile{std::string(Header),
105 !llvm::sys::path::is_absolute(Header)};
108 IncludeInserter Inserter(MainFile,
"", format::getLLVMStyle(),
109 CDB.getCompileCommand(MainFile)->Directory,
110 &
Clang->getPreprocessor().getHeaderSearchInfo(),
111 QuotedHeaders, AngledHeaders);
112 for (
const auto &Inc : Inclusions)
113 Inserter.addExisting(Inc);
114 auto Inserted = ToHeaderFile(Preferred);
115 if (!Inserter.shouldInsertInclude(Original, Inserted))
117 auto Path = Inserter.calculateIncludePath(Inserted, MainFile);
119 return Path.value_or(
"");
122 std::optional<TextEdit> insert(llvm::StringRef VerbatimHeader,
124 Clang = setupClang();
125 PreprocessOnlyAction
Action;
127 Action.BeginSourceFile(*Clang,
Clang->getFrontendOpts().Inputs[0]));
129 IncludeInserter Inserter(MainFile,
"", format::getLLVMStyle(),
130 CDB.getCompileCommand(MainFile)->Directory,
131 &
Clang->getPreprocessor().getHeaderSearchInfo(),
132 QuotedHeaders, AngledHeaders);
133 auto Edit = Inserter.insert(VerbatimHeader,
Directive);
139 MockCompilationDatabase CDB;
146 std::unique_ptr<CompilerInstance>
Clang;
151MATCHER_P(includeLine, N,
"") {
return arg.HashLine == N; }
152MATCHER_P(directive, D,
"") {
return arg.Directive == D; }
155 if (arg.getFirst() !=
File)
156 *result_listener <<
"file =" <<
static_cast<unsigned>(arg.getFirst());
157 if (arg.getSecond() != D)
158 *result_listener <<
"distance =" << arg.getSecond();
159 return arg.getFirst() ==
File && arg.getSecond() == D;
162TEST_F(HeadersTest, CollectRewrittenAndResolved) {
164#include "sub/bar.h" // not shortest
166 std::string BarHeader = testPath("sub/bar.h");
167 FS.Files[BarHeader] =
"";
169 auto Includes = collectIncludes();
171 UnorderedElementsAre(
172 AllOf(written(
"\"sub/bar.h\""), resolved(BarHeader))));
174 UnorderedElementsAre(Distance(getID(
MainFile, Includes), 0u),
175 Distance(getID(BarHeader, Includes), 1u)));
178TEST_F(HeadersTest, OnlyCollectInclusionsInMain) {
179 std::string BazHeader =
testPath(
"sub/baz.h");
180 FS.Files[BazHeader] =
"";
181 std::string BarHeader =
testPath(
"sub/bar.h");
182 FS.Files[BarHeader] = R
"cpp(
188 auto Includes = collectIncludes();
191 UnorderedElementsAre(AllOf(written(
"\"bar.h\""), resolved(BarHeader))));
193 UnorderedElementsAre(Distance(getID(
MainFile, Includes), 0u),
194 Distance(getID(BarHeader, Includes), 1u),
195 Distance(getID(BazHeader, Includes), 2u)));
197 EXPECT_THAT(Includes.
includeDepth(getID(BarHeader, Includes)),
198 UnorderedElementsAre(Distance(getID(BarHeader, Includes), 0u),
199 Distance(getID(BazHeader, Includes), 1u)));
202TEST_F(HeadersTest, CacheBySpellingIsBuiltForMainInclusions) {
203 std::string FooHeader =
testPath(
"foo.h");
204 FS.Files[FooHeader] = R
"cpp(
207 std::string BarHeader = testPath("bar.h");
208 FS.Files[BarHeader] = R
"cpp(
211 std::string BazHeader = testPath("baz.h");
212 FS.Files[BazHeader] = R
"cpp(
220 auto Includes = collectIncludes();
222 UnorderedElementsAre(written(
"\"foo.h\""), written(
"\"bar.h\""),
223 written(
"\"baz.h\"")));
232TEST_F(HeadersTest, PreambleIncludesPresentOnce) {
243 TU.HeaderFilename = "a.h";
244 EXPECT_THAT(TU.build().getIncludeStructure().MainFileIncludes,
245 ElementsAre(includeLine(1), includeLine(3), includeLine(5)));
248TEST_F(HeadersTest, UnResolvedInclusion) {
253 EXPECT_THAT(collectIncludes().MainFileIncludes,
254 UnorderedElementsAre(AllOf(written("\"foo.h\""), resolved(
""))));
255 EXPECT_THAT(collectIncludes().IncludeChildren, IsEmpty());
258TEST_F(HeadersTest, IncludedFilesGraph) {
263 std::string BarHeader = testPath("bar.h");
264 FS.Files[BarHeader] =
"";
265 std::string FooHeader =
testPath(
"foo.h");
266 FS.Files[FooHeader] = R
"cpp(
270 std::string BazHeader = testPath("baz.h");
271 FS.Files[BazHeader] =
"";
273 auto Includes = collectIncludes();
275 SmallVector<IncludeStructure::HeaderID>>
277 {getID(BarHeader, Includes), getID(FooHeader, Includes)}},
278 {getID(FooHeader, Includes),
279 {getID(BarHeader, Includes), getID(BazHeader, Includes)}}};
283TEST_F(HeadersTest, IncludeDirective) {
291 CDB.ExtraClangFlags.push_back(
"-fno-ms-compatibility");
292 EXPECT_THAT(collectIncludes().MainFileIncludes,
293 UnorderedElementsAre(directive(tok::pp_include),
294 directive(tok::pp_import),
295 directive(tok::pp_include_next)));
298TEST_F(HeadersTest, SearchPath) {
299 FS.Files[
"foo/bar.h"] =
"x";
300 FS.Files[
"foo/bar/baz.h"] =
"y";
301 CDB.ExtraClangFlags.push_back(
"-Ifoo/bar");
302 CDB.ExtraClangFlags.push_back(
"-Ifoo/bar/..");
303 EXPECT_THAT(collectIncludes().SearchPathsCanonical,
307TEST_F(HeadersTest, InsertInclude) {
310 EXPECT_EQ(calculate(
Path),
"\"bar.h\"");
313 EXPECT_EQ(calculate(
Path),
"<bar.h>");
316TEST_F(HeadersTest, DoNotInsertIfInSameFile) {
321TEST_F(HeadersTest, DoNotInsertOffIncludePath) {
323 EXPECT_EQ(calculate(
testPath(
"sub2/main.cpp")),
"");
326TEST_F(HeadersTest, ShortenIncludesInSearchPath) {
327 std::string BarHeader =
testPath(
"sub/bar.h");
328 EXPECT_EQ(calculate(BarHeader),
"\"bar.h\"");
333 EXPECT_EQ(calculate(BarHeader),
"\"sub/bar.h\"");
336TEST_F(HeadersTest, ShortenIncludesInSearchPathBracketed) {
338 std::string BarHeader =
testPath(
"sub/bar.h");
339 EXPECT_EQ(calculate(BarHeader),
"<bar.h>");
344 EXPECT_EQ(calculate(BarHeader),
"<sub/bar.h>");
347TEST_F(HeadersTest, ShortenedIncludeNotInSearchPath) {
348 std::string BarHeader =
349 llvm::sys::path::convert_to_slash(
testPath(
"sub-2/bar.h"));
350 EXPECT_EQ(calculate(BarHeader,
""),
"\"sub-2/bar.h\"");
353TEST_F(HeadersTest, PreferredHeader) {
354 std::string BarHeader =
testPath(
"sub/bar.h");
355 EXPECT_EQ(calculate(BarHeader,
"<bar>"),
"<bar>");
357 std::string BazHeader =
testPath(
"sub/baz.h");
358 EXPECT_EQ(calculate(BarHeader, BazHeader),
"\"baz.h\"");
361 std::string BiffHeader =
testPath(
"sub/biff.h");
362 EXPECT_EQ(calculate(BarHeader, BiffHeader),
"<biff.h>");
365TEST_F(HeadersTest, DontInsertDuplicatePreferred) {
367 Inc.Written =
"\"bar.h\"";
369 EXPECT_EQ(calculate(
testPath(
"sub/bar.h"),
"\"bar.h\"", {Inc}),
"");
370 EXPECT_EQ(calculate(
"\"x.h\"",
"\"bar.h\"", {Inc}),
"");
373TEST_F(HeadersTest, DontInsertDuplicateResolved) {
375 Inc.Written =
"fake-bar.h";
376 Inc.Resolved =
testPath(
"sub/bar.h");
377 EXPECT_EQ(calculate(Inc.Resolved,
"", {Inc}),
"");
379 EXPECT_EQ(calculate(Inc.Resolved,
"\"BAR.h\"", {Inc}),
"");
382TEST_F(HeadersTest, PreferInserted) {
383 auto Edit = insert(
"<y>", tooling::IncludeDirective::Include);
385 EXPECT_EQ(Edit->newText,
"#include <y>\n");
387 Edit = insert(
"\"header.h\"", tooling::IncludeDirective::Import);
389 EXPECT_EQ(Edit->newText,
"#import \"header.h\"\n");
392TEST(Headers, NoHeaderSearchInfo) {
394 IncludeInserter Inserter(
MainFile,
"", format::getLLVMStyle(),
398 auto HeaderPath =
testPath(
"sub/bar.h");
399 auto Inserting = HeaderFile{HeaderPath,
false};
400 auto Verbatim = HeaderFile{
"<x>",
true};
402 EXPECT_EQ(Inserter.calculateIncludePath(Inserting,
MainFile),
403 std::string(
"\"sub/bar.h\""));
404 EXPECT_EQ(Inserter.shouldInsertInclude(HeaderPath, Inserting),
false);
406 EXPECT_EQ(Inserter.calculateIncludePath(Verbatim,
MainFile),
408 EXPECT_EQ(Inserter.shouldInsertInclude(HeaderPath, Verbatim),
true);
410 EXPECT_EQ(Inserter.calculateIncludePath(Inserting,
"sub2/main2.cpp"),
414TEST_F(HeadersTest, PresumedLocations) {
415 std::string HeaderFile =
"__preamble_patch__.h";
419 llvm::formatv(
"#line 0 \"{0}\"", llvm::sys::path::filename(
MainFile));
426 FS.Files[
MainFile] =
"#include \"__preamble_patch__.h\"\n\n";
427 EXPECT_THAT(collectIncludes().MainFileIncludes,
428 Not(Contains(written(
"<a.h>"))));
431 CDB.ExtraClangFlags = {
"-include",
testPath(HeaderFile)};
432 EXPECT_THAT(collectIncludes().MainFileIncludes,
433 Contains(AllOf(includeLine(2), written(
"<a.h>"))));
llvm::SmallString< 256U > Name
std::string Filename
Filename as a string.
const MacroDirective * Directive
std::vector< HeaderEntry > HeaderContents
std::vector< const char * > Expected
std::unique_ptr< CompilerInvocation > CI
llvm::SmallVector< const Inclusion * > mainFileIncludesWithSpelling(llvm::StringRef Spelling) const
llvm::DenseMap< HeaderID, unsigned > includeDepth(HeaderID Root=MainFileID) const
std::vector< Inclusion > MainFileIncludes
llvm::DenseMap< HeaderID, SmallVector< HeaderID > > IncludeChildren
TEST_F(BackgroundIndexTest, NoCrashOnErrorFile)
std::string Path
A typedef to represent a file path.
std::unique_ptr< CompilerInvocation > buildCompilerInvocation(const ParseInputs &Inputs, clang::DiagnosticConsumer &D, std::vector< std::string > *CC1Args)
Builds compiler invocation that could be used to build AST or preamble.
MATCHER_P2(hasFlag, Flag, Path, "")
std::string testPath(PathRef File, llvm::sys::path::Style Style)
TEST(BackgroundQueueTest, Priority)
std::unique_ptr< CompilerInstance > prepareCompilerInstance(std::unique_ptr< clang::CompilerInvocation > CI, const PrecompiledPreamble *Preamble, std::unique_ptr< llvm::MemoryBuffer > Buffer, llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS, DiagnosticConsumer &DiagsClient)
llvm::StringRef PathRef
A typedef to represent a ref to file path.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
static TestTU withCode(llvm::StringRef Code)