1 //===- unittest/Format/FormatTest.cpp - Formatting unit tests -------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #define DEBUG_TYPE "format-test" 11 12 #include "clang/Format/Format.h" 13 #include "clang/Lex/Lexer.h" 14 #include "llvm/Support/Debug.h" 15 #include "gtest/gtest.h" 16 17 namespace clang { 18 namespace format { 19 20 class FormatTest : public ::testing::Test { 21 protected: 22 std::string format(llvm::StringRef Code, unsigned Offset, unsigned Length, 23 const FormatStyle &Style) { 24 DEBUG(llvm::errs() << "---\n"); 25 DEBUG(llvm::errs() << Code << "\n\n"); 26 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length)); 27 tooling::Replacements Replaces = reformat(Style, Code, Ranges); 28 ReplacementCount = Replaces.size(); 29 std::string Result = applyAllReplacements(Code, Replaces); 30 EXPECT_NE("", Result); 31 DEBUG(llvm::errs() << "\n" << Result << "\n\n"); 32 return Result; 33 } 34 35 std::string 36 format(llvm::StringRef Code, const FormatStyle &Style = getLLVMStyle()) { 37 return format(Code, 0, Code.size(), Style); 38 } 39 40 std::string messUp(llvm::StringRef Code) { 41 std::string MessedUp(Code.str()); 42 bool InComment = false; 43 bool InPreprocessorDirective = false; 44 bool JustReplacedNewline = false; 45 for (unsigned i = 0, e = MessedUp.size() - 1; i != e; ++i) { 46 if (MessedUp[i] == '/' && MessedUp[i + 1] == '/') { 47 if (JustReplacedNewline) 48 MessedUp[i - 1] = '\n'; 49 InComment = true; 50 } else if (MessedUp[i] == '#' && (JustReplacedNewline || i == 0)) { 51 if (i != 0) 52 MessedUp[i - 1] = '\n'; 53 InPreprocessorDirective = true; 54 } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') { 55 MessedUp[i] = ' '; 56 MessedUp[i + 1] = ' '; 57 } else if (MessedUp[i] == '\n') { 58 if (InComment) { 59 InComment = false; 60 } else if (InPreprocessorDirective) { 61 InPreprocessorDirective = false; 62 } else { 63 JustReplacedNewline = true; 64 MessedUp[i] = ' '; 65 } 66 } else if (MessedUp[i] != ' ') { 67 JustReplacedNewline = false; 68 } 69 } 70 std::string WithoutWhitespace; 71 if (MessedUp[0] != ' ') 72 WithoutWhitespace.push_back(MessedUp[0]); 73 for (unsigned i = 1, e = MessedUp.size(); i != e; ++i) { 74 if (MessedUp[i] != ' ' || MessedUp[i - 1] != ' ') 75 WithoutWhitespace.push_back(MessedUp[i]); 76 } 77 return WithoutWhitespace; 78 } 79 80 FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) { 81 FormatStyle Style = getLLVMStyle(); 82 Style.ColumnLimit = ColumnLimit; 83 return Style; 84 } 85 86 FormatStyle getGoogleStyleWithColumns(unsigned ColumnLimit) { 87 FormatStyle Style = getGoogleStyle(); 88 Style.ColumnLimit = ColumnLimit; 89 return Style; 90 } 91 92 void verifyFormat(llvm::StringRef Code, 93 const FormatStyle &Style = getLLVMStyle()) { 94 EXPECT_EQ(Code.str(), format(messUp(Code), Style)); 95 } 96 97 void verifyGoogleFormat(llvm::StringRef Code) { 98 verifyFormat(Code, getGoogleStyle()); 99 } 100 101 void verifyIndependentOfContext(llvm::StringRef text) { 102 verifyFormat(text); 103 verifyFormat(llvm::Twine("void f() { " + text + " }").str()); 104 } 105 106 int ReplacementCount; 107 }; 108 109 TEST_F(FormatTest, MessUp) { 110 EXPECT_EQ("1 2 3", messUp("1 2 3")); 111 EXPECT_EQ("1 2 3\n", messUp("1\n2\n3\n")); 112 EXPECT_EQ("a\n//b\nc", messUp("a\n//b\nc")); 113 EXPECT_EQ("a\n#b\nc", messUp("a\n#b\nc")); 114 EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne")); 115 } 116 117 //===----------------------------------------------------------------------===// 118 // Basic function tests. 119 //===----------------------------------------------------------------------===// 120 121 TEST_F(FormatTest, DoesNotChangeCorrectlyFormattedCode) { 122 EXPECT_EQ(";", format(";")); 123 } 124 125 TEST_F(FormatTest, FormatsGlobalStatementsAt0) { 126 EXPECT_EQ("int i;", format(" int i;")); 127 EXPECT_EQ("\nint i;", format(" \n\t \v \f int i;")); 128 EXPECT_EQ("int i;\nint j;", format(" int i; int j;")); 129 EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;")); 130 } 131 132 TEST_F(FormatTest, FormatsUnwrappedLinesAtFirstFormat) { 133 EXPECT_EQ("int i;", format("int\ni;")); 134 } 135 136 TEST_F(FormatTest, FormatsNestedBlockStatements) { 137 EXPECT_EQ("{\n {\n {}\n }\n}", format("{{{}}}")); 138 } 139 140 TEST_F(FormatTest, FormatsNestedCall) { 141 verifyFormat("Method(f1, f2(f3));"); 142 verifyFormat("Method(f1(f2, f3()));"); 143 verifyFormat("Method(f1(f2, (f3())));"); 144 } 145 146 TEST_F(FormatTest, NestedNameSpecifiers) { 147 verifyFormat("vector< ::Type> v;"); 148 verifyFormat("::ns::SomeFunction(::ns::SomeOtherFunction())"); 149 verifyFormat("static constexpr bool Bar = decltype(bar())::value;"); 150 } 151 152 TEST_F(FormatTest, OnlyGeneratesNecessaryReplacements) { 153 EXPECT_EQ("if (a) {\n" 154 " f();\n" 155 "}", 156 format("if(a){f();}")); 157 EXPECT_EQ(4, ReplacementCount); 158 EXPECT_EQ("if (a) {\n" 159 " f();\n" 160 "}", 161 format("if (a) {\n" 162 " f();\n" 163 "}")); 164 EXPECT_EQ(0, ReplacementCount); 165 } 166 167 TEST_F(FormatTest, RemovesTrailingWhitespaceOfFormattedLine) { 168 EXPECT_EQ("int a;\nint b;", format("int a; \nint b;", 0, 0, getLLVMStyle())); 169 EXPECT_EQ("int a;", format("int a; ")); 170 EXPECT_EQ("int a;\n", format("int a; \n \n \n ")); 171 EXPECT_EQ("int a;\nint b; ", 172 format("int a; \nint b; ", 0, 0, getLLVMStyle())); 173 } 174 175 TEST_F(FormatTest, FormatsCorrectRegionForLeadingWhitespace) { 176 EXPECT_EQ("int b;\nint a;", 177 format("int b;\n int a;", 7, 0, getLLVMStyle())); 178 EXPECT_EQ("int b;\n int a;", 179 format("int b;\n int a;", 6, 0, getLLVMStyle())); 180 181 EXPECT_EQ("#define A \\\n" 182 " int a; \\\n" 183 " int b;", 184 format("#define A \\\n" 185 " int a; \\\n" 186 " int b;", 187 26, 0, getLLVMStyleWithColumns(12))); 188 EXPECT_EQ("#define A \\\n" 189 " int a; \\\n" 190 " int b;", 191 format("#define A \\\n" 192 " int a; \\\n" 193 " int b;", 194 25, 0, getLLVMStyleWithColumns(12))); 195 } 196 197 TEST_F(FormatTest, RemovesWhitespaceWhenTriggeredOnEmptyLine) { 198 EXPECT_EQ("int a;\n\n int b;", 199 format("int a;\n \n\n int b;", 7, 0, getLLVMStyle())); 200 EXPECT_EQ("int a;\n\n int b;", 201 format("int a;\n \n\n int b;", 9, 0, getLLVMStyle())); 202 } 203 204 TEST_F(FormatTest, RemovesEmptyLines) { 205 EXPECT_EQ("class C {\n" 206 " int i;\n" 207 "};", 208 format("class C {\n" 209 " int i;\n" 210 "\n" 211 "};")); 212 213 // Don't remove empty lines in more complex control statements. 214 EXPECT_EQ("void f() {\n" 215 " if (a) {\n" 216 " f();\n" 217 "\n" 218 " } else if (b) {\n" 219 " f();\n" 220 " }\n" 221 "}", 222 format("void f() {\n" 223 " if (a) {\n" 224 " f();\n" 225 "\n" 226 " } else if (b) {\n" 227 " f();\n" 228 "\n" 229 " }\n" 230 "\n" 231 "}")); 232 233 // FIXME: This is slightly inconsistent. 234 EXPECT_EQ("namespace {\n" 235 "int i;\n" 236 "}", 237 format("namespace {\n" 238 "int i;\n" 239 "\n" 240 "}")); 241 EXPECT_EQ("namespace {\n" 242 "int i;\n" 243 "\n" 244 "} // namespace", 245 format("namespace {\n" 246 "int i;\n" 247 "\n" 248 "} // namespace")); 249 } 250 251 TEST_F(FormatTest, ReformatsMovedLines) { 252 EXPECT_EQ( 253 "template <typename T> T *getFETokenInfo() const {\n" 254 " return static_cast<T *>(FETokenInfo);\n" 255 "}\n" 256 " int a; // <- Should not be formatted", 257 format( 258 "template<typename T>\n" 259 "T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); }\n" 260 " int a; // <- Should not be formatted", 261 9, 5, getLLVMStyle())); 262 } 263 264 //===----------------------------------------------------------------------===// 265 // Tests for control statements. 266 //===----------------------------------------------------------------------===// 267 268 TEST_F(FormatTest, FormatIfWithoutCompoundStatement) { 269 verifyFormat("if (true)\n f();\ng();"); 270 verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();"); 271 verifyFormat("if (a)\n if (b) {\n f();\n }\ng();"); 272 273 FormatStyle AllowsMergedIf = getLLVMStyle(); 274 AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; 275 verifyFormat("if (a)\n" 276 " // comment\n" 277 " f();", 278 AllowsMergedIf); 279 verifyFormat("if (a)\n" 280 " ;", 281 AllowsMergedIf); 282 verifyFormat("if (a)\n" 283 " if (b) return;", 284 AllowsMergedIf); 285 286 verifyFormat("if (a) // Can't merge this\n" 287 " f();\n", 288 AllowsMergedIf); 289 verifyFormat("if (a) /* still don't merge */\n" 290 " f();", 291 AllowsMergedIf); 292 verifyFormat("if (a) { // Never merge this\n" 293 " f();\n" 294 "}", 295 AllowsMergedIf); 296 verifyFormat("if (a) { /* Never merge this */\n" 297 " f();\n" 298 "}", 299 AllowsMergedIf); 300 301 EXPECT_EQ("if (a) return;", format("if(a)\nreturn;", 7, 1, AllowsMergedIf)); 302 EXPECT_EQ("if (a) return; // comment", 303 format("if(a)\nreturn; // comment", 20, 1, AllowsMergedIf)); 304 305 AllowsMergedIf.ColumnLimit = 14; 306 verifyFormat("if (a) return;", AllowsMergedIf); 307 verifyFormat("if (aaaaaaaaa)\n" 308 " return;", 309 AllowsMergedIf); 310 311 AllowsMergedIf.ColumnLimit = 13; 312 verifyFormat("if (a)\n return;", AllowsMergedIf); 313 } 314 315 TEST_F(FormatTest, FormatLoopsWithoutCompoundStatement) { 316 FormatStyle AllowsMergedLoops = getLLVMStyle(); 317 AllowsMergedLoops.AllowShortLoopsOnASingleLine = true; 318 verifyFormat("while (true) continue;", AllowsMergedLoops); 319 verifyFormat("for (;;) continue;", AllowsMergedLoops); 320 verifyFormat("for (int &v : vec) v *= 2;", AllowsMergedLoops); 321 verifyFormat("while (true)\n" 322 " ;", 323 AllowsMergedLoops); 324 verifyFormat("for (;;)\n" 325 " ;", 326 AllowsMergedLoops); 327 verifyFormat("for (;;)\n" 328 " for (;;) continue;", 329 AllowsMergedLoops); 330 verifyFormat("for (;;) // Can't merge this\n" 331 " continue;", 332 AllowsMergedLoops); 333 verifyFormat("for (;;) /* still don't merge */\n" 334 " continue;", 335 AllowsMergedLoops); 336 } 337 338 TEST_F(FormatTest, ParseIfElse) { 339 verifyFormat("if (true)\n" 340 " if (true)\n" 341 " if (true)\n" 342 " f();\n" 343 " else\n" 344 " g();\n" 345 " else\n" 346 " h();\n" 347 "else\n" 348 " i();"); 349 verifyFormat("if (true)\n" 350 " if (true)\n" 351 " if (true) {\n" 352 " if (true)\n" 353 " f();\n" 354 " } else {\n" 355 " g();\n" 356 " }\n" 357 " else\n" 358 " h();\n" 359 "else {\n" 360 " i();\n" 361 "}"); 362 verifyFormat("void f() {\n" 363 " if (a) {\n" 364 " } else {\n" 365 " }\n" 366 "}"); 367 } 368 369 TEST_F(FormatTest, ElseIf) { 370 verifyFormat("if (a) {\n} else if (b) {\n}"); 371 verifyFormat("if (a)\n" 372 " f();\n" 373 "else if (b)\n" 374 " g();\n" 375 "else\n" 376 " h();"); 377 } 378 379 TEST_F(FormatTest, FormatsForLoop) { 380 verifyFormat( 381 "for (int VeryVeryLongLoopVariable = 0; VeryVeryLongLoopVariable < 10;\n" 382 " ++VeryVeryLongLoopVariable)\n" 383 " ;"); 384 verifyFormat("for (;;)\n" 385 " f();"); 386 verifyFormat("for (;;) {\n}"); 387 verifyFormat("for (;;) {\n" 388 " f();\n" 389 "}"); 390 verifyFormat("for (int i = 0; (i < 10); ++i) {\n}"); 391 392 verifyFormat( 393 "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n" 394 " E = UnwrappedLines.end();\n" 395 " I != E; ++I) {\n}"); 396 397 verifyFormat( 398 "for (MachineFun::iterator IIII = PrevIt, EEEE = F.end(); IIII != EEEE;\n" 399 " ++IIIII) {\n}"); 400 verifyFormat("for (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaa =\n" 401 " aaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa;\n" 402 " aaaaaaaaaaa != aaaaaaaaaaaaaaaaaaa; ++aaaaaaaaaaa) {\n}"); 403 verifyFormat("for (llvm::ArrayRef<NamedDecl *>::iterator\n" 404 " I = FD->getDeclsInPrototypeScope().begin(),\n" 405 " E = FD->getDeclsInPrototypeScope().end();\n" 406 " I != E; ++I) {\n}"); 407 408 // FIXME: Not sure whether we want extra identation in line 3 here: 409 verifyFormat( 410 "for (aaaaaaaaaaaaaaaaa aaaaaaaaaaa = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;\n" 411 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa !=\n" 412 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 413 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 414 " ++aaaaaaaaaaa) {\n}"); 415 verifyFormat("for (int aaaaaaaaaaa = 1; aaaaaaaaaaa <= bbbbbbbbbbbbbbb;\n" 416 " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n" 417 "}"); 418 verifyFormat("for (some_namespace::SomeIterator iter( // force break\n" 419 " aaaaaaaaaa);\n" 420 " iter; ++iter) {\n" 421 "}"); 422 423 FormatStyle NoBinPacking = getLLVMStyle(); 424 NoBinPacking.BinPackParameters = false; 425 verifyFormat("for (int aaaaaaaaaaa = 1;\n" 426 " aaaaaaaaaaa <= aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa,\n" 427 " aaaaaaaaaaaaaaaa,\n" 428 " aaaaaaaaaaaaaaaa,\n" 429 " aaaaaaaaaaaaaaaa);\n" 430 " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n" 431 "}", 432 NoBinPacking); 433 verifyFormat( 434 "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n" 435 " E = UnwrappedLines.end();\n" 436 " I != E;\n" 437 " ++I) {\n}", 438 NoBinPacking); 439 } 440 441 TEST_F(FormatTest, RangeBasedForLoops) { 442 verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" 443 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 444 verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaa :\n" 445 " aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa, aaaaaaaaaaaaa)) {\n}"); 446 verifyFormat("for (const aaaaaaaaaaaaaaaaaaaaa &aaaaaaaaa :\n" 447 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 448 } 449 450 TEST_F(FormatTest, FormatsWhileLoop) { 451 verifyFormat("while (true) {\n}"); 452 verifyFormat("while (true)\n" 453 " f();"); 454 verifyFormat("while () {\n}"); 455 verifyFormat("while () {\n" 456 " f();\n" 457 "}"); 458 } 459 460 TEST_F(FormatTest, FormatsDoWhile) { 461 verifyFormat("do {\n" 462 " do_something();\n" 463 "} while (something());"); 464 verifyFormat("do\n" 465 " do_something();\n" 466 "while (something());"); 467 } 468 469 TEST_F(FormatTest, FormatsSwitchStatement) { 470 verifyFormat("switch (x) {\n" 471 "case 1:\n" 472 " f();\n" 473 " break;\n" 474 "case kFoo:\n" 475 "case ns::kBar:\n" 476 "case kBaz:\n" 477 " break;\n" 478 "default:\n" 479 " g();\n" 480 " break;\n" 481 "}"); 482 verifyFormat("switch (x) {\n" 483 "case 1: {\n" 484 " f();\n" 485 " break;\n" 486 "}\n" 487 "}"); 488 verifyFormat("switch (x) {\n" 489 "case 1: {\n" 490 " f();\n" 491 " {\n" 492 " g();\n" 493 " h();\n" 494 " }\n" 495 " break;\n" 496 "}\n" 497 "}"); 498 verifyFormat("switch (x) {\n" 499 "case 1: {\n" 500 " f();\n" 501 " if (foo) {\n" 502 " g();\n" 503 " h();\n" 504 " }\n" 505 " break;\n" 506 "}\n" 507 "}"); 508 verifyFormat("switch (x) {\n" 509 "case 1: {\n" 510 " f();\n" 511 " g();\n" 512 "} break;\n" 513 "}"); 514 verifyFormat("switch (test)\n" 515 " ;"); 516 verifyFormat("switch (x) {\n" 517 "default: {\n" 518 " // Do nothing.\n" 519 "}\n" 520 "}"); 521 verifyFormat("switch (x) {\n" 522 "// comment\n" 523 "// if 1, do f()\n" 524 "case 1:\n" 525 " f();\n" 526 "}"); 527 verifyFormat("switch (x) {\n" 528 "case 1:\n" 529 " // Do amazing stuff\n" 530 " {\n" 531 " f();\n" 532 " g();\n" 533 " }\n" 534 " break;\n" 535 "}"); 536 verifyFormat("#define A \\\n" 537 " switch (x) { \\\n" 538 " case a: \\\n" 539 " foo = b; \\\n" 540 " }", getLLVMStyleWithColumns(20)); 541 verifyFormat("#define OPERATION_CASE(name) \\\n" 542 " case OP_name: \\\n" 543 " return operations::Operation##name\n", 544 getLLVMStyleWithColumns(40)); 545 546 verifyGoogleFormat("switch (x) {\n" 547 " case 1:\n" 548 " f();\n" 549 " break;\n" 550 " case kFoo:\n" 551 " case ns::kBar:\n" 552 " case kBaz:\n" 553 " break;\n" 554 " default:\n" 555 " g();\n" 556 " break;\n" 557 "}"); 558 verifyGoogleFormat("switch (x) {\n" 559 " case 1: {\n" 560 " f();\n" 561 " break;\n" 562 " }\n" 563 "}"); 564 verifyGoogleFormat("switch (test)\n" 565 " ;"); 566 567 verifyGoogleFormat("#define OPERATION_CASE(name) \\\n" 568 " case OP_name: \\\n" 569 " return operations::Operation##name\n"); 570 verifyGoogleFormat("Operation codeToOperation(OperationCode OpCode) {\n" 571 " // Get the correction operation class.\n" 572 " switch (OpCode) {\n" 573 " CASE(Add);\n" 574 " CASE(Subtract);\n" 575 " default:\n" 576 " return operations::Unknown;\n" 577 " }\n" 578 "#undef OPERATION_CASE\n" 579 "}"); 580 verifyFormat("DEBUG({\n" 581 " switch (x) {\n" 582 " case A:\n" 583 " f();\n" 584 " break;\n" 585 " // On B:\n" 586 " case B:\n" 587 " g();\n" 588 " break;\n" 589 " }\n" 590 "});"); 591 } 592 593 TEST_F(FormatTest, CaseRanges) { 594 verifyFormat("switch (x) {\n" 595 "case 'A' ... 'Z':\n" 596 "case 1 ... 5:\n" 597 " break;\n" 598 "}"); 599 } 600 601 TEST_F(FormatTest, FormatsLabels) { 602 verifyFormat("void f() {\n" 603 " some_code();\n" 604 "test_label:\n" 605 " some_other_code();\n" 606 " {\n" 607 " some_more_code();\n" 608 " another_label:\n" 609 " some_more_code();\n" 610 " }\n" 611 "}"); 612 verifyFormat("some_code();\n" 613 "test_label:\n" 614 "some_other_code();"); 615 } 616 617 //===----------------------------------------------------------------------===// 618 // Tests for comments. 619 //===----------------------------------------------------------------------===// 620 621 TEST_F(FormatTest, UnderstandsSingleLineComments) { 622 verifyFormat("//* */"); 623 verifyFormat("// line 1\n" 624 "// line 2\n" 625 "void f() {}\n"); 626 627 verifyFormat("void f() {\n" 628 " // Doesn't do anything\n" 629 "}"); 630 verifyFormat("SomeObject\n" 631 " // Calling someFunction on SomeObject\n" 632 " .someFunction();"); 633 verifyFormat("void f(int i, // some comment (probably for i)\n" 634 " int j, // some comment (probably for j)\n" 635 " int k); // some comment (probably for k)"); 636 verifyFormat("void f(int i,\n" 637 " // some comment (probably for j)\n" 638 " int j,\n" 639 " // some comment (probably for k)\n" 640 " int k);"); 641 642 verifyFormat("int i // This is a fancy variable\n" 643 " = 5; // with nicely aligned comment."); 644 645 verifyFormat("// Leading comment.\n" 646 "int a; // Trailing comment."); 647 verifyFormat("int a; // Trailing comment\n" 648 " // on 2\n" 649 " // or 3 lines.\n" 650 "int b;"); 651 verifyFormat("int a; // Trailing comment\n" 652 "\n" 653 "// Leading comment.\n" 654 "int b;"); 655 verifyFormat("int a; // Comment.\n" 656 " // More details.\n" 657 "int bbbb; // Another comment."); 658 verifyFormat( 659 "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; // comment\n" 660 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // comment\n" 661 "int cccccccccccccccccccccccccccccc; // comment\n" 662 "int ddd; // looooooooooooooooooooooooong comment\n" 663 "int aaaaaaaaaaaaaaaaaaaaaaa; // comment\n" 664 "int bbbbbbbbbbbbbbbbbbbbb; // comment\n" 665 "int ccccccccccccccccccc; // comment"); 666 667 verifyFormat("#include \"a\" // comment\n" 668 "#include \"a/b/c\" // comment"); 669 verifyFormat("#include <a> // comment\n" 670 "#include <a/b/c> // comment"); 671 EXPECT_EQ("#include \\\n" 672 " \"a\" // comment\n" 673 "#include \"a/b/c\" // comment", 674 format("#include \\\n" 675 " \"a\" // comment\n" 676 "#include \"a/b/c\" // comment")); 677 678 verifyFormat("enum E {\n" 679 " // comment\n" 680 " VAL_A, // comment\n" 681 " VAL_B\n" 682 "};"); 683 684 verifyFormat( 685 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 686 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // Trailing comment"); 687 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 688 " // Comment inside a statement.\n" 689 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 690 verifyFormat( 691 "bool aaaaaaaaaaaaa = // comment\n" 692 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 693 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 694 695 verifyFormat("int aaaa; // aaaaa\n" 696 "int aa; // aaaaaaa", 697 getLLVMStyleWithColumns(20)); 698 699 EXPECT_EQ("void f() { // This does something ..\n" 700 "}\n" 701 "int a; // This is unrelated", 702 format("void f() { // This does something ..\n" 703 " }\n" 704 "int a; // This is unrelated")); 705 EXPECT_EQ("class C {\n" 706 " void f() { // This does something ..\n" 707 " } // awesome..\n" 708 "\n" 709 " int a; // This is unrelated\n" 710 "};", 711 format("class C{void f() { // This does something ..\n" 712 " } // awesome..\n" 713 " \n" 714 "int a; // This is unrelated\n" 715 "};")); 716 717 EXPECT_EQ("int i; // single line trailing comment", 718 format("int i;\\\n// single line trailing comment")); 719 720 verifyGoogleFormat("int a; // Trailing comment."); 721 722 verifyFormat("someFunction(anotherFunction( // Force break.\n" 723 " parameter));"); 724 725 verifyGoogleFormat("#endif // HEADER_GUARD"); 726 727 verifyFormat("const char *test[] = {\n" 728 " // A\n" 729 " \"aaaa\",\n" 730 " // B\n" 731 " \"aaaaa\",\n" 732 "};"); 733 verifyGoogleFormat( 734 "aaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 735 " aaaaaaaaaaaaaaaaaaaaaa); // 81_cols_with_this_comment"); 736 EXPECT_EQ("D(a, {\n" 737 " // test\n" 738 " int a;\n" 739 "});", 740 format("D(a, {\n" 741 "// test\n" 742 "int a;\n" 743 "});")); 744 745 EXPECT_EQ("lineWith(); // comment\n" 746 "// at start\n" 747 "otherLine();", 748 format("lineWith(); // comment\n" 749 "// at start\n" 750 "otherLine();")); 751 EXPECT_EQ("lineWith(); // comment\n" 752 " // at start\n" 753 "otherLine();", 754 format("lineWith(); // comment\n" 755 " // at start\n" 756 "otherLine();")); 757 758 EXPECT_EQ("lineWith(); // comment\n" 759 "// at start\n" 760 "otherLine(); // comment", 761 format("lineWith(); // comment\n" 762 "// at start\n" 763 "otherLine(); // comment")); 764 EXPECT_EQ("lineWith();\n" 765 "// at start\n" 766 "otherLine(); // comment", 767 format("lineWith();\n" 768 " // at start\n" 769 "otherLine(); // comment")); 770 EXPECT_EQ("// first\n" 771 "// at start\n" 772 "otherLine(); // comment", 773 format("// first\n" 774 " // at start\n" 775 "otherLine(); // comment")); 776 EXPECT_EQ("f();\n" 777 "// first\n" 778 "// at start\n" 779 "otherLine(); // comment", 780 format("f();\n" 781 "// first\n" 782 " // at start\n" 783 "otherLine(); // comment")); 784 } 785 786 TEST_F(FormatTest, CanFormatCommentsLocally) { 787 EXPECT_EQ("int a; // comment\n" 788 "int b; // comment", 789 format("int a; // comment\n" 790 "int b; // comment", 791 0, 0, getLLVMStyle())); 792 EXPECT_EQ("int a; // comment\n" 793 " // line 2\n" 794 "int b;", 795 format("int a; // comment\n" 796 " // line 2\n" 797 "int b;", 798 28, 0, getLLVMStyle())); 799 EXPECT_EQ("int aaaaaa; // comment\n" 800 "int b;\n" 801 "int c; // unrelated comment", 802 format("int aaaaaa; // comment\n" 803 "int b;\n" 804 "int c; // unrelated comment", 805 31, 0, getLLVMStyle())); 806 } 807 808 TEST_F(FormatTest, RemovesTrailingWhitespaceOfComments) { 809 EXPECT_EQ("// comment", format("// comment ")); 810 EXPECT_EQ("int aaaaaaa, bbbbbbb; // comment", 811 format("int aaaaaaa, bbbbbbb; // comment ", 812 getLLVMStyleWithColumns(33))); 813 EXPECT_EQ("// comment\\\n", format("// comment\\\n \t \v \f ")); 814 EXPECT_EQ("// comment \\\n", format("// comment \\\n \t \v \f ")); 815 } 816 817 TEST_F(FormatTest, UnderstandsBlockComments) { 818 verifyFormat("f(/*noSpaceAfterParameterNamingComment=*/true);"); 819 EXPECT_EQ( 820 "f(aaaaaaaaaaaaaaaaaaaaaaaaa, /* Trailing comment for aa... */\n" 821 " bbbbbbbbbbbbbbbbbbbbbbbbb);", 822 format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \\\n/* Trailing comment for aa... */\n" 823 " bbbbbbbbbbbbbbbbbbbbbbbbb);")); 824 EXPECT_EQ( 825 "f(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 826 " /* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);", 827 format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \n" 828 "/* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);")); 829 EXPECT_EQ( 830 "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 831 " aaaaaaaaaaaaaaaaaa,\n" 832 " aaaaaaaaaaaaaaaaaa) { /*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/\n" 833 "}", 834 format("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 835 " aaaaaaaaaaaaaaaaaa ,\n" 836 " aaaaaaaaaaaaaaaaaa) { /*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/\n" 837 "}")); 838 839 FormatStyle NoBinPacking = getLLVMStyle(); 840 NoBinPacking.BinPackParameters = false; 841 verifyFormat("aaaaaaaa(/* parameter 1 */ aaaaaa,\n" 842 " /* parameter 2 */ aaaaaa,\n" 843 " /* parameter 3 */ aaaaaa,\n" 844 " /* parameter 4 */ aaaaaa);", 845 NoBinPacking); 846 } 847 848 TEST_F(FormatTest, AlignsBlockComments) { 849 EXPECT_EQ("/*\n" 850 " * Really multi-line\n" 851 " * comment.\n" 852 " */\n" 853 "void f() {}", 854 format(" /*\n" 855 " * Really multi-line\n" 856 " * comment.\n" 857 " */\n" 858 " void f() {}")); 859 EXPECT_EQ("class C {\n" 860 " /*\n" 861 " * Another multi-line\n" 862 " * comment.\n" 863 " */\n" 864 " void f() {}\n" 865 "};", 866 format("class C {\n" 867 "/*\n" 868 " * Another multi-line\n" 869 " * comment.\n" 870 " */\n" 871 "void f() {}\n" 872 "};")); 873 EXPECT_EQ("/*\n" 874 " 1. This is a comment with non-trivial formatting.\n" 875 " 1.1. We have to indent/outdent all lines equally\n" 876 " 1.1.1. to keep the formatting.\n" 877 " */", 878 format(" /*\n" 879 " 1. This is a comment with non-trivial formatting.\n" 880 " 1.1. We have to indent/outdent all lines equally\n" 881 " 1.1.1. to keep the formatting.\n" 882 " */")); 883 EXPECT_EQ("/*\n" 884 "Don't try to outdent if there's not enough indentation.\n" 885 "*/", 886 format(" /*\n" 887 " Don't try to outdent if there's not enough indentation.\n" 888 " */")); 889 890 EXPECT_EQ("int i; /* Comment with empty...\n" 891 " *\n" 892 " * line. */", 893 format("int i; /* Comment with empty...\n" 894 " *\n" 895 " * line. */")); 896 } 897 898 TEST_F(FormatTest, CorrectlyHandlesLengthOfBlockComments) { 899 EXPECT_EQ("double *x; /* aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 900 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */", 901 format("double *x; /* aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 902 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */")); 903 EXPECT_EQ( 904 "void ffffffffffff(\n" 905 " int aaaaaaaa, int bbbbbbbb,\n" 906 " int cccccccccccc) { /*\n" 907 " aaaaaaaaaa\n" 908 " aaaaaaaaaaaaa\n" 909 " bbbbbbbbbbbbbb\n" 910 " bbbbbbbbbb\n" 911 " */\n" 912 "}", 913 format("void ffffffffffff(int aaaaaaaa, int bbbbbbbb, int cccccccccccc)\n" 914 "{ /*\n" 915 " aaaaaaaaaa aaaaaaaaaaaaa\n" 916 " bbbbbbbbbbbbbb bbbbbbbbbb\n" 917 " */\n" 918 "}", 919 getLLVMStyleWithColumns(40))); 920 } 921 922 TEST_F(FormatTest, DontBreakNonTrailingBlockComments) { 923 EXPECT_EQ("void\n" 924 "ffffffffff(int aaaaa /* test */);", 925 format("void ffffffffff(int aaaaa /* test */);", 926 getLLVMStyleWithColumns(35))); 927 } 928 929 TEST_F(FormatTest, SplitsLongCxxComments) { 930 EXPECT_EQ("// A comment that\n" 931 "// doesn't fit on\n" 932 "// one line", 933 format("// A comment that doesn't fit on one line", 934 getLLVMStyleWithColumns(20))); 935 EXPECT_EQ("// a b c d\n" 936 "// e f g\n" 937 "// h i j k", 938 format("// a b c d e f g h i j k", 939 getLLVMStyleWithColumns(10))); 940 EXPECT_EQ("// a b c d\n" 941 "// e f g\n" 942 "// h i j k", 943 format("\\\n// a b c d e f g h i j k", 944 getLLVMStyleWithColumns(10))); 945 EXPECT_EQ("if (true) // A comment that\n" 946 " // doesn't fit on\n" 947 " // one line", 948 format("if (true) // A comment that doesn't fit on one line ", 949 getLLVMStyleWithColumns(30))); 950 EXPECT_EQ("// Don't_touch_leading_whitespace", 951 format("// Don't_touch_leading_whitespace", 952 getLLVMStyleWithColumns(20))); 953 EXPECT_EQ("// Add leading\n" 954 "// whitespace", 955 format("//Add leading whitespace", getLLVMStyleWithColumns(20))); 956 EXPECT_EQ("// whitespace", format("//whitespace", getLLVMStyle())); 957 EXPECT_EQ("// Even if it makes the line exceed the column\n" 958 "// limit", 959 format("//Even if it makes the line exceed the column limit", 960 getLLVMStyleWithColumns(51))); 961 EXPECT_EQ("//--But not here", format("//--But not here", getLLVMStyle())); 962 EXPECT_EQ("// A comment before\n" 963 "// a macro\n" 964 "// definition\n" 965 "#define a b", 966 format("// A comment before a macro definition\n" 967 "#define a b", 968 getLLVMStyleWithColumns(20))); 969 EXPECT_EQ("void ffffff(int aaaaaaaaa, // wwww\n" 970 " int a, int bbb, // xxxxxxx\n" 971 " // yyyyyyyyy\n" 972 " int c, int d, int e) {}", 973 format("void ffffff(\n" 974 " int aaaaaaaaa, // wwww\n" 975 " int a,\n" 976 " int bbb, // xxxxxxx yyyyyyyyy\n" 977 " int c, int d, int e) {}", 978 getLLVMStyleWithColumns(40))); 979 EXPECT_EQ("//\t aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 980 format("//\t aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 981 getLLVMStyleWithColumns(20))); 982 } 983 984 TEST_F(FormatTest, DontSplitLineCommentsWithEscapedNewlines) { 985 EXPECT_EQ("// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 986 "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 987 "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 988 format("// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 989 "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 990 "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")); 991 EXPECT_EQ("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 992 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 993 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 994 format("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 995 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 996 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 997 getLLVMStyleWithColumns(50))); 998 // FIXME: One day we might want to implement adjustment of leading whitespace 999 // of the consecutive lines in this kind of comment: 1000 EXPECT_EQ("int\n" 1001 "a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 1002 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 1003 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 1004 format("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 1005 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" 1006 " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", 1007 getLLVMStyleWithColumns(49))); 1008 } 1009 1010 TEST_F(FormatTest, PriorityOfCommentBreaking) { 1011 EXPECT_EQ("if (xxx ==\n" 1012 " yyy && // aaaaaaaaaaaa bbbbbbbbb\n" 1013 " zzz)\n" 1014 " q();", 1015 format("if (xxx == yyy && // aaaaaaaaaaaa bbbbbbbbb\n" 1016 " zzz) q();", 1017 getLLVMStyleWithColumns(40))); 1018 EXPECT_EQ("if (xxxxxxxxxx ==\n" 1019 " yyy && // aaaaaa bbbbbbbb cccc\n" 1020 " zzz)\n" 1021 " q();", 1022 format("if (xxxxxxxxxx == yyy && // aaaaaa bbbbbbbb cccc\n" 1023 " zzz) q();", 1024 getLLVMStyleWithColumns(40))); 1025 EXPECT_EQ("if (xxxxxxxxxx &&\n" 1026 " yyy || // aaaaaa bbbbbbbb cccc\n" 1027 " zzz)\n" 1028 " q();", 1029 format("if (xxxxxxxxxx && yyy || // aaaaaa bbbbbbbb cccc\n" 1030 " zzz) q();", 1031 getLLVMStyleWithColumns(40))); 1032 EXPECT_EQ("fffffffff(&xxx, // aaaaaaaaaaaa\n" 1033 " // bbbbbbbbbbb\n" 1034 " zzz);", 1035 format("fffffffff(&xxx, // aaaaaaaaaaaa bbbbbbbbbbb\n" 1036 " zzz);", 1037 getLLVMStyleWithColumns(40))); 1038 } 1039 1040 TEST_F(FormatTest, MultiLineCommentsInDefines) { 1041 EXPECT_EQ("#define A(x) /* \\\n" 1042 " a comment \\\n" 1043 " inside */ \\\n" 1044 " f();", 1045 format("#define A(x) /* \\\n" 1046 " a comment \\\n" 1047 " inside */ \\\n" 1048 " f();", 1049 getLLVMStyleWithColumns(17))); 1050 EXPECT_EQ("#define A( \\\n" 1051 " x) /* \\\n" 1052 " a comment \\\n" 1053 " inside */ \\\n" 1054 " f();", 1055 format("#define A( \\\n" 1056 " x) /* \\\n" 1057 " a comment \\\n" 1058 " inside */ \\\n" 1059 " f();", 1060 getLLVMStyleWithColumns(17))); 1061 } 1062 1063 TEST_F(FormatTest, ParsesCommentsAdjacentToPPDirectives) { 1064 EXPECT_EQ("namespace {}\n// Test\n#define A", 1065 format("namespace {}\n // Test\n#define A")); 1066 EXPECT_EQ("namespace {}\n/* Test */\n#define A", 1067 format("namespace {}\n /* Test */\n#define A")); 1068 EXPECT_EQ("namespace {}\n/* Test */ #define A", 1069 format("namespace {}\n /* Test */ #define A")); 1070 } 1071 1072 TEST_F(FormatTest, SplitsLongLinesInComments) { 1073 EXPECT_EQ("/* This is a long\n" 1074 " * comment that\n" 1075 " * doesn't\n" 1076 " * fit on one line.\n" 1077 " */", 1078 format("/* " 1079 "This is a long " 1080 "comment that " 1081 "doesn't " 1082 "fit on one line. */", 1083 getLLVMStyleWithColumns(20))); 1084 EXPECT_EQ("/* a b c d\n" 1085 " * e f g\n" 1086 " * h i j k\n" 1087 " */", 1088 format("/* a b c d e f g h i j k */", 1089 getLLVMStyleWithColumns(10))); 1090 EXPECT_EQ("/* a b c d\n" 1091 " * e f g\n" 1092 " * h i j k\n" 1093 " */", 1094 format("\\\n/* a b c d e f g h i j k */", 1095 getLLVMStyleWithColumns(10))); 1096 EXPECT_EQ("/*\n" 1097 "This is a long\n" 1098 "comment that doesn't\n" 1099 "fit on one line.\n" 1100 "*/", 1101 format("/*\n" 1102 "This is a long " 1103 "comment that doesn't " 1104 "fit on one line. \n" 1105 "*/", getLLVMStyleWithColumns(20))); 1106 EXPECT_EQ("/*\n" 1107 " * This is a long\n" 1108 " * comment that\n" 1109 " * doesn't fit on\n" 1110 " * one line.\n" 1111 " */", 1112 format("/* \n" 1113 " * This is a long " 1114 " comment that " 1115 " doesn't fit on " 1116 " one line. \n" 1117 " */", getLLVMStyleWithColumns(20))); 1118 EXPECT_EQ("/*\n" 1119 " * This_is_a_comment_with_words_that_dont_fit_on_one_line\n" 1120 " * so_it_should_be_broken\n" 1121 " * wherever_a_space_occurs\n" 1122 " */", 1123 format("/*\n" 1124 " * This_is_a_comment_with_words_that_dont_fit_on_one_line " 1125 " so_it_should_be_broken " 1126 " wherever_a_space_occurs \n" 1127 " */", 1128 getLLVMStyleWithColumns(20))); 1129 EXPECT_EQ("/*\n" 1130 " * This_comment_can_not_be_broken_into_lines\n" 1131 " */", 1132 format("/*\n" 1133 " * This_comment_can_not_be_broken_into_lines\n" 1134 " */", 1135 getLLVMStyleWithColumns(20))); 1136 EXPECT_EQ("{\n" 1137 " /*\n" 1138 " This is another\n" 1139 " long comment that\n" 1140 " doesn't fit on one\n" 1141 " line 1234567890\n" 1142 " */\n" 1143 "}", 1144 format("{\n" 1145 "/*\n" 1146 "This is another " 1147 " long comment that " 1148 " doesn't fit on one" 1149 " line 1234567890\n" 1150 "*/\n" 1151 "}", getLLVMStyleWithColumns(20))); 1152 EXPECT_EQ("{\n" 1153 " /*\n" 1154 " * This i s\n" 1155 " * another comment\n" 1156 " * t hat doesn' t\n" 1157 " * fit on one l i\n" 1158 " * n e\n" 1159 " */\n" 1160 "}", 1161 format("{\n" 1162 "/*\n" 1163 " * This i s" 1164 " another comment" 1165 " t hat doesn' t" 1166 " fit on one l i" 1167 " n e\n" 1168 " */\n" 1169 "}", getLLVMStyleWithColumns(20))); 1170 EXPECT_EQ("/*\n" 1171 " * This is a long\n" 1172 " * comment that\n" 1173 " * doesn't fit on\n" 1174 " * one line\n" 1175 " */", 1176 format(" /*\n" 1177 " * This is a long comment that doesn't fit on one line\n" 1178 " */", getLLVMStyleWithColumns(20))); 1179 EXPECT_EQ("{\n" 1180 " if (something) /* This is a\n" 1181 " long\n" 1182 " comment */\n" 1183 " ;\n" 1184 "}", 1185 format("{\n" 1186 " if (something) /* This is a long comment */\n" 1187 " ;\n" 1188 "}", 1189 getLLVMStyleWithColumns(30))); 1190 1191 EXPECT_EQ("/* A comment before\n" 1192 " * a macro\n" 1193 " * definition */\n" 1194 "#define a b", 1195 format("/* A comment before a macro definition */\n" 1196 "#define a b", 1197 getLLVMStyleWithColumns(20))); 1198 1199 EXPECT_EQ("/* some comment\n" 1200 " * a comment\n" 1201 "* that we break\n" 1202 " * another comment\n" 1203 "* we have to break\n" 1204 "* a left comment\n" 1205 " */", 1206 format(" /* some comment\n" 1207 " * a comment that we break\n" 1208 " * another comment we have to break\n" 1209 "* a left comment\n" 1210 " */", 1211 getLLVMStyleWithColumns(20))); 1212 1213 EXPECT_EQ("/*\n" 1214 "\n" 1215 "\n" 1216 " */\n", 1217 format(" /* \n" 1218 " \n" 1219 " \n" 1220 " */\n")); 1221 } 1222 1223 TEST_F(FormatTest, SplitsLongLinesInCommentsInPreprocessor) { 1224 EXPECT_EQ("#define X \\\n" 1225 " /* \\\n" 1226 " Test \\\n" 1227 " Macro comment \\\n" 1228 " with a long \\\n" 1229 " line \\\n" 1230 " */ \\\n" 1231 " A + B", 1232 format("#define X \\\n" 1233 " /*\n" 1234 " Test\n" 1235 " Macro comment with a long line\n" 1236 " */ \\\n" 1237 " A + B", 1238 getLLVMStyleWithColumns(20))); 1239 EXPECT_EQ("#define X \\\n" 1240 " /* Macro comment \\\n" 1241 " with a long \\\n" 1242 " line */ \\\n" 1243 " A + B", 1244 format("#define X \\\n" 1245 " /* Macro comment with a long\n" 1246 " line */ \\\n" 1247 " A + B", 1248 getLLVMStyleWithColumns(20))); 1249 EXPECT_EQ("#define X \\\n" 1250 " /* Macro comment \\\n" 1251 " * with a long \\\n" 1252 " * line */ \\\n" 1253 " A + B", 1254 format("#define X \\\n" 1255 " /* Macro comment with a long line */ \\\n" 1256 " A + B", 1257 getLLVMStyleWithColumns(20))); 1258 } 1259 1260 TEST_F(FormatTest, CommentsInStaticInitializers) { 1261 EXPECT_EQ( 1262 "static SomeType type = { aaaaaaaaaaaaaaaaaaaa, /* comment */\n" 1263 " aaaaaaaaaaaaaaaaaaaa /* comment */,\n" 1264 " /* comment */ aaaaaaaaaaaaaaaaaaaa,\n" 1265 " aaaaaaaaaaaaaaaaaaaa, // comment\n" 1266 " aaaaaaaaaaaaaaaaaaaa };", 1267 format("static SomeType type = { aaaaaaaaaaaaaaaaaaaa , /* comment */\n" 1268 " aaaaaaaaaaaaaaaaaaaa /* comment */ ,\n" 1269 " /* comment */ aaaaaaaaaaaaaaaaaaaa ,\n" 1270 " aaaaaaaaaaaaaaaaaaaa , // comment\n" 1271 " aaaaaaaaaaaaaaaaaaaa };")); 1272 verifyFormat("static SomeType type = { aaaaaaaaaaa, // comment for aa...\n" 1273 " bbbbbbbbbbb, ccccccccccc };"); 1274 verifyFormat("static SomeType type = { aaaaaaaaaaa,\n" 1275 " // comment for bb....\n" 1276 " bbbbbbbbbbb, ccccccccccc };"); 1277 verifyGoogleFormat( 1278 "static SomeType type = {aaaaaaaaaaa, // comment for aa...\n" 1279 " bbbbbbbbbbb, ccccccccccc};"); 1280 verifyGoogleFormat("static SomeType type = {aaaaaaaaaaa,\n" 1281 " // comment for bb....\n" 1282 " bbbbbbbbbbb, ccccccccccc};"); 1283 1284 verifyFormat("S s = { { a, b, c }, // Group #1\n" 1285 " { d, e, f }, // Group #2\n" 1286 " { g, h, i } }; // Group #3"); 1287 verifyFormat("S s = { { // Group #1\n" 1288 " a, b, c },\n" 1289 " { // Group #2\n" 1290 " d, e, f },\n" 1291 " { // Group #3\n" 1292 " g, h, i } };"); 1293 1294 EXPECT_EQ("S s = {\n" 1295 " // Some comment\n" 1296 " a,\n" 1297 "\n" 1298 " // Comment after empty line\n" 1299 " b\n" 1300 "}", 1301 format("S s = {\n" 1302 " // Some comment\n" 1303 " a,\n" 1304 " \n" 1305 " // Comment after empty line\n" 1306 " b\n" 1307 "}")); 1308 EXPECT_EQ("S s = {\n" 1309 " /* Some comment */\n" 1310 " a,\n" 1311 "\n" 1312 " /* Comment after empty line */\n" 1313 " b\n" 1314 "}", 1315 format("S s = {\n" 1316 " /* Some comment */\n" 1317 " a,\n" 1318 " \n" 1319 " /* Comment after empty line */\n" 1320 " b\n" 1321 "}")); 1322 verifyFormat("const uint8_t aaaaaaaaaaaaaaaaaaaaaa[0] = {\n" 1323 " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" 1324 " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" 1325 " 0x00, 0x00, 0x00, 0x00 // comment\n" 1326 "};"); 1327 } 1328 1329 TEST_F(FormatTest, IgnoresIf0Contents) { 1330 EXPECT_EQ("#if 0\n" 1331 "}{)(&*(^%%#%@! fsadj f;ldjs ,:;| <<<>>>][)(][\n" 1332 "#endif\n" 1333 "void f() {}", 1334 format("#if 0\n" 1335 "}{)(&*(^%%#%@! fsadj f;ldjs ,:;| <<<>>>][)(][\n" 1336 "#endif\n" 1337 "void f( ) { }")); 1338 EXPECT_EQ("#if false\n" 1339 "void f( ) { }\n" 1340 "#endif\n" 1341 "void g() {}\n", 1342 format("#if false\n" 1343 "void f( ) { }\n" 1344 "#endif\n" 1345 "void g( ) { }\n")); 1346 EXPECT_EQ("enum E {\n" 1347 " One,\n" 1348 " Two,\n" 1349 "#if 0\n" 1350 "Three,\n" 1351 " Four,\n" 1352 "#endif\n" 1353 " Five\n" 1354 "};", 1355 format("enum E {\n" 1356 " One,Two,\n" 1357 "#if 0\n" 1358 "Three,\n" 1359 " Four,\n" 1360 "#endif\n" 1361 " Five};")); 1362 EXPECT_EQ("enum F {\n" 1363 " One,\n" 1364 "#if 1\n" 1365 " Two,\n" 1366 "#if 0\n" 1367 "Three,\n" 1368 " Four,\n" 1369 "#endif\n" 1370 " Five\n" 1371 "#endif\n" 1372 "};", 1373 format("enum F {\n" 1374 "One,\n" 1375 "#if 1\n" 1376 "Two,\n" 1377 "#if 0\n" 1378 "Three,\n" 1379 " Four,\n" 1380 "#endif\n" 1381 "Five\n" 1382 "#endif\n" 1383 "};")); 1384 EXPECT_EQ("enum G {\n" 1385 " One,\n" 1386 "#if 0\n" 1387 "Two,\n" 1388 "#else\n" 1389 " Three,\n" 1390 "#endif\n" 1391 " Four\n" 1392 "};", 1393 format("enum G {\n" 1394 "One,\n" 1395 "#if 0\n" 1396 "Two,\n" 1397 "#else\n" 1398 "Three,\n" 1399 "#endif\n" 1400 "Four\n" 1401 "};")); 1402 EXPECT_EQ("enum H {\n" 1403 " One,\n" 1404 "#if 0\n" 1405 "#ifdef Q\n" 1406 "Two,\n" 1407 "#else\n" 1408 "Three,\n" 1409 "#endif\n" 1410 "#endif\n" 1411 " Four\n" 1412 "};", 1413 format("enum H {\n" 1414 "One,\n" 1415 "#if 0\n" 1416 "#ifdef Q\n" 1417 "Two,\n" 1418 "#else\n" 1419 "Three,\n" 1420 "#endif\n" 1421 "#endif\n" 1422 "Four\n" 1423 "};")); 1424 EXPECT_EQ("enum I {\n" 1425 " One,\n" 1426 "#if /* test */ 0 || 1\n" 1427 "Two,\n" 1428 "Three,\n" 1429 "#endif\n" 1430 " Four\n" 1431 "};", 1432 format("enum I {\n" 1433 "One,\n" 1434 "#if /* test */ 0 || 1\n" 1435 "Two,\n" 1436 "Three,\n" 1437 "#endif\n" 1438 "Four\n" 1439 "};")); 1440 EXPECT_EQ("enum J {\n" 1441 " One,\n" 1442 "#if 0\n" 1443 "#if 0\n" 1444 "Two,\n" 1445 "#else\n" 1446 "Three,\n" 1447 "#endif\n" 1448 "Four,\n" 1449 "#endif\n" 1450 " Five\n" 1451 "};", 1452 format("enum J {\n" 1453 "One,\n" 1454 "#if 0\n" 1455 "#if 0\n" 1456 "Two,\n" 1457 "#else\n" 1458 "Three,\n" 1459 "#endif\n" 1460 "Four,\n" 1461 "#endif\n" 1462 "Five\n" 1463 "};")); 1464 1465 } 1466 1467 //===----------------------------------------------------------------------===// 1468 // Tests for classes, namespaces, etc. 1469 //===----------------------------------------------------------------------===// 1470 1471 TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) { 1472 verifyFormat("class A {};"); 1473 } 1474 1475 TEST_F(FormatTest, UnderstandsAccessSpecifiers) { 1476 verifyFormat("class A {\n" 1477 "public:\n" 1478 "public: // comment\n" 1479 "protected:\n" 1480 "private:\n" 1481 " void f() {}\n" 1482 "};"); 1483 verifyGoogleFormat("class A {\n" 1484 " public:\n" 1485 " protected:\n" 1486 " private:\n" 1487 " void f() {}\n" 1488 "};"); 1489 } 1490 1491 TEST_F(FormatTest, SeparatesLogicalBlocks) { 1492 EXPECT_EQ("class A {\n" 1493 "public:\n" 1494 " void f();\n" 1495 "\n" 1496 "private:\n" 1497 " void g() {}\n" 1498 " // test\n" 1499 "protected:\n" 1500 " int h;\n" 1501 "};", 1502 format("class A {\n" 1503 "public:\n" 1504 "void f();\n" 1505 "private:\n" 1506 "void g() {}\n" 1507 "// test\n" 1508 "protected:\n" 1509 "int h;\n" 1510 "};")); 1511 EXPECT_EQ("class A {\n" 1512 "protected:\n" 1513 "public:\n" 1514 " void f();\n" 1515 "};", 1516 format("class A {\n" 1517 "protected:\n" 1518 "\n" 1519 "public:\n" 1520 "\n" 1521 " void f();\n" 1522 "};")); 1523 } 1524 1525 TEST_F(FormatTest, FormatsClasses) { 1526 verifyFormat("class A : public B {};"); 1527 verifyFormat("class A : public ::B {};"); 1528 1529 verifyFormat( 1530 "class AAAAAAAAAAAAAAAAAAAA : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" 1531 " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {};"); 1532 verifyFormat("class AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n" 1533 " : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" 1534 " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {};"); 1535 verifyFormat( 1536 "class A : public B, public C, public D, public E, public F {};"); 1537 verifyFormat("class AAAAAAAAAAAA : public B,\n" 1538 " public C,\n" 1539 " public D,\n" 1540 " public E,\n" 1541 " public F,\n" 1542 " public G {};"); 1543 1544 verifyFormat("class\n" 1545 " ReallyReallyLongClassName {\n" 1546 " int i;\n" 1547 "};", 1548 getLLVMStyleWithColumns(32)); 1549 verifyFormat("struct aaaaaaaaaaaaa : public aaaaaaaaaaaaaaaaaaa< // break\n" 1550 " aaaaaaaaaaaaaaaa> {};"); 1551 verifyFormat("struct aaaaaaaaaaaaaaaaaaaa\n" 1552 " : public aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaa,\n" 1553 " aaaaaaaaaaaaaaaaaaaaaa> {};"); 1554 } 1555 1556 TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) { 1557 verifyFormat("class A {\n} a, b;"); 1558 verifyFormat("struct A {\n} a, b;"); 1559 verifyFormat("union A {\n} a;"); 1560 } 1561 1562 TEST_F(FormatTest, FormatsEnum) { 1563 verifyFormat("enum {\n" 1564 " Zero,\n" 1565 " One = 1,\n" 1566 " Two = One + 1,\n" 1567 " Three = (One + Two),\n" 1568 " Four = (Zero && (One ^ Two)) | (One << Two),\n" 1569 " Five = (One, Two, Three, Four, 5)\n" 1570 "};"); 1571 verifyGoogleFormat("enum {\n" 1572 " Zero,\n" 1573 " One = 1,\n" 1574 " Two = One + 1,\n" 1575 " Three = (One + Two),\n" 1576 " Four = (Zero && (One ^ Two)) | (One << Two),\n" 1577 " Five = (One, Two, Three, Four, 5)\n" 1578 "};"); 1579 verifyFormat("enum Enum {};"); 1580 verifyFormat("enum {};"); 1581 verifyFormat("enum X E {} d;"); 1582 verifyFormat("enum __attribute__((...)) E {} d;"); 1583 verifyFormat("enum __declspec__((...)) E {} d;"); 1584 verifyFormat("enum X f() {\n a();\n return 42;\n}"); 1585 verifyFormat("enum {\n" 1586 " Bar = Foo<int, int>::value\n" 1587 "};"); 1588 } 1589 1590 TEST_F(FormatTest, FormatsEnumsWithErrors) { 1591 verifyFormat("enum Type {\n" 1592 " One = 0;\n" // These semicolons should be commas. 1593 " Two = 1;\n" 1594 "};"); 1595 verifyFormat("namespace n {\n" 1596 "enum Type {\n" 1597 " One,\n" 1598 " Two,\n" // missing }; 1599 " int i;\n" 1600 "}\n" 1601 "void g() {}"); 1602 } 1603 1604 TEST_F(FormatTest, FormatsEnumStruct) { 1605 verifyFormat("enum struct {\n" 1606 " Zero,\n" 1607 " One = 1,\n" 1608 " Two = One + 1,\n" 1609 " Three = (One + Two),\n" 1610 " Four = (Zero && (One ^ Two)) | (One << Two),\n" 1611 " Five = (One, Two, Three, Four, 5)\n" 1612 "};"); 1613 verifyFormat("enum struct Enum {};"); 1614 verifyFormat("enum struct {};"); 1615 verifyFormat("enum struct X E {} d;"); 1616 verifyFormat("enum struct __attribute__((...)) E {} d;"); 1617 verifyFormat("enum struct __declspec__((...)) E {} d;"); 1618 verifyFormat("enum struct X f() {\n a();\n return 42;\n}"); 1619 } 1620 1621 TEST_F(FormatTest, FormatsEnumClass) { 1622 verifyFormat("enum class {\n" 1623 " Zero,\n" 1624 " One = 1,\n" 1625 " Two = One + 1,\n" 1626 " Three = (One + Two),\n" 1627 " Four = (Zero && (One ^ Two)) | (One << Two),\n" 1628 " Five = (One, Two, Three, Four, 5)\n" 1629 "};"); 1630 verifyFormat("enum class Enum {};"); 1631 verifyFormat("enum class {};"); 1632 verifyFormat("enum class X E {} d;"); 1633 verifyFormat("enum class __attribute__((...)) E {} d;"); 1634 verifyFormat("enum class __declspec__((...)) E {} d;"); 1635 verifyFormat("enum class X f() {\n a();\n return 42;\n}"); 1636 } 1637 1638 TEST_F(FormatTest, FormatsEnumTypes) { 1639 verifyFormat("enum X : int {\n" 1640 " A,\n" 1641 " B\n" 1642 "};"); 1643 verifyFormat("enum X : std::uint32_t {\n" 1644 " A,\n" 1645 " B\n" 1646 "};"); 1647 } 1648 1649 TEST_F(FormatTest, FormatsBitfields) { 1650 verifyFormat("struct Bitfields {\n" 1651 " unsigned sClass : 8;\n" 1652 " unsigned ValueKind : 2;\n" 1653 "};"); 1654 verifyFormat("struct A {\n" 1655 " int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa : 1,\n" 1656 " bbbbbbbbbbbbbbbbbbbbbbbbb;\n" 1657 "};"); 1658 } 1659 1660 TEST_F(FormatTest, FormatsNamespaces) { 1661 verifyFormat("namespace some_namespace {\n" 1662 "class A {};\n" 1663 "void f() { f(); }\n" 1664 "}"); 1665 verifyFormat("namespace {\n" 1666 "class A {};\n" 1667 "void f() { f(); }\n" 1668 "}"); 1669 verifyFormat("inline namespace X {\n" 1670 "class A {};\n" 1671 "void f() { f(); }\n" 1672 "}"); 1673 verifyFormat("using namespace some_namespace;\n" 1674 "class A {};\n" 1675 "void f() { f(); }"); 1676 1677 // This code is more common than we thought; if we 1678 // layout this correctly the semicolon will go into 1679 // its own line, which is undesireable. 1680 verifyFormat("namespace {};"); 1681 verifyFormat("namespace {\n" 1682 "class A {};\n" 1683 "};"); 1684 1685 verifyFormat("namespace {\n" 1686 "int SomeVariable = 0; // comment\n" 1687 "} // namespace"); 1688 EXPECT_EQ("#ifndef HEADER_GUARD\n" 1689 "#define HEADER_GUARD\n" 1690 "namespace my_namespace {\n" 1691 "int i;\n" 1692 "} // my_namespace\n" 1693 "#endif // HEADER_GUARD", 1694 format("#ifndef HEADER_GUARD\n" 1695 " #define HEADER_GUARD\n" 1696 " namespace my_namespace {\n" 1697 "int i;\n" 1698 "} // my_namespace\n" 1699 "#endif // HEADER_GUARD")); 1700 1701 FormatStyle Style = getLLVMStyle(); 1702 Style.NamespaceIndentation = FormatStyle::NI_All; 1703 EXPECT_EQ("namespace out {\n" 1704 " int i;\n" 1705 " namespace in {\n" 1706 " int i;\n" 1707 " } // namespace\n" 1708 "} // namespace", 1709 format("namespace out {\n" 1710 "int i;\n" 1711 "namespace in {\n" 1712 "int i;\n" 1713 "} // namespace\n" 1714 "} // namespace", 1715 Style)); 1716 1717 Style.NamespaceIndentation = FormatStyle::NI_Inner; 1718 EXPECT_EQ("namespace out {\n" 1719 "int i;\n" 1720 "namespace in {\n" 1721 " int i;\n" 1722 "} // namespace\n" 1723 "} // namespace", 1724 format("namespace out {\n" 1725 "int i;\n" 1726 "namespace in {\n" 1727 "int i;\n" 1728 "} // namespace\n" 1729 "} // namespace", 1730 Style)); 1731 } 1732 1733 TEST_F(FormatTest, FormatsExternC) { verifyFormat("extern \"C\" {\nint a;"); } 1734 1735 TEST_F(FormatTest, FormatsInlineASM) { 1736 verifyFormat("asm(\"xyz\" : \"=a\"(a), \"=d\"(b) : \"a\"(data));"); 1737 verifyFormat( 1738 "asm(\"movq\\t%%rbx, %%rsi\\n\\t\"\n" 1739 " \"cpuid\\n\\t\"\n" 1740 " \"xchgq\\t%%rbx, %%rsi\\n\\t\"\n" 1741 " : \"=a\"(*rEAX), \"=S\"(*rEBX), \"=c\"(*rECX), \"=d\"(*rEDX)\n" 1742 " : \"a\"(value));"); 1743 } 1744 1745 TEST_F(FormatTest, FormatTryCatch) { 1746 // FIXME: Handle try-catch explicitly in the UnwrappedLineParser, then we'll 1747 // also not create single-line-blocks. 1748 verifyFormat("try {\n" 1749 " throw a * b;\n" 1750 "}\n" 1751 "catch (int a) {\n" 1752 " // Do nothing.\n" 1753 "}\n" 1754 "catch (...) {\n" 1755 " exit(42);\n" 1756 "}"); 1757 1758 // Function-level try statements. 1759 verifyFormat("int f() try { return 4; }\n" 1760 "catch (...) {\n" 1761 " return 5;\n" 1762 "}"); 1763 verifyFormat("class A {\n" 1764 " int a;\n" 1765 " A() try : a(0) {}\n" 1766 " catch (...) {\n" 1767 " throw;\n" 1768 " }\n" 1769 "};\n"); 1770 } 1771 1772 TEST_F(FormatTest, FormatObjCTryCatch) { 1773 verifyFormat("@try {\n" 1774 " f();\n" 1775 "}\n" 1776 "@catch (NSException e) {\n" 1777 " @throw;\n" 1778 "}\n" 1779 "@finally {\n" 1780 " exit(42);\n" 1781 "}"); 1782 } 1783 1784 TEST_F(FormatTest, StaticInitializers) { 1785 verifyFormat("static SomeClass SC = { 1, 'a' };"); 1786 1787 verifyFormat( 1788 "static SomeClass WithALoooooooooooooooooooongName = {\n" 1789 " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" 1790 "};"); 1791 1792 // Here, everything other than the "}" would fit on a line. 1793 verifyFormat("static int LooooooooooooooooooooooooongVariable[1] = {\n" 1794 " 100000000000000000000000\n" 1795 "};"); 1796 EXPECT_EQ("S s = { a, b };", format("S s = {\n" 1797 " a,\n" 1798 "\n" 1799 " b\n" 1800 "};")); 1801 1802 // FIXME: This would fit into the column limit if we'd fit "{ {" on the first 1803 // line. However, the formatting looks a bit off and this probably doesn't 1804 // happen often in practice. 1805 verifyFormat("static int Variable[1] = {\n" 1806 " { 1000000000000000000000000000000000000 }\n" 1807 "};", 1808 getLLVMStyleWithColumns(40)); 1809 } 1810 1811 TEST_F(FormatTest, DesignatedInitializers) { 1812 verifyFormat("const struct A a = { .a = 1, .b = 2 };"); 1813 verifyFormat("const struct A a = { .aaaaaaaaaa = 1,\n" 1814 " .bbbbbbbbbb = 2,\n" 1815 " .cccccccccc = 3,\n" 1816 " .dddddddddd = 4,\n" 1817 " .eeeeeeeeee = 5 };"); 1818 verifyFormat("const struct Aaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa = {\n" 1819 " .aaaaaaaaaaaaaaaaaaaaaaaaaaa = 1,\n" 1820 " .bbbbbbbbbbbbbbbbbbbbbbbbbbb = 2,\n" 1821 " .ccccccccccccccccccccccccccc = 3,\n" 1822 " .ddddddddddddddddddddddddddd = 4,\n" 1823 " .eeeeeeeeeeeeeeeeeeeeeeeeeee = 5\n" 1824 "};"); 1825 1826 verifyGoogleFormat("const struct A a = {.a = 1, .b = 2};"); 1827 } 1828 1829 TEST_F(FormatTest, NestedStaticInitializers) { 1830 verifyFormat("static A x = { { {} } };\n"); 1831 verifyFormat("static A x = { { { init1, init2, init3, init4 },\n" 1832 " { init1, init2, init3, init4 } } };"); 1833 1834 verifyFormat("somes Status::global_reps[3] = {\n" 1835 " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n" 1836 " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" 1837 " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" 1838 "};"); 1839 verifyGoogleFormat("SomeType Status::global_reps[3] = {\n" 1840 " {kGlobalRef, OK_CODE, NULL, NULL, NULL},\n" 1841 " {kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL},\n" 1842 " {kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL}};"); 1843 verifyFormat( 1844 "CGRect cg_rect = { { rect.fLeft, rect.fTop },\n" 1845 " { rect.fRight - rect.fLeft, rect.fBottom - rect.fTop" 1846 " } };"); 1847 1848 verifyFormat( 1849 "SomeArrayOfSomeType a = { { { 1, 2, 3 }, { 1, 2, 3 },\n" 1850 " { 111111111111111111111111111111,\n" 1851 " 222222222222222222222222222222,\n" 1852 " 333333333333333333333333333333 },\n" 1853 " { 1, 2, 3 }, { 1, 2, 3 } } };"); 1854 verifyFormat( 1855 "SomeArrayOfSomeType a = { { { 1, 2, 3 } }, { { 1, 2, 3 } },\n" 1856 " { { 111111111111111111111111111111,\n" 1857 " 222222222222222222222222222222,\n" 1858 " 333333333333333333333333333333 } },\n" 1859 " { { 1, 2, 3 } }, { { 1, 2, 3 } } };"); 1860 verifyGoogleFormat( 1861 "SomeArrayOfSomeType a = {\n" 1862 " {{1, 2, 3}}, {{1, 2, 3}},\n" 1863 " {{111111111111111111111111111111, 222222222222222222222222222222,\n" 1864 " 333333333333333333333333333333}},\n" 1865 " {{1, 2, 3}}, {{1, 2, 3}}};"); 1866 1867 verifyFormat( 1868 "struct {\n" 1869 " unsigned bit;\n" 1870 " const char *const name;\n" 1871 "} kBitsToOs[] = { { kOsMac, \"Mac\" },\n" 1872 " { kOsWin, \"Windows\" },\n" 1873 " { kOsLinux, \"Linux\" },\n" 1874 " { kOsCrOS, \"Chrome OS\" } };"); 1875 } 1876 1877 TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) { 1878 verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro(" 1879 " \\\n" 1880 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)"); 1881 } 1882 1883 TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) { 1884 verifyFormat("virtual void write(ELFWriter *writerrr,\n" 1885 " OwningPtr<FileOutputBuffer> &buffer) = 0;"); 1886 } 1887 1888 TEST_F(FormatTest, BreaksStringLiteralsOnlyInDefine) { 1889 verifyFormat("# 1111 \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/aaaaaaaa.cpp\" 2 3", 1890 getLLVMStyleWithColumns(40)); 1891 verifyFormat("#line 11111 \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/aaaaaaaa.cpp\"", 1892 getLLVMStyleWithColumns(40)); 1893 EXPECT_EQ("#define Q \\\n" 1894 " \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/\" \\\n" 1895 " \"aaaaaaaa.cpp\"", 1896 format("#define Q \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/aaaaaaaa.cpp\"", 1897 getLLVMStyleWithColumns(40))); 1898 } 1899 1900 TEST_F(FormatTest, UnderstandsLinePPDirective) { 1901 EXPECT_EQ("# 123 \"A string literal\"", 1902 format(" # 123 \"A string literal\"")); 1903 } 1904 1905 TEST_F(FormatTest, LayoutUnknownPPDirective) { 1906 EXPECT_EQ("#;", format("#;")); 1907 verifyFormat("#\n;\n;\n;"); 1908 } 1909 1910 TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) { 1911 EXPECT_EQ("#line 42 \"test\"\n", 1912 format("# \\\n line \\\n 42 \\\n \"test\"\n")); 1913 EXPECT_EQ("#define A B\n", format("# \\\n define \\\n A \\\n B\n", 1914 getLLVMStyleWithColumns(12))); 1915 } 1916 1917 TEST_F(FormatTest, EndOfFileEndsPPDirective) { 1918 EXPECT_EQ("#line 42 \"test\"", 1919 format("# \\\n line \\\n 42 \\\n \"test\"")); 1920 EXPECT_EQ("#define A B", format("# \\\n define \\\n A \\\n B")); 1921 } 1922 1923 TEST_F(FormatTest, DoesntRemoveUnknownTokens) { 1924 verifyFormat("#define A \\x20"); 1925 verifyFormat("#define A \\ x20"); 1926 EXPECT_EQ("#define A \\ x20", format("#define A \\ x20")); 1927 verifyFormat("#define A ''"); 1928 verifyFormat("#define A ''qqq"); 1929 verifyFormat("#define A `qqq"); 1930 verifyFormat("f(\"aaaa, bbbb, \"\\\"ccccc\\\"\");"); 1931 } 1932 1933 TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) { 1934 verifyFormat("#define A(BB)", getLLVMStyleWithColumns(13)); 1935 verifyFormat("#define A( \\\n BB)", getLLVMStyleWithColumns(12)); 1936 verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12)); 1937 // FIXME: We never break before the macro name. 1938 verifyFormat("#define AA( \\\n B)", getLLVMStyleWithColumns(12)); 1939 1940 verifyFormat("#define A A\n#define A A"); 1941 verifyFormat("#define A(X) A\n#define A A"); 1942 1943 verifyFormat("#define Something Other", getLLVMStyleWithColumns(23)); 1944 verifyFormat("#define Something \\\n Other", getLLVMStyleWithColumns(22)); 1945 } 1946 1947 TEST_F(FormatTest, HandlePreprocessorDirectiveContext) { 1948 EXPECT_EQ("// somecomment\n" 1949 "#include \"a.h\"\n" 1950 "#define A( \\\n" 1951 " A, B)\n" 1952 "#include \"b.h\"\n" 1953 "// somecomment\n", 1954 format(" // somecomment\n" 1955 " #include \"a.h\"\n" 1956 "#define A(A,\\\n" 1957 " B)\n" 1958 " #include \"b.h\"\n" 1959 " // somecomment\n", 1960 getLLVMStyleWithColumns(13))); 1961 } 1962 1963 TEST_F(FormatTest, LayoutSingleHash) { EXPECT_EQ("#\na;", format("#\na;")); } 1964 1965 TEST_F(FormatTest, LayoutCodeInMacroDefinitions) { 1966 EXPECT_EQ("#define A \\\n" 1967 " c; \\\n" 1968 " e;\n" 1969 "f;", 1970 format("#define A c; e;\n" 1971 "f;", 1972 getLLVMStyleWithColumns(14))); 1973 } 1974 1975 TEST_F(FormatTest, LayoutRemainingTokens) { EXPECT_EQ("{}", format("{}")); } 1976 1977 TEST_F(FormatTest, AlwaysFormatsEntireMacroDefinitions) { 1978 EXPECT_EQ("int i;\n" 1979 "#define A \\\n" 1980 " int i; \\\n" 1981 " int j\n" 1982 "int k;", 1983 format("int i;\n" 1984 "#define A \\\n" 1985 " int i ; \\\n" 1986 " int j\n" 1987 "int k;", 1988 8, 0, getGoogleStyle())); // 8: position of "#define". 1989 EXPECT_EQ("int i;\n" 1990 "#define A \\\n" 1991 " int i; \\\n" 1992 " int j\n" 1993 "int k;", 1994 format("int i;\n" 1995 "#define A \\\n" 1996 " int i ; \\\n" 1997 " int j\n" 1998 "int k;", 1999 45, 0, getGoogleStyle())); // 45: position of "j". 2000 } 2001 2002 TEST_F(FormatTest, MacroDefinitionInsideStatement) { 2003 EXPECT_EQ("int x,\n" 2004 "#define A\n" 2005 " y;", 2006 format("int x,\n#define A\ny;")); 2007 } 2008 2009 TEST_F(FormatTest, HashInMacroDefinition) { 2010 EXPECT_EQ("#define A(c) L#c", format("#define A(c) L#c", getLLVMStyle())); 2011 verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11)); 2012 verifyFormat("#define A \\\n" 2013 " { \\\n" 2014 " f(#c); \\\n" 2015 " }", 2016 getLLVMStyleWithColumns(11)); 2017 2018 verifyFormat("#define A(X) \\\n" 2019 " void function##X()", 2020 getLLVMStyleWithColumns(22)); 2021 2022 verifyFormat("#define A(a, b, c) \\\n" 2023 " void a##b##c()", 2024 getLLVMStyleWithColumns(22)); 2025 2026 verifyFormat("#define A void # ## #", getLLVMStyleWithColumns(22)); 2027 } 2028 2029 TEST_F(FormatTest, RespectWhitespaceInMacroDefinitions) { 2030 verifyFormat("#define A (1)"); 2031 } 2032 2033 TEST_F(FormatTest, EmptyLinesInMacroDefinitions) { 2034 EXPECT_EQ("#define A b;", format("#define A \\\n" 2035 " \\\n" 2036 " b;", 2037 getLLVMStyleWithColumns(25))); 2038 EXPECT_EQ("#define A \\\n" 2039 " \\\n" 2040 " a; \\\n" 2041 " b;", 2042 format("#define A \\\n" 2043 " \\\n" 2044 " a; \\\n" 2045 " b;", 2046 getLLVMStyleWithColumns(11))); 2047 EXPECT_EQ("#define A \\\n" 2048 " a; \\\n" 2049 " \\\n" 2050 " b;", 2051 format("#define A \\\n" 2052 " a; \\\n" 2053 " \\\n" 2054 " b;", 2055 getLLVMStyleWithColumns(11))); 2056 } 2057 2058 TEST_F(FormatTest, MacroDefinitionsWithIncompleteCode) { 2059 verifyFormat("#define A :"); 2060 verifyFormat("#define SOMECASES \\\n" 2061 " case 1: \\\n" 2062 " case 2\n", 2063 getLLVMStyleWithColumns(20)); 2064 verifyFormat("#define A template <typename T>"); 2065 verifyFormat("#define STR(x) #x\n" 2066 "f(STR(this_is_a_string_literal{));"); 2067 verifyFormat("#pragma omp threadprivate( \\\n" 2068 " y)), // expected-warning", 2069 getLLVMStyleWithColumns(28)); 2070 } 2071 2072 TEST_F(FormatTest, MacrosWithoutTrailingSemicolon) { 2073 verifyFormat("SOME_TYPE_NAME abc;"); // Gated on the newline. 2074 EXPECT_EQ("class A : public QObject {\n" 2075 " Q_OBJECT\n" 2076 "\n" 2077 " A() {}\n" 2078 "};", 2079 format("class A : public QObject {\n" 2080 " Q_OBJECT\n" 2081 "\n" 2082 " A() {\n}\n" 2083 "} ;")); 2084 EXPECT_EQ("SOME_MACRO\n" 2085 "namespace {\n" 2086 "void f();\n" 2087 "}", 2088 format("SOME_MACRO\n" 2089 " namespace {\n" 2090 "void f( );\n" 2091 "}")); 2092 // Only if the identifier contains at least 5 characters. 2093 EXPECT_EQ("HTTP f();", 2094 format("HTTP\nf();")); 2095 EXPECT_EQ("MACRO\nf();", 2096 format("MACRO\nf();")); 2097 // Only if everything is upper case. 2098 EXPECT_EQ("class A : public QObject {\n" 2099 " Q_Object A() {}\n" 2100 "};", 2101 format("class A : public QObject {\n" 2102 " Q_Object\n" 2103 "\n" 2104 " A() {\n}\n" 2105 "} ;")); 2106 } 2107 2108 TEST_F(FormatTest, MacroCallsWithoutTrailingSemicolon) { 2109 EXPECT_EQ("INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n" 2110 "INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n" 2111 "INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n" 2112 "class X {};\n" 2113 "INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n" 2114 "int *createScopDetectionPass() { return 0; }", 2115 format(" INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n" 2116 " INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n" 2117 " INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n" 2118 " class X {};\n" 2119 " INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n" 2120 " int *createScopDetectionPass() { return 0; }")); 2121 // FIXME: We could probably treat IPC_BEGIN_MESSAGE_MAP/IPC_END_MESSAGE_MAP as 2122 // braces, so that inner block is indented one level more. 2123 EXPECT_EQ("int q() {\n" 2124 " IPC_BEGIN_MESSAGE_MAP(WebKitTestController, message)\n" 2125 " IPC_MESSAGE_HANDLER(xxx, qqq)\n" 2126 " IPC_END_MESSAGE_MAP()\n" 2127 "}", 2128 format("int q() {\n" 2129 " IPC_BEGIN_MESSAGE_MAP(WebKitTestController, message)\n" 2130 " IPC_MESSAGE_HANDLER(xxx, qqq)\n" 2131 " IPC_END_MESSAGE_MAP()\n" 2132 "}")); 2133 2134 // These must not be recognized as macros. 2135 EXPECT_EQ("int q() {\n" 2136 " f(x);\n" 2137 " f(x) {}\n" 2138 " f(x)->g();\n" 2139 " f(x)->*g();\n" 2140 " f(x).g();\n" 2141 " f(x) = x;\n" 2142 " f(x) += x;\n" 2143 " f(x) -= x;\n" 2144 " f(x) *= x;\n" 2145 " f(x) /= x;\n" 2146 " f(x) %= x;\n" 2147 " f(x) &= x;\n" 2148 " f(x) |= x;\n" 2149 " f(x) ^= x;\n" 2150 " f(x) >>= x;\n" 2151 " f(x) <<= x;\n" 2152 " f(x)[y].z();\n" 2153 " LOG(INFO) << x;\n" 2154 " ifstream(x) >> x;\n" 2155 "}\n", 2156 format("int q() {\n" 2157 " f(x)\n;\n" 2158 " f(x)\n {}\n" 2159 " f(x)\n->g();\n" 2160 " f(x)\n->*g();\n" 2161 " f(x)\n.g();\n" 2162 " f(x)\n = x;\n" 2163 " f(x)\n += x;\n" 2164 " f(x)\n -= x;\n" 2165 " f(x)\n *= x;\n" 2166 " f(x)\n /= x;\n" 2167 " f(x)\n %= x;\n" 2168 " f(x)\n &= x;\n" 2169 " f(x)\n |= x;\n" 2170 " f(x)\n ^= x;\n" 2171 " f(x)\n >>= x;\n" 2172 " f(x)\n <<= x;\n" 2173 " f(x)\n[y].z();\n" 2174 " LOG(INFO)\n << x;\n" 2175 " ifstream(x)\n >> x;\n" 2176 "}\n")); 2177 EXPECT_EQ("int q() {\n" 2178 " f(x)\n" 2179 " if (1) {\n" 2180 " }\n" 2181 " f(x)\n" 2182 " while (1) {\n" 2183 " }\n" 2184 " f(x)\n" 2185 " g(x);\n" 2186 " f(x)\n" 2187 " try {\n" 2188 " q();\n" 2189 " }\n" 2190 " catch (...) {\n" 2191 " }\n" 2192 "}\n", 2193 format("int q() {\n" 2194 "f(x)\n" 2195 "if (1) {}\n" 2196 "f(x)\n" 2197 "while (1) {}\n" 2198 "f(x)\n" 2199 "g(x);\n" 2200 "f(x)\n" 2201 "try { q(); } catch (...) {}\n" 2202 "}\n")); 2203 EXPECT_EQ("class A {\n" 2204 " A() : t(0) {}\n" 2205 " A(X x)\n" // FIXME: function-level try blocks are broken. 2206 " try : t(0) {\n" 2207 " }\n" 2208 " catch (...) {\n" 2209 " }\n" 2210 "};", 2211 format("class A {\n" 2212 " A()\n : t(0) {}\n" 2213 " A(X x)\n" 2214 " try : t(0) {} catch (...) {}\n" 2215 "};")); 2216 } 2217 2218 TEST_F(FormatTest, LayoutMacroDefinitionsStatementsSpanningBlocks) { 2219 verifyFormat("#define A \\\n" 2220 " f({ \\\n" 2221 " g(); \\\n" 2222 " });", getLLVMStyleWithColumns(11)); 2223 } 2224 2225 TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) { 2226 EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}")); 2227 } 2228 2229 TEST_F(FormatTest, FormatHashIfNotAtStartOfLine) { 2230 verifyFormat("{\n { a #c; }\n}"); 2231 } 2232 2233 TEST_F(FormatTest, FormatUnbalancedStructuralElements) { 2234 EXPECT_EQ("#define A \\\n { \\\n {\nint i;", 2235 format("#define A { {\nint i;", getLLVMStyleWithColumns(11))); 2236 EXPECT_EQ("#define A \\\n } \\\n }\nint i;", 2237 format("#define A } }\nint i;", getLLVMStyleWithColumns(11))); 2238 } 2239 2240 TEST_F(FormatTest, EscapedNewlineAtStartOfToken) { 2241 EXPECT_EQ( 2242 "#define A \\\n int i; \\\n int j;", 2243 format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11))); 2244 EXPECT_EQ("template <class T> f();", format("\\\ntemplate <class T> f();")); 2245 } 2246 2247 TEST_F(FormatTest, NoEscapedNewlineHandlingInBlockComments) { 2248 EXPECT_EQ("/* \\ \\ \\\n*/", format("\\\n/* \\ \\ \\\n*/")); 2249 } 2250 2251 TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) { 2252 verifyFormat("#define A \\\n" 2253 " int v( \\\n" 2254 " a); \\\n" 2255 " int i;", 2256 getLLVMStyleWithColumns(11)); 2257 } 2258 2259 TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) { 2260 EXPECT_EQ( 2261 "#define ALooooooooooooooooooooooooooooooooooooooongMacro(" 2262 " \\\n" 2263 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" 2264 "\n" 2265 "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" 2266 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n", 2267 format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro(" 2268 "\\\n" 2269 "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" 2270 " \n" 2271 " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" 2272 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n")); 2273 } 2274 2275 TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) { 2276 EXPECT_EQ("int\n" 2277 "#define A\n" 2278 " a;", 2279 format("int\n#define A\na;", getGoogleStyle())); 2280 verifyFormat("functionCallTo(\n" 2281 " someOtherFunction(\n" 2282 " withSomeParameters, whichInSequence,\n" 2283 " areLongerThanALine(andAnotherCall,\n" 2284 "#define A B\n" 2285 " withMoreParamters,\n" 2286 " whichStronglyInfluenceTheLayout),\n" 2287 " andMoreParameters),\n" 2288 " trailing);", 2289 getLLVMStyleWithColumns(69)); 2290 verifyFormat("Foo::Foo()\n" 2291 "#ifdef BAR\n" 2292 " : baz(0)\n" 2293 "#endif\n" 2294 "{\n" 2295 "}"); 2296 verifyFormat("void f() {\n" 2297 " if (true)\n" 2298 "#ifdef A\n" 2299 " f(42);\n" 2300 " x();\n" 2301 "#else\n" 2302 " g();\n" 2303 " x();\n" 2304 "#endif\n" 2305 "}"); 2306 verifyFormat("void f(param1, param2,\n" 2307 " param3,\n" 2308 "#ifdef A\n" 2309 " param4(param5,\n" 2310 "#ifdef A1\n" 2311 " param6,\n" 2312 "#ifdef A2\n" 2313 " param7),\n" 2314 "#else\n" 2315 " param8),\n" 2316 " param9,\n" 2317 "#endif\n" 2318 " param10,\n" 2319 "#endif\n" 2320 " param11)\n" 2321 "#else\n" 2322 " param12)\n" 2323 "#endif\n" 2324 "{\n" 2325 " x();\n" 2326 "}", 2327 getLLVMStyleWithColumns(28)); 2328 verifyFormat("#if 1\n" 2329 "int i;"); 2330 verifyFormat( 2331 "#if 1\n" 2332 "#endif\n" 2333 "#if 1\n" 2334 "#else\n" 2335 "#endif\n"); 2336 verifyFormat("DEBUG({\n" 2337 " return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2338 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;\n" 2339 "});\n" 2340 "#if a\n" 2341 "#else\n" 2342 "#endif"); 2343 } 2344 2345 TEST_F(FormatTest, FormatsJoinedLinesOnSubsequentRuns) { 2346 FormatStyle SingleLine = getLLVMStyle(); 2347 SingleLine.AllowShortIfStatementsOnASingleLine = true; 2348 verifyFormat( 2349 "#if 0\n" 2350 "#elif 1\n" 2351 "#endif\n" 2352 "void foo() {\n" 2353 " if (test) foo2();\n" 2354 "}", 2355 SingleLine); 2356 } 2357 2358 TEST_F(FormatTest, LayoutBlockInsideParens) { 2359 EXPECT_EQ("functionCall({ int i; });", format(" functionCall ( {int i;} );")); 2360 EXPECT_EQ("functionCall({\n" 2361 " int i;\n" 2362 " int j;\n" 2363 "});", 2364 format(" functionCall ( {int i;int j;} );")); 2365 EXPECT_EQ("functionCall({\n" 2366 " int i;\n" 2367 " int j;\n" 2368 " },\n" 2369 " aaaa, bbbb, cccc);", 2370 format(" functionCall ( {int i;int j;}, aaaa, bbbb, cccc);")); 2371 EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });", 2372 format(" functionCall (aaaa, bbbb, {int i;});")); 2373 EXPECT_EQ("functionCall(aaaa, bbbb, {\n" 2374 " int i;\n" 2375 " int j;\n" 2376 "});", 2377 format(" functionCall (aaaa, bbbb, {int i;int j;});")); 2378 EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });", 2379 format(" functionCall (aaaa, bbbb, {int i;});")); 2380 verifyFormat( 2381 "Aaa({\n" 2382 " int i; // break\n" 2383 " },\n" 2384 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 2385 " ccccccccccccccccc));"); 2386 verifyFormat("DEBUG({\n" 2387 " if (a)\n" 2388 " f();\n" 2389 "});"); 2390 } 2391 2392 TEST_F(FormatTest, LayoutBlockInsideStatement) { 2393 EXPECT_EQ("SOME_MACRO { int i; }\n" 2394 "int i;", 2395 format(" SOME_MACRO {int i;} int i;")); 2396 } 2397 2398 TEST_F(FormatTest, LayoutNestedBlocks) { 2399 verifyFormat("void AddOsStrings(unsigned bitmask) {\n" 2400 " struct s {\n" 2401 " int i;\n" 2402 " };\n" 2403 " s kBitsToOs[] = { { 10 } };\n" 2404 " for (int i = 0; i < 10; ++i)\n" 2405 " return;\n" 2406 "}"); 2407 verifyFormat("call(parameter, {\n" 2408 " something();\n" 2409 " // Comment using all columns.\n" 2410 " somethingelse();\n" 2411 "});", 2412 getLLVMStyleWithColumns(40)); 2413 EXPECT_EQ("call(parameter, {\n" 2414 " something();\n" 2415 " // Comment too\n" 2416 " // looooooooooong.\n" 2417 " somethingElse();\n" 2418 "});", 2419 format("call(parameter, {\n" 2420 " something();\n" 2421 " // Comment too looooooooooong.\n" 2422 " somethingElse();\n" 2423 "});", 2424 getLLVMStyleWithColumns(29))); 2425 EXPECT_EQ("DEBUG({ int i; });", format("DEBUG({ int i; });")); 2426 EXPECT_EQ("DEBUG({ // comment\n" 2427 " int i;\n" 2428 "});", 2429 format("DEBUG({ // comment\n" 2430 "int i;\n" 2431 "});")); 2432 EXPECT_EQ("DEBUG({\n" 2433 " int i;\n" 2434 "\n" 2435 " // comment\n" 2436 " int j;\n" 2437 "});", 2438 format("DEBUG({\n" 2439 " int i;\n" 2440 "\n" 2441 " // comment\n" 2442 " int j;\n" 2443 "});")); 2444 } 2445 2446 TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) { 2447 EXPECT_EQ("{}", format("{}")); 2448 verifyFormat("enum E {};"); 2449 verifyFormat("enum E {}"); 2450 } 2451 2452 //===----------------------------------------------------------------------===// 2453 // Line break tests. 2454 //===----------------------------------------------------------------------===// 2455 2456 TEST_F(FormatTest, PreventConfusingIndents) { 2457 verifyFormat( 2458 "SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n" 2459 " parameter, parameter, parameter)),\n" 2460 " SecondLongCall(parameter));"); 2461 verifyFormat( 2462 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2463 " aaaaaaaaaaaaaaaaaaaaaaaa(\n" 2464 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2465 " aaaaaaaaaaaaaaaaaaaaaaaa);"); 2466 verifyFormat( 2467 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2468 " [aaaaaaaaaaaaaaaaaaaaaaaa\n" 2469 " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n" 2470 " [aaaaaaaaaaaaaaaaaaaaaaaa]];"); 2471 verifyFormat( 2472 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" 2473 " aaaaaaaaaaaaaaaaaaaaaaaa<\n" 2474 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>,\n" 2475 " aaaaaaaaaaaaaaaaaaaaaaaa>;"); 2476 verifyFormat("int a = bbbb && ccc && fffff(\n" 2477 "#define A Just forcing a new line\n" 2478 " ddd);"); 2479 } 2480 2481 TEST_F(FormatTest, LineBreakingInBinaryExpressions) { 2482 verifyFormat( 2483 "bool aaaaaaa =\n" 2484 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaa).aaaaaaaaaaaaaaaaaaa() ||\n" 2485 " bbbbbbbb();"); 2486 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaa =\n" 2487 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa != bbbbbbbbbbbbbbbbbb &&\n" 2488 " ccccccccc == ddddddddddd;"); 2489 2490 verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n" 2491 " aaaaaa) &&\n" 2492 " bbbbbb && cccccc;"); 2493 verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n" 2494 " aaaaaa) >>\n" 2495 " bbbbbb;"); 2496 verifyFormat("Whitespaces.addUntouchableComment(\n" 2497 " SourceMgr.getSpellingColumnNumber(\n" 2498 " TheLine.Last->FormatTok.Tok.getLocation()) -\n" 2499 " 1);"); 2500 2501 verifyFormat("if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2502 " bbbbbbbbbbbbbbbbbb) && // aaaaaaaaaaaaaaaa\n" 2503 " cccccc) {\n}"); 2504 2505 // If the LHS of a comparison is not a binary expression itself, the 2506 // additional linebreak confuses many people. 2507 verifyFormat( 2508 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2509 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) > 5) {\n" 2510 "}"); 2511 verifyFormat( 2512 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2513 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" 2514 "}"); 2515 verifyFormat( 2516 "if (aaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaa(\n" 2517 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" 2518 "}"); 2519 // Even explicit parentheses stress the precedence enough to make the 2520 // additional break unnecessary. 2521 verifyFormat( 2522 "if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2523 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" 2524 "}"); 2525 // This cases is borderline, but with the indentation it is still readable. 2526 verifyFormat( 2527 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2528 " aaaaaaaaaaaaaaa) > aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2529 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 2530 "}", 2531 getLLVMStyleWithColumns(75)); 2532 2533 // If the LHS is a binary expression, we should still use the additional break 2534 // as otherwise the formatting hides the operator precedence. 2535 verifyFormat( 2536 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2537 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2538 " 5) {\n" 2539 "}"); 2540 2541 FormatStyle OnePerLine = getLLVMStyle(); 2542 OnePerLine.BinPackParameters = false; 2543 verifyFormat( 2544 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2545 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2546 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}", 2547 OnePerLine); 2548 } 2549 2550 TEST_F(FormatTest, ExpressionIndentation) { 2551 verifyFormat("bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2552 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2553 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2554 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2555 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +\n" 2556 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb &&\n" 2557 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2558 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >\n" 2559 " ccccccccccccccccccccccccccccccccccccccccc;"); 2560 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2561 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2562 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2563 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2564 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2565 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2566 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2567 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2568 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2569 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2570 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2571 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2572 verifyFormat("if () {\n" 2573 "} else if (aaaaa && bbbbb > // break\n" 2574 " ccccc) {\n" 2575 "}"); 2576 2577 // Presence of a trailing comment used to change indentation of b. 2578 verifyFormat("return aaaaaaaaaaaaaaaaaaa +\n" 2579 " b;\n" 2580 "return aaaaaaaaaaaaaaaaaaa +\n" 2581 " b; //", 2582 getLLVMStyleWithColumns(30)); 2583 } 2584 2585 TEST_F(FormatTest, ExpressionIndentationBreakingBeforeOperators) { 2586 // Not sure what the best system is here. Like this, the LHS can be found 2587 // immediately above an operator (everything with the same or a higher 2588 // indent). The RHS is aligned right of the operator and so compasses 2589 // everything until something with the same indent as the operator is found. 2590 // FIXME: Is this a good system? 2591 FormatStyle Style = getLLVMStyle(); 2592 Style.BreakBeforeBinaryOperators = true; 2593 verifyFormat( 2594 "bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2595 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2596 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2597 " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2598 " * bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 2599 " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 2600 " && aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2601 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2602 " > ccccccccccccccccccccccccccccccccccccccccc;", 2603 Style); 2604 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2605 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2606 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2607 " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", 2608 Style); 2609 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2610 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2611 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2612 " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", 2613 Style); 2614 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2615 " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2616 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2617 " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", 2618 Style); 2619 verifyFormat("if () {\n" 2620 "} else if (aaaaa && bbbbb // break\n" 2621 " > ccccc) {\n" 2622 "}", 2623 Style); 2624 } 2625 2626 TEST_F(FormatTest, ConstructorInitializers) { 2627 verifyFormat("Constructor() : Initializer(FitsOnTheLine) {}"); 2628 verifyFormat("Constructor() : Inttializer(FitsOnTheLine) {}", 2629 getLLVMStyleWithColumns(45)); 2630 verifyFormat("Constructor()\n" 2631 " : Inttializer(FitsOnTheLine) {}", 2632 getLLVMStyleWithColumns(44)); 2633 verifyFormat("Constructor()\n" 2634 " : Inttializer(FitsOnTheLine) {}", 2635 getLLVMStyleWithColumns(43)); 2636 2637 verifyFormat( 2638 "SomeClass::Constructor()\n" 2639 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); 2640 2641 verifyFormat( 2642 "SomeClass::Constructor()\n" 2643 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2644 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}"); 2645 verifyFormat( 2646 "SomeClass::Constructor()\n" 2647 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2648 " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); 2649 2650 verifyFormat("Constructor()\n" 2651 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2652 " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2653 " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2654 " aaaaaaaaaaaaaaaaaaaaaaa() {}"); 2655 2656 verifyFormat("Constructor()\n" 2657 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2658 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 2659 2660 verifyFormat("Constructor(int Parameter = 0)\n" 2661 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa),\n" 2662 " aaaaaaaaaaaa(aaaaaaaaaaaaaaaaa) {}"); 2663 verifyFormat("Constructor()\n" 2664 " : aaaaaaaaaaaaaaaaaaaa(a), bbbbbbbbbbbbbbbbbbbbbbbb(b) {\n" 2665 "}", 2666 getLLVMStyleWithColumns(60)); 2667 2668 // Here a line could be saved by splitting the second initializer onto two 2669 // lines, but that is not desireable. 2670 verifyFormat("Constructor()\n" 2671 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n" 2672 " aaaaaaaaaaa(aaaaaaaaaaa),\n" 2673 " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 2674 2675 FormatStyle OnePerLine = getLLVMStyle(); 2676 OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 2677 verifyFormat("SomeClass::Constructor()\n" 2678 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2679 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2680 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 2681 OnePerLine); 2682 verifyFormat("SomeClass::Constructor()\n" 2683 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), // Some comment\n" 2684 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2685 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 2686 OnePerLine); 2687 verifyFormat("MyClass::MyClass(int var)\n" 2688 " : some_var_(var), // 4 space indent\n" 2689 " some_other_var_(var + 1) { // lined up\n" 2690 "}", 2691 OnePerLine); 2692 verifyFormat("Constructor()\n" 2693 " : aaaaa(aaaaaa),\n" 2694 " aaaaa(aaaaaa),\n" 2695 " aaaaa(aaaaaa),\n" 2696 " aaaaa(aaaaaa),\n" 2697 " aaaaa(aaaaaa) {}", 2698 OnePerLine); 2699 verifyFormat("Constructor()\n" 2700 " : aaaaa(aaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaa,\n" 2701 " aaaaaaaaaaaaaaaaaaaaaa) {}", 2702 OnePerLine); 2703 } 2704 2705 TEST_F(FormatTest, MemoizationTests) { 2706 // This breaks if the memoization lookup does not take \c Indent and 2707 // \c LastSpace into account. 2708 verifyFormat( 2709 "extern CFRunLoopTimerRef\n" 2710 "CFRunLoopTimerCreate(CFAllocatorRef allocato, CFAbsoluteTime fireDate,\n" 2711 " CFTimeInterval interval, CFOptionFlags flags,\n" 2712 " CFIndex order, CFRunLoopTimerCallBack callout,\n" 2713 " CFRunLoopTimerContext *context) {}"); 2714 2715 // Deep nesting somewhat works around our memoization. 2716 verifyFormat( 2717 "aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2718 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2719 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2720 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2721 " aaaaa())))))))))))))))))))))))))))))))))))))));", 2722 getLLVMStyleWithColumns(65)); 2723 verifyFormat( 2724 "aaaaa(\n" 2725 " aaaaa,\n" 2726 " aaaaa(\n" 2727 " aaaaa,\n" 2728 " aaaaa(\n" 2729 " aaaaa,\n" 2730 " aaaaa(\n" 2731 " aaaaa,\n" 2732 " aaaaa(\n" 2733 " aaaaa,\n" 2734 " aaaaa(\n" 2735 " aaaaa,\n" 2736 " aaaaa(\n" 2737 " aaaaa,\n" 2738 " aaaaa(\n" 2739 " aaaaa,\n" 2740 " aaaaa(\n" 2741 " aaaaa,\n" 2742 " aaaaa(\n" 2743 " aaaaa,\n" 2744 " aaaaa(\n" 2745 " aaaaa,\n" 2746 " aaaaa(\n" 2747 " aaaaa,\n" 2748 " aaaaa))))))))))));", 2749 getLLVMStyleWithColumns(65)); 2750 verifyFormat( 2751 "a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(), a), a), a), a),\n" 2752 " a),\n" 2753 " a),\n" 2754 " a),\n" 2755 " a),\n" 2756 " a),\n" 2757 " a),\n" 2758 " a),\n" 2759 " a),\n" 2760 " a),\n" 2761 " a),\n" 2762 " a),\n" 2763 " a),\n" 2764 " a),\n" 2765 " a),\n" 2766 " a),\n" 2767 " a),\n" 2768 " a)", 2769 getLLVMStyleWithColumns(65)); 2770 2771 // This test takes VERY long when memoization is broken. 2772 FormatStyle OnePerLine = getLLVMStyle(); 2773 OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 2774 OnePerLine.BinPackParameters = false; 2775 std::string input = "Constructor()\n" 2776 " : aaaa(a,\n"; 2777 for (unsigned i = 0, e = 80; i != e; ++i) { 2778 input += " a,\n"; 2779 } 2780 input += " a) {}"; 2781 verifyFormat(input, OnePerLine); 2782 } 2783 2784 TEST_F(FormatTest, BreaksAsHighAsPossible) { 2785 verifyFormat( 2786 "void f() {\n" 2787 " if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n" 2788 " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n" 2789 " f();\n" 2790 "}"); 2791 verifyFormat("if (Intervals[i].getRange().getFirst() <\n" 2792 " Intervals[i - 1].getRange().getLast()) {\n}"); 2793 } 2794 2795 TEST_F(FormatTest, BreaksFunctionDeclarations) { 2796 // Principially, we break function declarations in a certain order: 2797 // 1) break amongst arguments. 2798 verifyFormat("Aaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccc,\n" 2799 " Cccccccccccccc cccccccccccccc);"); 2800 verifyFormat( 2801 "template <class TemplateIt>\n" 2802 "SomeReturnType SomeFunction(TemplateIt begin, TemplateIt end,\n" 2803 " TemplateIt *stop) {}"); 2804 2805 // 2) break after return type. 2806 verifyFormat( 2807 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2808 " bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccccccccccccccc);", 2809 getGoogleStyle()); 2810 2811 // 3) break after (. 2812 verifyFormat( 2813 "Aaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb(\n" 2814 " Cccccccccccccccccccccccccccccc cccccccccccccccccccccccccccccccc);", 2815 getGoogleStyle()); 2816 2817 // 4) break before after nested name specifiers. 2818 verifyFormat( 2819 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2820 " SomeClasssssssssssssssssssssssssssssssssssssss::\n" 2821 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc);", 2822 getGoogleStyle()); 2823 2824 // However, there are exceptions, if a sufficient amount of lines can be 2825 // saved. 2826 // FIXME: The precise cut-offs wrt. the number of saved lines might need some 2827 // more adjusting. 2828 verifyFormat("Aaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" 2829 " Cccccccccccccc cccccccccc,\n" 2830 " Cccccccccccccc cccccccccc,\n" 2831 " Cccccccccccccc cccccccccc,\n" 2832 " Cccccccccccccc cccccccccc);"); 2833 verifyFormat( 2834 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2835 " bbbbbbbbbbb(Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2836 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2837 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);", 2838 getGoogleStyle()); 2839 verifyFormat( 2840 "Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" 2841 " Cccccccccccccc cccccccccc,\n" 2842 " Cccccccccccccc cccccccccc,\n" 2843 " Cccccccccccccc cccccccccc,\n" 2844 " Cccccccccccccc cccccccccc,\n" 2845 " Cccccccccccccc cccccccccc,\n" 2846 " Cccccccccccccc cccccccccc);"); 2847 verifyFormat("Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n" 2848 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2849 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2850 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2851 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);"); 2852 2853 // Break after multi-line parameters. 2854 verifyFormat("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2855 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2856 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2857 " bbbb bbbb);"); 2858 2859 // Treat overloaded operators like other functions. 2860 verifyFormat("SomeLoooooooooooooooooooooooooogType\n" 2861 "operator>(const SomeLoooooooooooooooooooooooooogType &other);"); 2862 verifyFormat("SomeLoooooooooooooooooooooooooogType\n" 2863 "operator>>(const SomeLooooooooooooooooooooooooogType &other);"); 2864 verifyGoogleFormat( 2865 "SomeLoooooooooooooooooooooooooooooogType operator<<(\n" 2866 " const SomeLooooooooogType &a, const SomeLooooooooogType &b);"); 2867 } 2868 2869 TEST_F(FormatTest, TrailingReturnType) { 2870 verifyFormat("auto foo() -> int;\n"); 2871 verifyFormat("struct S {\n" 2872 " auto bar() const -> int;\n" 2873 "};"); 2874 verifyFormat("template <size_t Order, typename T>\n" 2875 "auto load_img(const std::string &filename)\n" 2876 " -> alias::tensor<Order, T, mem::tag::cpu> {}"); 2877 2878 // Not trailing return types. 2879 verifyFormat("void f() { auto a = b->c(); }"); 2880 } 2881 2882 TEST_F(FormatTest, BreaksFunctionDeclarationsWithTrailingTokens) { 2883 // Avoid breaking before trailing 'const' or other trailing annotations, if 2884 // they are not function-like. 2885 FormatStyle Style = getGoogleStyle(); 2886 Style.ColumnLimit = 47; 2887 verifyFormat("void\n" 2888 "someLongFunction(int someLongParameter) const {\n}", 2889 getLLVMStyleWithColumns(47)); 2890 verifyFormat("LoooooongReturnType\n" 2891 "someLoooooooongFunction() const {}", 2892 getLLVMStyleWithColumns(47)); 2893 verifyFormat("LoooooongReturnType someLoooooooongFunction()\n" 2894 " const {}", 2895 Style); 2896 verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" 2897 " aaaaa aaaaaaaaaaaaaaaaaaaa) OVERRIDE;"); 2898 verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" 2899 " aaaaa aaaaaaaaaaaaaaaaaaaa) OVERRIDE FINAL;"); 2900 verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" 2901 " aaaaa aaaaaaaaaaaaaaaaaaaa) override final;"); 2902 2903 // Unless this would lead to the first parameter being broken. 2904 verifyFormat("void someLongFunction(int someLongParameter)\n" 2905 " const {}", 2906 getLLVMStyleWithColumns(46)); 2907 verifyFormat("void someLongFunction(int someLongParameter)\n" 2908 " const {}", 2909 Style); 2910 verifyFormat("void SomeFunction(aaaaaaaaaa aaaaaaaaaaaaaaa,\n" 2911 " aaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2912 " LONG_AND_UGLY_ANNOTATION;"); 2913 2914 // Breaking before function-like trailing annotations is fine to keep them 2915 // close to their arguments. 2916 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2917 " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); 2918 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" 2919 " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); 2920 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" 2921 " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}"); 2922 2923 verifyFormat( 2924 "void aaaaaaaaaaaaaaaaaa()\n" 2925 " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n" 2926 " aaaaaaaaaaaaaaaaaaaaaaaaa));"); 2927 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2928 " __attribute__((unused));"); 2929 verifyFormat( 2930 "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2931 " GUARDED_BY(aaaaaaaaaaaa);", 2932 getGoogleStyle()); 2933 verifyFormat( 2934 "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2935 " GUARDED_BY(aaaaaaaaaaaa);", 2936 getGoogleStyle()); 2937 } 2938 2939 TEST_F(FormatTest, BreaksDesireably) { 2940 verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" 2941 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" 2942 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {\n}"); 2943 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2944 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)) {\n" 2945 "}"); 2946 2947 verifyFormat( 2948 "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2949 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 2950 2951 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2952 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2953 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2954 2955 verifyFormat( 2956 "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2957 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" 2958 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2959 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));"); 2960 2961 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2962 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2963 2964 verifyFormat( 2965 "void f() {\n" 2966 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" 2967 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 2968 "}"); 2969 verifyFormat( 2970 "aaaaaa(new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2971 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2972 verifyFormat( 2973 "aaaaaa(aaa, new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2974 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2975 verifyFormat( 2976 "aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2977 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2978 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2979 2980 // Indent consistently indenpendent of call expression. 2981 verifyFormat("aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbb.ccccccccccccccccc(\n" 2982 " dddddddddddddddddddddddddddddd));\n" 2983 "aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n" 2984 " dddddddddddddddddddddddddddddd));"); 2985 2986 // This test case breaks on an incorrect memoization, i.e. an optimization not 2987 // taking into account the StopAt value. 2988 verifyFormat( 2989 "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 2990 " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 2991 " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 2992 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2993 2994 verifyFormat("{\n {\n {\n" 2995 " Annotation.SpaceRequiredBefore =\n" 2996 " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n" 2997 " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n" 2998 " }\n }\n}"); 2999 3000 // Break on an outer level if there was a break on an inner level. 3001 EXPECT_EQ("f(g(h(a, // comment\n" 3002 " b, c),\n" 3003 " d, e),\n" 3004 " x, y);", 3005 format("f(g(h(a, // comment\n" 3006 " b, c), d, e), x, y);")); 3007 3008 // Prefer breaking similar line breaks. 3009 verifyFormat( 3010 "const int kTrackingOptions = NSTrackingMouseMoved |\n" 3011 " NSTrackingMouseEnteredAndExited |\n" 3012 " NSTrackingActiveAlways;"); 3013 } 3014 3015 TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { 3016 FormatStyle NoBinPacking = getGoogleStyle(); 3017 NoBinPacking.BinPackParameters = false; 3018 verifyFormat("f(aaaaaaaaaaaaaaaaaaaa,\n" 3019 " aaaaaaaaaaaaaaaaaaaa,\n" 3020 " aaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaa);", 3021 NoBinPacking); 3022 verifyFormat("aaaaaaa(aaaaaaaaaaaaa,\n" 3023 " aaaaaaaaaaaaa,\n" 3024 " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));", 3025 NoBinPacking); 3026 verifyFormat( 3027 "aaaaaaaa(aaaaaaaaaaaaa,\n" 3028 " aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3029 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" 3030 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3031 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));", 3032 NoBinPacking); 3033 verifyFormat("aaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" 3034 " .aaaaaaaaaaaaaaaaaa();", 3035 NoBinPacking); 3036 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3037 " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);", 3038 NoBinPacking); 3039 3040 verifyFormat( 3041 "aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3042 " aaaaaaaaaaaa,\n" 3043 " aaaaaaaaaaaa);", 3044 NoBinPacking); 3045 verifyFormat( 3046 "somefunction(someotherFunction(ddddddddddddddddddddddddddddddddddd,\n" 3047 " ddddddddddddddddddddddddddddd),\n" 3048 " test);", 3049 NoBinPacking); 3050 3051 verifyFormat("std::vector<aaaaaaaaaaaaaaaaaaaaaaa,\n" 3052 " aaaaaaaaaaaaaaaaaaaaaaa,\n" 3053 " aaaaaaaaaaaaaaaaaaaaaaa> aaaaaaaaaaaaaaaaaa;", 3054 NoBinPacking); 3055 verifyFormat("a(\"a\"\n" 3056 " \"a\",\n" 3057 " a);"); 3058 3059 NoBinPacking.AllowAllParametersOfDeclarationOnNextLine = false; 3060 verifyFormat("void aaaaaaaaaa(aaaaaaaaa,\n" 3061 " aaaaaaaaa,\n" 3062 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", 3063 NoBinPacking); 3064 verifyFormat( 3065 "void f() {\n" 3066 " aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" 3067 " .aaaaaaa();\n" 3068 "}", 3069 NoBinPacking); 3070 verifyFormat( 3071 "template <class SomeType, class SomeOtherType>\n" 3072 "SomeType SomeFunction(SomeType Type, SomeOtherType OtherType) {}", 3073 NoBinPacking); 3074 } 3075 3076 TEST_F(FormatTest, AdaptiveOnePerLineFormatting) { 3077 FormatStyle Style = getLLVMStyleWithColumns(15); 3078 Style.ExperimentalAutoDetectBinPacking = true; 3079 EXPECT_EQ("aaa(aaaa,\n" 3080 " aaaa,\n" 3081 " aaaa);\n" 3082 "aaa(aaaa,\n" 3083 " aaaa,\n" 3084 " aaaa);", 3085 format("aaa(aaaa,\n" // one-per-line 3086 " aaaa,\n" 3087 " aaaa );\n" 3088 "aaa(aaaa, aaaa, aaaa);", // inconclusive 3089 Style)); 3090 EXPECT_EQ("aaa(aaaa, aaaa,\n" 3091 " aaaa);\n" 3092 "aaa(aaaa, aaaa,\n" 3093 " aaaa);", 3094 format("aaa(aaaa, aaaa,\n" // bin-packed 3095 " aaaa );\n" 3096 "aaa(aaaa, aaaa, aaaa);", // inconclusive 3097 Style)); 3098 } 3099 3100 TEST_F(FormatTest, FormatsBuilderPattern) { 3101 verifyFormat( 3102 "return llvm::StringSwitch<Reference::Kind>(name)\n" 3103 " .StartsWith(\".eh_frame_hdr\", ORDER_EH_FRAMEHDR)\n" 3104 " .StartsWith(\".eh_frame\", ORDER_EH_FRAME)\n" 3105 " .StartsWith(\".init\", ORDER_INIT)\n" 3106 " .StartsWith(\".fini\", ORDER_FINI)\n" 3107 " .StartsWith(\".hash\", ORDER_HASH)\n" 3108 " .Default(ORDER_TEXT);\n"); 3109 3110 verifyFormat("return aaaaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa() <\n" 3111 " aaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa();"); 3112 verifyFormat( 3113 "aaaaaaa->aaaaaaa->aaaaaaaaaaaaaaaa(\n" 3114 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3115 " ->aaaaaaaa(aaaaaaaaaaaaaaa);"); 3116 verifyFormat( 3117 "aaaaaaaaaaaaaaaaaaa()->aaaaaa(bbbbb)->aaaaaaaaaaaaaaaaaaa( // break\n" 3118 " aaaaaaaaaaaaaa);"); 3119 verifyFormat( 3120 "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa =\n" 3121 " aaaaaa->aaaaaaaaaaaa()\n" 3122 " ->aaaaaaaaaaaaaaaa(\n" 3123 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3124 " ->aaaaaaaaaaaaaaaaa();"); 3125 verifyGoogleFormat( 3126 "someobj->Add((new util::filetools::Handler(dir))\n" 3127 " ->OnEvent1(NewPermanentCallback(\n" 3128 " this, &HandlerHolderClass::EventHandlerCBA))\n" 3129 " ->OnEvent2(NewPermanentCallback(\n" 3130 " this, &HandlerHolderClass::EventHandlerCBB))\n" 3131 " ->OnEvent3(NewPermanentCallback(\n" 3132 " this, &HandlerHolderClass::EventHandlerCBC))\n" 3133 " ->OnEvent5(NewPermanentCallback(\n" 3134 " this, &HandlerHolderClass::EventHandlerCBD))\n" 3135 " ->OnEvent6(NewPermanentCallback(\n" 3136 " this, &HandlerHolderClass::EventHandlerCBE)));"); 3137 3138 verifyFormat( 3139 "aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa();"); 3140 verifyFormat("aaaaaaaaaaaaaaa()\n" 3141 " .aaaaaaaaaaaaaaa()\n" 3142 " .aaaaaaaaaaaaaaa()\n" 3143 " .aaaaaaaaaaaaaaa()\n" 3144 " .aaaaaaaaaaaaaaa();"); 3145 verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" 3146 " .aaaaaaaaaaaaaaa()\n" 3147 " .aaaaaaaaaaaaaaa()\n" 3148 " .aaaaaaaaaaaaaaa();"); 3149 verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" 3150 " .aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" 3151 " .aaaaaaaaaaaaaaa();"); 3152 verifyFormat("aaaaaaaaaaaaa->aaaaaaaaaaaaaaaaaaaaaaaa()\n" 3153 " ->aaaaaaaaaaaaaae(0)\n" 3154 " ->aaaaaaaaaaaaaaa();"); 3155 3156 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaa()\n" 3157 " .aaaaaaaaaaaaaaaaaaaaaaaaaa()\n" 3158 " .has<bbbbbbbbbbbbbbbbbbbbb>();"); 3159 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaa()\n" 3160 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" 3161 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>();"); 3162 3163 // Prefer not to break after empty parentheses. 3164 verifyFormat("FirstToken->WhitespaceRange.getBegin().getLocWithOffset(\n" 3165 " First->LastNewlineOffset);"); 3166 } 3167 3168 TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) { 3169 verifyFormat( 3170 "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 3171 " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {\n}"); 3172 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" 3173 " ccccccccccccccccccccccccc) {\n}"); 3174 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" 3175 " ccccccccccccccccccccccccc) {\n}"); 3176 verifyFormat( 3177 "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n" 3178 " ccccccccccccccccccccccccc) {\n}"); 3179 verifyFormat("return aaaa & AAAAAAAAAAAAAAAAAAAAAAAAAAAAA ||\n" 3180 " bbbb & BBBBBBBBBBBBBBBBBBBBBBBBBBBBB ||\n" 3181 " cccc & CCCCCCCCCCCCCCCCCCCCCCCCCC ||\n" 3182 " dddd & DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD;"); 3183 verifyFormat("if ((aaaaaaaaaa != aaaaaaaaaaaaaaa ||\n" 3184 " aaaaaaaaaaaaaaaaaaaaaaaa() >= aaaaaaaaaaaaaaaaaaaa) &&\n" 3185 " aaaaaaaaaaaaaaa != aa) {\n}"); 3186 } 3187 3188 TEST_F(FormatTest, BreaksAfterAssignments) { 3189 verifyFormat( 3190 "unsigned Cost =\n" 3191 " TTI.getMemoryOpCost(I->getOpcode(), VectorTy, SI->getAlignment(),\n" 3192 " SI->getPointerAddressSpaceee());\n"); 3193 verifyFormat( 3194 "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n" 3195 " Line.Tokens.front().Tok.getLo(), Line.Tokens.back().Tok.getLoc());"); 3196 3197 verifyFormat( 3198 "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa().aaaaaaaaa(\n" 3199 " aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);"); 3200 verifyFormat("unsigned OriginalStartColumn =\n" 3201 " SourceMgr.getSpellingColumnNumber(\n" 3202 " Current.FormatTok.getStartOfNonWhitespace()) -\n" 3203 " 1;"); 3204 } 3205 3206 TEST_F(FormatTest, AlignsAfterAssignments) { 3207 verifyFormat( 3208 "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3209 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3210 verifyFormat( 3211 "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3212 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3213 verifyFormat( 3214 "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3215 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3216 verifyFormat( 3217 "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3218 " aaaaaaaaaaaaaaaaaaaaaaaaa);"); 3219 verifyFormat( 3220 "double LooooooooooooooooooooooooongResult = aaaaaaaaaaaaaaaaaaaaaaaa +\n" 3221 " aaaaaaaaaaaaaaaaaaaaaaaa +\n" 3222 " aaaaaaaaaaaaaaaaaaaaaaaa;"); 3223 } 3224 3225 TEST_F(FormatTest, AlignsAfterReturn) { 3226 verifyFormat( 3227 "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3228 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3229 verifyFormat( 3230 "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3231 " aaaaaaaaaaaaaaaaaaaaaaaaa);"); 3232 verifyFormat( 3233 "return aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" 3234 " aaaaaaaaaaaaaaaaaaaaaa();"); 3235 verifyFormat( 3236 "return (aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" 3237 " aaaaaaaaaaaaaaaaaaaaaa());"); 3238 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3239 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3240 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3241 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) &&\n" 3242 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3243 verifyFormat("return\n" 3244 " // true if code is one of a or b.\n" 3245 " code == a || code == b;"); 3246 } 3247 3248 TEST_F(FormatTest, BreaksConditionalExpressions) { 3249 verifyFormat( 3250 "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3251 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3252 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3253 verifyFormat( 3254 "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3255 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3256 verifyFormat( 3257 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaa ? aaaa(aaaaaa)\n" 3258 " : aaaaaaaaaaaaa);"); 3259 verifyFormat( 3260 "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3261 " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3262 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3263 " aaaaaaaaaaaaa);"); 3264 verifyFormat( 3265 "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3266 " aaaaaaaaaaaaaaaa ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3267 " aaaaaaaaaaaaa);"); 3268 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3269 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3270 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3271 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3272 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3273 verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3274 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3275 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3276 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3277 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3278 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 3279 " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3280 verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3281 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3282 " ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3283 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 3284 " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3285 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3286 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3287 " : aaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3288 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaa =\n" 3289 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3290 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3291 " : aaaaaaaaaaaaaaaa;"); 3292 verifyFormat( 3293 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3294 " ? aaaaaaaaaaaaaaa\n" 3295 " : aaaaaaaaaaaaaaa;"); 3296 verifyFormat("f(aaaaaaaaaaaaaaaa == // force break\n" 3297 " aaaaaaaaa\n" 3298 " ? b\n" 3299 " : c);"); 3300 verifyFormat( 3301 "unsigned Indent =\n" 3302 " format(TheLine.First, IndentForLevel[TheLine.Level] >= 0\n" 3303 " ? IndentForLevel[TheLine.Level]\n" 3304 " : TheLine * 2,\n" 3305 " TheLine.InPPDirective, PreviousEndOfLineColumn);", 3306 getLLVMStyleWithColumns(70)); 3307 verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n" 3308 " ? aaaaaaaaaaaaaaa\n" 3309 " : bbbbbbbbbbbbbbb //\n" 3310 " ? ccccccccccccccc\n" 3311 " : ddddddddddddddd;"); 3312 verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n" 3313 " ? aaaaaaaaaaaaaaa\n" 3314 " : (bbbbbbbbbbbbbbb //\n" 3315 " ? ccccccccccccccc\n" 3316 " : ddddddddddddddd);"); 3317 3318 FormatStyle NoBinPacking = getLLVMStyle(); 3319 NoBinPacking.BinPackParameters = false; 3320 verifyFormat( 3321 "void f() {\n" 3322 " g(aaa,\n" 3323 " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" 3324 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3325 " ? aaaaaaaaaaaaaaa\n" 3326 " : aaaaaaaaaaaaaaa);\n" 3327 "}", 3328 NoBinPacking); 3329 verifyFormat( 3330 "void f() {\n" 3331 " g(aaa,\n" 3332 " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" 3333 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3334 " ?: aaaaaaaaaaaaaaa);\n" 3335 "}", 3336 NoBinPacking); 3337 } 3338 3339 TEST_F(FormatTest, DeclarationsOfMultipleVariables) { 3340 verifyFormat("bool aaaaaaaaaaaaaaaaa = aaaaaa->aaaaaaaaaaaaaaaaa(),\n" 3341 " aaaaaaaaaaa = aaaaaa->aaaaaaaaaaa();"); 3342 verifyFormat("bool a = true, b = false;"); 3343 3344 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3345 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa),\n" 3346 " bbbbbbbbbbbbbbbbbbbbbbbbb =\n" 3347 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(bbbbbbbbbbbbbbbb);"); 3348 verifyFormat( 3349 "bool aaaaaaaaaaaaaaaaaaaaa =\n" 3350 " bbbbbbbbbbbbbbbbbbbbbbbbbbbb && cccccccccccccccccccccccccccc,\n" 3351 " d = e && f;"); 3352 verifyFormat("aaaaaaaaa a = aaaaaaaaaaaaaaaaaaaa, b = bbbbbbbbbbbbbbbbbbbb,\n" 3353 " c = cccccccccccccccccccc, d = dddddddddddddddddddd;"); 3354 verifyFormat("aaaaaaaaa *a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" 3355 " *c = ccccccccccccccccccc, *d = ddddddddddddddddddd;"); 3356 verifyFormat("aaaaaaaaa ***a = aaaaaaaaaaaaaaaaaaa, ***b = bbbbbbbbbbbbbbb,\n" 3357 " ***c = ccccccccccccccccccc, ***d = ddddddddddddddd;"); 3358 // FIXME: If multiple variables are defined, the "*" needs to move to the new 3359 // line. Also fix indent for breaking after the type, this looks bad. 3360 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*\n" 3361 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa = aaaaaaaaaaaaaaaaaaa,\n" 3362 " *b = bbbbbbbbbbbbbbbbbbb;", 3363 getGoogleStyle()); 3364 3365 // Not ideal, but pointer-with-type does not allow much here. 3366 verifyGoogleFormat( 3367 "aaaaaaaaa* a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" 3368 " *b = bbbbbbbbbbbbbbbbbbb, *d = ddddddddddddddddddd;"); 3369 } 3370 3371 TEST_F(FormatTest, ConditionalExpressionsInBrackets) { 3372 verifyFormat("arr[foo ? bar : baz];"); 3373 verifyFormat("f()[foo ? bar : baz];"); 3374 verifyFormat("(a + b)[foo ? bar : baz];"); 3375 verifyFormat("arr[foo ? (4 > 5 ? 4 : 5) : 5 < 5 ? 5 : 7];"); 3376 } 3377 3378 TEST_F(FormatTest, AlignsStringLiterals) { 3379 verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n" 3380 " \"short literal\");"); 3381 verifyFormat( 3382 "looooooooooooooooooooooooongFunction(\n" 3383 " \"short literal\"\n" 3384 " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");"); 3385 verifyFormat("someFunction(\"Always break between multi-line\"\n" 3386 " \" string literals\",\n" 3387 " and, other, parameters);"); 3388 EXPECT_EQ("fun + \"1243\" /* comment */\n" 3389 " \"5678\";", 3390 format("fun + \"1243\" /* comment */\n" 3391 " \"5678\";", 3392 getLLVMStyleWithColumns(28))); 3393 EXPECT_EQ( 3394 "aaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 3395 " \"aaaaaaaaaaaaaaaaaaaaa\"\n" 3396 " \"aaaaaaaaaaaaaaaa\";", 3397 format("aaaaaa =" 3398 "\"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa " 3399 "aaaaaaaaaaaaaaaaaaaaa\" " 3400 "\"aaaaaaaaaaaaaaaa\";")); 3401 verifyFormat("a = a + \"a\"\n" 3402 " \"a\"\n" 3403 " \"a\";"); 3404 verifyFormat("f(\"a\", \"b\"\n" 3405 " \"c\");"); 3406 3407 verifyFormat( 3408 "#define LL_FORMAT \"ll\"\n" 3409 "printf(\"aaaaa: %d, bbbbbb: %\" LL_FORMAT \"d, cccccccc: %\" LL_FORMAT\n" 3410 " \"d, ddddddddd: %\" LL_FORMAT \"d\");"); 3411 3412 verifyFormat("#define A(X) \\\n" 3413 " \"aaaaa\" #X \"bbbbbb\" \\\n" 3414 " \"ccccc\"", 3415 getLLVMStyleWithColumns(23)); 3416 verifyFormat("#define A \"def\"\n" 3417 "f(\"abc\" A \"ghi\"\n" 3418 " \"jkl\");"); 3419 } 3420 3421 TEST_F(FormatTest, AlwaysBreakBeforeMultilineStrings) { 3422 FormatStyle NoBreak = getLLVMStyle(); 3423 NoBreak.AlwaysBreakBeforeMultilineStrings = false; 3424 FormatStyle Break = getLLVMStyle(); 3425 Break.AlwaysBreakBeforeMultilineStrings = true; 3426 verifyFormat("aaaa = \"bbbb\"\n" 3427 " \"cccc\";", 3428 NoBreak); 3429 verifyFormat("aaaa =\n" 3430 " \"bbbb\"\n" 3431 " \"cccc\";", 3432 Break); 3433 verifyFormat("aaaa(\"bbbb\"\n" 3434 " \"cccc\");", 3435 NoBreak); 3436 verifyFormat("aaaa(\n" 3437 " \"bbbb\"\n" 3438 " \"cccc\");", 3439 Break); 3440 verifyFormat("aaaa(qqq, \"bbbb\"\n" 3441 " \"cccc\");", 3442 NoBreak); 3443 verifyFormat("aaaa(qqq,\n" 3444 " \"bbbb\"\n" 3445 " \"cccc\");", 3446 Break); 3447 3448 // Don't break if there is no column gain. 3449 verifyFormat("f(\"aaaa\"\n" 3450 " \"bbbb\");", 3451 Break); 3452 3453 // Treat literals with escaped newlines like multi-line string literals. 3454 EXPECT_EQ("x = \"a\\\n" 3455 "b\\\n" 3456 "c\";", 3457 format("x = \"a\\\n" 3458 "b\\\n" 3459 "c\";", 3460 NoBreak)); 3461 EXPECT_EQ("x =\n" 3462 " \"a\\\n" 3463 "b\\\n" 3464 "c\";", 3465 format("x = \"a\\\n" 3466 "b\\\n" 3467 "c\";", 3468 Break)); 3469 } 3470 3471 TEST_F(FormatTest, AlignsPipes) { 3472 verifyFormat( 3473 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3474 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3475 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3476 verifyFormat( 3477 "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n" 3478 " << aaaaaaaaaaaaaaaaaaaa;"); 3479 verifyFormat( 3480 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3481 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3482 verifyFormat( 3483 "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" 3484 " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n" 3485 " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";"); 3486 verifyFormat( 3487 "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3488 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3489 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3490 3491 verifyFormat("return out << \"somepacket = {\\n\"\n" 3492 " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n" 3493 " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n" 3494 " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n" 3495 " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n" 3496 " << \"}\";"); 3497 3498 verifyFormat("llvm::outs() << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n" 3499 " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n" 3500 " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa;"); 3501 verifyFormat( 3502 "llvm::outs() << \"aaaaaaaaaaaaaaaaa = \" << aaaaaaaaaaaaaaaaa\n" 3503 " << \"bbbbbbbbbbbbbbbbb = \" << bbbbbbbbbbbbbbbbb\n" 3504 " << \"ccccccccccccccccc = \" << ccccccccccccccccc\n" 3505 " << \"ddddddddddddddddd = \" << ddddddddddddddddd\n" 3506 " << \"eeeeeeeeeeeeeeeee = \" << eeeeeeeeeeeeeeeee;"); 3507 verifyFormat("llvm::outs() << aaaaaaaaaaaaaaaaaaaaaaaa << \"=\"\n" 3508 " << bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 3509 verifyFormat( 3510 "void f() {\n" 3511 " llvm::outs() << \"aaaaaaaaaaaaaaaaaaaa: \"\n" 3512 " << aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 3513 "}"); 3514 3515 // Breaking before the first "<<" is generally not desirable. 3516 verifyFormat( 3517 "llvm::errs()\n" 3518 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3519 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3520 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3521 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 3522 getLLVMStyleWithColumns(70)); 3523 verifyFormat("llvm::errs() << \"aaaaaaaaaaaaaaaaaaa: \"\n" 3524 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3525 " << \"aaaaaaaaaaaaaaaaaaa: \"\n" 3526 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3527 " << \"aaaaaaaaaaaaaaaaaaa: \"\n" 3528 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 3529 getLLVMStyleWithColumns(70)); 3530 3531 // But sometimes, breaking before the first "<<" is desirable. 3532 verifyFormat("Diag(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbb)\n" 3533 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3534 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3535 verifyFormat("SemaRef.Diag(Loc, diag::note_for_range_begin_end)\n" 3536 " << BEF << IsTemplate << Description << E->getType();"); 3537 3538 verifyFormat( 3539 "llvm::errs() << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3540 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3541 3542 // Incomplete string literal. 3543 EXPECT_EQ("llvm::errs() << \"\n" 3544 " << a;", 3545 format("llvm::errs() << \"\n<<a;")); 3546 } 3547 3548 TEST_F(FormatTest, UnderstandsEquals) { 3549 verifyFormat( 3550 "aaaaaaaaaaaaaaaaa =\n" 3551 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3552 verifyFormat( 3553 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3554 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 3555 verifyFormat( 3556 "if (a) {\n" 3557 " f();\n" 3558 "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3559 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 3560 "}"); 3561 3562 verifyFormat("if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3563 " 100000000 + 10000000) {\n}"); 3564 } 3565 3566 TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) { 3567 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" 3568 " .looooooooooooooooooooooooooooooooooooooongFunction();"); 3569 3570 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" 3571 " ->looooooooooooooooooooooooooooooooooooooongFunction();"); 3572 3573 verifyFormat( 3574 "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n" 3575 " Parameter2);"); 3576 3577 verifyFormat( 3578 "ShortObject->shortFunction(\n" 3579 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n" 3580 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);"); 3581 3582 verifyFormat("loooooooooooooongFunction(\n" 3583 " LoooooooooooooongObject->looooooooooooooooongFunction());"); 3584 3585 verifyFormat( 3586 "function(LoooooooooooooooooooooooooooooooooooongObject\n" 3587 " ->loooooooooooooooooooooooooooooooooooooooongFunction());"); 3588 3589 verifyFormat("EXPECT_CALL(SomeObject, SomeFunction(Parameter))\n" 3590 " .WillRepeatedly(Return(SomeValue));"); 3591 verifyFormat("SomeMap[std::pair(aaaaaaaaaaaa, bbbbbbbbbbbbbbb)]\n" 3592 " .insert(ccccccccccccccccccccccc);"); 3593 verifyFormat("aaaaa(aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3594 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).aaaaa(aaaaa),\n" 3595 " aaaaaaaaaaaaaaaaaaaaa);"); 3596 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3597 " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa)->aaaaaaaaa());"); 3598 verifyFormat( 3599 "aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3600 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3601 " .aaaaaaaaaaaaaaa(aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3602 " aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3603 " aaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 3604 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3605 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3606 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3607 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()) {\n" 3608 "}"); 3609 3610 // Here, it is not necessary to wrap at "." or "->". 3611 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n" 3612 " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 3613 verifyFormat( 3614 "aaaaaaaaaaa->aaaaaaaaa(\n" 3615 " aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3616 " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n"); 3617 3618 verifyFormat( 3619 "aaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3620 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa().aaaaaaaaaaaaaaaaa());"); 3621 verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() *\n" 3622 " aaaaaaaaa()->aaaaaa()->aaaaa());"); 3623 verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() ||\n" 3624 " aaaaaaaaa()->aaaaaa()->aaaaa());"); 3625 3626 // FIXME: Should we break before .a()? 3627 verifyFormat("aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3628 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).a();"); 3629 3630 FormatStyle NoBinPacking = getLLVMStyle(); 3631 NoBinPacking.BinPackParameters = false; 3632 verifyFormat("aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 3633 " .aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 3634 " .aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa,\n" 3635 " aaaaaaaaaaaaaaaaaaa,\n" 3636 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", 3637 NoBinPacking); 3638 3639 // If there is a subsequent call, change to hanging indentation. 3640 verifyFormat( 3641 "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3642 " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa))\n" 3643 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3644 verifyFormat( 3645 "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3646 " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa));"); 3647 } 3648 3649 TEST_F(FormatTest, WrapsTemplateDeclarations) { 3650 verifyFormat("template <typename T>\n" 3651 "virtual void loooooooooooongFunction(int Param1, int Param2);"); 3652 verifyFormat("template <typename T>\n" 3653 "// T should be one of {A, B}.\n" 3654 "virtual void loooooooooooongFunction(int Param1, int Param2);"); 3655 verifyFormat( 3656 "template <typename T>\n" 3657 "using comment_to_xml_conversion = comment_to_xml_conversion<T, int>;"); 3658 verifyFormat("template <typename T>\n" 3659 "void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n" 3660 " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);"); 3661 verifyFormat( 3662 "template <typename T>\n" 3663 "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n" 3664 " int Paaaaaaaaaaaaaaaaaaaaram2);"); 3665 verifyFormat( 3666 "template <typename T>\n" 3667 "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n" 3668 " aaaaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaaaaa,\n" 3669 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3670 verifyFormat("template <typename T>\n" 3671 "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3672 " int aaaaaaaaaaaaaaaaaaaaaa);"); 3673 verifyFormat( 3674 "template <typename T1, typename T2 = char, typename T3 = char,\n" 3675 " typename T4 = char>\n" 3676 "void f();"); 3677 verifyFormat( 3678 "aaaaaaaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa>(\n" 3679 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3680 3681 verifyFormat("a<aaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaa>(\n" 3682 " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));"); 3683 3684 verifyFormat("template <typename T> class C {};"); 3685 verifyFormat("template <typename T> void f();"); 3686 verifyFormat("template <typename T> void f() {}"); 3687 verifyFormat( 3688 "aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n" 3689 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3690 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa> *aaaa =\n" 3691 " new aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n" 3692 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3693 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>(\n" 3694 " bbbbbbbbbbbbbbbbbbbbbbbb);", 3695 getLLVMStyleWithColumns(72)); 3696 3697 FormatStyle AlwaysBreak = getLLVMStyle(); 3698 AlwaysBreak.AlwaysBreakTemplateDeclarations = true; 3699 verifyFormat("template <typename T>\nclass C {};", AlwaysBreak); 3700 verifyFormat("template <typename T>\nvoid f();", AlwaysBreak); 3701 verifyFormat("template <typename T>\nvoid f() {}", AlwaysBreak); 3702 verifyFormat("void aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3703 " bbbbbbbbbbbbbbbbbbbbbbbbbbbb>(\n" 3704 " ccccccccccccccccccccccccccccccccccccccccccccccc);"); 3705 verifyFormat("template <template <typename> class Fooooooo,\n" 3706 " template <typename> class Baaaaaaar>\n" 3707 "struct C {};", 3708 AlwaysBreak); 3709 verifyFormat("template <typename T> // T can be A, B or C.\n" 3710 "struct C {};", 3711 AlwaysBreak); 3712 } 3713 3714 TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) { 3715 verifyFormat( 3716 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3717 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3718 verifyFormat( 3719 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3720 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3721 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa());"); 3722 3723 // FIXME: Should we have the extra indent after the second break? 3724 verifyFormat( 3725 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3726 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3727 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3728 3729 verifyFormat( 3730 "aaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb::\n" 3731 " cccccccccccccccccccccccccccccccccccccccccccccc());"); 3732 3733 // Breaking at nested name specifiers is generally not desirable. 3734 verifyFormat( 3735 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3736 " aaaaaaaaaaaaaaaaaaaaaaa);"); 3737 3738 verifyFormat( 3739 "aaaaaaaaaaaaaaaaaa(aaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3740 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3741 " aaaaaaaaaaaaaaaaaaaaa);", 3742 getLLVMStyleWithColumns(74)); 3743 3744 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3745 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3746 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3747 } 3748 3749 TEST_F(FormatTest, UnderstandsTemplateParameters) { 3750 verifyFormat("A<int> a;"); 3751 verifyFormat("A<A<A<int> > > a;"); 3752 verifyFormat("A<A<A<int, 2>, 3>, 4> a;"); 3753 verifyFormat("bool x = a < 1 || 2 > a;"); 3754 verifyFormat("bool x = 5 < f<int>();"); 3755 verifyFormat("bool x = f<int>() > 5;"); 3756 verifyFormat("bool x = 5 < a<int>::x;"); 3757 verifyFormat("bool x = a < 4 ? a > 2 : false;"); 3758 verifyFormat("bool x = f() ? a < 2 : a > 2;"); 3759 3760 verifyGoogleFormat("A<A<int>> a;"); 3761 verifyGoogleFormat("A<A<A<int>>> a;"); 3762 verifyGoogleFormat("A<A<A<A<int>>>> a;"); 3763 verifyGoogleFormat("A<A<int> > a;"); 3764 verifyGoogleFormat("A<A<A<int> > > a;"); 3765 verifyGoogleFormat("A<A<A<A<int> > > > a;"); 3766 verifyGoogleFormat("A<::A<int>> a;"); 3767 verifyGoogleFormat("A<::A> a;"); 3768 verifyGoogleFormat("A< ::A> a;"); 3769 verifyGoogleFormat("A< ::A<int> > a;"); 3770 EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A> >> a;", getGoogleStyle())); 3771 EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A>> > a;", getGoogleStyle())); 3772 EXPECT_EQ("A<::A<int>> a;", format("A< ::A<int>> a;", getGoogleStyle())); 3773 EXPECT_EQ("A<::A<int>> a;", format("A<::A<int> > a;", getGoogleStyle())); 3774 3775 verifyFormat("test >> a >> b;"); 3776 verifyFormat("test << a >> b;"); 3777 3778 verifyFormat("f<int>();"); 3779 verifyFormat("template <typename T> void f() {}"); 3780 3781 // Not template parameters. 3782 verifyFormat("return a < b && c > d;"); 3783 verifyFormat("void f() {\n" 3784 " while (a < b && c > d) {\n" 3785 " }\n" 3786 "}"); 3787 verifyFormat("template <typename... Types>\n" 3788 "typename enable_if<0 < sizeof...(Types)>::type Foo() {}"); 3789 3790 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3791 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa >> aaaaa);", 3792 getLLVMStyleWithColumns(60)); 3793 } 3794 3795 TEST_F(FormatTest, UnderstandsBinaryOperators) { 3796 verifyFormat("COMPARE(a, ==, b);"); 3797 } 3798 3799 TEST_F(FormatTest, UnderstandsPointersToMembers) { 3800 verifyFormat("int A::*x;"); 3801 verifyFormat("int (S::*func)(void *);"); 3802 verifyFormat("void f() { int (S::*func)(void *); }"); 3803 verifyFormat("typedef bool *(Class::*Member)() const;"); 3804 verifyFormat("void f() {\n" 3805 " (a->*f)();\n" 3806 " a->*x;\n" 3807 " (a.*f)();\n" 3808 " ((*a).*f)();\n" 3809 " a.*x;\n" 3810 "}"); 3811 verifyFormat("void f() {\n" 3812 " (a->*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)(\n" 3813 " aaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb);\n" 3814 "}"); 3815 FormatStyle Style = getLLVMStyle(); 3816 Style.PointerBindsToType = true; 3817 verifyFormat("typedef bool* (Class::*Member)() const;", Style); 3818 } 3819 3820 TEST_F(FormatTest, UnderstandsUnaryOperators) { 3821 verifyFormat("int a = -2;"); 3822 verifyFormat("f(-1, -2, -3);"); 3823 verifyFormat("a[-1] = 5;"); 3824 verifyFormat("int a = 5 + -2;"); 3825 verifyFormat("if (i == -1) {\n}"); 3826 verifyFormat("if (i != -1) {\n}"); 3827 verifyFormat("if (i > -1) {\n}"); 3828 verifyFormat("if (i < -1) {\n}"); 3829 verifyFormat("++(a->f());"); 3830 verifyFormat("--(a->f());"); 3831 verifyFormat("(a->f())++;"); 3832 verifyFormat("a[42]++;"); 3833 verifyFormat("if (!(a->f())) {\n}"); 3834 3835 verifyFormat("a-- > b;"); 3836 verifyFormat("b ? -a : c;"); 3837 verifyFormat("n * sizeof char16;"); 3838 verifyFormat("n * alignof char16;", getGoogleStyle()); 3839 verifyFormat("sizeof(char);"); 3840 verifyFormat("alignof(char);", getGoogleStyle()); 3841 3842 verifyFormat("return -1;"); 3843 verifyFormat("switch (a) {\n" 3844 "case -1:\n" 3845 " break;\n" 3846 "}"); 3847 verifyFormat("#define X -1"); 3848 verifyFormat("#define X -kConstant"); 3849 3850 verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { -5, +3 };"); 3851 verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { +5, -3 };"); 3852 3853 verifyFormat("int a = /* confusing comment */ -1;"); 3854 // FIXME: The space after 'i' is wrong, but hopefully, this is a rare case. 3855 verifyFormat("int a = i /* confusing comment */++;"); 3856 } 3857 3858 TEST_F(FormatTest, IndentsRelativeToUnaryOperators) { 3859 verifyFormat("if (!aaaaaaaaaa( // break\n" 3860 " aaaaa)) {\n" 3861 "}"); 3862 verifyFormat("aaaaaaaaaa(!aaaaaaaaaa( // break\n" 3863 " aaaaa));"); 3864 3865 // Only indent relative to unary operators if the expression is nested. 3866 verifyFormat("*aaa = aaaaaaa( // break\n" 3867 " bbbbbb);"); 3868 } 3869 3870 TEST_F(FormatTest, UnderstandsOverloadedOperators) { 3871 verifyFormat("bool operator<();"); 3872 verifyFormat("bool operator>();"); 3873 verifyFormat("bool operator=();"); 3874 verifyFormat("bool operator==();"); 3875 verifyFormat("bool operator!=();"); 3876 verifyFormat("int operator+();"); 3877 verifyFormat("int operator++();"); 3878 verifyFormat("bool operator();"); 3879 verifyFormat("bool operator()();"); 3880 verifyFormat("bool operator[]();"); 3881 verifyFormat("operator bool();"); 3882 verifyFormat("operator int();"); 3883 verifyFormat("operator void *();"); 3884 verifyFormat("operator SomeType<int>();"); 3885 verifyFormat("operator SomeType<int, int>();"); 3886 verifyFormat("operator SomeType<SomeType<int> >();"); 3887 verifyFormat("void *operator new(std::size_t size);"); 3888 verifyFormat("void *operator new[](std::size_t size);"); 3889 verifyFormat("void operator delete(void *ptr);"); 3890 verifyFormat("void operator delete[](void *ptr);"); 3891 verifyFormat("template <typename AAAAAAA, typename BBBBBBB>\n" 3892 "AAAAAAA operator/(const AAAAAAA &a, BBBBBBB &b);"); 3893 3894 verifyFormat( 3895 "ostream &operator<<(ostream &OutputStream,\n" 3896 " SomeReallyLongType WithSomeReallyLongValue);"); 3897 verifyFormat("bool operator<(const aaaaaaaaaaaaaaaaaaaaa &left,\n" 3898 " const aaaaaaaaaaaaaaaaaaaaa &right) {\n" 3899 " return left.group < right.group;\n" 3900 "}"); 3901 verifyFormat("SomeType &operator=(const SomeType &S);"); 3902 3903 verifyGoogleFormat("operator void*();"); 3904 verifyGoogleFormat("operator SomeType<SomeType<int>>();"); 3905 3906 verifyFormat("using A::operator+;"); 3907 } 3908 3909 TEST_F(FormatTest, UnderstandsNewAndDelete) { 3910 verifyFormat("void f() {\n" 3911 " A *a = new A;\n" 3912 " A *a = new (placement) A;\n" 3913 " delete a;\n" 3914 " delete (A *)a;\n" 3915 "}"); 3916 } 3917 3918 TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) { 3919 verifyFormat("int *f(int *a) {}"); 3920 verifyFormat("int main(int argc, char **argv) {}"); 3921 verifyFormat("Test::Test(int b) : a(b * b) {}"); 3922 verifyIndependentOfContext("f(a, *a);"); 3923 verifyFormat("void g() { f(*a); }"); 3924 verifyIndependentOfContext("int a = b * 10;"); 3925 verifyIndependentOfContext("int a = 10 * b;"); 3926 verifyIndependentOfContext("int a = b * c;"); 3927 verifyIndependentOfContext("int a += b * c;"); 3928 verifyIndependentOfContext("int a -= b * c;"); 3929 verifyIndependentOfContext("int a *= b * c;"); 3930 verifyIndependentOfContext("int a /= b * c;"); 3931 verifyIndependentOfContext("int a = *b;"); 3932 verifyIndependentOfContext("int a = *b * c;"); 3933 verifyIndependentOfContext("int a = b * *c;"); 3934 verifyIndependentOfContext("return 10 * b;"); 3935 verifyIndependentOfContext("return *b * *c;"); 3936 verifyIndependentOfContext("return a & ~b;"); 3937 verifyIndependentOfContext("f(b ? *c : *d);"); 3938 verifyIndependentOfContext("int a = b ? *c : *d;"); 3939 verifyIndependentOfContext("*b = a;"); 3940 verifyIndependentOfContext("a * ~b;"); 3941 verifyIndependentOfContext("a * !b;"); 3942 verifyIndependentOfContext("a * +b;"); 3943 verifyIndependentOfContext("a * -b;"); 3944 verifyIndependentOfContext("a * ++b;"); 3945 verifyIndependentOfContext("a * --b;"); 3946 verifyIndependentOfContext("a[4] * b;"); 3947 verifyIndependentOfContext("a[a * a] = 1;"); 3948 verifyIndependentOfContext("f() * b;"); 3949 verifyIndependentOfContext("a * [self dostuff];"); 3950 verifyIndependentOfContext("int x = a * (a + b);"); 3951 verifyIndependentOfContext("(a *)(a + b);"); 3952 verifyIndependentOfContext("int *pa = (int *)&a;"); 3953 verifyIndependentOfContext("return sizeof(int **);"); 3954 verifyIndependentOfContext("return sizeof(int ******);"); 3955 verifyIndependentOfContext("return (int **&)a;"); 3956 verifyIndependentOfContext("f((*PointerToArray)[10]);"); 3957 verifyFormat("void f(Type (*parameter)[10]) {}"); 3958 verifyGoogleFormat("return sizeof(int**);"); 3959 verifyIndependentOfContext("Type **A = static_cast<Type **>(P);"); 3960 verifyGoogleFormat("Type** A = static_cast<Type**>(P);"); 3961 verifyFormat("auto a = [](int **&, int ***) {};"); 3962 verifyFormat("auto PointerBinding = [](const char *S) {};"); 3963 verifyFormat("typedef typeof(int(int, int)) *MyFunc;"); 3964 3965 verifyIndependentOfContext("InvalidRegions[*R] = 0;"); 3966 3967 verifyIndependentOfContext("A<int *> a;"); 3968 verifyIndependentOfContext("A<int **> a;"); 3969 verifyIndependentOfContext("A<int *, int *> a;"); 3970 verifyIndependentOfContext( 3971 "const char *const p = reinterpret_cast<const char *const>(q);"); 3972 verifyIndependentOfContext("A<int **, int **> a;"); 3973 verifyIndependentOfContext("void f(int *a = d * e, int *b = c * d);"); 3974 verifyFormat("for (char **a = b; *a; ++a) {\n}"); 3975 verifyFormat("for (; a && b;) {\n}"); 3976 3977 verifyFormat( 3978 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3979 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3980 3981 verifyGoogleFormat("int main(int argc, char** argv) {}"); 3982 verifyGoogleFormat("A<int*> a;"); 3983 verifyGoogleFormat("A<int**> a;"); 3984 verifyGoogleFormat("A<int*, int*> a;"); 3985 verifyGoogleFormat("A<int**, int**> a;"); 3986 verifyGoogleFormat("f(b ? *c : *d);"); 3987 verifyGoogleFormat("int a = b ? *c : *d;"); 3988 verifyGoogleFormat("Type* t = **x;"); 3989 verifyGoogleFormat("Type* t = *++*x;"); 3990 verifyGoogleFormat("*++*x;"); 3991 verifyGoogleFormat("Type* t = const_cast<T*>(&*x);"); 3992 verifyGoogleFormat("Type* t = x++ * y;"); 3993 verifyGoogleFormat( 3994 "const char* const p = reinterpret_cast<const char* const>(q);"); 3995 3996 verifyIndependentOfContext("a = *(x + y);"); 3997 verifyIndependentOfContext("a = &(x + y);"); 3998 verifyIndependentOfContext("*(x + y).call();"); 3999 verifyIndependentOfContext("&(x + y)->call();"); 4000 verifyFormat("void f() { &(*I).first; }"); 4001 4002 verifyIndependentOfContext("f(b * /* confusing comment */ ++c);"); 4003 verifyFormat( 4004 "int *MyValues = {\n" 4005 " *A, // Operator detection might be confused by the '{'\n" 4006 " *BB // Operator detection might be confused by previous comment\n" 4007 "};"); 4008 4009 verifyIndependentOfContext("if (int *a = &b)"); 4010 verifyIndependentOfContext("if (int &a = *b)"); 4011 verifyIndependentOfContext("if (a & b[i])"); 4012 verifyIndependentOfContext("if (a::b::c::d & b[i])"); 4013 verifyIndependentOfContext("if (*b[i])"); 4014 verifyIndependentOfContext("if (int *a = (&b))"); 4015 verifyIndependentOfContext("while (int *a = &b)"); 4016 verifyIndependentOfContext("size = sizeof *a;"); 4017 verifyFormat("void f() {\n" 4018 " for (const int &v : Values) {\n" 4019 " }\n" 4020 "}"); 4021 verifyFormat("for (int i = a * a; i < 10; ++i) {\n}"); 4022 verifyFormat("for (int i = 0; i < a * a; ++i) {\n}"); 4023 verifyGoogleFormat("for (int i = 0; i * 2 < z; i *= 2) {\n}"); 4024 4025 verifyFormat("#define MACRO \\\n" 4026 " int *i = a * b; \\\n" 4027 " void f(a *b);", 4028 getLLVMStyleWithColumns(19)); 4029 4030 verifyIndependentOfContext("A = new SomeType *[Length];"); 4031 verifyIndependentOfContext("A = new SomeType *[Length]();"); 4032 verifyIndependentOfContext("T **t = new T *;"); 4033 verifyIndependentOfContext("T **t = new T *();"); 4034 verifyGoogleFormat("A = new SomeType* [Length]();"); 4035 verifyGoogleFormat("A = new SomeType* [Length];"); 4036 verifyGoogleFormat("T** t = new T*;"); 4037 verifyGoogleFormat("T** t = new T*();"); 4038 4039 FormatStyle PointerLeft = getLLVMStyle(); 4040 PointerLeft.PointerBindsToType = true; 4041 verifyFormat("delete *x;", PointerLeft); 4042 } 4043 4044 TEST_F(FormatTest, UnderstandsAttributes) { 4045 verifyFormat("SomeType s __attribute__((unused)) (InitValue);"); 4046 } 4047 4048 TEST_F(FormatTest, UnderstandsEllipsis) { 4049 verifyFormat("int printf(const char *fmt, ...);"); 4050 verifyFormat("template <class... Ts> void Foo(Ts... ts) { Foo(ts...); }"); 4051 verifyFormat("template <class... Ts> void Foo(Ts *... ts) {}"); 4052 4053 FormatStyle PointersLeft = getLLVMStyle(); 4054 PointersLeft.PointerBindsToType = true; 4055 verifyFormat("template <class... Ts> void Foo(Ts*... ts) {}", PointersLeft); 4056 } 4057 4058 TEST_F(FormatTest, AdaptivelyFormatsPointersAndReferences) { 4059 EXPECT_EQ("int *a;\n" 4060 "int *a;\n" 4061 "int *a;", 4062 format("int *a;\n" 4063 "int* a;\n" 4064 "int *a;", 4065 getGoogleStyle())); 4066 EXPECT_EQ("int* a;\n" 4067 "int* a;\n" 4068 "int* a;", 4069 format("int* a;\n" 4070 "int* a;\n" 4071 "int *a;", 4072 getGoogleStyle())); 4073 EXPECT_EQ("int *a;\n" 4074 "int *a;\n" 4075 "int *a;", 4076 format("int *a;\n" 4077 "int * a;\n" 4078 "int * a;", 4079 getGoogleStyle())); 4080 } 4081 4082 TEST_F(FormatTest, UnderstandsRvalueReferences) { 4083 verifyFormat("int f(int &&a) {}"); 4084 verifyFormat("int f(int a, char &&b) {}"); 4085 verifyFormat("void f() { int &&a = b; }"); 4086 verifyGoogleFormat("int f(int a, char&& b) {}"); 4087 verifyGoogleFormat("void f() { int&& a = b; }"); 4088 4089 verifyIndependentOfContext("A<int &&> a;"); 4090 verifyIndependentOfContext("A<int &&, int &&> a;"); 4091 verifyGoogleFormat("A<int&&> a;"); 4092 verifyGoogleFormat("A<int&&, int&&> a;"); 4093 4094 // Not rvalue references: 4095 verifyFormat("template <bool B, bool C> class A {\n" 4096 " static_assert(B && C, \"Something is wrong\");\n" 4097 "};"); 4098 verifyGoogleFormat("#define IF(a, b, c) if (a && (b == c))"); 4099 verifyGoogleFormat("#define WHILE(a, b, c) while (a && (b == c))"); 4100 } 4101 4102 TEST_F(FormatTest, FormatsBinaryOperatorsPrecedingEquals) { 4103 verifyFormat("void f() {\n" 4104 " x[aaaaaaaaa -\n" 4105 " b] = 23;\n" 4106 "}", 4107 getLLVMStyleWithColumns(15)); 4108 } 4109 4110 TEST_F(FormatTest, FormatsCasts) { 4111 verifyFormat("Type *A = static_cast<Type *>(P);"); 4112 verifyFormat("Type *A = (Type *)P;"); 4113 verifyFormat("Type *A = (vector<Type *, int *>)P;"); 4114 verifyFormat("int a = (int)(2.0f);"); 4115 verifyFormat("int a = (int)2.0f;"); 4116 verifyFormat("x[(int32)y];"); 4117 verifyFormat("x = (int32)y;"); 4118 verifyFormat("#define AA(X) sizeof(((X *)NULL)->a)"); 4119 verifyFormat("int a = (int)*b;"); 4120 verifyFormat("int a = (int)2.0f;"); 4121 verifyFormat("int a = (int)~0;"); 4122 verifyFormat("int a = (int)++a;"); 4123 verifyFormat("int a = (int)sizeof(int);"); 4124 verifyFormat("int a = (int)+2;"); 4125 verifyFormat("my_int a = (my_int)2.0f;"); 4126 verifyFormat("my_int a = (my_int)sizeof(int);"); 4127 verifyFormat("return (my_int)aaa;"); 4128 verifyFormat("#define x ((int)-1)"); 4129 verifyFormat("#define p(q) ((int *)&q)"); 4130 4131 // FIXME: Without type knowledge, this can still fall apart miserably. 4132 verifyFormat("void f() { my_int a = (my_int) * b; }"); 4133 verifyFormat("void f() { return P ? (my_int) * P : (my_int)0; }"); 4134 verifyFormat("my_int a = (my_int) ~0;"); 4135 verifyFormat("my_int a = (my_int)++ a;"); 4136 verifyFormat("my_int a = (my_int) + 2;"); 4137 4138 // Don't break after a cast's 4139 verifyFormat("int aaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 4140 " (aaaaaaaaaaaaaaaaaaaaaaaaaa *)(aaaaaaaaaaaaaaaaaaaaaa +\n" 4141 " bbbbbbbbbbbbbbbbbbbbbb);"); 4142 4143 // These are not casts. 4144 verifyFormat("void f(int *) {}"); 4145 verifyFormat("f(foo)->b;"); 4146 verifyFormat("f(foo).b;"); 4147 verifyFormat("f(foo)(b);"); 4148 verifyFormat("f(foo)[b];"); 4149 verifyFormat("[](foo) { return 4; }(bar);"); 4150 verifyFormat("(*funptr)(foo)[4];"); 4151 verifyFormat("funptrs[4](foo)[4];"); 4152 verifyFormat("void f(int *);"); 4153 verifyFormat("void f(int *) = 0;"); 4154 verifyFormat("void f(SmallVector<int>) {}"); 4155 verifyFormat("void f(SmallVector<int>);"); 4156 verifyFormat("void f(SmallVector<int>) = 0;"); 4157 verifyFormat("void f(int i = (kValue) * kMask) {}"); 4158 verifyFormat("void f(int i = (kA * kB) & kMask) {}"); 4159 verifyFormat("int a = sizeof(int) * b;"); 4160 verifyFormat("int a = alignof(int) * b;", getGoogleStyle()); 4161 verifyFormat("template <> void f<int>(int i) SOME_ANNOTATION;"); 4162 verifyFormat("f(\"%\" SOME_MACRO(ll) \"d\");"); 4163 verifyFormat("aaaaa &operator=(const aaaaa &) LLVM_DELETED_FUNCTION;"); 4164 4165 // These are not casts, but at some point were confused with casts. 4166 verifyFormat("virtual void foo(int *) override;"); 4167 verifyFormat("virtual void foo(char &) const;"); 4168 verifyFormat("virtual void foo(int *a, char *) const;"); 4169 verifyFormat("int a = sizeof(int *) + b;"); 4170 verifyFormat("int a = alignof(int *) + b;", getGoogleStyle()); 4171 4172 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *foo = (aaaaaaaaaaaaaaaaa *)\n" 4173 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 4174 // FIXME: The indentation here is not ideal. 4175 verifyFormat( 4176 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4177 " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (*cccccccccccccccc)\n" 4178 " [dddddddddddddddddddddddddddddddddddddddddddddddddddddddd];"); 4179 } 4180 4181 TEST_F(FormatTest, FormatsFunctionTypes) { 4182 verifyFormat("A<bool()> a;"); 4183 verifyFormat("A<SomeType()> a;"); 4184 verifyFormat("A<void (*)(int, std::string)> a;"); 4185 verifyFormat("A<void *(int)>;"); 4186 verifyFormat("void *(*a)(int *, SomeType *);"); 4187 verifyFormat("int (*func)(void *);"); 4188 verifyFormat("void f() { int (*func)(void *); }"); 4189 verifyFormat("template <class CallbackClass>\n" 4190 "using MyCallback = void (CallbackClass::*)(SomeObject *Data);"); 4191 4192 verifyGoogleFormat("A<void*(int*, SomeType*)>;"); 4193 verifyGoogleFormat("void* (*a)(int);"); 4194 verifyGoogleFormat( 4195 "template <class CallbackClass>\n" 4196 "using MyCallback = void (CallbackClass::*)(SomeObject* Data);"); 4197 4198 // Other constructs can look somewhat like function types: 4199 verifyFormat("A<sizeof(*x)> a;"); 4200 verifyFormat("#define DEREF_AND_CALL_F(x) f(*x)"); 4201 verifyFormat("some_var = function(*some_pointer_var)[0];"); 4202 verifyFormat("void f() { function(*some_pointer_var)[0] = 10; }"); 4203 } 4204 4205 TEST_F(FormatTest, BreaksLongDeclarations) { 4206 verifyFormat("typedef LoooooooooooooooooooooooooooooooooooooooongType\n" 4207 " AnotherNameForTheLongType;", 4208 getGoogleStyle()); 4209 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType\n" 4210 " LoooooooooooooooooooooooooooooooooooooooongVariable;", 4211 getGoogleStyle()); 4212 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType const\n" 4213 " LoooooooooooooooooooooooooooooooooooooooongVariable;", 4214 getGoogleStyle()); 4215 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" 4216 " LoooooooooooooooooooooooooooooooongFunctionDeclaration();", 4217 getGoogleStyle()); 4218 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" 4219 "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); 4220 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType const\n" 4221 "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); 4222 4223 // FIXME: Without the comment, this breaks after "(". 4224 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType // break\n" 4225 " (*LoooooooooooooooooooooooooooongFunctionTypeVarialbe)();", 4226 getGoogleStyle()); 4227 4228 verifyFormat("int *someFunction(int LoooooooooooooooooooongParam1,\n" 4229 " int LoooooooooooooooooooongParam2) {}"); 4230 verifyFormat( 4231 "TypeSpecDecl *TypeSpecDecl::Create(ASTContext &C, DeclContext *DC,\n" 4232 " SourceLocation L, IdentifierIn *II,\n" 4233 " Type *T) {}"); 4234 verifyFormat("ReallyLongReturnType<TemplateParam1, TemplateParam2>\n" 4235 "ReallyReallyLongFunctionName(\n" 4236 " const std::string &SomeParameter,\n" 4237 " const SomeType<string, SomeOtherTemplateParameter> &\n" 4238 " ReallyReallyLongParameterName,\n" 4239 " const SomeType<string, SomeOtherTemplateParameter> &\n" 4240 " AnotherLongParameterName) {}"); 4241 verifyFormat("template <typename A>\n" 4242 "SomeLoooooooooooooooooooooongType<\n" 4243 " typename some_namespace::SomeOtherType<A>::Type>\n" 4244 "Function() {}"); 4245 4246 verifyGoogleFormat( 4247 "aaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaa<aaaaaaaaaaaaa, aaaaaaaaaaaa>\n" 4248 " aaaaaaaaaaaaaaaaaaaaaaa;"); 4249 verifyGoogleFormat( 4250 "TypeSpecDecl* TypeSpecDecl::Create(ASTContext& C, DeclContext* DC,\n" 4251 " SourceLocation L) {}"); 4252 verifyGoogleFormat( 4253 "some_namespace::LongReturnType\n" 4254 "long_namespace::SomeVeryLongClass::SomeVeryLongFunction(\n" 4255 " int first_long_parameter, int second_parameter) {}"); 4256 4257 verifyGoogleFormat("template <typename T>\n" 4258 "aaaaaaaa::aaaaa::aaaaaa<T, aaaaaaaaaaaaaaaaaaaaaaaaa>\n" 4259 "aaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaa() {}"); 4260 verifyGoogleFormat("A<A<A>> aaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 4261 " int aaaaaaaaaaaaaaaaaaaaaaa);"); 4262 } 4263 4264 TEST_F(FormatTest, FormatsArrays) { 4265 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa[aaaaaaaaaaaaaaaaaaaaaaaaa]\n" 4266 " [bbbbbbbbbbbbbbbbbbbbbbbbb] = c;"); 4267 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4268 " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;"); 4269 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4270 " [a][bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = cccccccc;"); 4271 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4272 " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n" 4273 " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;"); 4274 verifyFormat( 4275 "llvm::outs() << \"aaaaaaaaaaaa: \"\n" 4276 " << (*aaaaaaaiaaaaaaa)[aaaaaaaaaaaaaaaaaaaaaaaaa]\n" 4277 " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa];"); 4278 } 4279 4280 TEST_F(FormatTest, LineStartsWithSpecialCharacter) { 4281 verifyFormat("(a)->b();"); 4282 verifyFormat("--a;"); 4283 } 4284 4285 TEST_F(FormatTest, HandlesIncludeDirectives) { 4286 verifyFormat("#include <string>\n" 4287 "#include <a/b/c.h>\n" 4288 "#include \"a/b/string\"\n" 4289 "#include \"string.h\"\n" 4290 "#include \"string.h\"\n" 4291 "#include <a-a>\n" 4292 "#include < path with space >\n" 4293 "#include \"abc.h\" // this is included for ABC\n" 4294 "#include \"some long include\" // with a comment\n" 4295 "#include \"some very long include paaaaaaaaaaaaaaaaaaaaaaath\"", 4296 getLLVMStyleWithColumns(35)); 4297 4298 verifyFormat("#import <string>"); 4299 verifyFormat("#import <a/b/c.h>"); 4300 verifyFormat("#import \"a/b/string\""); 4301 verifyFormat("#import \"string.h\""); 4302 verifyFormat("#import \"string.h\""); 4303 verifyFormat("#if __has_include(<strstream>)\n" 4304 "#include <strstream>\n" 4305 "#endif"); 4306 } 4307 4308 //===----------------------------------------------------------------------===// 4309 // Error recovery tests. 4310 //===----------------------------------------------------------------------===// 4311 4312 TEST_F(FormatTest, IncompleteParameterLists) { 4313 FormatStyle NoBinPacking = getLLVMStyle(); 4314 NoBinPacking.BinPackParameters = false; 4315 verifyFormat("void aaaaaaaaaaaaaaaaaa(int level,\n" 4316 " double *min_x,\n" 4317 " double *max_x,\n" 4318 " double *min_y,\n" 4319 " double *max_y,\n" 4320 " double *min_z,\n" 4321 " double *max_z, ) {}", 4322 NoBinPacking); 4323 } 4324 4325 TEST_F(FormatTest, IncorrectCodeTrailingStuff) { 4326 verifyFormat("void f() { return; }\n42"); 4327 verifyFormat("void f() {\n" 4328 " if (0)\n" 4329 " return;\n" 4330 "}\n" 4331 "42"); 4332 verifyFormat("void f() { return }\n42"); 4333 verifyFormat("void f() {\n" 4334 " if (0)\n" 4335 " return\n" 4336 "}\n" 4337 "42"); 4338 } 4339 4340 TEST_F(FormatTest, IncorrectCodeMissingSemicolon) { 4341 EXPECT_EQ("void f() { return }", format("void f ( ) { return }")); 4342 EXPECT_EQ("void f() {\n" 4343 " if (a)\n" 4344 " return\n" 4345 "}", 4346 format("void f ( ) { if ( a ) return }")); 4347 EXPECT_EQ("namespace N {\n" 4348 "void f()\n" 4349 "}", 4350 format("namespace N { void f() }")); 4351 EXPECT_EQ("namespace N {\n" 4352 "void f() {}\n" 4353 "void g()\n" 4354 "}", 4355 format("namespace N { void f( ) { } void g( ) }")); 4356 } 4357 4358 TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) { 4359 verifyFormat("int aaaaaaaa =\n" 4360 " // Overlylongcomment\n" 4361 " b;", 4362 getLLVMStyleWithColumns(20)); 4363 verifyFormat("function(\n" 4364 " ShortArgument,\n" 4365 " LoooooooooooongArgument);\n", 4366 getLLVMStyleWithColumns(20)); 4367 } 4368 4369 TEST_F(FormatTest, IncorrectAccessSpecifier) { 4370 verifyFormat("public:"); 4371 verifyFormat("class A {\n" 4372 "public\n" 4373 " void f() {}\n" 4374 "};"); 4375 verifyFormat("public\n" 4376 "int qwerty;"); 4377 verifyFormat("public\n" 4378 "B {}"); 4379 verifyFormat("public\n" 4380 "{}"); 4381 verifyFormat("public\n" 4382 "B { int x; }"); 4383 } 4384 4385 TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) { 4386 verifyFormat("{"); 4387 verifyFormat("#})"); 4388 } 4389 4390 TEST_F(FormatTest, IncorrectCodeDoNoWhile) { 4391 verifyFormat("do {\n}"); 4392 verifyFormat("do {\n}\n" 4393 "f();"); 4394 verifyFormat("do {\n}\n" 4395 "wheeee(fun);"); 4396 verifyFormat("do {\n" 4397 " f();\n" 4398 "}"); 4399 } 4400 4401 TEST_F(FormatTest, IncorrectCodeMissingParens) { 4402 verifyFormat("if {\n foo;\n foo();\n}"); 4403 verifyFormat("switch {\n foo;\n foo();\n}"); 4404 verifyFormat("for {\n foo;\n foo();\n}"); 4405 verifyFormat("while {\n foo;\n foo();\n}"); 4406 verifyFormat("do {\n foo;\n foo();\n} while;"); 4407 } 4408 4409 TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) { 4410 verifyFormat("namespace {\n" 4411 "class Foo { Foo (\n" 4412 "};\n" 4413 "} // comment"); 4414 } 4415 4416 TEST_F(FormatTest, IncorrectCodeErrorDetection) { 4417 EXPECT_EQ("{\n {}\n", format("{\n{\n}\n")); 4418 EXPECT_EQ("{\n {}\n", format("{\n {\n}\n")); 4419 EXPECT_EQ("{\n {}\n", format("{\n {\n }\n")); 4420 EXPECT_EQ("{\n {}\n}\n}\n", format("{\n {\n }\n }\n}\n")); 4421 4422 EXPECT_EQ("{\n" 4423 " {\n" 4424 " breakme(\n" 4425 " qwe);\n" 4426 " }\n", 4427 format("{\n" 4428 " {\n" 4429 " breakme(qwe);\n" 4430 "}\n", 4431 getLLVMStyleWithColumns(10))); 4432 } 4433 4434 TEST_F(FormatTest, LayoutCallsInsideBraceInitializers) { 4435 verifyFormat("int x = {\n" 4436 " avariable,\n" 4437 " b(alongervariable)\n" 4438 "};", 4439 getLLVMStyleWithColumns(25)); 4440 } 4441 4442 TEST_F(FormatTest, LayoutBraceInitializersInReturnStatement) { 4443 verifyFormat("return (a)(b) { 1, 2, 3 };"); 4444 } 4445 4446 TEST_F(FormatTest, LayoutCxx11ConstructorBraceInitializers) { 4447 verifyFormat("vector<int> x{ 1, 2, 3, 4 };"); 4448 verifyFormat("vector<T> x{ {}, {}, {}, {} };"); 4449 verifyFormat("f({ 1, 2 });"); 4450 verifyFormat("auto v = Foo{ 1 };"); 4451 verifyFormat("f({ 1, 2 }, { { 2, 3 }, { 4, 5 } }, c, { d });"); 4452 verifyFormat("Class::Class : member{ 1, 2, 3 } {}"); 4453 verifyFormat("new vector<int>{ 1, 2, 3 };"); 4454 verifyFormat("new int[3]{ 1, 2, 3 };"); 4455 verifyFormat("return { arg1, arg2 };"); 4456 verifyFormat("return { arg1, SomeType{ parameter } };"); 4457 verifyFormat("new T{ arg1, arg2 };"); 4458 verifyFormat("f(MyMap[{ composite, key }]);"); 4459 verifyFormat("class Class {\n" 4460 " T member = { arg1, arg2 };\n" 4461 "};"); 4462 verifyFormat( 4463 "foo = aaaaaaaaaaa ? vector<int>{ aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 4464 " aaaaaaaaaaaaaaaaaaaa, aaaaa }\n" 4465 " : vector<int>{ bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 4466 " bbbbbbbbbbbbbbbbbbbb, bbbbb };"); 4467 verifyFormat("DoSomethingWithVector({} /* No data */);"); 4468 verifyFormat("DoSomethingWithVector({ {} /* No data */ }, { { 1, 2 } });"); 4469 verifyFormat( 4470 "someFunction(OtherParam, BracedList{\n" 4471 " // comment 1 (Forcing interesting break)\n" 4472 " param1, param2,\n" 4473 " // comment 2\n" 4474 " param3, param4\n" 4475 " });"); 4476 verifyFormat( 4477 "std::this_thread::sleep_for(\n" 4478 " std::chrono::nanoseconds{ std::chrono::seconds{ 1 } } / 5);"); 4479 4480 FormatStyle NoSpaces = getLLVMStyle(); 4481 NoSpaces.Cpp11BracedListStyle = true; 4482 verifyFormat("vector<int> x{1, 2, 3, 4};", NoSpaces); 4483 verifyFormat("vector<T> x{{}, {}, {}, {}};", NoSpaces); 4484 verifyFormat("f({1, 2});", NoSpaces); 4485 verifyFormat("auto v = Foo{-1};", NoSpaces); 4486 verifyFormat("f({1, 2}, {{2, 3}, {4, 5}}, c, {d});", NoSpaces); 4487 verifyFormat("Class::Class : member{1, 2, 3} {}", NoSpaces); 4488 verifyFormat("new vector<int>{1, 2, 3};", NoSpaces); 4489 verifyFormat("new int[3]{1, 2, 3};", NoSpaces); 4490 verifyFormat("return {arg1, arg2};", NoSpaces); 4491 verifyFormat("return {arg1, SomeType{parameter}};", NoSpaces); 4492 verifyFormat("new T{arg1, arg2};", NoSpaces); 4493 verifyFormat("f(MyMap[{composite, key}]);", NoSpaces); 4494 verifyFormat("class Class {\n" 4495 " T member = {arg1, arg2};\n" 4496 "};", 4497 NoSpaces); 4498 } 4499 4500 TEST_F(FormatTest, FormatsBracedListsInColumnLayout) { 4501 verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4502 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4503 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4504 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4505 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4506 " 1, 22, 333, 4444, 55555, 666666, 7777777 };"); 4507 verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4508 " // line comment\n" 4509 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4510 " 1, 22, 333, 4444, 55555,\n" 4511 " // line comment\n" 4512 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4513 " 1, 22, 333, 4444, 55555, 666666, 7777777 };"); 4514 verifyFormat( 4515 "vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4516 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4517 " 1, 22, 333, 4444, 55555, 666666, // comment\n" 4518 " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" 4519 " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" 4520 " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" 4521 " 7777777 };"); 4522 verifyFormat("static const uint16_t CallerSavedRegs64Bittttt[] = {\n" 4523 " X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,\n" 4524 " X86::R8, X86::R9, X86::R10, X86::R11, 0\n" 4525 "};"); 4526 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4527 " 1, 1, 1, 1 };", 4528 getLLVMStyleWithColumns(39)); 4529 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4530 " 1, 1, 1, 1 };", 4531 getLLVMStyleWithColumns(38)); 4532 verifyFormat("vector<int> aaaaaaaaaaaaaaaaaaaaaa = {\n" 4533 " 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1\n" 4534 "};", 4535 getLLVMStyleWithColumns(40)); 4536 4537 // Trailing commas. 4538 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4539 " 1, 1, 1, 1, };", 4540 getLLVMStyleWithColumns(39)); 4541 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4542 " 1, 1, 1, 1, //\n" 4543 "};", 4544 getLLVMStyleWithColumns(39)); 4545 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4546 " 1, 1, 1, 1,\n" 4547 " /**/ /**/ };", 4548 getLLVMStyleWithColumns(39)); 4549 verifyFormat("return { { aaaaaaaaaaaaaaaaaaaaa },\n" 4550 " { aaaaaaaaaaaaaaaaaaa },\n" 4551 " { aaaaaaaaaaaaaaaaaaaaa },\n" 4552 " { aaaaaaaaaaaaaaaaa } };", 4553 getLLVMStyleWithColumns(60)); 4554 } 4555 4556 TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) { 4557 verifyFormat("void f() { return 42; }"); 4558 verifyFormat("void f() {\n" 4559 " // Comment\n" 4560 "}"); 4561 verifyFormat("{\n" 4562 "#error {\n" 4563 " int a;\n" 4564 "}"); 4565 verifyFormat("{\n" 4566 " int a;\n" 4567 "#error {\n" 4568 "}"); 4569 verifyFormat("void f() {} // comment"); 4570 verifyFormat("void f() { int a; } // comment"); 4571 verifyFormat("void f() {\n" 4572 "} // comment", 4573 getLLVMStyleWithColumns(15)); 4574 4575 verifyFormat("void f() { return 42; }", getLLVMStyleWithColumns(23)); 4576 verifyFormat("void f() {\n return 42;\n}", getLLVMStyleWithColumns(22)); 4577 4578 verifyFormat("void f() {}", getLLVMStyleWithColumns(11)); 4579 verifyFormat("void f() {\n}", getLLVMStyleWithColumns(10)); 4580 } 4581 4582 TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) { 4583 // Elaborate type variable declarations. 4584 verifyFormat("struct foo a = { bar };\nint n;"); 4585 verifyFormat("class foo a = { bar };\nint n;"); 4586 verifyFormat("union foo a = { bar };\nint n;"); 4587 4588 // Elaborate types inside function definitions. 4589 verifyFormat("struct foo f() {}\nint n;"); 4590 verifyFormat("class foo f() {}\nint n;"); 4591 verifyFormat("union foo f() {}\nint n;"); 4592 4593 // Templates. 4594 verifyFormat("template <class X> void f() {}\nint n;"); 4595 verifyFormat("template <struct X> void f() {}\nint n;"); 4596 verifyFormat("template <union X> void f() {}\nint n;"); 4597 4598 // Actual definitions... 4599 verifyFormat("struct {\n} n;"); 4600 verifyFormat( 4601 "template <template <class T, class Y>, class Z> class X {\n} n;"); 4602 verifyFormat("union Z {\n int n;\n} x;"); 4603 verifyFormat("class MACRO Z {\n} n;"); 4604 verifyFormat("class MACRO(X) Z {\n} n;"); 4605 verifyFormat("class __attribute__(X) Z {\n} n;"); 4606 verifyFormat("class __declspec(X) Z {\n} n;"); 4607 verifyFormat("class A##B##C {\n} n;"); 4608 verifyFormat("class alignas(16) Z {\n} n;"); 4609 4610 // Redefinition from nested context: 4611 verifyFormat("class A::B::C {\n} n;"); 4612 4613 // Template definitions. 4614 verifyFormat( 4615 "template <typename F>\n" 4616 "Matcher(const Matcher<F> &Other,\n" 4617 " typename enable_if_c<is_base_of<F, T>::value &&\n" 4618 " !is_same<F, T>::value>::type * = 0)\n" 4619 " : Implementation(new ImplicitCastMatcher<F>(Other)) {}"); 4620 4621 // FIXME: This is still incorrectly handled at the formatter side. 4622 verifyFormat("template <> struct X < 15, i<3 && 42 < 50 && 33 < 28> {};"); 4623 4624 // FIXME: 4625 // This now gets parsed incorrectly as class definition. 4626 // verifyFormat("class A<int> f() {\n}\nint n;"); 4627 4628 // Elaborate types where incorrectly parsing the structural element would 4629 // break the indent. 4630 verifyFormat("if (true)\n" 4631 " class X x;\n" 4632 "else\n" 4633 " f();\n"); 4634 4635 // This is simply incomplete. Formatting is not important, but must not crash. 4636 verifyFormat("class A:"); 4637 } 4638 4639 TEST_F(FormatTest, DoNotInterfereWithErrorAndWarning) { 4640 EXPECT_EQ("#error Leave all white!!!!! space* alone!\n", 4641 format("#error Leave all white!!!!! space* alone!\n")); 4642 EXPECT_EQ( 4643 "#warning Leave all white!!!!! space* alone!\n", 4644 format("#warning Leave all white!!!!! space* alone!\n")); 4645 EXPECT_EQ("#error 1", format(" # error 1")); 4646 EXPECT_EQ("#warning 1", format(" # warning 1")); 4647 } 4648 4649 TEST_F(FormatTest, FormatHashIfExpressions) { 4650 // FIXME: Come up with a better indentation for #elif. 4651 verifyFormat( 4652 "#if !defined(AAAAAAA) && (defined CCCCCC || defined DDDDDD) && \\\n" 4653 " defined(BBBBBBBB)\n" 4654 "#elif !defined(AAAAAA) && (defined CCCCC || defined DDDDDD) && \\\n" 4655 " defined(BBBBBBBB)\n" 4656 "#endif", 4657 getLLVMStyleWithColumns(65)); 4658 } 4659 4660 TEST_F(FormatTest, MergeHandlingInTheFaceOfPreprocessorDirectives) { 4661 FormatStyle AllowsMergedIf = getGoogleStyle(); 4662 AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; 4663 verifyFormat("void f() { f(); }\n#error E", AllowsMergedIf); 4664 verifyFormat("if (true) return 42;\n#error E", AllowsMergedIf); 4665 verifyFormat("if (true)\n#error E\n return 42;", AllowsMergedIf); 4666 EXPECT_EQ("if (true) return 42;", 4667 format("if (true)\nreturn 42;", AllowsMergedIf)); 4668 FormatStyle ShortMergedIf = AllowsMergedIf; 4669 ShortMergedIf.ColumnLimit = 25; 4670 verifyFormat("#define A \\\n" 4671 " if (true) return 42;", 4672 ShortMergedIf); 4673 verifyFormat("#define A \\\n" 4674 " f(); \\\n" 4675 " if (true)\n" 4676 "#define B", 4677 ShortMergedIf); 4678 verifyFormat("#define A \\\n" 4679 " f(); \\\n" 4680 " if (true)\n" 4681 "g();", 4682 ShortMergedIf); 4683 verifyFormat("{\n" 4684 "#ifdef A\n" 4685 " // Comment\n" 4686 " if (true) continue;\n" 4687 "#endif\n" 4688 " // Comment\n" 4689 " if (true) continue;\n" 4690 "}", 4691 ShortMergedIf); 4692 } 4693 4694 TEST_F(FormatTest, BlockCommentsInControlLoops) { 4695 verifyFormat("if (0) /* a comment in a strange place */ {\n" 4696 " f();\n" 4697 "}"); 4698 verifyFormat("if (0) /* a comment in a strange place */ {\n" 4699 " f();\n" 4700 "} /* another comment */ else /* comment #3 */ {\n" 4701 " g();\n" 4702 "}"); 4703 verifyFormat("while (0) /* a comment in a strange place */ {\n" 4704 " f();\n" 4705 "}"); 4706 verifyFormat("for (;;) /* a comment in a strange place */ {\n" 4707 " f();\n" 4708 "}"); 4709 verifyFormat("do /* a comment in a strange place */ {\n" 4710 " f();\n" 4711 "} /* another comment */ while (0);"); 4712 } 4713 4714 TEST_F(FormatTest, BlockComments) { 4715 EXPECT_EQ("/* */ /* */ /* */\n/* */ /* */ /* */", 4716 format("/* *//* */ /* */\n/* *//* */ /* */")); 4717 EXPECT_EQ("/* */ a /* */ b;", format(" /* */ a/* */ b;")); 4718 EXPECT_EQ("#define A /*123*/ \\\n" 4719 " b\n" 4720 "/* */\n" 4721 "someCall(\n" 4722 " parameter);", 4723 format("#define A /*123*/ b\n" 4724 "/* */\n" 4725 "someCall(parameter);", 4726 getLLVMStyleWithColumns(15))); 4727 4728 EXPECT_EQ("#define A\n" 4729 "/* */ someCall(\n" 4730 " parameter);", 4731 format("#define A\n" 4732 "/* */someCall(parameter);", 4733 getLLVMStyleWithColumns(15))); 4734 EXPECT_EQ("/*\n**\n*/", format("/*\n**\n*/")); 4735 EXPECT_EQ("/*\n" 4736 "*\n" 4737 " * aaaaaa\n" 4738 "*aaaaaa\n" 4739 "*/", 4740 format("/*\n" 4741 "*\n" 4742 " * aaaaaa aaaaaa\n" 4743 "*/", 4744 getLLVMStyleWithColumns(10))); 4745 EXPECT_EQ("/*\n" 4746 "**\n" 4747 "* aaaaaa\n" 4748 "*aaaaaa\n" 4749 "*/", 4750 format("/*\n" 4751 "**\n" 4752 "* aaaaaa aaaaaa\n" 4753 "*/", 4754 getLLVMStyleWithColumns(10))); 4755 4756 FormatStyle NoBinPacking = getLLVMStyle(); 4757 NoBinPacking.BinPackParameters = false; 4758 EXPECT_EQ("someFunction(1, /* comment 1 */\n" 4759 " 2, /* comment 2 */\n" 4760 " 3, /* comment 3 */\n" 4761 " aaaa,\n" 4762 " bbbb);", 4763 format("someFunction (1, /* comment 1 */\n" 4764 " 2, /* comment 2 */ \n" 4765 " 3, /* comment 3 */\n" 4766 "aaaa, bbbb );", 4767 NoBinPacking)); 4768 verifyFormat( 4769 "bool aaaaaaaaaaaaa = /* comment: */ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 4770 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 4771 EXPECT_EQ( 4772 "bool aaaaaaaaaaaaa = /* trailing comment */\n" 4773 " aaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 4774 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;", 4775 format( 4776 "bool aaaaaaaaaaaaa = /* trailing comment */\n" 4777 " aaaaaaaaaaaaaaaaaaaaaaaaaaa||aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 4778 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;")); 4779 EXPECT_EQ( 4780 "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" 4781 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" 4782 "int cccccccccccccccccccccccccccccc; /* comment */\n", 4783 format("int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" 4784 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" 4785 "int cccccccccccccccccccccccccccccc; /* comment */\n")); 4786 4787 verifyFormat("void f(int * /* unused */) {}"); 4788 4789 EXPECT_EQ("/*\n" 4790 " **\n" 4791 " */", 4792 format("/*\n" 4793 " **\n" 4794 " */")); 4795 EXPECT_EQ("/*\n" 4796 " *q\n" 4797 " */", 4798 format("/*\n" 4799 " *q\n" 4800 " */")); 4801 EXPECT_EQ("/*\n" 4802 " * q\n" 4803 " */", 4804 format("/*\n" 4805 " * q\n" 4806 " */")); 4807 EXPECT_EQ("/*\n" 4808 " **/", 4809 format("/*\n" 4810 " **/")); 4811 EXPECT_EQ("/*\n" 4812 " ***/", 4813 format("/*\n" 4814 " ***/")); 4815 } 4816 4817 TEST_F(FormatTest, BlockCommentsInMacros) { 4818 EXPECT_EQ("#define A \\\n" 4819 " { \\\n" 4820 " /* one line */ \\\n" 4821 " someCall();", 4822 format("#define A { \\\n" 4823 " /* one line */ \\\n" 4824 " someCall();", 4825 getLLVMStyleWithColumns(20))); 4826 EXPECT_EQ("#define A \\\n" 4827 " { \\\n" 4828 " /* previous */ \\\n" 4829 " /* one line */ \\\n" 4830 " someCall();", 4831 format("#define A { \\\n" 4832 " /* previous */ \\\n" 4833 " /* one line */ \\\n" 4834 " someCall();", 4835 getLLVMStyleWithColumns(20))); 4836 } 4837 4838 TEST_F(FormatTest, BlockCommentsAtEndOfLine) { 4839 EXPECT_EQ("a = {\n" 4840 " 1111 /* */\n" 4841 "};", 4842 format("a = {1111 /* */\n" 4843 "};", 4844 getLLVMStyleWithColumns(15))); 4845 EXPECT_EQ("a = {\n" 4846 " 1111 /* */\n" 4847 "};", 4848 format("a = {1111 /* */\n" 4849 "};", 4850 getLLVMStyleWithColumns(15))); 4851 4852 // FIXME: The formatting is still wrong here. 4853 EXPECT_EQ("a = {\n" 4854 " 1111 /* a\n" 4855 " */\n" 4856 "};", 4857 format("a = {1111 /* a */\n" 4858 "};", 4859 getLLVMStyleWithColumns(15))); 4860 } 4861 4862 TEST_F(FormatTest, IndentLineCommentsInStartOfBlockAtEndOfFile) { 4863 // FIXME: This is not what we want... 4864 verifyFormat("{\n" 4865 "// a" 4866 "// b"); 4867 } 4868 4869 TEST_F(FormatTest, FormatStarDependingOnContext) { 4870 verifyFormat("void f(int *a);"); 4871 verifyFormat("void f() { f(fint * b); }"); 4872 verifyFormat("class A {\n void f(int *a);\n};"); 4873 verifyFormat("class A {\n int *a;\n};"); 4874 verifyFormat("namespace a {\n" 4875 "namespace b {\n" 4876 "class A {\n" 4877 " void f() {}\n" 4878 " int *a;\n" 4879 "};\n" 4880 "}\n" 4881 "}"); 4882 } 4883 4884 TEST_F(FormatTest, SpecialTokensAtEndOfLine) { 4885 verifyFormat("while"); 4886 verifyFormat("operator"); 4887 } 4888 4889 //===----------------------------------------------------------------------===// 4890 // Objective-C tests. 4891 //===----------------------------------------------------------------------===// 4892 4893 TEST_F(FormatTest, FormatForObjectiveCMethodDecls) { 4894 verifyFormat("- (void)sendAction:(SEL)aSelector to:(BOOL)anObject;"); 4895 EXPECT_EQ("- (NSUInteger)indexOfObject:(id)anObject;", 4896 format("-(NSUInteger)indexOfObject:(id)anObject;")); 4897 EXPECT_EQ("- (NSInteger)Mthod1;", format("-(NSInteger)Mthod1;")); 4898 EXPECT_EQ("+ (id)Mthod2;", format("+(id)Mthod2;")); 4899 EXPECT_EQ("- (NSInteger)Method3:(id)anObject;", 4900 format("-(NSInteger)Method3:(id)anObject;")); 4901 EXPECT_EQ("- (NSInteger)Method4:(id)anObject;", 4902 format("-(NSInteger)Method4:(id)anObject;")); 4903 EXPECT_EQ("- (NSInteger)Method5:(id)anObject:(id)AnotherObject;", 4904 format("-(NSInteger)Method5:(id)anObject:(id)AnotherObject;")); 4905 EXPECT_EQ("- (id)Method6:(id)A:(id)B:(id)C:(id)D;", 4906 format("- (id)Method6:(id)A:(id)B:(id)C:(id)D;")); 4907 EXPECT_EQ( 4908 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;", 4909 format( 4910 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;")); 4911 4912 // Very long objectiveC method declaration. 4913 verifyFormat("- (NSUInteger)indexOfObject:(id)anObject\n" 4914 " inRange:(NSRange)range\n" 4915 " outRange:(NSRange)out_range\n" 4916 " outRange1:(NSRange)out_range1\n" 4917 " outRange2:(NSRange)out_range2\n" 4918 " outRange3:(NSRange)out_range3\n" 4919 " outRange4:(NSRange)out_range4\n" 4920 " outRange5:(NSRange)out_range5\n" 4921 " outRange6:(NSRange)out_range6\n" 4922 " outRange7:(NSRange)out_range7\n" 4923 " outRange8:(NSRange)out_range8\n" 4924 " outRange9:(NSRange)out_range9;"); 4925 4926 verifyFormat("- (int)sum:(vector<int>)numbers;"); 4927 verifyGoogleFormat("- (void)setDelegate:(id<Protocol>)delegate;"); 4928 // FIXME: In LLVM style, there should be a space in front of a '<' for ObjC 4929 // protocol lists (but not for template classes): 4930 //verifyFormat("- (void)setDelegate:(id <Protocol>)delegate;"); 4931 4932 verifyFormat("- (int (*)())foo:(int (*)())f;"); 4933 verifyGoogleFormat("- (int (*)())foo:(int (*)())foo;"); 4934 4935 // If there's no return type (very rare in practice!), LLVM and Google style 4936 // agree. 4937 verifyFormat("- foo;"); 4938 verifyFormat("- foo:(int)f;"); 4939 verifyGoogleFormat("- foo:(int)foo;"); 4940 } 4941 4942 TEST_F(FormatTest, FormatObjCBlocks) { 4943 verifyFormat("int (^Block)(int, int);"); 4944 verifyFormat("int (^Block1)(int, int) = ^(int i, int j)"); 4945 } 4946 4947 TEST_F(FormatTest, FormatObjCInterface) { 4948 verifyFormat("@interface Foo : NSObject <NSSomeDelegate> {\n" 4949 "@public\n" 4950 " int field1;\n" 4951 "@protected\n" 4952 " int field2;\n" 4953 "@private\n" 4954 " int field3;\n" 4955 "@package\n" 4956 " int field4;\n" 4957 "}\n" 4958 "+ (id)init;\n" 4959 "@end"); 4960 4961 verifyGoogleFormat("@interface Foo : NSObject<NSSomeDelegate> {\n" 4962 " @public\n" 4963 " int field1;\n" 4964 " @protected\n" 4965 " int field2;\n" 4966 " @private\n" 4967 " int field3;\n" 4968 " @package\n" 4969 " int field4;\n" 4970 "}\n" 4971 "+ (id)init;\n" 4972 "@end"); 4973 4974 verifyFormat("@interface /* wait for it */ Foo\n" 4975 "+ (id)init;\n" 4976 "// Look, a comment!\n" 4977 "- (int)answerWith:(int)i;\n" 4978 "@end"); 4979 4980 verifyFormat("@interface Foo\n" 4981 "@end\n" 4982 "@interface Bar\n" 4983 "@end"); 4984 4985 verifyFormat("@interface Foo : Bar\n" 4986 "+ (id)init;\n" 4987 "@end"); 4988 4989 verifyFormat("@interface Foo : /**/ Bar /**/ <Baz, /**/ Quux>\n" 4990 "+ (id)init;\n" 4991 "@end"); 4992 4993 verifyGoogleFormat("@interface Foo : Bar<Baz, Quux>\n" 4994 "+ (id)init;\n" 4995 "@end"); 4996 4997 verifyFormat("@interface Foo (HackStuff)\n" 4998 "+ (id)init;\n" 4999 "@end"); 5000 5001 verifyFormat("@interface Foo ()\n" 5002 "+ (id)init;\n" 5003 "@end"); 5004 5005 verifyFormat("@interface Foo (HackStuff) <MyProtocol>\n" 5006 "+ (id)init;\n" 5007 "@end"); 5008 5009 verifyGoogleFormat("@interface Foo (HackStuff)<MyProtocol>\n" 5010 "+ (id)init;\n" 5011 "@end"); 5012 5013 verifyFormat("@interface Foo {\n" 5014 " int _i;\n" 5015 "}\n" 5016 "+ (id)init;\n" 5017 "@end"); 5018 5019 verifyFormat("@interface Foo : Bar {\n" 5020 " int _i;\n" 5021 "}\n" 5022 "+ (id)init;\n" 5023 "@end"); 5024 5025 verifyFormat("@interface Foo : Bar <Baz, Quux> {\n" 5026 " int _i;\n" 5027 "}\n" 5028 "+ (id)init;\n" 5029 "@end"); 5030 5031 verifyFormat("@interface Foo (HackStuff) {\n" 5032 " int _i;\n" 5033 "}\n" 5034 "+ (id)init;\n" 5035 "@end"); 5036 5037 verifyFormat("@interface Foo () {\n" 5038 " int _i;\n" 5039 "}\n" 5040 "+ (id)init;\n" 5041 "@end"); 5042 5043 verifyFormat("@interface Foo (HackStuff) <MyProtocol> {\n" 5044 " int _i;\n" 5045 "}\n" 5046 "+ (id)init;\n" 5047 "@end"); 5048 } 5049 5050 TEST_F(FormatTest, FormatObjCImplementation) { 5051 verifyFormat("@implementation Foo : NSObject {\n" 5052 "@public\n" 5053 " int field1;\n" 5054 "@protected\n" 5055 " int field2;\n" 5056 "@private\n" 5057 " int field3;\n" 5058 "@package\n" 5059 " int field4;\n" 5060 "}\n" 5061 "+ (id)init {\n}\n" 5062 "@end"); 5063 5064 verifyGoogleFormat("@implementation Foo : NSObject {\n" 5065 " @public\n" 5066 " int field1;\n" 5067 " @protected\n" 5068 " int field2;\n" 5069 " @private\n" 5070 " int field3;\n" 5071 " @package\n" 5072 " int field4;\n" 5073 "}\n" 5074 "+ (id)init {\n}\n" 5075 "@end"); 5076 5077 verifyFormat("@implementation Foo\n" 5078 "+ (id)init {\n" 5079 " if (true)\n" 5080 " return nil;\n" 5081 "}\n" 5082 "// Look, a comment!\n" 5083 "- (int)answerWith:(int)i {\n" 5084 " return i;\n" 5085 "}\n" 5086 "+ (int)answerWith:(int)i {\n" 5087 " return i;\n" 5088 "}\n" 5089 "@end"); 5090 5091 verifyFormat("@implementation Foo\n" 5092 "@end\n" 5093 "@implementation Bar\n" 5094 "@end"); 5095 5096 verifyFormat("@implementation Foo : Bar\n" 5097 "+ (id)init {\n}\n" 5098 "- (void)foo {\n}\n" 5099 "@end"); 5100 5101 verifyFormat("@implementation Foo {\n" 5102 " int _i;\n" 5103 "}\n" 5104 "+ (id)init {\n}\n" 5105 "@end"); 5106 5107 verifyFormat("@implementation Foo : Bar {\n" 5108 " int _i;\n" 5109 "}\n" 5110 "+ (id)init {\n}\n" 5111 "@end"); 5112 5113 verifyFormat("@implementation Foo (HackStuff)\n" 5114 "+ (id)init {\n}\n" 5115 "@end"); 5116 verifyFormat("@implementation ObjcClass\n" 5117 "- (void)method;\n" 5118 "{}\n" 5119 "@end"); 5120 } 5121 5122 TEST_F(FormatTest, FormatObjCProtocol) { 5123 verifyFormat("@protocol Foo\n" 5124 "@property(weak) id delegate;\n" 5125 "- (NSUInteger)numberOfThings;\n" 5126 "@end"); 5127 5128 verifyFormat("@protocol MyProtocol <NSObject>\n" 5129 "- (NSUInteger)numberOfThings;\n" 5130 "@end"); 5131 5132 verifyGoogleFormat("@protocol MyProtocol<NSObject>\n" 5133 "- (NSUInteger)numberOfThings;\n" 5134 "@end"); 5135 5136 verifyFormat("@protocol Foo;\n" 5137 "@protocol Bar;\n"); 5138 5139 verifyFormat("@protocol Foo\n" 5140 "@end\n" 5141 "@protocol Bar\n" 5142 "@end"); 5143 5144 verifyFormat("@protocol myProtocol\n" 5145 "- (void)mandatoryWithInt:(int)i;\n" 5146 "@optional\n" 5147 "- (void)optional;\n" 5148 "@required\n" 5149 "- (void)required;\n" 5150 "@optional\n" 5151 "@property(assign) int madProp;\n" 5152 "@end\n"); 5153 5154 verifyFormat("@property(nonatomic, assign, readonly)\n" 5155 " int *looooooooooooooooooooooooooooongNumber;\n" 5156 "@property(nonatomic, assign, readonly)\n" 5157 " NSString *looooooooooooooooooooooooooooongName;"); 5158 } 5159 5160 TEST_F(FormatTest, FormatObjCMethodDeclarations) { 5161 verifyFormat("- (void)doSomethingWith:(GTMFoo *)theFoo\n" 5162 " rect:(NSRect)theRect\n" 5163 " interval:(float)theInterval {\n" 5164 "}"); 5165 verifyFormat("- (void)shortf:(GTMFoo *)theFoo\n" 5166 " longKeyword:(NSRect)theRect\n" 5167 " evenLongerKeyword:(float)theInterval\n" 5168 " error:(NSError **)theError {\n" 5169 "}"); 5170 } 5171 5172 TEST_F(FormatTest, FormatObjCMethodExpr) { 5173 verifyFormat("[foo bar:baz];"); 5174 verifyFormat("return [foo bar:baz];"); 5175 verifyFormat("f([foo bar:baz]);"); 5176 verifyFormat("f(2, [foo bar:baz]);"); 5177 verifyFormat("f(2, a ? b : c);"); 5178 verifyFormat("[[self initWithInt:4] bar:[baz quux:arrrr]];"); 5179 5180 // Unary operators. 5181 verifyFormat("int a = +[foo bar:baz];"); 5182 verifyFormat("int a = -[foo bar:baz];"); 5183 verifyFormat("int a = ![foo bar:baz];"); 5184 verifyFormat("int a = ~[foo bar:baz];"); 5185 verifyFormat("int a = ++[foo bar:baz];"); 5186 verifyFormat("int a = --[foo bar:baz];"); 5187 verifyFormat("int a = sizeof [foo bar:baz];"); 5188 verifyFormat("int a = alignof [foo bar:baz];", getGoogleStyle()); 5189 verifyFormat("int a = &[foo bar:baz];"); 5190 verifyFormat("int a = *[foo bar:baz];"); 5191 // FIXME: Make casts work, without breaking f()[4]. 5192 //verifyFormat("int a = (int)[foo bar:baz];"); 5193 //verifyFormat("return (int)[foo bar:baz];"); 5194 //verifyFormat("(void)[foo bar:baz];"); 5195 verifyFormat("return (MyType *)[self.tableView cellForRowAtIndexPath:cell];"); 5196 5197 // Binary operators. 5198 verifyFormat("[foo bar:baz], [foo bar:baz];"); 5199 verifyFormat("[foo bar:baz] = [foo bar:baz];"); 5200 verifyFormat("[foo bar:baz] *= [foo bar:baz];"); 5201 verifyFormat("[foo bar:baz] /= [foo bar:baz];"); 5202 verifyFormat("[foo bar:baz] %= [foo bar:baz];"); 5203 verifyFormat("[foo bar:baz] += [foo bar:baz];"); 5204 verifyFormat("[foo bar:baz] -= [foo bar:baz];"); 5205 verifyFormat("[foo bar:baz] <<= [foo bar:baz];"); 5206 verifyFormat("[foo bar:baz] >>= [foo bar:baz];"); 5207 verifyFormat("[foo bar:baz] &= [foo bar:baz];"); 5208 verifyFormat("[foo bar:baz] ^= [foo bar:baz];"); 5209 verifyFormat("[foo bar:baz] |= [foo bar:baz];"); 5210 verifyFormat("[foo bar:baz] ? [foo bar:baz] : [foo bar:baz];"); 5211 verifyFormat("[foo bar:baz] || [foo bar:baz];"); 5212 verifyFormat("[foo bar:baz] && [foo bar:baz];"); 5213 verifyFormat("[foo bar:baz] | [foo bar:baz];"); 5214 verifyFormat("[foo bar:baz] ^ [foo bar:baz];"); 5215 verifyFormat("[foo bar:baz] & [foo bar:baz];"); 5216 verifyFormat("[foo bar:baz] == [foo bar:baz];"); 5217 verifyFormat("[foo bar:baz] != [foo bar:baz];"); 5218 verifyFormat("[foo bar:baz] >= [foo bar:baz];"); 5219 verifyFormat("[foo bar:baz] <= [foo bar:baz];"); 5220 verifyFormat("[foo bar:baz] > [foo bar:baz];"); 5221 verifyFormat("[foo bar:baz] < [foo bar:baz];"); 5222 verifyFormat("[foo bar:baz] >> [foo bar:baz];"); 5223 verifyFormat("[foo bar:baz] << [foo bar:baz];"); 5224 verifyFormat("[foo bar:baz] - [foo bar:baz];"); 5225 verifyFormat("[foo bar:baz] + [foo bar:baz];"); 5226 verifyFormat("[foo bar:baz] * [foo bar:baz];"); 5227 verifyFormat("[foo bar:baz] / [foo bar:baz];"); 5228 verifyFormat("[foo bar:baz] % [foo bar:baz];"); 5229 // Whew! 5230 5231 verifyFormat("return in[42];"); 5232 verifyFormat("for (id foo in [self getStuffFor:bla]) {\n" 5233 "}"); 5234 5235 verifyFormat("[self stuffWithInt:(4 + 2) float:4.5];"); 5236 verifyFormat("[self stuffWithInt:a ? b : c float:4.5];"); 5237 verifyFormat("[self stuffWithInt:a ? [self foo:bar] : c];"); 5238 verifyFormat("[self stuffWithInt:a ? (e ? f : g) : c];"); 5239 verifyFormat("[cond ? obj1 : obj2 methodWithParam:param]"); 5240 verifyFormat("[button setAction:@selector(zoomOut:)];"); 5241 verifyFormat("[color getRed:&r green:&g blue:&b alpha:&a];"); 5242 5243 verifyFormat("arr[[self indexForFoo:a]];"); 5244 verifyFormat("throw [self errorFor:a];"); 5245 verifyFormat("@throw [self errorFor:a];"); 5246 5247 verifyFormat("[(id)foo bar:(id)baz quux:(id)snorf];"); 5248 verifyFormat("[(id)foo bar:(id) ? baz : quux];"); 5249 verifyFormat("4 > 4 ? (id)a : (id)baz;"); 5250 5251 // This tests that the formatter doesn't break after "backing" but before ":", 5252 // which would be at 80 columns. 5253 verifyFormat( 5254 "void f() {\n" 5255 " if ((self = [super initWithContentRect:contentRect\n" 5256 " styleMask:styleMask ?: otherMask\n" 5257 " backing:NSBackingStoreBuffered\n" 5258 " defer:YES]))"); 5259 5260 verifyFormat( 5261 "[foo checkThatBreakingAfterColonWorksOk:\n" 5262 " [bar ifItDoes:reduceOverallLineLengthLikeInThisCase]];"); 5263 5264 verifyFormat("[myObj short:arg1 // Force line break\n" 5265 " longKeyword:arg2 != nil ? arg2 : @\"longKeyword\"\n" 5266 " evenLongerKeyword:arg3 ?: @\"evenLongerKeyword\"\n" 5267 " error:arg4];"); 5268 verifyFormat( 5269 "void f() {\n" 5270 " popup_window_.reset([[RenderWidgetPopupWindow alloc]\n" 5271 " initWithContentRect:NSMakeRect(origin_global.x, origin_global.y,\n" 5272 " pos.width(), pos.height())\n" 5273 " styleMask:NSBorderlessWindowMask\n" 5274 " backing:NSBackingStoreBuffered\n" 5275 " defer:NO]);\n" 5276 "}"); 5277 verifyFormat("[contentsContainer replaceSubview:[subviews objectAtIndex:0]\n" 5278 " with:contentsNativeView];"); 5279 5280 verifyFormat( 5281 "[pboard addTypes:[NSArray arrayWithObject:kBookmarkButtonDragType]\n" 5282 " owner:nillllll];"); 5283 5284 verifyFormat( 5285 "[pboard setData:[NSData dataWithBytes:&button length:sizeof(button)]\n" 5286 " forType:kBookmarkButtonDragType];"); 5287 5288 verifyFormat("[defaultCenter addObserver:self\n" 5289 " selector:@selector(willEnterFullscreen)\n" 5290 " name:kWillEnterFullscreenNotification\n" 5291 " object:nil];"); 5292 verifyFormat("[image_rep drawInRect:drawRect\n" 5293 " fromRect:NSZeroRect\n" 5294 " operation:NSCompositeCopy\n" 5295 " fraction:1.0\n" 5296 " respectFlipped:NO\n" 5297 " hints:nil];"); 5298 5299 verifyFormat( 5300 "scoped_nsobject<NSTextField> message(\n" 5301 " // The frame will be fixed up when |-setMessageText:| is called.\n" 5302 " [[NSTextField alloc] initWithFrame:NSMakeRect(0, 0, 0, 0)]);"); 5303 verifyFormat("[self aaaaaa:bbbbbbbbbbbbb\n" 5304 " aaaaaaaaaa:bbbbbbbbbbbbbbbbb\n" 5305 " aaaaa:bbbbbbbbbbb + bbbbbbbbbbbb\n" 5306 " aaaa:bbb];"); 5307 5308 // Variadic parameters. 5309 verifyFormat( 5310 "NSArray *myStrings = [NSArray stringarray:@\"a\", @\"b\", nil];"); 5311 } 5312 5313 TEST_F(FormatTest, ObjCAt) { 5314 verifyFormat("@autoreleasepool"); 5315 verifyFormat("@catch"); 5316 verifyFormat("@class"); 5317 verifyFormat("@compatibility_alias"); 5318 verifyFormat("@defs"); 5319 verifyFormat("@dynamic"); 5320 verifyFormat("@encode"); 5321 verifyFormat("@end"); 5322 verifyFormat("@finally"); 5323 verifyFormat("@implementation"); 5324 verifyFormat("@import"); 5325 verifyFormat("@interface"); 5326 verifyFormat("@optional"); 5327 verifyFormat("@package"); 5328 verifyFormat("@private"); 5329 verifyFormat("@property"); 5330 verifyFormat("@protected"); 5331 verifyFormat("@protocol"); 5332 verifyFormat("@public"); 5333 verifyFormat("@required"); 5334 verifyFormat("@selector"); 5335 verifyFormat("@synchronized"); 5336 verifyFormat("@synthesize"); 5337 verifyFormat("@throw"); 5338 verifyFormat("@try"); 5339 5340 EXPECT_EQ("@interface", format("@ interface")); 5341 5342 // The precise formatting of this doesn't matter, nobody writes code like 5343 // this. 5344 verifyFormat("@ /*foo*/ interface"); 5345 } 5346 5347 TEST_F(FormatTest, ObjCSnippets) { 5348 verifyFormat("@autoreleasepool {\n" 5349 " foo();\n" 5350 "}"); 5351 verifyFormat("@class Foo, Bar;"); 5352 verifyFormat("@compatibility_alias AliasName ExistingClass;"); 5353 verifyFormat("@dynamic textColor;"); 5354 verifyFormat("char *buf1 = @encode(int *);"); 5355 verifyFormat("char *buf1 = @encode(typeof(4 * 5));"); 5356 verifyFormat("char *buf1 = @encode(int **);"); 5357 verifyFormat("Protocol *proto = @protocol(p1);"); 5358 verifyFormat("SEL s = @selector(foo:);"); 5359 verifyFormat("@synchronized(self) {\n" 5360 " f();\n" 5361 "}"); 5362 5363 verifyFormat("@synthesize dropArrowPosition = dropArrowPosition_;"); 5364 verifyGoogleFormat("@synthesize dropArrowPosition = dropArrowPosition_;"); 5365 5366 verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;"); 5367 verifyFormat("@property(assign, getter=isEditable) BOOL editable;"); 5368 verifyGoogleFormat("@property(assign, getter=isEditable) BOOL editable;"); 5369 5370 verifyFormat("@import foo.bar;\n" 5371 "@import baz;"); 5372 } 5373 5374 TEST_F(FormatTest, ObjCLiterals) { 5375 verifyFormat("@\"String\""); 5376 verifyFormat("@1"); 5377 verifyFormat("@+4.8"); 5378 verifyFormat("@-4"); 5379 verifyFormat("@1LL"); 5380 verifyFormat("@.5"); 5381 verifyFormat("@'c'"); 5382 verifyFormat("@true"); 5383 5384 verifyFormat("NSNumber *smallestInt = @(-INT_MAX - 1);"); 5385 verifyFormat("NSNumber *piOverTwo = @(M_PI / 2);"); 5386 verifyFormat("NSNumber *favoriteColor = @(Green);"); 5387 verifyFormat("NSString *path = @(getenv(\"PATH\"));"); 5388 } 5389 5390 TEST_F(FormatTest, ObjCDictLiterals) { 5391 verifyFormat("@{"); 5392 verifyFormat("@{}"); 5393 verifyFormat("@{ @\"one\" : @1 }"); 5394 verifyFormat("return @{ @\"one\" : @1 };"); 5395 verifyFormat("@{ @\"one\" : @1, }"); 5396 5397 verifyFormat("@{ @\"one\" : @{ @2 : @1 } }"); 5398 verifyFormat("@{ @\"one\" : @{ @2 : @1 }, }"); 5399 5400 verifyFormat("@{ 1 > 2 ? @\"one\" : @\"two\" : 1 > 2 ? @1 : @2 }"); 5401 verifyFormat("[self setDict:@{}"); 5402 verifyFormat("[self setDict:@{ @1 : @2 }"); 5403 verifyFormat("NSLog(@\"%@\", @{ @1 : @2, @2 : @3 }[@1]);"); 5404 verifyFormat( 5405 "NSDictionary *masses = @{ @\"H\" : @1.0078, @\"He\" : @4.0026 };"); 5406 verifyFormat( 5407 "NSDictionary *settings = @{ AVEncoderKey : @(AVAudioQualityMax) };"); 5408 5409 verifyFormat( 5410 "NSDictionary *d = @{\n" 5411 " @\"nam\" : NSUserNam(),\n" 5412 " @\"dte\" : [NSDate date],\n" 5413 " @\"processInfo\" : [NSProcessInfo processInfo]\n" 5414 "};"); 5415 verifyFormat( 5416 "@{\n" 5417 " NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee : " 5418 "regularFont,\n" 5419 "};"); 5420 verifyGoogleFormat( 5421 "@{\n" 5422 " NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee : " 5423 "regularFont,\n" 5424 "};"); 5425 5426 // We should try to be robust in case someone forgets the "@". 5427 verifyFormat( 5428 "NSDictionary *d = {\n" 5429 " @\"nam\" : NSUserNam(),\n" 5430 " @\"dte\" : [NSDate date],\n" 5431 " @\"processInfo\" : [NSProcessInfo processInfo]\n" 5432 "};"); 5433 } 5434 5435 TEST_F(FormatTest, ObjCArrayLiterals) { 5436 verifyFormat("@["); 5437 verifyFormat("@[]"); 5438 verifyFormat( 5439 "NSArray *array = @[ @\" Hey \", NSApp, [NSNumber numberWithInt:42] ];"); 5440 verifyFormat("return @[ @3, @[], @[ @4, @5 ] ];"); 5441 verifyFormat("NSArray *array = @[ [foo description] ];"); 5442 5443 verifyFormat( 5444 "NSArray *some_variable = @[\n" 5445 " aaaa == bbbbbbbbbbb ? @\"aaaaaaaaaaaa\" : @\"aaaaaaaaaaaaaa\",\n" 5446 " @\"aaaaaaaaaaaaaaaaa\",\n" 5447 " @\"aaaaaaaaaaaaaaaaa\",\n" 5448 " @\"aaaaaaaaaaaaaaaaa\"\n" 5449 "];"); 5450 verifyFormat("NSArray *some_variable = @[\n" 5451 " @\"aaaaaaaaaaaaaaaaa\",\n" 5452 " @\"aaaaaaaaaaaaaaaaa\",\n" 5453 " @\"aaaaaaaaaaaaaaaaa\",\n" 5454 " @\"aaaaaaaaaaaaaaaaa\",\n" 5455 "];"); 5456 verifyGoogleFormat("NSArray *some_variable = @[\n" 5457 " @\"aaaaaaaaaaaaaaaaa\",\n" 5458 " @\"aaaaaaaaaaaaaaaaa\",\n" 5459 " @\"aaaaaaaaaaaaaaaaa\",\n" 5460 " @\"aaaaaaaaaaaaaaaaa\"\n" 5461 "];"); 5462 5463 // We should try to be robust in case someone forgets the "@". 5464 verifyFormat("NSArray *some_variable = [\n" 5465 " @\"aaaaaaaaaaaaaaaaa\",\n" 5466 " @\"aaaaaaaaaaaaaaaaa\",\n" 5467 " @\"aaaaaaaaaaaaaaaaa\",\n" 5468 " @\"aaaaaaaaaaaaaaaaa\",\n" 5469 "];"); 5470 } 5471 5472 TEST_F(FormatTest, ReformatRegionAdjustsIndent) { 5473 EXPECT_EQ("{\n" 5474 "{\n" 5475 "a;\n" 5476 "b;\n" 5477 "}\n" 5478 "}", 5479 format("{\n" 5480 "{\n" 5481 "a;\n" 5482 " b;\n" 5483 "}\n" 5484 "}", 5485 13, 2, getLLVMStyle())); 5486 EXPECT_EQ("{\n" 5487 "{\n" 5488 " a;\n" 5489 "b;\n" 5490 "}\n" 5491 "}", 5492 format("{\n" 5493 "{\n" 5494 " a;\n" 5495 "b;\n" 5496 "}\n" 5497 "}", 5498 9, 2, getLLVMStyle())); 5499 EXPECT_EQ("{\n" 5500 "{\n" 5501 "public:\n" 5502 " b;\n" 5503 "}\n" 5504 "}", 5505 format("{\n" 5506 "{\n" 5507 "public:\n" 5508 " b;\n" 5509 "}\n" 5510 "}", 5511 17, 2, getLLVMStyle())); 5512 EXPECT_EQ("{\n" 5513 "{\n" 5514 "a;\n" 5515 "}\n" 5516 "{\n" 5517 " b; //\n" 5518 "}\n" 5519 "}", 5520 format("{\n" 5521 "{\n" 5522 "a;\n" 5523 "}\n" 5524 "{\n" 5525 " b; //\n" 5526 "}\n" 5527 "}", 5528 22, 2, getLLVMStyle())); 5529 EXPECT_EQ(" {\n" 5530 " a; //\n" 5531 " }", 5532 format(" {\n" 5533 "a; //\n" 5534 " }", 5535 4, 2, getLLVMStyle())); 5536 EXPECT_EQ("void f() {}\n" 5537 "void g() {}", 5538 format("void f() {}\n" 5539 "void g() {}", 5540 13, 0, getLLVMStyle())); 5541 EXPECT_EQ("int a; // comment\n" 5542 " // line 2\n" 5543 "int b;", 5544 format("int a; // comment\n" 5545 " // line 2\n" 5546 " int b;", 5547 35, 0, getLLVMStyle())); 5548 EXPECT_EQ(" int a;\n" 5549 " void\n" 5550 " ffffff() {\n" 5551 " }", 5552 format(" int a;\n" 5553 "void ffffff() {}", 5554 11, 0, getLLVMStyleWithColumns(11))); 5555 } 5556 5557 TEST_F(FormatTest, BreakStringLiterals) { 5558 EXPECT_EQ("\"some text \"\n" 5559 "\"other\";", 5560 format("\"some text other\";", getLLVMStyleWithColumns(12))); 5561 EXPECT_EQ("\"some text \"\n" 5562 "\"other\";", 5563 format("\\\n\"some text other\";", getLLVMStyleWithColumns(12))); 5564 EXPECT_EQ( 5565 "#define A \\\n" 5566 " \"some \" \\\n" 5567 " \"text \" \\\n" 5568 " \"other\";", 5569 format("#define A \"some text other\";", getLLVMStyleWithColumns(12))); 5570 EXPECT_EQ( 5571 "#define A \\\n" 5572 " \"so \" \\\n" 5573 " \"text \" \\\n" 5574 " \"other\";", 5575 format("#define A \"so text other\";", getLLVMStyleWithColumns(12))); 5576 5577 EXPECT_EQ("\"some text\"", 5578 format("\"some text\"", getLLVMStyleWithColumns(1))); 5579 EXPECT_EQ("\"some text\"", 5580 format("\"some text\"", getLLVMStyleWithColumns(11))); 5581 EXPECT_EQ("\"some \"\n" 5582 "\"text\"", 5583 format("\"some text\"", getLLVMStyleWithColumns(10))); 5584 EXPECT_EQ("\"some \"\n" 5585 "\"text\"", 5586 format("\"some text\"", getLLVMStyleWithColumns(7))); 5587 EXPECT_EQ("\"some\"\n" 5588 "\" tex\"\n" 5589 "\"t\"", 5590 format("\"some text\"", getLLVMStyleWithColumns(6))); 5591 EXPECT_EQ("\"some\"\n" 5592 "\" tex\"\n" 5593 "\" and\"", 5594 format("\"some tex and\"", getLLVMStyleWithColumns(6))); 5595 EXPECT_EQ("\"some\"\n" 5596 "\"/tex\"\n" 5597 "\"/and\"", 5598 format("\"some/tex/and\"", getLLVMStyleWithColumns(6))); 5599 5600 EXPECT_EQ("variable =\n" 5601 " \"long string \"\n" 5602 " \"literal\";", 5603 format("variable = \"long string literal\";", 5604 getLLVMStyleWithColumns(20))); 5605 5606 EXPECT_EQ("variable = f(\n" 5607 " \"long string \"\n" 5608 " \"literal\",\n" 5609 " short,\n" 5610 " loooooooooooooooooooong);", 5611 format("variable = f(\"long string literal\", short, " 5612 "loooooooooooooooooooong);", 5613 getLLVMStyleWithColumns(20))); 5614 5615 EXPECT_EQ("f(g(\"long string \"\n" 5616 " \"literal\"),\n" 5617 " b);", 5618 format("f(g(\"long string literal\"), b);", 5619 getLLVMStyleWithColumns(20))); 5620 EXPECT_EQ("f(g(\"long string \"\n" 5621 " \"literal\",\n" 5622 " a),\n" 5623 " b);", 5624 format("f(g(\"long string literal\", a), b);", 5625 getLLVMStyleWithColumns(20))); 5626 EXPECT_EQ( 5627 "f(\"one two\".split(\n" 5628 " variable));", 5629 format("f(\"one two\".split(variable));", getLLVMStyleWithColumns(20))); 5630 EXPECT_EQ("f(\"one two three four five six \"\n" 5631 " \"seven\".split(\n" 5632 " really_looooong_variable));", 5633 format("f(\"one two three four five six seven\"." 5634 "split(really_looooong_variable));", 5635 getLLVMStyleWithColumns(33))); 5636 5637 EXPECT_EQ("f(\"some \"\n" 5638 " \"text\",\n" 5639 " other);", 5640 format("f(\"some text\", other);", getLLVMStyleWithColumns(10))); 5641 5642 // Only break as a last resort. 5643 verifyFormat( 5644 "aaaaaaaaaaaaaaaaaaaa(\n" 5645 " aaaaaaaaaaaaaaaaaaaa,\n" 5646 " aaaaaa(\"aaa aaaaa aaa aaa aaaaa aaa aaaaa aaa aaa aaaaaa\"));"); 5647 5648 EXPECT_EQ( 5649 "\"splitmea\"\n" 5650 "\"trandomp\"\n" 5651 "\"oint\"", 5652 format("\"splitmeatrandompoint\"", getLLVMStyleWithColumns(10))); 5653 5654 EXPECT_EQ( 5655 "\"split/\"\n" 5656 "\"pathat/\"\n" 5657 "\"slashes\"", 5658 format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); 5659 5660 EXPECT_EQ( 5661 "\"split/\"\n" 5662 "\"pathat/\"\n" 5663 "\"slashes\"", 5664 format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); 5665 EXPECT_EQ("\"split at \"\n" 5666 "\"spaces/at/\"\n" 5667 "\"slashes.at.any$\"\n" 5668 "\"non-alphanumeric%\"\n" 5669 "\"1111111111characte\"\n" 5670 "\"rs\"", 5671 format("\"split at " 5672 "spaces/at/" 5673 "slashes.at." 5674 "any$non-" 5675 "alphanumeric%" 5676 "1111111111characte" 5677 "rs\"", 5678 getLLVMStyleWithColumns(20))); 5679 5680 // Verify that splitting the strings understands 5681 // Style::AlwaysBreakBeforeMultilineStrings. 5682 EXPECT_EQ("aaaaaaaaaaaa(aaaaaaaaaaaaa,\n" 5683 " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa \"\n" 5684 " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\");", 5685 format("aaaaaaaaaaaa(aaaaaaaaaaaaa, \"aaaaaaaaaaaaaaaaaaaaaa " 5686 "aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa " 5687 "aaaaaaaaaaaaaaaaaaaaaa\");", 5688 getGoogleStyle())); 5689 EXPECT_EQ("return \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 5690 " \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\";", 5691 format("return \"aaaaaaaaaaaaaaaaaaaaaa " 5692 "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaa " 5693 "aaaaaaaaaaaaaaaaaaaaaa\";", 5694 getGoogleStyle())); 5695 EXPECT_EQ("llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 5696 " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";", 5697 format("llvm::outs() << " 5698 "\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa" 5699 "aaaaaaaaaaaaaaaaaaa\";")); 5700 EXPECT_EQ("ffff(\n" 5701 " {\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 5702 " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});", 5703 format("ffff({\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa " 5704 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});", 5705 getGoogleStyle())); 5706 5707 FormatStyle AlignLeft = getLLVMStyleWithColumns(12); 5708 AlignLeft.AlignEscapedNewlinesLeft = true; 5709 EXPECT_EQ( 5710 "#define A \\\n" 5711 " \"some \" \\\n" 5712 " \"text \" \\\n" 5713 " \"other\";", 5714 format("#define A \"some text other\";", AlignLeft)); 5715 } 5716 5717 TEST_F(FormatTest, BreaksWideStringLiterals) { 5718 EXPECT_EQ( 5719 "u8\"utf8 string \"\n" 5720 "u8\"literal\";", 5721 format("u8\"utf8 string literal\";", getGoogleStyleWithColumns(16))); 5722 EXPECT_EQ( 5723 "u\"utf16 string \"\n" 5724 "u\"literal\";", 5725 format("u\"utf16 string literal\";", getGoogleStyleWithColumns(16))); 5726 EXPECT_EQ( 5727 "U\"utf32 string \"\n" 5728 "U\"literal\";", 5729 format("U\"utf32 string literal\";", getGoogleStyleWithColumns(16))); 5730 EXPECT_EQ("L\"wide string \"\n" 5731 "L\"literal\";", 5732 format("L\"wide string literal\";", getGoogleStyleWithColumns(16))); 5733 } 5734 5735 TEST_F(FormatTest, BreaksRawStringLiterals) { 5736 EXPECT_EQ("R\"x(raw )x\"\n" 5737 "R\"x(literal)x\";", 5738 format("R\"x(raw literal)x\";", getGoogleStyleWithColumns(15))); 5739 EXPECT_EQ("uR\"x(raw )x\"\n" 5740 "uR\"x(literal)x\";", 5741 format("uR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); 5742 EXPECT_EQ("u8R\"x(raw )x\"\n" 5743 "u8R\"x(literal)x\";", 5744 format("u8R\"x(raw literal)x\";", getGoogleStyleWithColumns(17))); 5745 EXPECT_EQ("LR\"x(raw )x\"\n" 5746 "LR\"x(literal)x\";", 5747 format("LR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); 5748 EXPECT_EQ("UR\"x(raw )x\"\n" 5749 "UR\"x(literal)x\";", 5750 format("UR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); 5751 } 5752 5753 TEST_F(FormatTest, BreaksStringLiteralsWithin_TMacro) { 5754 FormatStyle Style = getLLVMStyleWithColumns(20); 5755 EXPECT_EQ( 5756 "_T(\"aaaaaaaaaaaaaa\")\n" 5757 "_T(\"aaaaaaaaaaaaaa\")\n" 5758 "_T(\"aaaaaaaaaaaa\")", 5759 format(" _T(\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")", Style)); 5760 EXPECT_EQ("f(x, _T(\"aaaaaaaaa\")\n" 5761 " _T(\"aaaaaa\"),\n" 5762 " z);", 5763 format("f(x, _T(\"aaaaaaaaaaaaaaa\"), z);", Style)); 5764 5765 // FIXME: Handle embedded spaces in one iteration. 5766 // EXPECT_EQ("_T(\"aaaaaaaaaaaaa\")\n" 5767 // "_T(\"aaaaaaaaaaaaa\")\n" 5768 // "_T(\"aaaaaaaaaaaaa\")\n" 5769 // "_T(\"a\")", 5770 // format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", 5771 // getLLVMStyleWithColumns(20))); 5772 EXPECT_EQ( 5773 "_T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", 5774 format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", Style)); 5775 } 5776 5777 TEST_F(FormatTest, DontSplitStringLiteralsWithEscapedNewlines) { 5778 EXPECT_EQ( 5779 "aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5780 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5781 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";", 5782 format("aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5783 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5784 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";")); 5785 } 5786 5787 TEST_F(FormatTest, CountsCharactersInMultilineRawStringLiterals) { 5788 EXPECT_EQ("f(g(R\"x(raw literal)x\", a), b);", 5789 format("f(g(R\"x(raw literal)x\", a), b);", getGoogleStyle())); 5790 EXPECT_EQ("fffffffffff(g(R\"x(\n" 5791 "multiline raw string literal xxxxxxxxxxxxxx\n" 5792 ")x\",\n" 5793 " a),\n" 5794 " b);", 5795 format("fffffffffff(g(R\"x(\n" 5796 "multiline raw string literal xxxxxxxxxxxxxx\n" 5797 ")x\", a), b);", 5798 getGoogleStyleWithColumns(20))); 5799 EXPECT_EQ("fffffffffff(\n" 5800 " g(R\"x(qqq\n" 5801 "multiline raw string literal xxxxxxxxxxxxxx\n" 5802 ")x\",\n" 5803 " a),\n" 5804 " b);", 5805 format("fffffffffff(g(R\"x(qqq\n" 5806 "multiline raw string literal xxxxxxxxxxxxxx\n" 5807 ")x\", a), b);", 5808 getGoogleStyleWithColumns(20))); 5809 5810 EXPECT_EQ("fffffffffff(R\"x(\n" 5811 "multiline raw string literal xxxxxxxxxxxxxx\n" 5812 ")x\");", 5813 format("fffffffffff(R\"x(\n" 5814 "multiline raw string literal xxxxxxxxxxxxxx\n" 5815 ")x\");", 5816 getGoogleStyleWithColumns(20))); 5817 EXPECT_EQ("fffffffffff(R\"x(\n" 5818 "multiline raw string literal xxxxxxxxxxxxxx\n" 5819 ")x\" +\n" 5820 " bbbbbb);", 5821 format("fffffffffff(R\"x(\n" 5822 "multiline raw string literal xxxxxxxxxxxxxx\n" 5823 ")x\" + bbbbbb);", 5824 getGoogleStyleWithColumns(20))); 5825 } 5826 5827 TEST_F(FormatTest, SkipsUnknownStringLiterals) { 5828 verifyFormat("string a = \"unterminated;"); 5829 EXPECT_EQ("function(\"unterminated,\n" 5830 " OtherParameter);", 5831 format("function( \"unterminated,\n" 5832 " OtherParameter);")); 5833 } 5834 5835 TEST_F(FormatTest, DoesNotTryToParseUDLiteralsInPreCpp11Code) { 5836 EXPECT_EQ("#define x(_a) printf(\"foo\" _a);", 5837 format("#define x(_a) printf(\"foo\"_a);", getLLVMStyle())); 5838 } 5839 5840 TEST_F(FormatTest, BreakStringLiteralsBeforeUnbreakableTokenSequence) { 5841 EXPECT_EQ("someFunction(\"aaabbbcccd\"\n" 5842 " \"ddeeefff\");", 5843 format("someFunction(\"aaabbbcccdddeeefff\");", 5844 getLLVMStyleWithColumns(25))); 5845 EXPECT_EQ("someFunction1234567890(\n" 5846 " \"aaabbbcccdddeeefff\");", 5847 format("someFunction1234567890(\"aaabbbcccdddeeefff\");", 5848 getLLVMStyleWithColumns(26))); 5849 EXPECT_EQ("someFunction1234567890(\n" 5850 " \"aaabbbcccdddeeeff\"\n" 5851 " \"f\");", 5852 format("someFunction1234567890(\"aaabbbcccdddeeefff\");", 5853 getLLVMStyleWithColumns(25))); 5854 EXPECT_EQ("someFunction1234567890(\n" 5855 " \"aaabbbcccdddeeeff\"\n" 5856 " \"f\");", 5857 format("someFunction1234567890(\"aaabbbcccdddeeefff\");", 5858 getLLVMStyleWithColumns(24))); 5859 EXPECT_EQ("someFunction(\"aaabbbcc \"\n" 5860 " \"ddde \"\n" 5861 " \"efff\");", 5862 format("someFunction(\"aaabbbcc ddde efff\");", 5863 getLLVMStyleWithColumns(25))); 5864 EXPECT_EQ("someFunction(\"aaabbbccc \"\n" 5865 " \"ddeeefff\");", 5866 format("someFunction(\"aaabbbccc ddeeefff\");", 5867 getLLVMStyleWithColumns(25))); 5868 EXPECT_EQ("someFunction1234567890(\n" 5869 " \"aaabb \"\n" 5870 " \"cccdddeeefff\");", 5871 format("someFunction1234567890(\"aaabb cccdddeeefff\");", 5872 getLLVMStyleWithColumns(25))); 5873 EXPECT_EQ("#define A \\\n" 5874 " string s = \\\n" 5875 " \"123456789\" \\\n" 5876 " \"0\"; \\\n" 5877 " int i;", 5878 format("#define A string s = \"1234567890\"; int i;", 5879 getLLVMStyleWithColumns(20))); 5880 // FIXME: Put additional penalties on breaking at non-whitespace locations. 5881 EXPECT_EQ("someFunction(\"aaabbbcc \"\n" 5882 " \"dddeeeff\"\n" 5883 " \"f\");", 5884 format("someFunction(\"aaabbbcc dddeeefff\");", 5885 getLLVMStyleWithColumns(25))); 5886 } 5887 5888 TEST_F(FormatTest, DoNotBreakStringLiteralsInEscapeSequence) { 5889 EXPECT_EQ("\"\\a\"", 5890 format("\"\\a\"", getLLVMStyleWithColumns(3))); 5891 EXPECT_EQ("\"\\\"", 5892 format("\"\\\"", getLLVMStyleWithColumns(2))); 5893 EXPECT_EQ("\"test\"\n" 5894 "\"\\n\"", 5895 format("\"test\\n\"", getLLVMStyleWithColumns(7))); 5896 EXPECT_EQ("\"tes\\\\\"\n" 5897 "\"n\"", 5898 format("\"tes\\\\n\"", getLLVMStyleWithColumns(7))); 5899 EXPECT_EQ("\"\\\\\\\\\"\n" 5900 "\"\\n\"", 5901 format("\"\\\\\\\\\\n\"", getLLVMStyleWithColumns(7))); 5902 EXPECT_EQ("\"\\uff01\"", 5903 format("\"\\uff01\"", getLLVMStyleWithColumns(7))); 5904 EXPECT_EQ("\"\\uff01\"\n" 5905 "\"test\"", 5906 format("\"\\uff01test\"", getLLVMStyleWithColumns(8))); 5907 EXPECT_EQ("\"\\Uff01ff02\"", 5908 format("\"\\Uff01ff02\"", getLLVMStyleWithColumns(11))); 5909 EXPECT_EQ("\"\\x000000000001\"\n" 5910 "\"next\"", 5911 format("\"\\x000000000001next\"", getLLVMStyleWithColumns(16))); 5912 EXPECT_EQ("\"\\x000000000001next\"", 5913 format("\"\\x000000000001next\"", getLLVMStyleWithColumns(15))); 5914 EXPECT_EQ("\"\\x000000000001\"", 5915 format("\"\\x000000000001\"", getLLVMStyleWithColumns(7))); 5916 EXPECT_EQ("\"test\"\n" 5917 "\"\\000000\"\n" 5918 "\"000001\"", 5919 format("\"test\\000000000001\"", getLLVMStyleWithColumns(9))); 5920 EXPECT_EQ("\"test\\000\"\n" 5921 "\"00000000\"\n" 5922 "\"1\"", 5923 format("\"test\\000000000001\"", getLLVMStyleWithColumns(10))); 5924 // FIXME: We probably don't need to care about escape sequences in raw 5925 // literals. 5926 EXPECT_EQ("R\"(\\x)\"\n" 5927 "R\"(\\x00)\"\n", 5928 format("R\"(\\x\\x00)\"\n", getGoogleStyleWithColumns(7))); 5929 } 5930 5931 TEST_F(FormatTest, DoNotCreateUnreasonableUnwrappedLines) { 5932 verifyFormat("void f() {\n" 5933 " return g() {}\n" 5934 " void h() {}"); 5935 verifyFormat("if (foo)\n" 5936 " return { forgot_closing_brace();\n" 5937 "test();"); 5938 verifyFormat("int a[] = { void forgot_closing_brace() { f();\n" 5939 "g();\n" 5940 "}"); 5941 } 5942 5943 TEST_F(FormatTest, FormatsClosingBracesInEmptyNestedBlocks) { 5944 verifyFormat("class X {\n" 5945 " void f() {\n" 5946 " }\n" 5947 "};", 5948 getLLVMStyleWithColumns(12)); 5949 } 5950 5951 TEST_F(FormatTest, ConfigurableIndentWidth) { 5952 FormatStyle EightIndent = getLLVMStyleWithColumns(18); 5953 EightIndent.IndentWidth = 8; 5954 verifyFormat("void f() {\n" 5955 " someFunction();\n" 5956 " if (true) {\n" 5957 " f();\n" 5958 " }\n" 5959 "}", 5960 EightIndent); 5961 verifyFormat("class X {\n" 5962 " void f() {\n" 5963 " }\n" 5964 "};", 5965 EightIndent); 5966 verifyFormat("int x[] = {\n" 5967 " call(),\n" 5968 " call(),\n" 5969 "};", 5970 EightIndent); 5971 } 5972 5973 TEST_F(FormatTest, ConfigurableFunctionDeclarationIndentAfterType) { 5974 verifyFormat("void\n" 5975 "f();", 5976 getLLVMStyleWithColumns(8)); 5977 } 5978 5979 TEST_F(FormatTest, ConfigurableUseOfTab) { 5980 FormatStyle Tab = getLLVMStyleWithColumns(42); 5981 Tab.IndentWidth = 8; 5982 Tab.UseTab = FormatStyle::UT_Always; 5983 Tab.AlignEscapedNewlinesLeft = true; 5984 5985 EXPECT_EQ("if (aaaaaaaa && // q\n" 5986 " bb)\t\t// w\n" 5987 "\t;", 5988 format("if (aaaaaaaa &&// q\n" 5989 "bb)// w\n" 5990 ";", 5991 Tab)); 5992 EXPECT_EQ("if (aaa && bbb) // w\n" 5993 "\t;", 5994 format("if(aaa&&bbb)// w\n" 5995 ";", 5996 Tab)); 5997 5998 verifyFormat("class X {\n" 5999 "\tvoid f() {\n" 6000 "\t\tsomeFunction(parameter1,\n" 6001 "\t\t\t parameter2);\n" 6002 "\t}\n" 6003 "};", 6004 Tab); 6005 verifyFormat("#define A \\\n" 6006 "\tvoid f() { \\\n" 6007 "\t\tsomeFunction( \\\n" 6008 "\t\t parameter1, \\\n" 6009 "\t\t parameter2); \\\n" 6010 "\t}", 6011 Tab); 6012 EXPECT_EQ("void f() {\n" 6013 "\tf();\n" 6014 "\tg();\n" 6015 "}", 6016 format("void f() {\n" 6017 "\tf();\n" 6018 "\tg();\n" 6019 "}", 6020 0, 0, Tab)); 6021 EXPECT_EQ("void f() {\n" 6022 "\tf();\n" 6023 "\tg();\n" 6024 "}", 6025 format("void f() {\n" 6026 "\tf();\n" 6027 "\tg();\n" 6028 "}", 6029 16, 0, Tab)); 6030 EXPECT_EQ("void f() {\n" 6031 " \tf();\n" 6032 "\tg();\n" 6033 "}", 6034 format("void f() {\n" 6035 " \tf();\n" 6036 " \tg();\n" 6037 "}", 6038 21, 0, Tab)); 6039 6040 Tab.TabWidth = 4; 6041 Tab.IndentWidth = 8; 6042 verifyFormat("class TabWidth4Indent8 {\n" 6043 "\t\tvoid f() {\n" 6044 "\t\t\t\tsomeFunction(parameter1,\n" 6045 "\t\t\t\t\t\t\t parameter2);\n" 6046 "\t\t}\n" 6047 "};", 6048 Tab); 6049 6050 Tab.TabWidth = 4; 6051 Tab.IndentWidth = 4; 6052 verifyFormat("class TabWidth4Indent4 {\n" 6053 "\tvoid f() {\n" 6054 "\t\tsomeFunction(parameter1,\n" 6055 "\t\t\t\t\t parameter2);\n" 6056 "\t}\n" 6057 "};", 6058 Tab); 6059 6060 Tab.TabWidth = 8; 6061 Tab.IndentWidth = 4; 6062 verifyFormat("class TabWidth8Indent4 {\n" 6063 " void f() {\n" 6064 "\tsomeFunction(parameter1,\n" 6065 "\t\t parameter2);\n" 6066 " }\n" 6067 "};", 6068 Tab); 6069 6070 Tab.TabWidth = 8; 6071 Tab.IndentWidth = 8; 6072 EXPECT_EQ("/*\n" 6073 "\t a\t\tcomment\n" 6074 "\t in multiple lines\n" 6075 " */", 6076 format(" /*\t \t \n" 6077 " \t \t a\t\tcomment\t \t\n" 6078 " \t \t in multiple lines\t\n" 6079 " \t */", 6080 Tab)); 6081 6082 Tab.UseTab = FormatStyle::UT_ForIndentation; 6083 verifyFormat("T t[] = {\n" 6084 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6085 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6086 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6087 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6088 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6089 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6090 "};", 6091 Tab); 6092 verifyFormat("enum A {\n" 6093 "\ta1,\n" 6094 "\ta2,\n" 6095 "\ta3\n" 6096 "};", 6097 Tab); 6098 EXPECT_EQ("if (aaaaaaaa && // q\n" 6099 " bb) // w\n" 6100 "\t;", 6101 format("if (aaaaaaaa &&// q\n" 6102 "bb)// w\n" 6103 ";", 6104 Tab)); 6105 verifyFormat("class X {\n" 6106 "\tvoid f() {\n" 6107 "\t\tsomeFunction(parameter1,\n" 6108 "\t\t parameter2);\n" 6109 "\t}\n" 6110 "};", 6111 Tab); 6112 verifyFormat("{\n" 6113 "\tQ({\n" 6114 "\t\t int a;\n" 6115 "\t\t someFunction(aaaaaaaaaa,\n" 6116 "\t\t bbbbbbbbb);\n" 6117 "\t },\n" 6118 "\t p);\n" 6119 "}", 6120 Tab); 6121 EXPECT_EQ("{\n" 6122 "\t/* aaaa\n" 6123 "\t bbbb */\n" 6124 "}", 6125 format("{\n" 6126 "/* aaaa\n" 6127 " bbbb */\n" 6128 "}", 6129 Tab)); 6130 EXPECT_EQ("{\n" 6131 "\t/*\n" 6132 "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6133 "\t bbbbbbbbbbbbb\n" 6134 "\t*/\n" 6135 "}", 6136 format("{\n" 6137 "/*\n" 6138 " aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" 6139 "*/\n" 6140 "}", 6141 Tab)); 6142 EXPECT_EQ("{\n" 6143 "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6144 "\t// bbbbbbbbbbbbb\n" 6145 "}", 6146 format("{\n" 6147 "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" 6148 "}", 6149 Tab)); 6150 EXPECT_EQ("{\n" 6151 "\t/*\n" 6152 "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6153 "\t bbbbbbbbbbbbb\n" 6154 "\t*/\n" 6155 "}", 6156 format("{\n" 6157 "\t/*\n" 6158 "\t aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" 6159 "\t*/\n" 6160 "}", 6161 Tab)); 6162 EXPECT_EQ("{\n" 6163 "\t/*\n" 6164 "\n" 6165 "\t*/\n" 6166 "}", 6167 format("{\n" 6168 "\t/*\n" 6169 "\n" 6170 "\t*/\n" 6171 "}", 6172 Tab)); 6173 EXPECT_EQ("{\n" 6174 "\t/*\n" 6175 " asdf\n" 6176 "\t*/\n" 6177 "}", 6178 format("{\n" 6179 "\t/*\n" 6180 " asdf\n" 6181 "\t*/\n" 6182 "}", 6183 Tab)); 6184 6185 Tab.UseTab = FormatStyle::UT_Never; 6186 EXPECT_EQ("/*\n" 6187 " a\t\tcomment\n" 6188 " in multiple lines\n" 6189 " */", 6190 format(" /*\t \t \n" 6191 " \t \t a\t\tcomment\t \t\n" 6192 " \t \t in multiple lines\t\n" 6193 " \t */", 6194 Tab)); 6195 EXPECT_EQ("/* some\n" 6196 " comment */", 6197 format(" \t \t /* some\n" 6198 " \t \t comment */", 6199 Tab)); 6200 EXPECT_EQ("int a; /* some\n" 6201 " comment */", 6202 format(" \t \t int a; /* some\n" 6203 " \t \t comment */", 6204 Tab)); 6205 6206 EXPECT_EQ("int a; /* some\n" 6207 "comment */", 6208 format(" \t \t int\ta; /* some\n" 6209 " \t \t comment */", 6210 Tab)); 6211 EXPECT_EQ("f(\"\t\t\"); /* some\n" 6212 " comment */", 6213 format(" \t \t f(\"\t\t\"); /* some\n" 6214 " \t \t comment */", 6215 Tab)); 6216 EXPECT_EQ("{\n" 6217 " /*\n" 6218 " * Comment\n" 6219 " */\n" 6220 " int i;\n" 6221 "}", 6222 format("{\n" 6223 "\t/*\n" 6224 "\t * Comment\n" 6225 "\t */\n" 6226 "\t int i;\n" 6227 "}")); 6228 } 6229 6230 TEST_F(FormatTest, CalculatesOriginalColumn) { 6231 EXPECT_EQ("\"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6232 "q\"; /* some\n" 6233 " comment */", 6234 format(" \"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6235 "q\"; /* some\n" 6236 " comment */", 6237 getLLVMStyle())); 6238 EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n" 6239 "/* some\n" 6240 " comment */", 6241 format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n" 6242 " /* some\n" 6243 " comment */", 6244 getLLVMStyle())); 6245 EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6246 "qqq\n" 6247 "/* some\n" 6248 " comment */", 6249 format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6250 "qqq\n" 6251 " /* some\n" 6252 " comment */", 6253 getLLVMStyle())); 6254 EXPECT_EQ("inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6255 "wwww; /* some\n" 6256 " comment */", 6257 format(" inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6258 "wwww; /* some\n" 6259 " comment */", 6260 getLLVMStyle())); 6261 } 6262 6263 TEST_F(FormatTest, ConfigurableSpaceAfterControlStatementKeyword) { 6264 FormatStyle NoSpace = getLLVMStyle(); 6265 NoSpace.SpaceAfterControlStatementKeyword = false; 6266 6267 verifyFormat("while(true)\n" 6268 " continue;", NoSpace); 6269 verifyFormat("for(;;)\n" 6270 " continue;", NoSpace); 6271 verifyFormat("if(true)\n" 6272 " f();\n" 6273 "else if(true)\n" 6274 " f();", NoSpace); 6275 verifyFormat("do {\n" 6276 " do_something();\n" 6277 "} while(something());", NoSpace); 6278 verifyFormat("switch(x) {\n" 6279 "default:\n" 6280 " break;\n" 6281 "}", NoSpace); 6282 } 6283 6284 TEST_F(FormatTest, ConfigurableSpacesInParentheses) { 6285 FormatStyle Spaces = getLLVMStyle(); 6286 6287 Spaces.SpacesInParentheses = true; 6288 verifyFormat("call( x, y, z );", Spaces); 6289 verifyFormat("while ( (bool)1 )\n" 6290 " continue;", Spaces); 6291 verifyFormat("for ( ;; )\n" 6292 " continue;", Spaces); 6293 verifyFormat("if ( true )\n" 6294 " f();\n" 6295 "else if ( true )\n" 6296 " f();", Spaces); 6297 verifyFormat("do {\n" 6298 " do_something( (int)i );\n" 6299 "} while ( something() );", Spaces); 6300 verifyFormat("switch ( x ) {\n" 6301 "default:\n" 6302 " break;\n" 6303 "}", Spaces); 6304 6305 Spaces.SpacesInParentheses = false; 6306 Spaces.SpacesInCStyleCastParentheses = true; 6307 verifyFormat("Type *A = ( Type * )P;", Spaces); 6308 verifyFormat("Type *A = ( vector<Type *, int *> )P;", Spaces); 6309 verifyFormat("x = ( int32 )y;", Spaces); 6310 verifyFormat("int a = ( int )(2.0f);", Spaces); 6311 verifyFormat("#define AA(X) sizeof((( X * )NULL)->a)", Spaces); 6312 verifyFormat("my_int a = ( my_int )sizeof(int);", Spaces); 6313 verifyFormat("#define x (( int )-1)", Spaces); 6314 6315 Spaces.SpacesInParentheses = false; 6316 Spaces.SpaceInEmptyParentheses = true; 6317 verifyFormat("call(x, y, z);", Spaces); 6318 verifyFormat("call( )", Spaces); 6319 6320 // Run the first set of tests again with 6321 // Spaces.SpacesInParentheses = false, 6322 // Spaces.SpaceInEmptyParentheses = true and 6323 // Spaces.SpacesInCStyleCastParentheses = true 6324 Spaces.SpacesInParentheses = false, 6325 Spaces.SpaceInEmptyParentheses = true; 6326 Spaces.SpacesInCStyleCastParentheses = true; 6327 verifyFormat("call(x, y, z);", Spaces); 6328 verifyFormat("while (( bool )1)\n" 6329 " continue;", Spaces); 6330 verifyFormat("for (;;)\n" 6331 " continue;", Spaces); 6332 verifyFormat("if (true)\n" 6333 " f( );\n" 6334 "else if (true)\n" 6335 " f( );", Spaces); 6336 verifyFormat("do {\n" 6337 " do_something(( int )i);\n" 6338 "} while (something( ));", Spaces); 6339 verifyFormat("switch (x) {\n" 6340 "default:\n" 6341 " break;\n" 6342 "}", Spaces); 6343 } 6344 6345 TEST_F(FormatTest, ConfigurableSpaceBeforeAssignmentOperators) { 6346 verifyFormat("int a = 5;"); 6347 verifyFormat("a += 42;"); 6348 verifyFormat("a or_eq 8;"); 6349 6350 FormatStyle Spaces = getLLVMStyle(); 6351 Spaces.SpaceBeforeAssignmentOperators = false; 6352 verifyFormat("int a= 5;", Spaces); 6353 verifyFormat("a+= 42;", Spaces); 6354 verifyFormat("a or_eq 8;", Spaces); 6355 } 6356 6357 TEST_F(FormatTest, LinuxBraceBreaking) { 6358 FormatStyle BreakBeforeBrace = getLLVMStyle(); 6359 BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Linux; 6360 verifyFormat("namespace a\n" 6361 "{\n" 6362 "class A\n" 6363 "{\n" 6364 " void f()\n" 6365 " {\n" 6366 " if (true) {\n" 6367 " a();\n" 6368 " b();\n" 6369 " }\n" 6370 " }\n" 6371 " void g()\n" 6372 " {\n" 6373 " return;\n" 6374 " }\n" 6375 "}\n" 6376 "}", 6377 BreakBeforeBrace); 6378 } 6379 6380 TEST_F(FormatTest, StroustrupBraceBreaking) { 6381 FormatStyle BreakBeforeBrace = getLLVMStyle(); 6382 BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Stroustrup; 6383 verifyFormat("namespace a {\n" 6384 "class A {\n" 6385 " void f()\n" 6386 " {\n" 6387 " if (true) {\n" 6388 " a();\n" 6389 " b();\n" 6390 " }\n" 6391 " }\n" 6392 " void g()\n" 6393 " {\n" 6394 " return;\n" 6395 " }\n" 6396 "}\n" 6397 "}", 6398 BreakBeforeBrace); 6399 } 6400 6401 TEST_F(FormatTest, AllmanBraceBreaking) { 6402 FormatStyle BreakBeforeBrace = getLLVMStyle(); 6403 BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Allman; 6404 verifyFormat("namespace a\n" 6405 "{\n" 6406 "class A\n" 6407 "{\n" 6408 " void f()\n" 6409 " {\n" 6410 " if (true)\n" 6411 " {\n" 6412 " a();\n" 6413 " b();\n" 6414 " }\n" 6415 " }\n" 6416 " void g()\n" 6417 " {\n" 6418 " return;\n" 6419 " }\n" 6420 "}\n" 6421 "}", 6422 BreakBeforeBrace); 6423 6424 verifyFormat("void f()\n" 6425 "{\n" 6426 " if (true)\n" 6427 " {\n" 6428 " a();\n" 6429 " }\n" 6430 " else if (false)\n" 6431 " {\n" 6432 " b();\n" 6433 " }\n" 6434 " else\n" 6435 " {\n" 6436 " c();\n" 6437 " }\n" 6438 "}\n", 6439 BreakBeforeBrace); 6440 6441 verifyFormat("void f()\n" 6442 "{\n" 6443 " for (int i = 0; i < 10; ++i)\n" 6444 " {\n" 6445 " a();\n" 6446 " }\n" 6447 " while (false)\n" 6448 " {\n" 6449 " b();\n" 6450 " }\n" 6451 " do\n" 6452 " {\n" 6453 " c();\n" 6454 " } while (false)\n" 6455 "}\n", 6456 BreakBeforeBrace); 6457 6458 verifyFormat("void f(int a)\n" 6459 "{\n" 6460 " switch (a)\n" 6461 " {\n" 6462 " case 0:\n" 6463 " break;\n" 6464 " case 1:\n" 6465 " {\n" 6466 " break;\n" 6467 " }\n" 6468 " case 2:\n" 6469 " {\n" 6470 " }\n" 6471 " break;\n" 6472 " default:\n" 6473 " break;\n" 6474 " }\n" 6475 "}\n", 6476 BreakBeforeBrace); 6477 6478 verifyFormat("enum X\n" 6479 "{\n" 6480 " Y = 0,\n" 6481 "}\n", 6482 BreakBeforeBrace); 6483 6484 FormatStyle BreakBeforeBraceShortIfs = BreakBeforeBrace; 6485 BreakBeforeBraceShortIfs.AllowShortIfStatementsOnASingleLine = true; 6486 BreakBeforeBraceShortIfs.AllowShortLoopsOnASingleLine = true; 6487 verifyFormat("void f(bool b)\n" 6488 "{\n" 6489 " if (b)\n" 6490 " {\n" 6491 " return;\n" 6492 " }\n" 6493 "}\n", 6494 BreakBeforeBraceShortIfs); 6495 verifyFormat("void f(bool b)\n" 6496 "{\n" 6497 " if (b) return;\n" 6498 "}\n", 6499 BreakBeforeBraceShortIfs); 6500 verifyFormat("void f(bool b)\n" 6501 "{\n" 6502 " while (b)\n" 6503 " {\n" 6504 " return;\n" 6505 " }\n" 6506 "}\n", 6507 BreakBeforeBraceShortIfs); 6508 } 6509 6510 TEST_F(FormatTest, CatchExceptionReferenceBinding) { 6511 verifyFormat("void f() {\n" 6512 " try {\n" 6513 " }\n" 6514 " catch (const Exception &e) {\n" 6515 " }\n" 6516 "}\n", 6517 getLLVMStyle()); 6518 } 6519 6520 TEST_F(FormatTest, UnderstandsPragmas) { 6521 verifyFormat("#pragma omp reduction(| : var)"); 6522 verifyFormat("#pragma omp reduction(+ : var)"); 6523 } 6524 6525 bool allStylesEqual(ArrayRef<FormatStyle> Styles) { 6526 for (size_t i = 1; i < Styles.size(); ++i) 6527 if (!(Styles[0] == Styles[i])) 6528 return false; 6529 return true; 6530 } 6531 6532 TEST_F(FormatTest, GetsPredefinedStyleByName) { 6533 FormatStyle Styles[3]; 6534 6535 Styles[0] = getLLVMStyle(); 6536 EXPECT_TRUE(getPredefinedStyle("LLVM", &Styles[1])); 6537 EXPECT_TRUE(getPredefinedStyle("lLvM", &Styles[2])); 6538 EXPECT_TRUE(allStylesEqual(Styles)); 6539 6540 Styles[0] = getGoogleStyle(); 6541 EXPECT_TRUE(getPredefinedStyle("Google", &Styles[1])); 6542 EXPECT_TRUE(getPredefinedStyle("gOOgle", &Styles[2])); 6543 EXPECT_TRUE(allStylesEqual(Styles)); 6544 6545 Styles[0] = getChromiumStyle(); 6546 EXPECT_TRUE(getPredefinedStyle("Chromium", &Styles[1])); 6547 EXPECT_TRUE(getPredefinedStyle("cHRoMiUM", &Styles[2])); 6548 EXPECT_TRUE(allStylesEqual(Styles)); 6549 6550 Styles[0] = getMozillaStyle(); 6551 EXPECT_TRUE(getPredefinedStyle("Mozilla", &Styles[1])); 6552 EXPECT_TRUE(getPredefinedStyle("moZILla", &Styles[2])); 6553 EXPECT_TRUE(allStylesEqual(Styles)); 6554 6555 Styles[0] = getWebKitStyle(); 6556 EXPECT_TRUE(getPredefinedStyle("WebKit", &Styles[1])); 6557 EXPECT_TRUE(getPredefinedStyle("wEbKit", &Styles[2])); 6558 EXPECT_TRUE(allStylesEqual(Styles)); 6559 6560 EXPECT_FALSE(getPredefinedStyle("qwerty", &Styles[0])); 6561 } 6562 6563 TEST_F(FormatTest, ParsesConfiguration) { 6564 FormatStyle Style = {}; 6565 #define CHECK_PARSE(TEXT, FIELD, VALUE) \ 6566 EXPECT_NE(VALUE, Style.FIELD); \ 6567 EXPECT_EQ(0, parseConfiguration(TEXT, &Style).value()); \ 6568 EXPECT_EQ(VALUE, Style.FIELD) 6569 6570 #define CHECK_PARSE_BOOL(FIELD) \ 6571 Style.FIELD = false; \ 6572 EXPECT_EQ(0, parseConfiguration(#FIELD ": true", &Style).value()); \ 6573 EXPECT_TRUE(Style.FIELD); \ 6574 EXPECT_EQ(0, parseConfiguration(#FIELD ": false", &Style).value()); \ 6575 EXPECT_FALSE(Style.FIELD); 6576 6577 CHECK_PARSE_BOOL(AlignEscapedNewlinesLeft); 6578 CHECK_PARSE_BOOL(AlignTrailingComments); 6579 CHECK_PARSE_BOOL(AllowAllParametersOfDeclarationOnNextLine); 6580 CHECK_PARSE_BOOL(AllowShortIfStatementsOnASingleLine); 6581 CHECK_PARSE_BOOL(AllowShortLoopsOnASingleLine); 6582 CHECK_PARSE_BOOL(AlwaysBreakTemplateDeclarations); 6583 CHECK_PARSE_BOOL(BinPackParameters); 6584 CHECK_PARSE_BOOL(BreakBeforeBinaryOperators); 6585 CHECK_PARSE_BOOL(BreakConstructorInitializersBeforeComma); 6586 CHECK_PARSE_BOOL(ConstructorInitializerAllOnOneLineOrOnePerLine); 6587 CHECK_PARSE_BOOL(DerivePointerBinding); 6588 CHECK_PARSE_BOOL(IndentCaseLabels); 6589 CHECK_PARSE_BOOL(ObjCSpaceBeforeProtocolList); 6590 CHECK_PARSE_BOOL(PointerBindsToType); 6591 CHECK_PARSE_BOOL(Cpp11BracedListStyle); 6592 CHECK_PARSE_BOOL(IndentFunctionDeclarationAfterType); 6593 CHECK_PARSE_BOOL(SpacesInParentheses); 6594 CHECK_PARSE_BOOL(SpaceInEmptyParentheses); 6595 CHECK_PARSE_BOOL(SpacesInCStyleCastParentheses); 6596 CHECK_PARSE_BOOL(SpaceAfterControlStatementKeyword); 6597 CHECK_PARSE_BOOL(SpaceBeforeAssignmentOperators); 6598 6599 CHECK_PARSE("AccessModifierOffset: -1234", AccessModifierOffset, -1234); 6600 CHECK_PARSE("ConstructorInitializerIndentWidth: 1234", 6601 ConstructorInitializerIndentWidth, 1234u); 6602 CHECK_PARSE("ColumnLimit: 1234", ColumnLimit, 1234u); 6603 CHECK_PARSE("MaxEmptyLinesToKeep: 1234", MaxEmptyLinesToKeep, 1234u); 6604 CHECK_PARSE("PenaltyBreakBeforeFirstCallParameter: 1234", 6605 PenaltyBreakBeforeFirstCallParameter, 1234u); 6606 CHECK_PARSE("PenaltyExcessCharacter: 1234", PenaltyExcessCharacter, 1234u); 6607 CHECK_PARSE("PenaltyReturnTypeOnItsOwnLine: 1234", 6608 PenaltyReturnTypeOnItsOwnLine, 1234u); 6609 CHECK_PARSE("SpacesBeforeTrailingComments: 1234", 6610 SpacesBeforeTrailingComments, 1234u); 6611 CHECK_PARSE("IndentWidth: 32", IndentWidth, 32u); 6612 CHECK_PARSE("ContinuationIndentWidth: 11", ContinuationIndentWidth, 11u); 6613 6614 Style.Standard = FormatStyle::LS_Auto; 6615 CHECK_PARSE("Standard: Cpp03", Standard, FormatStyle::LS_Cpp03); 6616 CHECK_PARSE("Standard: Cpp11", Standard, FormatStyle::LS_Cpp11); 6617 CHECK_PARSE("Standard: C++03", Standard, FormatStyle::LS_Cpp03); 6618 CHECK_PARSE("Standard: C++11", Standard, FormatStyle::LS_Cpp11); 6619 CHECK_PARSE("Standard: Auto", Standard, FormatStyle::LS_Auto); 6620 6621 Style.UseTab = FormatStyle::UT_ForIndentation; 6622 CHECK_PARSE("UseTab: false", UseTab, FormatStyle::UT_Never); 6623 CHECK_PARSE("UseTab: true", UseTab, FormatStyle::UT_Always); 6624 CHECK_PARSE("UseTab: Never", UseTab, FormatStyle::UT_Never); 6625 CHECK_PARSE("UseTab: ForIndentation", UseTab, FormatStyle::UT_ForIndentation); 6626 CHECK_PARSE("UseTab: Always", UseTab, FormatStyle::UT_Always); 6627 6628 Style.ColumnLimit = 123; 6629 FormatStyle BaseStyle = getLLVMStyle(); 6630 CHECK_PARSE("BasedOnStyle: LLVM", ColumnLimit, BaseStyle.ColumnLimit); 6631 CHECK_PARSE("BasedOnStyle: LLVM\nColumnLimit: 1234", ColumnLimit, 1234u); 6632 6633 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup; 6634 CHECK_PARSE("BreakBeforeBraces: Attach", BreakBeforeBraces, 6635 FormatStyle::BS_Attach); 6636 CHECK_PARSE("BreakBeforeBraces: Linux", BreakBeforeBraces, 6637 FormatStyle::BS_Linux); 6638 CHECK_PARSE("BreakBeforeBraces: Stroustrup", BreakBeforeBraces, 6639 FormatStyle::BS_Stroustrup); 6640 6641 Style.NamespaceIndentation = FormatStyle::NI_All; 6642 CHECK_PARSE("NamespaceIndentation: None", NamespaceIndentation, 6643 FormatStyle::NI_None); 6644 CHECK_PARSE("NamespaceIndentation: Inner", NamespaceIndentation, 6645 FormatStyle::NI_Inner); 6646 CHECK_PARSE("NamespaceIndentation: All", NamespaceIndentation, 6647 FormatStyle::NI_All); 6648 6649 #undef CHECK_PARSE 6650 #undef CHECK_PARSE_BOOL 6651 } 6652 6653 TEST_F(FormatTest, ConfigurationRoundTripTest) { 6654 FormatStyle Style = getLLVMStyle(); 6655 std::string YAML = configurationAsText(Style); 6656 FormatStyle ParsedStyle = {}; 6657 EXPECT_EQ(0, parseConfiguration(YAML, &ParsedStyle).value()); 6658 EXPECT_EQ(Style, ParsedStyle); 6659 } 6660 6661 TEST_F(FormatTest, WorksFor8bitEncodings) { 6662 EXPECT_EQ("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 \"\n" 6663 "\"\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \"\n" 6664 "\"\xe7\xe8\xec\xed\xfe\xfe \"\n" 6665 "\"\xef\xee\xf0\xf3...\"", 6666 format("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 " 6667 "\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \xe7\xe8\xec\xed\xfe\xfe " 6668 "\xef\xee\xf0\xf3...\"", 6669 getLLVMStyleWithColumns(12))); 6670 } 6671 6672 // FIXME: Encode Cyrillic and CJK characters below to appease MS compilers. 6673 #if !defined(_MSC_VER) 6674 6675 TEST_F(FormatTest, CountsUTF8CharactersProperly) { 6676 verifyFormat("\"Однажды в студёную зимнюю пору...\"", 6677 getLLVMStyleWithColumns(35)); 6678 verifyFormat("\"一 二 三 四 五 六 七 八 九 十\"", 6679 getLLVMStyleWithColumns(31)); 6680 verifyFormat("// Однажды в студёную зимнюю пору...", 6681 getLLVMStyleWithColumns(36)); 6682 verifyFormat("// 一 二 三 四 五 六 七 八 九 十", 6683 getLLVMStyleWithColumns(32)); 6684 verifyFormat("/* Однажды в студёную зимнюю пору... */", 6685 getLLVMStyleWithColumns(39)); 6686 verifyFormat("/* 一 二 三 四 五 六 七 八 九 十 */", 6687 getLLVMStyleWithColumns(35)); 6688 } 6689 6690 TEST_F(FormatTest, SplitsUTF8Strings) { 6691 EXPECT_EQ( 6692 "\"Однажды, в \"\n" 6693 "\"студёную \"\n" 6694 "\"зимнюю \"\n" 6695 "\"пору,\"", 6696 format("\"Однажды, в студёную зимнюю пору,\"", 6697 getLLVMStyleWithColumns(13))); 6698 EXPECT_EQ("\"一 二 三 \"\n" 6699 "\"四 五六 \"\n" 6700 "\"七 八 九 \"\n" 6701 "\"十\"", 6702 format("\"一 二 三 四 五六 七 八 九 十\"", 6703 getLLVMStyleWithColumns(11))); 6704 EXPECT_EQ("\"一\t二 \"\n" 6705 "\"\t三 \"\n" 6706 "\"四 五\t六 \"\n" 6707 "\"\t七 \"\n" 6708 "\"八九十\tqq\"", 6709 format("\"一\t二 \t三 四 五\t六 \t七 八九十\tqq\"", 6710 getLLVMStyleWithColumns(11))); 6711 } 6712 6713 6714 TEST_F(FormatTest, HandlesDoubleWidthCharsInMultiLineStrings) { 6715 EXPECT_EQ("const char *sssss =\n" 6716 " \"一二三四五六七八\\\n" 6717 " 九 十\";", 6718 format("const char *sssss = \"一二三四五六七八\\\n" 6719 " 九 十\";", 6720 getLLVMStyleWithColumns(30))); 6721 } 6722 6723 TEST_F(FormatTest, SplitsUTF8LineComments) { 6724 EXPECT_EQ("// Я из лесу\n" 6725 "// вышел; был\n" 6726 "// сильный\n" 6727 "// мороз.", 6728 format("// Я из лесу вышел; был сильный мороз.", 6729 getLLVMStyleWithColumns(13))); 6730 EXPECT_EQ("// 一二三\n" 6731 "// 四五六七\n" 6732 "// 八 九\n" 6733 "// 十", 6734 format("// 一二三 四五六七 八 九 十", getLLVMStyleWithColumns(9))); 6735 } 6736 6737 TEST_F(FormatTest, SplitsUTF8BlockComments) { 6738 EXPECT_EQ("/* Гляжу,\n" 6739 " * поднимается\n" 6740 " * медленно в\n" 6741 " * гору\n" 6742 " * Лошадка,\n" 6743 " * везущая\n" 6744 " * хворосту\n" 6745 " * воз. */", 6746 format("/* Гляжу, поднимается медленно в гору\n" 6747 " * Лошадка, везущая хворосту воз. */", 6748 getLLVMStyleWithColumns(13))); 6749 EXPECT_EQ( 6750 "/* 一二三\n" 6751 " * 四五六七\n" 6752 " * 八 九\n" 6753 " * 十 */", 6754 format("/* 一二三 四五六七 八 九 十 */", getLLVMStyleWithColumns(9))); 6755 EXPECT_EQ("/* �������� ��������\n" 6756 " * ��������\n" 6757 " * ������-�� */", 6758 format("/* �������� �������� �������� ������-�� */", getLLVMStyleWithColumns(12))); 6759 } 6760 6761 #endif // _MSC_VER 6762 6763 TEST_F(FormatTest, ConstructorInitializerIndentWidth) { 6764 FormatStyle Style = getLLVMStyle(); 6765 6766 Style.ConstructorInitializerIndentWidth = 4; 6767 verifyFormat( 6768 "SomeClass::Constructor()\n" 6769 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 6770 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 6771 Style); 6772 6773 Style.ConstructorInitializerIndentWidth = 2; 6774 verifyFormat( 6775 "SomeClass::Constructor()\n" 6776 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 6777 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 6778 Style); 6779 6780 Style.ConstructorInitializerIndentWidth = 0; 6781 verifyFormat( 6782 "SomeClass::Constructor()\n" 6783 ": aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 6784 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 6785 Style); 6786 6787 Style.BreakConstructorInitializersBeforeComma = true; 6788 Style.ConstructorInitializerIndentWidth = 4; 6789 verifyFormat("SomeClass::Constructor()\n" 6790 " : a(a)\n" 6791 " , b(b)\n" 6792 " , c(c) {}", 6793 Style); 6794 6795 Style.ConstructorInitializerIndentWidth = 2; 6796 verifyFormat("SomeClass::Constructor()\n" 6797 " : a(a)\n" 6798 " , b(b)\n" 6799 " , c(c) {}", 6800 Style); 6801 6802 Style.ConstructorInitializerIndentWidth = 0; 6803 verifyFormat("SomeClass::Constructor()\n" 6804 ": a(a)\n" 6805 ", b(b)\n" 6806 ", c(c) {}", 6807 Style); 6808 6809 Style.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 6810 Style.ConstructorInitializerIndentWidth = 4; 6811 verifyFormat( 6812 "SomeClass::Constructor()\n" 6813 " : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa) {}", 6814 Style); 6815 Style.ConstructorInitializerIndentWidth = 4; 6816 Style.ColumnLimit = 60; 6817 verifyFormat("SomeClass::Constructor()\n" 6818 " : aaaaaaaa(aaaaaaaa)\n" 6819 " , aaaaaaaa(aaaaaaaa)\n" 6820 " , aaaaaaaa(aaaaaaaa) {}", 6821 Style); 6822 } 6823 6824 TEST_F(FormatTest, FormatsWithWebKitStyle) { 6825 FormatStyle Style = getWebKitStyle(); 6826 6827 // Don't indent in outer namespaces. 6828 verifyFormat("namespace outer {\n" 6829 "int i;\n" 6830 "namespace inner {\n" 6831 " int i;\n" 6832 "} // namespace inner\n" 6833 "} // namespace outer\n" 6834 "namespace other_outer {\n" 6835 "int i;\n" 6836 "}", 6837 Style); 6838 6839 // Don't indent case labels. 6840 verifyFormat("switch (variable) {\n" 6841 "case 1:\n" 6842 "case 2:\n" 6843 " doSomething();\n" 6844 " break;\n" 6845 "default:\n" 6846 " ++variable;\n" 6847 "}", 6848 Style); 6849 6850 // Wrap before binary operators. 6851 EXPECT_EQ( 6852 "void f()\n" 6853 "{\n" 6854 " if (aaaaaaaaaaaaaaaa\n" 6855 " && bbbbbbbbbbbbbbbbbbbbbbbb\n" 6856 " && (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n" 6857 " return;\n" 6858 "}", 6859 format( 6860 "void f() {\n" 6861 "if (aaaaaaaaaaaaaaaa\n" 6862 "&& bbbbbbbbbbbbbbbbbbbbbbbb\n" 6863 "&& (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n" 6864 "return;\n" 6865 "}", 6866 Style)); 6867 6868 // Constructor initializers are formatted one per line with the "," on the 6869 // new line. 6870 verifyFormat("Constructor()\n" 6871 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 6872 " , aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaa, // break\n" 6873 " aaaaaaaaaaaaaa)\n" 6874 " , aaaaaaaaaaaaaaaaaaaaaaa()\n{\n}", 6875 Style); 6876 6877 // Access specifiers should be aligned left. 6878 verifyFormat("class C {\n" 6879 "public:\n" 6880 " int i;\n" 6881 "};", 6882 Style); 6883 6884 // Do not align comments. 6885 verifyFormat("int a; // Do not\n" 6886 "double b; // align comments.", 6887 Style); 6888 6889 // Accept input's line breaks. 6890 EXPECT_EQ("if (aaaaaaaaaaaaaaa\n" 6891 " || bbbbbbbbbbbbbbb) {\n" 6892 " i++;\n" 6893 "}", 6894 format("if (aaaaaaaaaaaaaaa\n" 6895 "|| bbbbbbbbbbbbbbb) { i++; }", 6896 Style)); 6897 EXPECT_EQ("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) {\n" 6898 " i++;\n" 6899 "}", 6900 format("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) { i++; }", Style)); 6901 } 6902 6903 TEST_F(FormatTest, FormatsProtocolBufferDefinitions) { 6904 // It seems that clang-format can format protocol buffer definitions 6905 // (see https://code.google.com/p/protobuf/). 6906 verifyFormat("message SomeMessage {\n" 6907 " required int32 field1 = 1;\n" 6908 " optional string field2 = 2 [default = \"2\"]\n" 6909 "}"); 6910 } 6911 6912 TEST_F(FormatTest, FormatsLambdas) { 6913 verifyFormat("int c = [b]() mutable {\n" 6914 " return [&b] { return b++; }();\n" 6915 "}();\n"); 6916 verifyFormat("int c = [&] {\n" 6917 " [=] { return b++; }();\n" 6918 "}();\n"); 6919 verifyFormat("int c = [&, &a, a] {\n" 6920 " [=, c, &d] { return b++; }();\n" 6921 "}();\n"); 6922 verifyFormat("int c = [&a, &a, a] {\n" 6923 " [=, a, b, &c] { return b++; }();\n" 6924 "}();\n"); 6925 verifyFormat("auto c = { [&a, &a, a] {\n" 6926 " [=, a, b, &c] { return b++; }();\n" 6927 "} }\n"); 6928 verifyFormat("auto c = { [&a, &a, a] { [=, a, b, &c] {}(); } }\n"); 6929 verifyFormat("void f() {\n" 6930 " other(x.begin(), x.end(), [&](int, int) { return 1; });\n" 6931 "}\n"); 6932 verifyFormat("void f() {\n" 6933 " other(x.begin(), //\n" 6934 " x.end(), //\n" 6935 " [&](int, int) { return 1; });\n" 6936 "}\n"); 6937 6938 // Not lambdas. 6939 verifyFormat("constexpr char hello[]{ \"hello\" };"); 6940 verifyFormat("double &operator[](int i) { return 0; }\n" 6941 "int i;"); 6942 } 6943 6944 TEST_F(FormatTest, FormatsBlocks) { 6945 // FIXME: Make whitespace formatting consistent. Ask a ObjC dev how 6946 // it would ideally look. 6947 verifyFormat("[operation setCompletionBlock:^{ [self onOperationDone]; }];"); 6948 verifyFormat("int i = {[operation setCompletionBlock : ^{ [self " 6949 "onOperationDone]; }] };"); 6950 } 6951 6952 TEST_F(FormatTest, SupportsCRLF) { 6953 EXPECT_EQ("int a;\r\n" 6954 "int b;\r\n" 6955 "int c;\r\n", 6956 format("int a;\r\n" 6957 " int b;\r\n" 6958 " int c;\r\n", 6959 getLLVMStyle())); 6960 EXPECT_EQ("int a;\r\n" 6961 "int b;\r\n" 6962 "int c;\r\n", 6963 format("int a;\r\n" 6964 " int b;\n" 6965 " int c;\r\n", 6966 getLLVMStyle())); 6967 EXPECT_EQ("int a;\n" 6968 "int b;\n" 6969 "int c;\n", 6970 format("int a;\r\n" 6971 " int b;\n" 6972 " int c;\n", 6973 getLLVMStyle())); 6974 EXPECT_EQ("\"aaaaaaa \"\r\n" 6975 "\"bbbbbbb\";\r\n", 6976 format("\"aaaaaaa bbbbbbb\";\r\n", getLLVMStyleWithColumns(10))); 6977 EXPECT_EQ("#define A \\\r\n" 6978 " b; \\\r\n" 6979 " c; \\\r\n" 6980 " d;\r\n", 6981 format("#define A \\\r\n" 6982 " b; \\\r\n" 6983 " c; d; \r\n", 6984 getGoogleStyle())); 6985 } 6986 6987 TEST_F(FormatTest, MunchSemicolonAfterBlocks) { 6988 verifyFormat("MY_CLASS(C) {\n" 6989 " int i;\n" 6990 " int j;\n" 6991 "};"); 6992 } 6993 6994 TEST_F(FormatTest, ConfigurableContinuationIndentWidth) { 6995 FormatStyle TwoIndent = getLLVMStyleWithColumns(15); 6996 TwoIndent.ContinuationIndentWidth = 2; 6997 6998 EXPECT_EQ("int i =\n" 6999 " longFunction(\n" 7000 " arg);", 7001 format("int i = longFunction(arg);", TwoIndent)); 7002 7003 FormatStyle SixIndent = getLLVMStyleWithColumns(20); 7004 SixIndent.ContinuationIndentWidth = 6; 7005 7006 EXPECT_EQ("int i =\n" 7007 " longFunction(\n" 7008 " arg);", 7009 format("int i = longFunction(arg);", SixIndent)); 7010 } 7011 7012 } // end namespace tooling 7013 } // end namespace clang 7014