1 //===-- SourceCodeTests.cpp ------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 #include "Annotations.h" 9 #include "Context.h" 10 #include "Protocol.h" 11 #include "SourceCode.h" 12 #include "TestTU.h" 13 #include "clang/Basic/LangOptions.h" 14 #include "clang/Basic/SourceLocation.h" 15 #include "clang/Format/Format.h" 16 #include "llvm/Support/Error.h" 17 #include "llvm/Support/raw_os_ostream.h" 18 #include "llvm/Testing/Support/Annotations.h" 19 #include "llvm/Testing/Support/Error.h" 20 #include "gmock/gmock.h" 21 #include "gtest/gtest.h" 22 #include <tuple> 23 24 namespace clang { 25 namespace clangd { 26 namespace { 27 28 using llvm::Failed; 29 using llvm::HasValue; 30 31 MATCHER_P2(Pos, Line, Col, "") { 32 return arg.line == int(Line) && arg.character == int(Col); 33 } 34 35 MATCHER_P(MacroName, Name, "") { return arg.Name == Name; } 36 37 /// A helper to make tests easier to read. 38 Position position(int Line, int Character) { 39 Position Pos; 40 Pos.line = Line; 41 Pos.character = Character; 42 return Pos; 43 } 44 45 Range range(const std::pair<int, int> &P1, const std::pair<int, int> &P2) { 46 Range Range; 47 Range.start = position(P1.first, P1.second); 48 Range.end = position(P2.first, P2.second); 49 return Range; 50 } 51 52 TEST(SourceCodeTests, lspLength) { 53 EXPECT_EQ(lspLength(""), 0UL); 54 EXPECT_EQ(lspLength("ascii"), 5UL); 55 // BMP 56 EXPECT_EQ(lspLength("↓"), 1UL); 57 EXPECT_EQ(lspLength("¥"), 1UL); 58 // astral 59 EXPECT_EQ(lspLength("��"), 2UL); 60 61 WithContextValue UTF8(kCurrentOffsetEncoding, OffsetEncoding::UTF8); 62 EXPECT_EQ(lspLength(""), 0UL); 63 EXPECT_EQ(lspLength("ascii"), 5UL); 64 // BMP 65 EXPECT_EQ(lspLength("↓"), 3UL); 66 EXPECT_EQ(lspLength("¥"), 2UL); 67 // astral 68 EXPECT_EQ(lspLength("��"), 4UL); 69 70 WithContextValue UTF32(kCurrentOffsetEncoding, OffsetEncoding::UTF32); 71 EXPECT_EQ(lspLength(""), 0UL); 72 EXPECT_EQ(lspLength("ascii"), 5UL); 73 // BMP 74 EXPECT_EQ(lspLength("↓"), 1UL); 75 EXPECT_EQ(lspLength("¥"), 1UL); 76 // astral 77 EXPECT_EQ(lspLength("��"), 1UL); 78 } 79 80 // The = → �� below are ASCII (1 byte), BMP (3 bytes), and astral (4 bytes). 81 const char File[] = R"(0:0 = 0 82 1:0 → 8 83 2:0 �� 18)"; 84 struct Line { 85 unsigned Number; 86 unsigned Offset; 87 unsigned Length; 88 }; 89 Line FileLines[] = {Line{0, 0, 7}, Line{1, 8, 9}, Line{2, 18, 11}}; 90 91 TEST(SourceCodeTests, PositionToOffset) { 92 // line out of bounds 93 EXPECT_THAT_EXPECTED(positionToOffset(File, position(-1, 2)), llvm::Failed()); 94 // first line 95 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, -1)), 96 llvm::Failed()); // out of range 97 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 0)), 98 llvm::HasValue(0)); // first character 99 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 3)), 100 llvm::HasValue(3)); // middle character 101 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 6)), 102 llvm::HasValue(6)); // last character 103 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 7)), 104 llvm::HasValue(7)); // the newline itself 105 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 7), false), 106 llvm::HasValue(7)); 107 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 8)), 108 llvm::HasValue(7)); // out of range 109 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 8), false), 110 llvm::Failed()); // out of range 111 // middle line 112 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, -1)), 113 llvm::Failed()); // out of range 114 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 0)), 115 llvm::HasValue(8)); // first character 116 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 3)), 117 llvm::HasValue(11)); // middle character 118 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 3), false), 119 llvm::HasValue(11)); 120 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 6)), 121 llvm::HasValue(16)); // last character 122 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 7)), 123 llvm::HasValue(17)); // the newline itself 124 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 8)), 125 llvm::HasValue(17)); // out of range 126 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 8), false), 127 llvm::Failed()); // out of range 128 // last line 129 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, -1)), 130 llvm::Failed()); // out of range 131 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 0)), 132 llvm::HasValue(18)); // first character 133 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 3)), 134 llvm::HasValue(21)); // middle character 135 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 5), false), 136 llvm::Failed()); // middle of surrogate pair 137 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 5)), 138 llvm::HasValue(26)); // middle of surrogate pair 139 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 6), false), 140 llvm::HasValue(26)); // end of surrogate pair 141 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 8)), 142 llvm::HasValue(28)); // last character 143 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 9)), 144 llvm::HasValue(29)); // EOF 145 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 10), false), 146 llvm::Failed()); // out of range 147 // line out of bounds 148 EXPECT_THAT_EXPECTED(positionToOffset(File, position(3, 0)), llvm::Failed()); 149 EXPECT_THAT_EXPECTED(positionToOffset(File, position(3, 1)), llvm::Failed()); 150 151 // Codepoints are similar, except near astral characters. 152 WithContextValue UTF32(kCurrentOffsetEncoding, OffsetEncoding::UTF32); 153 // line out of bounds 154 EXPECT_THAT_EXPECTED(positionToOffset(File, position(-1, 2)), llvm::Failed()); 155 // first line 156 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, -1)), 157 llvm::Failed()); // out of range 158 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 0)), 159 llvm::HasValue(0)); // first character 160 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 3)), 161 llvm::HasValue(3)); // middle character 162 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 6)), 163 llvm::HasValue(6)); // last character 164 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 7)), 165 llvm::HasValue(7)); // the newline itself 166 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 7), false), 167 llvm::HasValue(7)); 168 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 8)), 169 llvm::HasValue(7)); // out of range 170 EXPECT_THAT_EXPECTED(positionToOffset(File, position(0, 8), false), 171 llvm::Failed()); // out of range 172 // middle line 173 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, -1)), 174 llvm::Failed()); // out of range 175 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 0)), 176 llvm::HasValue(8)); // first character 177 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 3)), 178 llvm::HasValue(11)); // middle character 179 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 3), false), 180 llvm::HasValue(11)); 181 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 6)), 182 llvm::HasValue(16)); // last character 183 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 7)), 184 llvm::HasValue(17)); // the newline itself 185 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 8)), 186 llvm::HasValue(17)); // out of range 187 EXPECT_THAT_EXPECTED(positionToOffset(File, position(1, 8), false), 188 llvm::Failed()); // out of range 189 // last line 190 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, -1)), 191 llvm::Failed()); // out of range 192 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 0)), 193 llvm::HasValue(18)); // first character 194 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 4)), 195 llvm::HasValue(22)); // Before astral character. 196 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 5), false), 197 llvm::HasValue(26)); // after astral character 198 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 7)), 199 llvm::HasValue(28)); // last character 200 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 8)), 201 llvm::HasValue(29)); // EOF 202 EXPECT_THAT_EXPECTED(positionToOffset(File, position(2, 9), false), 203 llvm::Failed()); // out of range 204 // line out of bounds 205 EXPECT_THAT_EXPECTED(positionToOffset(File, position(3, 0)), llvm::Failed()); 206 EXPECT_THAT_EXPECTED(positionToOffset(File, position(3, 1)), llvm::Failed()); 207 208 // Test UTF-8, where transformations are trivial. 209 WithContextValue UTF8(kCurrentOffsetEncoding, OffsetEncoding::UTF8); 210 EXPECT_THAT_EXPECTED(positionToOffset(File, position(-1, 2)), llvm::Failed()); 211 EXPECT_THAT_EXPECTED(positionToOffset(File, position(3, 0)), llvm::Failed()); 212 for (Line L : FileLines) { 213 EXPECT_THAT_EXPECTED(positionToOffset(File, position(L.Number, -1)), 214 llvm::Failed()); // out of range 215 for (unsigned I = 0; I <= L.Length; ++I) 216 EXPECT_THAT_EXPECTED(positionToOffset(File, position(L.Number, I)), 217 llvm::HasValue(L.Offset + I)); 218 EXPECT_THAT_EXPECTED(positionToOffset(File, position(L.Number, L.Length+1)), 219 llvm::HasValue(L.Offset + L.Length)); 220 EXPECT_THAT_EXPECTED( 221 positionToOffset(File, position(L.Number, L.Length + 1), false), 222 llvm::Failed()); // out of range 223 } 224 } 225 226 TEST(SourceCodeTests, OffsetToPosition) { 227 EXPECT_THAT(offsetToPosition(File, 0), Pos(0, 0)) << "start of file"; 228 EXPECT_THAT(offsetToPosition(File, 3), Pos(0, 3)) << "in first line"; 229 EXPECT_THAT(offsetToPosition(File, 6), Pos(0, 6)) << "end of first line"; 230 EXPECT_THAT(offsetToPosition(File, 7), Pos(0, 7)) << "first newline"; 231 EXPECT_THAT(offsetToPosition(File, 8), Pos(1, 0)) << "start of second line"; 232 EXPECT_THAT(offsetToPosition(File, 12), Pos(1, 4)) << "before BMP char"; 233 EXPECT_THAT(offsetToPosition(File, 13), Pos(1, 5)) << "in BMP char"; 234 EXPECT_THAT(offsetToPosition(File, 15), Pos(1, 5)) << "after BMP char"; 235 EXPECT_THAT(offsetToPosition(File, 16), Pos(1, 6)) << "end of second line"; 236 EXPECT_THAT(offsetToPosition(File, 17), Pos(1, 7)) << "second newline"; 237 EXPECT_THAT(offsetToPosition(File, 18), Pos(2, 0)) << "start of last line"; 238 EXPECT_THAT(offsetToPosition(File, 21), Pos(2, 3)) << "in last line"; 239 EXPECT_THAT(offsetToPosition(File, 22), Pos(2, 4)) << "before astral char"; 240 EXPECT_THAT(offsetToPosition(File, 24), Pos(2, 6)) << "in astral char"; 241 EXPECT_THAT(offsetToPosition(File, 26), Pos(2, 6)) << "after astral char"; 242 EXPECT_THAT(offsetToPosition(File, 28), Pos(2, 8)) << "end of last line"; 243 EXPECT_THAT(offsetToPosition(File, 29), Pos(2, 9)) << "EOF"; 244 EXPECT_THAT(offsetToPosition(File, 30), Pos(2, 9)) << "out of bounds"; 245 246 // Codepoints are similar, except near astral characters. 247 WithContextValue UTF32(kCurrentOffsetEncoding, OffsetEncoding::UTF32); 248 EXPECT_THAT(offsetToPosition(File, 0), Pos(0, 0)) << "start of file"; 249 EXPECT_THAT(offsetToPosition(File, 3), Pos(0, 3)) << "in first line"; 250 EXPECT_THAT(offsetToPosition(File, 6), Pos(0, 6)) << "end of first line"; 251 EXPECT_THAT(offsetToPosition(File, 7), Pos(0, 7)) << "first newline"; 252 EXPECT_THAT(offsetToPosition(File, 8), Pos(1, 0)) << "start of second line"; 253 EXPECT_THAT(offsetToPosition(File, 12), Pos(1, 4)) << "before BMP char"; 254 EXPECT_THAT(offsetToPosition(File, 13), Pos(1, 5)) << "in BMP char"; 255 EXPECT_THAT(offsetToPosition(File, 15), Pos(1, 5)) << "after BMP char"; 256 EXPECT_THAT(offsetToPosition(File, 16), Pos(1, 6)) << "end of second line"; 257 EXPECT_THAT(offsetToPosition(File, 17), Pos(1, 7)) << "second newline"; 258 EXPECT_THAT(offsetToPosition(File, 18), Pos(2, 0)) << "start of last line"; 259 EXPECT_THAT(offsetToPosition(File, 21), Pos(2, 3)) << "in last line"; 260 EXPECT_THAT(offsetToPosition(File, 22), Pos(2, 4)) << "before astral char"; 261 EXPECT_THAT(offsetToPosition(File, 24), Pos(2, 5)) << "in astral char"; 262 EXPECT_THAT(offsetToPosition(File, 26), Pos(2, 5)) << "after astral char"; 263 EXPECT_THAT(offsetToPosition(File, 28), Pos(2, 7)) << "end of last line"; 264 EXPECT_THAT(offsetToPosition(File, 29), Pos(2, 8)) << "EOF"; 265 EXPECT_THAT(offsetToPosition(File, 30), Pos(2, 8)) << "out of bounds"; 266 267 WithContextValue UTF8(kCurrentOffsetEncoding, OffsetEncoding::UTF8); 268 for (Line L : FileLines) { 269 for (unsigned I = 0; I <= L.Length; ++I) 270 EXPECT_THAT(offsetToPosition(File, L.Offset + I), Pos(L.Number, I)); 271 } 272 EXPECT_THAT(offsetToPosition(File, 30), Pos(2, 11)) << "out of bounds"; 273 } 274 275 TEST(SourceCodeTests, IsRangeConsecutive) { 276 EXPECT_TRUE(isRangeConsecutive(range({2, 2}, {2, 3}), range({2, 3}, {2, 4}))); 277 EXPECT_FALSE( 278 isRangeConsecutive(range({0, 2}, {0, 3}), range({2, 3}, {2, 4}))); 279 EXPECT_FALSE( 280 isRangeConsecutive(range({2, 2}, {2, 3}), range({2, 4}, {2, 5}))); 281 } 282 283 TEST(SourceCodeTests, SourceLocationInMainFile) { 284 Annotations Source(R"cpp( 285 ^in^t ^foo 286 ^bar 287 ^baz ^() {} {} {} {} { }^ 288 )cpp"); 289 290 SourceManagerForFile Owner("foo.cpp", Source.code()); 291 SourceManager &SM = Owner.get(); 292 293 SourceLocation StartOfFile = SM.getLocForStartOfFile(SM.getMainFileID()); 294 EXPECT_THAT_EXPECTED(sourceLocationInMainFile(SM, position(0, 0)), 295 HasValue(StartOfFile)); 296 // End of file. 297 EXPECT_THAT_EXPECTED( 298 sourceLocationInMainFile(SM, position(4, 0)), 299 HasValue(StartOfFile.getLocWithOffset(Source.code().size()))); 300 // Column number is too large. 301 EXPECT_THAT_EXPECTED(sourceLocationInMainFile(SM, position(0, 1)), Failed()); 302 EXPECT_THAT_EXPECTED(sourceLocationInMainFile(SM, position(0, 100)), 303 Failed()); 304 EXPECT_THAT_EXPECTED(sourceLocationInMainFile(SM, position(4, 1)), Failed()); 305 // Line number is too large. 306 EXPECT_THAT_EXPECTED(sourceLocationInMainFile(SM, position(5, 0)), Failed()); 307 // Check all positions mentioned in the test return valid results. 308 for (auto P : Source.points()) { 309 size_t Offset = llvm::cantFail(positionToOffset(Source.code(), P)); 310 EXPECT_THAT_EXPECTED(sourceLocationInMainFile(SM, P), 311 HasValue(StartOfFile.getLocWithOffset(Offset))); 312 } 313 } 314 315 TEST(SourceCodeTests, CollectIdentifiers) { 316 auto Style = format::getLLVMStyle(); 317 auto IDs = collectIdentifiers(R"cpp( 318 #include "a.h" 319 void foo() { int xyz; int abc = xyz; return foo(); } 320 )cpp", 321 Style); 322 EXPECT_EQ(IDs.size(), 7u); 323 EXPECT_EQ(IDs["include"], 1u); 324 EXPECT_EQ(IDs["void"], 1u); 325 EXPECT_EQ(IDs["int"], 2u); 326 EXPECT_EQ(IDs["xyz"], 2u); 327 EXPECT_EQ(IDs["abc"], 1u); 328 EXPECT_EQ(IDs["return"], 1u); 329 EXPECT_EQ(IDs["foo"], 2u); 330 } 331 332 TEST(SourceCodeTests, CollectWords) { 333 auto Words = collectWords(R"cpp( 334 #define FIZZ_BUZZ 335 // this is a comment 336 std::string getSomeText() { return "magic word"; } 337 )cpp"); 338 std::set<StringRef> ActualWords(Words.keys().begin(), Words.keys().end()); 339 std::set<StringRef> ExpectedWords = {"define", "fizz", "buzz", "this", 340 "comment", "string", "some", "text", 341 "return", "magic", "word"}; 342 EXPECT_EQ(ActualWords, ExpectedWords); 343 } 344 345 TEST(SourceCodeTests, VisibleNamespaces) { 346 std::vector<std::pair<const char *, std::vector<std::string>>> Cases = { 347 { 348 R"cpp( 349 // Using directive resolved against enclosing namespaces. 350 using namespace foo; 351 namespace ns { 352 using namespace bar; 353 )cpp", 354 {"ns", "", "bar", "foo", "ns::bar"}, 355 }, 356 { 357 R"cpp( 358 // Don't include namespaces we've closed, ignore namespace aliases. 359 using namespace clang; 360 using std::swap; 361 namespace clang { 362 namespace clangd {} 363 namespace ll = ::llvm; 364 } 365 namespace clang { 366 )cpp", 367 {"clang", ""}, 368 }, 369 { 370 R"cpp( 371 // Using directives visible even if a namespace is reopened. 372 // Ignore anonymous namespaces. 373 namespace foo{ using namespace bar; } 374 namespace foo{ namespace { 375 )cpp", 376 {"foo", "", "bar", "foo::bar"}, 377 }, 378 { 379 R"cpp( 380 // Mismatched braces 381 namespace foo{} 382 }}} 383 namespace bar{ 384 )cpp", 385 {"bar", ""}, 386 }, 387 { 388 R"cpp( 389 // Namespaces with multiple chunks. 390 namespace a::b { 391 using namespace c::d; 392 namespace e::f { 393 )cpp", 394 { 395 "a::b::e::f", 396 "", 397 "a", 398 "a::b", 399 "a::b::c::d", 400 "a::b::e", 401 "a::c::d", 402 "c::d", 403 }, 404 }, 405 { 406 "", 407 {""}, 408 }, 409 { 410 R"cpp( 411 // Parse until EOF 412 namespace bar{})cpp", 413 {""}, 414 }, 415 }; 416 for (const auto& Case : Cases) { 417 EXPECT_EQ(Case.second, 418 visibleNamespaces(Case.first, format::getLLVMStyle())) 419 << Case.first; 420 } 421 } 422 423 TEST(SourceCodeTests, GetMacros) { 424 Annotations Code(R"cpp( 425 #define MACRO 123 426 int abc = MA^CRO; 427 )cpp"); 428 TestTU TU = TestTU::withCode(Code.code()); 429 auto AST = TU.build(); 430 auto CurLoc = sourceLocationInMainFile(AST.getSourceManager(), Code.point()); 431 ASSERT_TRUE(bool(CurLoc)); 432 const auto *Id = syntax::spelledIdentifierTouching(*CurLoc, AST.getTokens()); 433 ASSERT_TRUE(Id); 434 auto Result = locateMacroAt(Id->location(), AST.getPreprocessor()); 435 ASSERT_TRUE(Result); 436 EXPECT_THAT(*Result, MacroName("MACRO")); 437 } 438 439 TEST(SourceCodeTests, WorksAtBeginOfFile) { 440 Annotations Code("^MACRO"); 441 TestTU TU = TestTU::withCode(Code.code()); 442 TU.HeaderCode = "#define MACRO int x;"; 443 auto AST = TU.build(); 444 auto CurLoc = sourceLocationInMainFile(AST.getSourceManager(), Code.point()); 445 ASSERT_TRUE(bool(CurLoc)); 446 const auto *Id = syntax::spelledIdentifierTouching(*CurLoc, AST.getTokens()); 447 ASSERT_TRUE(Id); 448 auto Result = locateMacroAt(Id->location(), AST.getPreprocessor()); 449 ASSERT_TRUE(Result); 450 EXPECT_THAT(*Result, MacroName("MACRO")); 451 } 452 453 TEST(SourceCodeTests, IsInsideMainFile){ 454 TestTU TU; 455 TU.HeaderCode = R"cpp( 456 #define DEFINE_CLASS(X) class X {}; 457 #define DEFINE_YY DEFINE_CLASS(YY) 458 459 class Header1 {}; 460 DEFINE_CLASS(Header2) 461 class Header {}; 462 )cpp"; 463 TU.Code = R"cpp( 464 class Main1 {}; 465 DEFINE_CLASS(Main2) 466 DEFINE_YY 467 class Main {}; 468 )cpp"; 469 TU.ExtraArgs.push_back("-DHeader=Header3"); 470 TU.ExtraArgs.push_back("-DMain=Main3"); 471 auto AST = TU.build(); 472 const auto& SM = AST.getSourceManager(); 473 auto DeclLoc = [&AST](llvm::StringRef Name) { 474 return findDecl(AST, Name).getLocation(); 475 }; 476 for (const auto *HeaderDecl : {"Header1", "Header2", "Header3"}) 477 EXPECT_FALSE(isInsideMainFile(DeclLoc(HeaderDecl), SM)); 478 479 for (const auto *MainDecl : {"Main1", "Main2", "Main3", "YY"}) 480 EXPECT_TRUE(isInsideMainFile(DeclLoc(MainDecl), SM)); 481 } 482 483 // Test for functions toHalfOpenFileRange and getHalfOpenFileRange 484 TEST(SourceCodeTests, HalfOpenFileRange) { 485 // Each marked range should be the file range of the decl with the same name 486 // and each name should be unique. 487 Annotations Test(R"cpp( 488 #define FOO(X, Y) int Y = ++X 489 #define BAR(X) X + 1 490 #define ECHO(X) X 491 492 #define BUZZ BAZZ(ADD) 493 #define BAZZ(m) m(1) 494 #define ADD(a) int f = a + 1; 495 template<typename T> 496 class P {}; 497 498 int main() { 499 $a[[P<P<P<P<P<int>>>>> a]]; 500 $b[[int b = 1]]; 501 $c[[FOO(b, c)]]; 502 $d[[FOO(BAR(BAR(b)), d)]]; 503 // FIXME: We might want to select everything inside the outer ECHO. 504 ECHO(ECHO($e[[int) ECHO(e]])); 505 // Shouldn't crash. 506 $f[[BUZZ]]; 507 } 508 )cpp"); 509 510 ParsedAST AST = TestTU::withCode(Test.code()).build(); 511 llvm::errs() << Test.code(); 512 const SourceManager &SM = AST.getSourceManager(); 513 const LangOptions &LangOpts = AST.getLangOpts(); 514 // Turn a SourceLocation into a pair of positions 515 auto SourceRangeToRange = [&SM](SourceRange SrcRange) { 516 return Range{sourceLocToPosition(SM, SrcRange.getBegin()), 517 sourceLocToPosition(SM, SrcRange.getEnd())}; 518 }; 519 auto CheckRange = [&](llvm::StringRef Name) { 520 const NamedDecl &Decl = findUnqualifiedDecl(AST, Name); 521 auto FileRange = toHalfOpenFileRange(SM, LangOpts, Decl.getSourceRange()); 522 SCOPED_TRACE("Checking range: " + Name); 523 ASSERT_NE(FileRange, llvm::None); 524 Range HalfOpenRange = SourceRangeToRange(*FileRange); 525 EXPECT_EQ(HalfOpenRange, Test.ranges(Name)[0]); 526 }; 527 528 CheckRange("a"); 529 CheckRange("b"); 530 CheckRange("c"); 531 CheckRange("d"); 532 CheckRange("e"); 533 CheckRange("f"); 534 } 535 536 TEST(SourceCodeTests, HalfOpenFileRangePathologicalPreprocessor) { 537 const char *Case = R"cpp( 538 #define MACRO while(1) 539 void test() { 540 [[#include "Expand.inc" 541 br^eak]]; 542 } 543 )cpp"; 544 Annotations Test(Case); 545 auto TU = TestTU::withCode(Test.code()); 546 TU.AdditionalFiles["Expand.inc"] = "MACRO\n"; 547 auto AST = TU.build(); 548 549 const auto &Func = cast<FunctionDecl>(findDecl(AST, "test")); 550 const auto &Body = cast<CompoundStmt>(Func.getBody()); 551 const auto &Loop = cast<WhileStmt>(*Body->child_begin()); 552 llvm::Optional<SourceRange> Range = toHalfOpenFileRange( 553 AST.getSourceManager(), AST.getLangOpts(), Loop->getSourceRange()); 554 ASSERT_TRUE(Range) << "Failed to get file range"; 555 EXPECT_EQ(AST.getSourceManager().getFileOffset(Range->getBegin()), 556 Test.llvm::Annotations::range().Begin); 557 EXPECT_EQ(AST.getSourceManager().getFileOffset(Range->getEnd()), 558 Test.llvm::Annotations::range().End); 559 } 560 561 TEST(SourceCodeTests, IncludeHashLoc) { 562 const char *Case = R"cpp( 563 $foo^#include "foo.inc" 564 #define HEADER "bar.inc" 565 $bar^# include HEADER 566 )cpp"; 567 Annotations Test(Case); 568 auto TU = TestTU::withCode(Test.code()); 569 TU.AdditionalFiles["foo.inc"] = "int foo;\n"; 570 TU.AdditionalFiles["bar.inc"] = "int bar;\n"; 571 auto AST = TU.build(); 572 const auto& SM = AST.getSourceManager(); 573 574 FileID Foo = SM.getFileID(findDecl(AST, "foo").getLocation()); 575 EXPECT_EQ(SM.getFileOffset(includeHashLoc(Foo, SM)), 576 Test.llvm::Annotations::point("foo")); 577 FileID Bar = SM.getFileID(findDecl(AST, "bar").getLocation()); 578 EXPECT_EQ(SM.getFileOffset(includeHashLoc(Bar, SM)), 579 Test.llvm::Annotations::point("bar")); 580 } 581 582 TEST(SourceCodeTests, GetEligiblePoints) { 583 constexpr struct { 584 const char *Code; 585 const char *FullyQualifiedName; 586 const char *EnclosingNamespace; 587 } Cases[] = { 588 {R"cpp(// FIXME: We should also mark positions before and after 589 //declarations/definitions as eligible. 590 namespace ns1 { 591 namespace a { namespace ns2 {} } 592 namespace ns2 {^ 593 void foo(); 594 namespace {} 595 void bar() {} 596 namespace ns3 {} 597 class T {}; 598 ^} 599 using namespace ns2; 600 })cpp", 601 "ns1::ns2::symbol", "ns1::ns2::"}, 602 {R"cpp( 603 namespace ns1 {^ 604 namespace a { namespace ns2 {} } 605 namespace b {} 606 namespace ns {} 607 ^})cpp", 608 "ns1::ns2::symbol", "ns1::"}, 609 {R"cpp( 610 namespace x { 611 namespace a { namespace ns2 {} } 612 namespace b {} 613 namespace ns {} 614 }^)cpp", 615 "ns1::ns2::symbol", ""}, 616 {R"cpp( 617 namespace ns1 { 618 namespace ns2 {^^} 619 namespace b {} 620 namespace ns2 {^^} 621 } 622 namespace ns1 {namespace ns2 {^^}})cpp", 623 "ns1::ns2::symbol", "ns1::ns2::"}, 624 {R"cpp( 625 namespace ns1 {^ 626 namespace ns {} 627 namespace b {} 628 namespace ns {} 629 ^} 630 namespace ns1 {^namespace ns {}^})cpp", 631 "ns1::ns2::symbol", "ns1::"}, 632 }; 633 for (auto Case : Cases) { 634 Annotations Test(Case.Code); 635 636 auto Res = getEligiblePoints(Test.code(), Case.FullyQualifiedName, 637 format::getLLVMStyle()); 638 EXPECT_THAT(Res.EligiblePoints, testing::ElementsAreArray(Test.points())) 639 << Test.code(); 640 EXPECT_EQ(Res.EnclosingNamespace, Case.EnclosingNamespace) << Test.code(); 641 } 642 } 643 644 TEST(SourceCodeTests, IdentifierRanges) { 645 Annotations Code(R"cpp( 646 class [[Foo]] {}; 647 // Foo 648 /* Foo */ 649 void f([[Foo]]* foo1) { 650 [[Foo]] foo2; 651 auto S = [[Foo]](); 652 // cross-line identifier is not supported. 653 F\ 654 o\ 655 o foo2; 656 } 657 )cpp"); 658 LangOptions LangOpts; 659 LangOpts.CPlusPlus = true; 660 EXPECT_EQ(Code.ranges(), 661 collectIdentifierRanges("Foo", Code.code(), LangOpts)); 662 } 663 664 TEST(SourceCodeTests, isHeaderFile) { 665 // Without lang options. 666 EXPECT_TRUE(isHeaderFile("foo.h")); 667 EXPECT_TRUE(isHeaderFile("foo.hh")); 668 EXPECT_TRUE(isHeaderFile("foo.hpp")); 669 670 EXPECT_FALSE(isHeaderFile("foo.cpp")); 671 EXPECT_FALSE(isHeaderFile("foo.c++")); 672 EXPECT_FALSE(isHeaderFile("foo.cxx")); 673 EXPECT_FALSE(isHeaderFile("foo.cc")); 674 EXPECT_FALSE(isHeaderFile("foo.c")); 675 EXPECT_FALSE(isHeaderFile("foo.mm")); 676 EXPECT_FALSE(isHeaderFile("foo.m")); 677 678 // With lang options 679 LangOptions LangOpts; 680 LangOpts.IsHeaderFile = true; 681 EXPECT_TRUE(isHeaderFile("string", LangOpts)); 682 // Emulate cases where there is no "-x header" flag for a .h file, we still 683 // want to treat it as a header. 684 LangOpts.IsHeaderFile = false; 685 EXPECT_TRUE(isHeaderFile("header.h", LangOpts)); 686 } 687 688 } // namespace 689 } // namespace clangd 690 } // namespace clang 691