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 // FIXME: We might at some point want to handle this similar to parameter 1868 // lists, where we have an option to put each on a single line. 1869 verifyFormat( 1870 "struct {\n" 1871 " unsigned bit;\n" 1872 " const char *const name;\n" 1873 "} kBitsToOs[] = { { kOsMac, \"Mac\" }, { kOsWin, \"Windows\" },\n" 1874 " { kOsLinux, \"Linux\" }, { 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 } 2337 2338 TEST_F(FormatTest, FormatsJoinedLinesOnSubsequentRuns) { 2339 FormatStyle SingleLine = getLLVMStyle(); 2340 SingleLine.AllowShortIfStatementsOnASingleLine = true; 2341 verifyFormat( 2342 "#if 0\n" 2343 "#elif 1\n" 2344 "#endif\n" 2345 "void foo() {\n" 2346 " if (test) foo2();\n" 2347 "}", 2348 SingleLine); 2349 } 2350 2351 TEST_F(FormatTest, LayoutBlockInsideParens) { 2352 EXPECT_EQ("functionCall({ int i; });", format(" functionCall ( {int i;} );")); 2353 EXPECT_EQ("functionCall({\n" 2354 " int i;\n" 2355 " int j;\n" 2356 "});", 2357 format(" functionCall ( {int i;int j;} );")); 2358 EXPECT_EQ("functionCall({\n" 2359 " int i;\n" 2360 " int j;\n" 2361 " },\n" 2362 " aaaa, bbbb, cccc);", 2363 format(" functionCall ( {int i;int j;}, aaaa, bbbb, cccc);")); 2364 EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });", 2365 format(" functionCall (aaaa, bbbb, {int i;});")); 2366 EXPECT_EQ("functionCall(aaaa, bbbb, {\n" 2367 " int i;\n" 2368 " int j;\n" 2369 "});", 2370 format(" functionCall (aaaa, bbbb, {int i;int j;});")); 2371 EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });", 2372 format(" functionCall (aaaa, bbbb, {int i;});")); 2373 verifyFormat( 2374 "Aaa({\n" 2375 " int i; // break\n" 2376 " },\n" 2377 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 2378 " ccccccccccccccccc));"); 2379 verifyFormat("DEBUG({\n" 2380 " if (a)\n" 2381 " f();\n" 2382 "});"); 2383 } 2384 2385 TEST_F(FormatTest, LayoutBlockInsideStatement) { 2386 EXPECT_EQ("SOME_MACRO { int i; }\n" 2387 "int i;", 2388 format(" SOME_MACRO {int i;} int i;")); 2389 } 2390 2391 TEST_F(FormatTest, LayoutNestedBlocks) { 2392 verifyFormat("void AddOsStrings(unsigned bitmask) {\n" 2393 " struct s {\n" 2394 " int i;\n" 2395 " };\n" 2396 " s kBitsToOs[] = { { 10 } };\n" 2397 " for (int i = 0; i < 10; ++i)\n" 2398 " return;\n" 2399 "}"); 2400 verifyFormat("call(parameter, {\n" 2401 " something();\n" 2402 " // Comment using all columns.\n" 2403 " somethingelse();\n" 2404 "});", 2405 getLLVMStyleWithColumns(40)); 2406 EXPECT_EQ("call(parameter, {\n" 2407 " something();\n" 2408 " // Comment too\n" 2409 " // looooooooooong.\n" 2410 " somethingElse();\n" 2411 "});", 2412 format("call(parameter, {\n" 2413 " something();\n" 2414 " // Comment too looooooooooong.\n" 2415 " somethingElse();\n" 2416 "});", 2417 getLLVMStyleWithColumns(29))); 2418 EXPECT_EQ("DEBUG({ int i; });", format("DEBUG({ int i; });")); 2419 EXPECT_EQ("DEBUG({ // comment\n" 2420 " int i;\n" 2421 "});", 2422 format("DEBUG({ // comment\n" 2423 "int i;\n" 2424 "});")); 2425 EXPECT_EQ("DEBUG({\n" 2426 " int i;\n" 2427 "\n" 2428 " // comment\n" 2429 " int j;\n" 2430 "});", 2431 format("DEBUG({\n" 2432 " int i;\n" 2433 "\n" 2434 " // comment\n" 2435 " int j;\n" 2436 "});")); 2437 } 2438 2439 TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) { 2440 EXPECT_EQ("{}", format("{}")); 2441 verifyFormat("enum E {};"); 2442 verifyFormat("enum E {}"); 2443 } 2444 2445 //===----------------------------------------------------------------------===// 2446 // Line break tests. 2447 //===----------------------------------------------------------------------===// 2448 2449 TEST_F(FormatTest, PreventConfusingIndents) { 2450 verifyFormat( 2451 "SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n" 2452 " parameter, parameter, parameter)),\n" 2453 " SecondLongCall(parameter));"); 2454 verifyFormat( 2455 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2456 " aaaaaaaaaaaaaaaaaaaaaaaa(\n" 2457 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2458 " aaaaaaaaaaaaaaaaaaaaaaaa);"); 2459 verifyFormat( 2460 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2461 " [aaaaaaaaaaaaaaaaaaaaaaaa\n" 2462 " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n" 2463 " [aaaaaaaaaaaaaaaaaaaaaaaa]];"); 2464 verifyFormat( 2465 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" 2466 " aaaaaaaaaaaaaaaaaaaaaaaa<\n" 2467 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>,\n" 2468 " aaaaaaaaaaaaaaaaaaaaaaaa>;"); 2469 verifyFormat("int a = bbbb && ccc && fffff(\n" 2470 "#define A Just forcing a new line\n" 2471 " ddd);"); 2472 } 2473 2474 TEST_F(FormatTest, LineBreakingInBinaryExpressions) { 2475 verifyFormat( 2476 "bool aaaaaaa =\n" 2477 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaa).aaaaaaaaaaaaaaaaaaa() ||\n" 2478 " bbbbbbbb();"); 2479 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaa =\n" 2480 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa != bbbbbbbbbbbbbbbbbb &&\n" 2481 " ccccccccc == ddddddddddd;"); 2482 2483 verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n" 2484 " aaaaaa) &&\n" 2485 " bbbbbb && cccccc;"); 2486 verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n" 2487 " aaaaaa) >>\n" 2488 " bbbbbb;"); 2489 verifyFormat("Whitespaces.addUntouchableComment(\n" 2490 " SourceMgr.getSpellingColumnNumber(\n" 2491 " TheLine.Last->FormatTok.Tok.getLocation()) -\n" 2492 " 1);"); 2493 2494 verifyFormat("if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2495 " bbbbbbbbbbbbbbbbbb) && // aaaaaaaaaaaaaaaa\n" 2496 " cccccc) {\n}"); 2497 2498 // If the LHS of a comparison is not a binary expression itself, the 2499 // additional linebreak confuses many people. 2500 verifyFormat( 2501 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2502 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) > 5) {\n" 2503 "}"); 2504 verifyFormat( 2505 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2506 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" 2507 "}"); 2508 verifyFormat( 2509 "if (aaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaa(\n" 2510 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" 2511 "}"); 2512 // Even explicit parentheses stress the precedence enough to make the 2513 // additional break unnecessary. 2514 verifyFormat( 2515 "if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2516 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" 2517 "}"); 2518 // This cases is borderline, but with the indentation it is still readable. 2519 verifyFormat( 2520 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2521 " aaaaaaaaaaaaaaa) > aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2522 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 2523 "}", 2524 getLLVMStyleWithColumns(75)); 2525 2526 // If the LHS is a binary expression, we should still use the additional break 2527 // as otherwise the formatting hides the operator precedence. 2528 verifyFormat( 2529 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2530 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2531 " 5) {\n" 2532 "}"); 2533 2534 FormatStyle OnePerLine = getLLVMStyle(); 2535 OnePerLine.BinPackParameters = false; 2536 verifyFormat( 2537 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2538 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2539 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}", 2540 OnePerLine); 2541 } 2542 2543 TEST_F(FormatTest, ExpressionIndentation) { 2544 verifyFormat("bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2545 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2546 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2547 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2548 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +\n" 2549 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb &&\n" 2550 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2551 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >\n" 2552 " ccccccccccccccccccccccccccccccccccccccccc;"); 2553 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2554 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2555 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2556 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2557 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2558 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2559 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2560 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2561 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 2562 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2563 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2564 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 2565 verifyFormat("if () {\n" 2566 "} else if (aaaaa && bbbbb > // break\n" 2567 " ccccc) {\n" 2568 "}"); 2569 2570 // Presence of a trailing comment used to change indentation of b. 2571 verifyFormat("return aaaaaaaaaaaaaaaaaaa +\n" 2572 " b;\n" 2573 "return aaaaaaaaaaaaaaaaaaa +\n" 2574 " b; //", 2575 getLLVMStyleWithColumns(30)); 2576 } 2577 2578 TEST_F(FormatTest, ExpressionIndentationBreakingBeforeOperators) { 2579 // Not sure what the best system is here. Like this, the LHS can be found 2580 // immediately above an operator (everything with the same or a higher 2581 // indent). The RHS is aligned right of the operator and so compasses 2582 // everything until something with the same indent as the operator is found. 2583 // FIXME: Is this a good system? 2584 FormatStyle Style = getLLVMStyle(); 2585 Style.BreakBeforeBinaryOperators = true; 2586 verifyFormat( 2587 "bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2588 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2589 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2590 " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2591 " * bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 2592 " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" 2593 " && aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2594 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2595 " > ccccccccccccccccccccccccccccccccccccccccc;", 2596 Style); 2597 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2598 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2599 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2600 " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", 2601 Style); 2602 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2603 " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2604 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2605 " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", 2606 Style); 2607 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2608 " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2609 " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2610 " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", 2611 Style); 2612 verifyFormat("if () {\n" 2613 "} else if (aaaaa && bbbbb // break\n" 2614 " > ccccc) {\n" 2615 "}", 2616 Style); 2617 } 2618 2619 TEST_F(FormatTest, ConstructorInitializers) { 2620 verifyFormat("Constructor() : Initializer(FitsOnTheLine) {}"); 2621 verifyFormat("Constructor() : Inttializer(FitsOnTheLine) {}", 2622 getLLVMStyleWithColumns(45)); 2623 verifyFormat("Constructor()\n" 2624 " : Inttializer(FitsOnTheLine) {}", 2625 getLLVMStyleWithColumns(44)); 2626 verifyFormat("Constructor()\n" 2627 " : Inttializer(FitsOnTheLine) {}", 2628 getLLVMStyleWithColumns(43)); 2629 2630 verifyFormat( 2631 "SomeClass::Constructor()\n" 2632 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); 2633 2634 verifyFormat( 2635 "SomeClass::Constructor()\n" 2636 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2637 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}"); 2638 verifyFormat( 2639 "SomeClass::Constructor()\n" 2640 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2641 " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); 2642 2643 verifyFormat("Constructor()\n" 2644 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2645 " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2646 " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2647 " aaaaaaaaaaaaaaaaaaaaaaa() {}"); 2648 2649 verifyFormat("Constructor()\n" 2650 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2651 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 2652 2653 verifyFormat("Constructor(int Parameter = 0)\n" 2654 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa),\n" 2655 " aaaaaaaaaaaa(aaaaaaaaaaaaaaaaa) {}"); 2656 verifyFormat("Constructor()\n" 2657 " : aaaaaaaaaaaaaaaaaaaa(a), bbbbbbbbbbbbbbbbbbbbbbbb(b) {\n" 2658 "}", 2659 getLLVMStyleWithColumns(60)); 2660 2661 // Here a line could be saved by splitting the second initializer onto two 2662 // lines, but that is not desireable. 2663 verifyFormat("Constructor()\n" 2664 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n" 2665 " aaaaaaaaaaa(aaaaaaaaaaa),\n" 2666 " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 2667 2668 FormatStyle OnePerLine = getLLVMStyle(); 2669 OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 2670 verifyFormat("SomeClass::Constructor()\n" 2671 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2672 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2673 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 2674 OnePerLine); 2675 verifyFormat("SomeClass::Constructor()\n" 2676 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), // Some comment\n" 2677 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 2678 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 2679 OnePerLine); 2680 verifyFormat("MyClass::MyClass(int var)\n" 2681 " : some_var_(var), // 4 space indent\n" 2682 " some_other_var_(var + 1) { // lined up\n" 2683 "}", 2684 OnePerLine); 2685 verifyFormat("Constructor()\n" 2686 " : aaaaa(aaaaaa),\n" 2687 " aaaaa(aaaaaa),\n" 2688 " aaaaa(aaaaaa),\n" 2689 " aaaaa(aaaaaa),\n" 2690 " aaaaa(aaaaaa) {}", 2691 OnePerLine); 2692 verifyFormat("Constructor()\n" 2693 " : aaaaa(aaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaa,\n" 2694 " aaaaaaaaaaaaaaaaaaaaaa) {}", 2695 OnePerLine); 2696 } 2697 2698 TEST_F(FormatTest, MemoizationTests) { 2699 // This breaks if the memoization lookup does not take \c Indent and 2700 // \c LastSpace into account. 2701 verifyFormat( 2702 "extern CFRunLoopTimerRef\n" 2703 "CFRunLoopTimerCreate(CFAllocatorRef allocato, CFAbsoluteTime fireDate,\n" 2704 " CFTimeInterval interval, CFOptionFlags flags,\n" 2705 " CFIndex order, CFRunLoopTimerCallBack callout,\n" 2706 " CFRunLoopTimerContext *context) {}"); 2707 2708 // Deep nesting somewhat works around our memoization. 2709 verifyFormat( 2710 "aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2711 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2712 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2713 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 2714 " aaaaa())))))))))))))))))))))))))))))))))))))));", 2715 getLLVMStyleWithColumns(65)); 2716 verifyFormat( 2717 "aaaaa(\n" 2718 " aaaaa,\n" 2719 " aaaaa(\n" 2720 " aaaaa,\n" 2721 " aaaaa(\n" 2722 " aaaaa,\n" 2723 " aaaaa(\n" 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))))))))))));", 2742 getLLVMStyleWithColumns(65)); 2743 verifyFormat( 2744 "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" 2745 " a),\n" 2746 " a),\n" 2747 " a),\n" 2748 " a),\n" 2749 " a),\n" 2750 " a),\n" 2751 " 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)", 2762 getLLVMStyleWithColumns(65)); 2763 2764 // This test takes VERY long when memoization is broken. 2765 FormatStyle OnePerLine = getLLVMStyle(); 2766 OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 2767 OnePerLine.BinPackParameters = false; 2768 std::string input = "Constructor()\n" 2769 " : aaaa(a,\n"; 2770 for (unsigned i = 0, e = 80; i != e; ++i) { 2771 input += " a,\n"; 2772 } 2773 input += " a) {}"; 2774 verifyFormat(input, OnePerLine); 2775 } 2776 2777 TEST_F(FormatTest, BreaksAsHighAsPossible) { 2778 verifyFormat( 2779 "void f() {\n" 2780 " if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n" 2781 " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n" 2782 " f();\n" 2783 "}"); 2784 verifyFormat("if (Intervals[i].getRange().getFirst() <\n" 2785 " Intervals[i - 1].getRange().getLast()) {\n}"); 2786 } 2787 2788 TEST_F(FormatTest, BreaksFunctionDeclarations) { 2789 // Principially, we break function declarations in a certain order: 2790 // 1) break amongst arguments. 2791 verifyFormat("Aaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccc,\n" 2792 " Cccccccccccccc cccccccccccccc);"); 2793 verifyFormat( 2794 "template <class TemplateIt>\n" 2795 "SomeReturnType SomeFunction(TemplateIt begin, TemplateIt end,\n" 2796 " TemplateIt *stop) {}"); 2797 2798 // 2) break after return type. 2799 verifyFormat( 2800 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2801 " bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccccccccccccccc);", 2802 getGoogleStyle()); 2803 2804 // 3) break after (. 2805 verifyFormat( 2806 "Aaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb(\n" 2807 " Cccccccccccccccccccccccccccccc cccccccccccccccccccccccccccccccc);", 2808 getGoogleStyle()); 2809 2810 // 4) break before after nested name specifiers. 2811 verifyFormat( 2812 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2813 " SomeClasssssssssssssssssssssssssssssssssssssss::\n" 2814 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc);", 2815 getGoogleStyle()); 2816 2817 // However, there are exceptions, if a sufficient amount of lines can be 2818 // saved. 2819 // FIXME: The precise cut-offs wrt. the number of saved lines might need some 2820 // more adjusting. 2821 verifyFormat("Aaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" 2822 " Cccccccccccccc cccccccccc,\n" 2823 " Cccccccccccccc cccccccccc,\n" 2824 " Cccccccccccccc cccccccccc,\n" 2825 " Cccccccccccccc cccccccccc);"); 2826 verifyFormat( 2827 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2828 " bbbbbbbbbbb(Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2829 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2830 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);", 2831 getGoogleStyle()); 2832 verifyFormat( 2833 "Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" 2834 " Cccccccccccccc cccccccccc,\n" 2835 " Cccccccccccccc cccccccccc,\n" 2836 " Cccccccccccccc cccccccccc,\n" 2837 " Cccccccccccccc cccccccccc,\n" 2838 " Cccccccccccccc cccccccccc,\n" 2839 " Cccccccccccccc cccccccccc);"); 2840 verifyFormat("Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n" 2841 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2842 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2843 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 2844 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);"); 2845 2846 // Break after multi-line parameters. 2847 verifyFormat("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2848 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2849 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2850 " bbbb bbbb);"); 2851 2852 // Treat overloaded operators like other functions. 2853 verifyFormat("SomeLoooooooooooooooooooooooooogType\n" 2854 "operator>(const SomeLoooooooooooooooooooooooooogType &other);"); 2855 verifyFormat("SomeLoooooooooooooooooooooooooogType\n" 2856 "operator>>(const SomeLooooooooooooooooooooooooogType &other);"); 2857 verifyGoogleFormat( 2858 "SomeLoooooooooooooooooooooooooooooogType operator<<(\n" 2859 " const SomeLooooooooogType &a, const SomeLooooooooogType &b);"); 2860 } 2861 2862 TEST_F(FormatTest, TrailingReturnType) { 2863 verifyFormat("auto foo() -> int;\n"); 2864 verifyFormat("struct S {\n" 2865 " auto bar() const -> int;\n" 2866 "};"); 2867 verifyFormat("template <size_t Order, typename T>\n" 2868 "auto load_img(const std::string &filename)\n" 2869 " -> alias::tensor<Order, T, mem::tag::cpu> {}"); 2870 2871 // Not trailing return types. 2872 verifyFormat("void f() { auto a = b->c(); }"); 2873 } 2874 2875 TEST_F(FormatTest, BreaksFunctionDeclarationsWithTrailingTokens) { 2876 // Avoid breaking before trailing 'const' or other trailing annotations, if 2877 // they are not function-like. 2878 FormatStyle Style = getGoogleStyle(); 2879 Style.ColumnLimit = 47; 2880 verifyFormat("void\n" 2881 "someLongFunction(int someLongParameter) const {\n}", 2882 getLLVMStyleWithColumns(47)); 2883 verifyFormat("LoooooongReturnType\n" 2884 "someLoooooooongFunction() const {}", 2885 getLLVMStyleWithColumns(47)); 2886 verifyFormat("LoooooongReturnType someLoooooooongFunction()\n" 2887 " const {}", 2888 Style); 2889 verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" 2890 " aaaaa aaaaaaaaaaaaaaaaaaaa) OVERRIDE;"); 2891 verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" 2892 " aaaaa aaaaaaaaaaaaaaaaaaaa) OVERRIDE FINAL;"); 2893 verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" 2894 " aaaaa aaaaaaaaaaaaaaaaaaaa) override final;"); 2895 2896 // Unless this would lead to the first parameter being broken. 2897 verifyFormat("void someLongFunction(int someLongParameter)\n" 2898 " const {}", 2899 getLLVMStyleWithColumns(46)); 2900 verifyFormat("void someLongFunction(int someLongParameter)\n" 2901 " const {}", 2902 Style); 2903 verifyFormat("void SomeFunction(aaaaaaaaaa aaaaaaaaaaaaaaa,\n" 2904 " aaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2905 " LONG_AND_UGLY_ANNOTATION;"); 2906 2907 // Breaking before function-like trailing annotations is fine to keep them 2908 // close to their arguments. 2909 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2910 " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); 2911 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" 2912 " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); 2913 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" 2914 " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}"); 2915 2916 verifyFormat( 2917 "void aaaaaaaaaaaaaaaaaa()\n" 2918 " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n" 2919 " aaaaaaaaaaaaaaaaaaaaaaaaa));"); 2920 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2921 " __attribute__((unused));"); 2922 verifyFormat( 2923 "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2924 " GUARDED_BY(aaaaaaaaaaaa);", 2925 getGoogleStyle()); 2926 verifyFormat( 2927 "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2928 " GUARDED_BY(aaaaaaaaaaaa);", 2929 getGoogleStyle()); 2930 } 2931 2932 TEST_F(FormatTest, BreaksDesireably) { 2933 verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" 2934 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" 2935 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {\n}"); 2936 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2937 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)) {\n" 2938 "}"); 2939 2940 verifyFormat( 2941 "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2942 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 2943 2944 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2945 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2946 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2947 2948 verifyFormat( 2949 "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2950 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" 2951 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2952 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));"); 2953 2954 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 2955 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2956 2957 verifyFormat( 2958 "void f() {\n" 2959 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" 2960 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 2961 "}"); 2962 verifyFormat( 2963 "aaaaaa(new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2964 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2965 verifyFormat( 2966 "aaaaaa(aaa, new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2967 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2968 verifyFormat( 2969 "aaaaaaaaaaaaaaaaa(\n" 2970 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2971 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2972 2973 // Indent consistently indenpendent of call expression. 2974 verifyFormat("aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbb.ccccccccccccccccc(\n" 2975 " dddddddddddddddddddddddddddddd));\n" 2976 "aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n" 2977 " dddddddddddddddddddddddddddddd));"); 2978 2979 // This test case breaks on an incorrect memoization, i.e. an optimization not 2980 // taking into account the StopAt value. 2981 verifyFormat( 2982 "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 2983 " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 2984 " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 2985 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2986 2987 verifyFormat("{\n {\n {\n" 2988 " Annotation.SpaceRequiredBefore =\n" 2989 " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n" 2990 " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n" 2991 " }\n }\n}"); 2992 2993 // Break on an outer level if there was a break on an inner level. 2994 EXPECT_EQ("f(g(h(a, // comment\n" 2995 " b, c),\n" 2996 " d, e),\n" 2997 " x, y);", 2998 format("f(g(h(a, // comment\n" 2999 " b, c), d, e), x, y);")); 3000 3001 // Prefer breaking similar line breaks. 3002 verifyFormat( 3003 "const int kTrackingOptions = NSTrackingMouseMoved |\n" 3004 " NSTrackingMouseEnteredAndExited |\n" 3005 " NSTrackingActiveAlways;"); 3006 } 3007 3008 TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { 3009 FormatStyle NoBinPacking = getGoogleStyle(); 3010 NoBinPacking.BinPackParameters = false; 3011 verifyFormat("f(aaaaaaaaaaaaaaaaaaaa,\n" 3012 " aaaaaaaaaaaaaaaaaaaa,\n" 3013 " aaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaa);", 3014 NoBinPacking); 3015 verifyFormat("aaaaaaa(aaaaaaaaaaaaa,\n" 3016 " aaaaaaaaaaaaa,\n" 3017 " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));", 3018 NoBinPacking); 3019 verifyFormat( 3020 "aaaaaaaa(aaaaaaaaaaaaa,\n" 3021 " aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3022 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" 3023 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3024 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));", 3025 NoBinPacking); 3026 verifyFormat("aaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" 3027 " .aaaaaaaaaaaaaaaaaa();", 3028 NoBinPacking); 3029 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3030 " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);", 3031 NoBinPacking); 3032 3033 verifyFormat( 3034 "aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3035 " aaaaaaaaaaaa,\n" 3036 " aaaaaaaaaaaa);", 3037 NoBinPacking); 3038 verifyFormat( 3039 "somefunction(someotherFunction(ddddddddddddddddddddddddddddddddddd,\n" 3040 " ddddddddddddddddddddddddddddd),\n" 3041 " test);", 3042 NoBinPacking); 3043 3044 verifyFormat("std::vector<aaaaaaaaaaaaaaaaaaaaaaa,\n" 3045 " aaaaaaaaaaaaaaaaaaaaaaa,\n" 3046 " aaaaaaaaaaaaaaaaaaaaaaa> aaaaaaaaaaaaaaaaaa;", 3047 NoBinPacking); 3048 verifyFormat("a(\"a\"\n" 3049 " \"a\",\n" 3050 " a);"); 3051 3052 NoBinPacking.AllowAllParametersOfDeclarationOnNextLine = false; 3053 verifyFormat("void aaaaaaaaaa(aaaaaaaaa,\n" 3054 " aaaaaaaaa,\n" 3055 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", 3056 NoBinPacking); 3057 verifyFormat( 3058 "void f() {\n" 3059 " aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" 3060 " .aaaaaaa();\n" 3061 "}", 3062 NoBinPacking); 3063 verifyFormat( 3064 "template <class SomeType, class SomeOtherType>\n" 3065 "SomeType SomeFunction(SomeType Type, SomeOtherType OtherType) {}", 3066 NoBinPacking); 3067 } 3068 3069 TEST_F(FormatTest, AdaptiveOnePerLineFormatting) { 3070 FormatStyle Style = getLLVMStyleWithColumns(15); 3071 Style.ExperimentalAutoDetectBinPacking = true; 3072 EXPECT_EQ("aaa(aaaa,\n" 3073 " aaaa,\n" 3074 " aaaa);\n" 3075 "aaa(aaaa,\n" 3076 " aaaa,\n" 3077 " aaaa);", 3078 format("aaa(aaaa,\n" // one-per-line 3079 " aaaa,\n" 3080 " aaaa );\n" 3081 "aaa(aaaa, aaaa, aaaa);", // inconclusive 3082 Style)); 3083 EXPECT_EQ("aaa(aaaa, aaaa,\n" 3084 " aaaa);\n" 3085 "aaa(aaaa, aaaa,\n" 3086 " aaaa);", 3087 format("aaa(aaaa, aaaa,\n" // bin-packed 3088 " aaaa );\n" 3089 "aaa(aaaa, aaaa, aaaa);", // inconclusive 3090 Style)); 3091 } 3092 3093 TEST_F(FormatTest, FormatsBuilderPattern) { 3094 verifyFormat( 3095 "return llvm::StringSwitch<Reference::Kind>(name)\n" 3096 " .StartsWith(\".eh_frame_hdr\", ORDER_EH_FRAMEHDR)\n" 3097 " .StartsWith(\".eh_frame\", ORDER_EH_FRAME)\n" 3098 " .StartsWith(\".init\", ORDER_INIT)\n" 3099 " .StartsWith(\".fini\", ORDER_FINI)\n" 3100 " .StartsWith(\".hash\", ORDER_HASH)\n" 3101 " .Default(ORDER_TEXT);\n"); 3102 3103 verifyFormat("return aaaaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa() <\n" 3104 " aaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa();"); 3105 verifyFormat( 3106 "aaaaaaa->aaaaaaa->aaaaaaaaaaaaaaaa(\n" 3107 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3108 " ->aaaaaaaa(aaaaaaaaaaaaaaa);"); 3109 verifyFormat( 3110 "aaaaaaaaaaaaaaaaaaa()->aaaaaa(bbbbb)->aaaaaaaaaaaaaaaaaaa( // break\n" 3111 " aaaaaaaaaaaaaa);"); 3112 verifyFormat( 3113 "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa =\n" 3114 " aaaaaa->aaaaaaaaaaaa()\n" 3115 " ->aaaaaaaaaaaaaaaa(\n" 3116 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3117 " ->aaaaaaaaaaaaaaaaa();"); 3118 verifyFormat( 3119 "someobj->Add((new util::filetools::Handler(dir))\n" 3120 " ->OnEvent1(NewPermanentCallback(\n" 3121 " this, &HandlerHolderClass::EventHandlerCBA))\n" 3122 " ->OnEvent2(NewPermanentCallback(\n" 3123 " this, &HandlerHolderClass::EventHandlerCBB))\n" 3124 " ->OnEvent3(NewPermanentCallback(\n" 3125 " this, &HandlerHolderClass::EventHandlerCBC))\n" 3126 " ->OnEvent5(NewPermanentCallback(\n" 3127 " this, &HandlerHolderClass::EventHandlerCBD))\n" 3128 " ->OnEvent6(NewPermanentCallback(\n" 3129 " this, &HandlerHolderClass::EventHandlerCBE)));"); 3130 3131 verifyFormat( 3132 "aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa();"); 3133 verifyFormat("aaaaaaaaaaaaaaa()\n" 3134 " .aaaaaaaaaaaaaaa()\n" 3135 " .aaaaaaaaaaaaaaa()\n" 3136 " .aaaaaaaaaaaaaaa()\n" 3137 " .aaaaaaaaaaaaaaa();"); 3138 verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" 3139 " .aaaaaaaaaaaaaaa()\n" 3140 " .aaaaaaaaaaaaaaa()\n" 3141 " .aaaaaaaaaaaaaaa();"); 3142 verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" 3143 " .aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" 3144 " .aaaaaaaaaaaaaaa();"); 3145 verifyFormat("aaaaaaaaaaaaa->aaaaaaaaaaaaaaaaaaaaaaaa()\n" 3146 " ->aaaaaaaaaaaaaae(0)\n" 3147 " ->aaaaaaaaaaaaaaa();"); 3148 3149 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaa()\n" 3150 " .aaaaaaaaaaaaaaaaaaaaaaaaaa()\n" 3151 " .has<bbbbbbbbbbbbbbbbbbbbb>();"); 3152 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaa()\n" 3153 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" 3154 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>();"); 3155 3156 // Prefer not to break after empty parentheses. 3157 verifyFormat("FirstToken->WhitespaceRange.getBegin().getLocWithOffset(\n" 3158 " First->LastNewlineOffset);"); 3159 } 3160 3161 TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) { 3162 verifyFormat( 3163 "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 3164 " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {\n}"); 3165 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" 3166 " ccccccccccccccccccccccccc) {\n}"); 3167 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" 3168 " ccccccccccccccccccccccccc) {\n}"); 3169 verifyFormat( 3170 "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n" 3171 " ccccccccccccccccccccccccc) {\n}"); 3172 verifyFormat("return aaaa & AAAAAAAAAAAAAAAAAAAAAAAAAAAAA ||\n" 3173 " bbbb & BBBBBBBBBBBBBBBBBBBBBBBBBBBBB ||\n" 3174 " cccc & CCCCCCCCCCCCCCCCCCCCCCCCCC ||\n" 3175 " dddd & DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD;"); 3176 verifyFormat("if ((aaaaaaaaaa != aaaaaaaaaaaaaaa ||\n" 3177 " aaaaaaaaaaaaaaaaaaaaaaaa() >= aaaaaaaaaaaaaaaaaaaa) &&\n" 3178 " aaaaaaaaaaaaaaa != aa) {\n}"); 3179 } 3180 3181 TEST_F(FormatTest, BreaksAfterAssignments) { 3182 verifyFormat( 3183 "unsigned Cost =\n" 3184 " TTI.getMemoryOpCost(I->getOpcode(), VectorTy, SI->getAlignment(),\n" 3185 " SI->getPointerAddressSpaceee());\n"); 3186 verifyFormat( 3187 "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n" 3188 " Line.Tokens.front().Tok.getLo(), Line.Tokens.back().Tok.getLoc());"); 3189 3190 verifyFormat( 3191 "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa().aaaaaaaaa(\n" 3192 " aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);"); 3193 verifyFormat("unsigned OriginalStartColumn =\n" 3194 " SourceMgr.getSpellingColumnNumber(\n" 3195 " Current.FormatTok.getStartOfNonWhitespace()) -\n" 3196 " 1;"); 3197 } 3198 3199 TEST_F(FormatTest, AlignsAfterAssignments) { 3200 verifyFormat( 3201 "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3202 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3203 verifyFormat( 3204 "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3205 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3206 verifyFormat( 3207 "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3208 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3209 verifyFormat( 3210 "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3211 " aaaaaaaaaaaaaaaaaaaaaaaaa);"); 3212 verifyFormat( 3213 "double LooooooooooooooooooooooooongResult = aaaaaaaaaaaaaaaaaaaaaaaa +\n" 3214 " aaaaaaaaaaaaaaaaaaaaaaaa +\n" 3215 " aaaaaaaaaaaaaaaaaaaaaaaa;"); 3216 } 3217 3218 TEST_F(FormatTest, AlignsAfterReturn) { 3219 verifyFormat( 3220 "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3221 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 3222 verifyFormat( 3223 "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 3224 " aaaaaaaaaaaaaaaaaaaaaaaaa);"); 3225 verifyFormat( 3226 "return aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" 3227 " aaaaaaaaaaaaaaaaaaaaaa();"); 3228 verifyFormat( 3229 "return (aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" 3230 " aaaaaaaaaaaaaaaaaaaaaa());"); 3231 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3232 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3233 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3234 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) &&\n" 3235 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3236 verifyFormat("return\n" 3237 " // true if code is one of a or b.\n" 3238 " code == a || code == b;"); 3239 } 3240 3241 TEST_F(FormatTest, BreaksConditionalExpressions) { 3242 verifyFormat( 3243 "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3244 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3245 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3246 verifyFormat( 3247 "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3248 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3249 verifyFormat( 3250 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaa ? aaaa(aaaaaa)\n" 3251 " : aaaaaaaaaaaaa);"); 3252 verifyFormat( 3253 "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3254 " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3255 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3256 " aaaaaaaaaaaaa);"); 3257 verifyFormat( 3258 "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3259 " aaaaaaaaaaaaaaaa ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3260 " aaaaaaaaaaaaa);"); 3261 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3262 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3263 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3264 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3265 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3266 verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3267 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3268 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3269 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3270 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3271 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 3272 " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3273 verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3274 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3275 " ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3276 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 3277 " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3278 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3279 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3280 " : aaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3281 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaa =\n" 3282 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3283 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3284 " : aaaaaaaaaaaaaaaa;"); 3285 verifyFormat( 3286 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3287 " ? aaaaaaaaaaaaaaa\n" 3288 " : aaaaaaaaaaaaaaa;"); 3289 verifyFormat("f(aaaaaaaaaaaaaaaa == // force break\n" 3290 " aaaaaaaaa\n" 3291 " ? b\n" 3292 " : c);"); 3293 verifyFormat( 3294 "unsigned Indent =\n" 3295 " format(TheLine.First, IndentForLevel[TheLine.Level] >= 0\n" 3296 " ? IndentForLevel[TheLine.Level]\n" 3297 " : TheLine * 2,\n" 3298 " TheLine.InPPDirective, PreviousEndOfLineColumn);", 3299 getLLVMStyleWithColumns(70)); 3300 verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n" 3301 " ? aaaaaaaaaaaaaaa\n" 3302 " : bbbbbbbbbbbbbbb //\n" 3303 " ? ccccccccccccccc\n" 3304 " : ddddddddddddddd;"); 3305 verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n" 3306 " ? aaaaaaaaaaaaaaa\n" 3307 " : (bbbbbbbbbbbbbbb //\n" 3308 " ? ccccccccccccccc\n" 3309 " : ddddddddddddddd);"); 3310 3311 FormatStyle NoBinPacking = getLLVMStyle(); 3312 NoBinPacking.BinPackParameters = false; 3313 verifyFormat( 3314 "void f() {\n" 3315 " g(aaa,\n" 3316 " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" 3317 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3318 " ? aaaaaaaaaaaaaaa\n" 3319 " : aaaaaaaaaaaaaaa);\n" 3320 "}", 3321 NoBinPacking); 3322 verifyFormat( 3323 "void f() {\n" 3324 " g(aaa,\n" 3325 " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" 3326 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3327 " ?: aaaaaaaaaaaaaaa);\n" 3328 "}", 3329 NoBinPacking); 3330 } 3331 3332 TEST_F(FormatTest, DeclarationsOfMultipleVariables) { 3333 verifyFormat("bool aaaaaaaaaaaaaaaaa = aaaaaa->aaaaaaaaaaaaaaaaa(),\n" 3334 " aaaaaaaaaaa = aaaaaa->aaaaaaaaaaa();"); 3335 verifyFormat("bool a = true, b = false;"); 3336 3337 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3338 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa),\n" 3339 " bbbbbbbbbbbbbbbbbbbbbbbbb =\n" 3340 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(bbbbbbbbbbbbbbbb);"); 3341 verifyFormat( 3342 "bool aaaaaaaaaaaaaaaaaaaaa =\n" 3343 " bbbbbbbbbbbbbbbbbbbbbbbbbbbb && cccccccccccccccccccccccccccc,\n" 3344 " d = e && f;"); 3345 verifyFormat("aaaaaaaaa a = aaaaaaaaaaaaaaaaaaaa, b = bbbbbbbbbbbbbbbbbbbb,\n" 3346 " c = cccccccccccccccccccc, d = dddddddddddddddddddd;"); 3347 verifyFormat("aaaaaaaaa *a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" 3348 " *c = ccccccccccccccccccc, *d = ddddddddddddddddddd;"); 3349 verifyFormat("aaaaaaaaa ***a = aaaaaaaaaaaaaaaaaaa, ***b = bbbbbbbbbbbbbbb,\n" 3350 " ***c = ccccccccccccccccccc, ***d = ddddddddddddddd;"); 3351 // FIXME: If multiple variables are defined, the "*" needs to move to the new 3352 // line. Also fix indent for breaking after the type, this looks bad. 3353 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*\n" 3354 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa = aaaaaaaaaaaaaaaaaaa,\n" 3355 " *b = bbbbbbbbbbbbbbbbbbb;", 3356 getGoogleStyle()); 3357 3358 // Not ideal, but pointer-with-type does not allow much here. 3359 verifyGoogleFormat( 3360 "aaaaaaaaa* a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" 3361 " *b = bbbbbbbbbbbbbbbbbbb, *d = ddddddddddddddddddd;"); 3362 } 3363 3364 TEST_F(FormatTest, ConditionalExpressionsInBrackets) { 3365 verifyFormat("arr[foo ? bar : baz];"); 3366 verifyFormat("f()[foo ? bar : baz];"); 3367 verifyFormat("(a + b)[foo ? bar : baz];"); 3368 verifyFormat("arr[foo ? (4 > 5 ? 4 : 5) : 5 < 5 ? 5 : 7];"); 3369 } 3370 3371 TEST_F(FormatTest, AlignsStringLiterals) { 3372 verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n" 3373 " \"short literal\");"); 3374 verifyFormat( 3375 "looooooooooooooooooooooooongFunction(\n" 3376 " \"short literal\"\n" 3377 " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");"); 3378 verifyFormat("someFunction(\"Always break between multi-line\"\n" 3379 " \" string literals\",\n" 3380 " and, other, parameters);"); 3381 EXPECT_EQ("fun + \"1243\" /* comment */\n" 3382 " \"5678\";", 3383 format("fun + \"1243\" /* comment */\n" 3384 " \"5678\";", 3385 getLLVMStyleWithColumns(28))); 3386 EXPECT_EQ( 3387 "aaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 3388 " \"aaaaaaaaaaaaaaaaaaaaa\"\n" 3389 " \"aaaaaaaaaaaaaaaa\";", 3390 format("aaaaaa =" 3391 "\"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa " 3392 "aaaaaaaaaaaaaaaaaaaaa\" " 3393 "\"aaaaaaaaaaaaaaaa\";")); 3394 verifyFormat("a = a + \"a\"\n" 3395 " \"a\"\n" 3396 " \"a\";"); 3397 verifyFormat("f(\"a\", \"b\"\n" 3398 " \"c\");"); 3399 3400 verifyFormat( 3401 "#define LL_FORMAT \"ll\"\n" 3402 "printf(\"aaaaa: %d, bbbbbb: %\" LL_FORMAT \"d, cccccccc: %\" LL_FORMAT\n" 3403 " \"d, ddddddddd: %\" LL_FORMAT \"d\");"); 3404 3405 verifyFormat("#define A(X) \\\n" 3406 " \"aaaaa\" #X \"bbbbbb\" \\\n" 3407 " \"ccccc\"", 3408 getLLVMStyleWithColumns(23)); 3409 verifyFormat("#define A \"def\"\n" 3410 "f(\"abc\" A \"ghi\"\n" 3411 " \"jkl\");"); 3412 } 3413 3414 TEST_F(FormatTest, AlwaysBreakBeforeMultilineStrings) { 3415 FormatStyle NoBreak = getLLVMStyle(); 3416 NoBreak.AlwaysBreakBeforeMultilineStrings = false; 3417 FormatStyle Break = getLLVMStyle(); 3418 Break.AlwaysBreakBeforeMultilineStrings = true; 3419 verifyFormat("aaaa = \"bbbb\"\n" 3420 " \"cccc\";", 3421 NoBreak); 3422 verifyFormat("aaaa =\n" 3423 " \"bbbb\"\n" 3424 " \"cccc\";", 3425 Break); 3426 verifyFormat("aaaa(\"bbbb\"\n" 3427 " \"cccc\");", 3428 NoBreak); 3429 verifyFormat("aaaa(\n" 3430 " \"bbbb\"\n" 3431 " \"cccc\");", 3432 Break); 3433 verifyFormat("aaaa(qqq, \"bbbb\"\n" 3434 " \"cccc\");", 3435 NoBreak); 3436 verifyFormat("aaaa(qqq,\n" 3437 " \"bbbb\"\n" 3438 " \"cccc\");", 3439 Break); 3440 3441 // Don't break if there is no column gain. 3442 verifyFormat("f(\"aaaa\"\n" 3443 " \"bbbb\");", 3444 Break); 3445 3446 // Treat literals with escaped newlines like multi-line string literals. 3447 EXPECT_EQ("x = \"a\\\n" 3448 "b\\\n" 3449 "c\";", 3450 format("x = \"a\\\n" 3451 "b\\\n" 3452 "c\";", 3453 NoBreak)); 3454 EXPECT_EQ("x =\n" 3455 " \"a\\\n" 3456 "b\\\n" 3457 "c\";", 3458 format("x = \"a\\\n" 3459 "b\\\n" 3460 "c\";", 3461 Break)); 3462 } 3463 3464 TEST_F(FormatTest, AlignsPipes) { 3465 verifyFormat( 3466 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3467 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3468 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3469 verifyFormat( 3470 "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n" 3471 " << aaaaaaaaaaaaaaaaaaaa;"); 3472 verifyFormat( 3473 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3474 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3475 verifyFormat( 3476 "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" 3477 " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n" 3478 " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";"); 3479 verifyFormat( 3480 "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3481 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3482 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3483 3484 verifyFormat("return out << \"somepacket = {\\n\"\n" 3485 " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n" 3486 " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n" 3487 " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n" 3488 " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n" 3489 " << \"}\";"); 3490 3491 verifyFormat("llvm::outs() << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n" 3492 " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n" 3493 " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa;"); 3494 verifyFormat( 3495 "llvm::outs() << \"aaaaaaaaaaaaaaaaa = \" << aaaaaaaaaaaaaaaaa\n" 3496 " << \"bbbbbbbbbbbbbbbbb = \" << bbbbbbbbbbbbbbbbb\n" 3497 " << \"ccccccccccccccccc = \" << ccccccccccccccccc\n" 3498 " << \"ddddddddddddddddd = \" << ddddddddddddddddd\n" 3499 " << \"eeeeeeeeeeeeeeeee = \" << eeeeeeeeeeeeeeeee;"); 3500 verifyFormat("llvm::outs() << aaaaaaaaaaaaaaaaaaaaaaaa << \"=\"\n" 3501 " << bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 3502 verifyFormat( 3503 "void f() {\n" 3504 " llvm::outs() << \"aaaaaaaaaaaaaaaaaaaa: \"\n" 3505 " << aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 3506 "}"); 3507 3508 // Breaking before the first "<<" is generally not desirable. 3509 verifyFormat( 3510 "llvm::errs()\n" 3511 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3512 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3513 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3514 " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 3515 getLLVMStyleWithColumns(70)); 3516 verifyFormat("llvm::errs() << \"aaaaaaaaaaaaaaaaaaa: \"\n" 3517 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3518 " << \"aaaaaaaaaaaaaaaaaaa: \"\n" 3519 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3520 " << \"aaaaaaaaaaaaaaaaaaa: \"\n" 3521 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 3522 getLLVMStyleWithColumns(70)); 3523 3524 // But sometimes, breaking before the first "<<" is desirable. 3525 verifyFormat("Diag(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbb)\n" 3526 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3527 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3528 verifyFormat("SemaRef.Diag(Loc, diag::note_for_range_begin_end)\n" 3529 " << BEF << IsTemplate << Description << E->getType();"); 3530 3531 verifyFormat( 3532 "llvm::errs() << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3533 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3534 3535 // Incomplete string literal. 3536 EXPECT_EQ("llvm::errs() << \"\n" 3537 " << a;", 3538 format("llvm::errs() << \"\n<<a;")); 3539 } 3540 3541 TEST_F(FormatTest, UnderstandsEquals) { 3542 verifyFormat( 3543 "aaaaaaaaaaaaaaaaa =\n" 3544 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3545 verifyFormat( 3546 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3547 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 3548 verifyFormat( 3549 "if (a) {\n" 3550 " f();\n" 3551 "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3552 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 3553 "}"); 3554 3555 verifyFormat("if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 3556 " 100000000 + 10000000) {\n}"); 3557 } 3558 3559 TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) { 3560 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" 3561 " .looooooooooooooooooooooooooooooooooooooongFunction();"); 3562 3563 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" 3564 " ->looooooooooooooooooooooooooooooooooooooongFunction();"); 3565 3566 verifyFormat( 3567 "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n" 3568 " Parameter2);"); 3569 3570 verifyFormat( 3571 "ShortObject->shortFunction(\n" 3572 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n" 3573 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);"); 3574 3575 verifyFormat("loooooooooooooongFunction(\n" 3576 " LoooooooooooooongObject->looooooooooooooooongFunction());"); 3577 3578 verifyFormat( 3579 "function(LoooooooooooooooooooooooooooooooooooongObject\n" 3580 " ->loooooooooooooooooooooooooooooooooooooooongFunction());"); 3581 3582 verifyFormat("EXPECT_CALL(SomeObject, SomeFunction(Parameter))\n" 3583 " .WillRepeatedly(Return(SomeValue));"); 3584 verifyFormat("SomeMap[std::pair(aaaaaaaaaaaa, bbbbbbbbbbbbbbb)]\n" 3585 " .insert(ccccccccccccccccccccccc);"); 3586 verifyFormat("aaaaa(aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3587 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).aaaaa(aaaaa),\n" 3588 " aaaaaaaaaaaaaaaaaaaaa);"); 3589 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3590 " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa)->aaaaaaaaa());"); 3591 verifyFormat( 3592 "aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3593 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 3594 " .aaaaaaaaaaaaaaa(aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3595 " aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3596 " aaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 3597 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3598 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3599 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3600 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()) {\n" 3601 "}"); 3602 3603 // Here, it is not necessary to wrap at "." or "->". 3604 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n" 3605 " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 3606 verifyFormat( 3607 "aaaaaaaaaaa->aaaaaaaaa(\n" 3608 " aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3609 " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n"); 3610 3611 verifyFormat( 3612 "aaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3613 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa().aaaaaaaaaaaaaaaaa());"); 3614 verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() *\n" 3615 " aaaaaaaaa()->aaaaaa()->aaaaa());"); 3616 verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() ||\n" 3617 " aaaaaaaaa()->aaaaaa()->aaaaa());"); 3618 3619 // FIXME: Should we break before .a()? 3620 verifyFormat("aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3621 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).a();"); 3622 3623 FormatStyle NoBinPacking = getLLVMStyle(); 3624 NoBinPacking.BinPackParameters = false; 3625 verifyFormat("aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 3626 " .aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 3627 " .aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa,\n" 3628 " aaaaaaaaaaaaaaaaaaa,\n" 3629 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", 3630 NoBinPacking); 3631 3632 // If there is a subsequent call, change to hanging indentation. 3633 verifyFormat( 3634 "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3635 " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa))\n" 3636 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3637 verifyFormat( 3638 "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3639 " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa));"); 3640 } 3641 3642 TEST_F(FormatTest, WrapsTemplateDeclarations) { 3643 verifyFormat("template <typename T>\n" 3644 "virtual void loooooooooooongFunction(int Param1, int Param2);"); 3645 verifyFormat("template <typename T>\n" 3646 "// T should be one of {A, B}.\n" 3647 "virtual void loooooooooooongFunction(int Param1, int Param2);"); 3648 verifyFormat( 3649 "template <typename T>\n" 3650 "using comment_to_xml_conversion = comment_to_xml_conversion<T, int>;"); 3651 verifyFormat("template <typename T>\n" 3652 "void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n" 3653 " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);"); 3654 verifyFormat( 3655 "template <typename T>\n" 3656 "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n" 3657 " int Paaaaaaaaaaaaaaaaaaaaram2);"); 3658 verifyFormat( 3659 "template <typename T>\n" 3660 "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n" 3661 " aaaaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaaaaa,\n" 3662 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3663 verifyFormat("template <typename T>\n" 3664 "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3665 " int aaaaaaaaaaaaaaaaaaaaaa);"); 3666 verifyFormat( 3667 "template <typename T1, typename T2 = char, typename T3 = char,\n" 3668 " typename T4 = char>\n" 3669 "void f();"); 3670 verifyFormat( 3671 "aaaaaaaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa>(\n" 3672 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3673 3674 verifyFormat("a<aaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaa>(\n" 3675 " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));"); 3676 3677 verifyFormat("template <typename T> class C {};"); 3678 verifyFormat("template <typename T> void f();"); 3679 verifyFormat("template <typename T> void f() {}"); 3680 verifyFormat( 3681 "aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n" 3682 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3683 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa> *aaaa =\n" 3684 " new aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n" 3685 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3686 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>(\n" 3687 " bbbbbbbbbbbbbbbbbbbbbbbb);", 3688 getLLVMStyleWithColumns(72)); 3689 3690 FormatStyle AlwaysBreak = getLLVMStyle(); 3691 AlwaysBreak.AlwaysBreakTemplateDeclarations = true; 3692 verifyFormat("template <typename T>\nclass C {};", AlwaysBreak); 3693 verifyFormat("template <typename T>\nvoid f();", AlwaysBreak); 3694 verifyFormat("template <typename T>\nvoid f() {}", AlwaysBreak); 3695 verifyFormat("void aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3696 " bbbbbbbbbbbbbbbbbbbbbbbbbbbb>(\n" 3697 " ccccccccccccccccccccccccccccccccccccccccccccccc);"); 3698 verifyFormat("template <template <typename> class Fooooooo,\n" 3699 " template <typename> class Baaaaaaar>\n" 3700 "struct C {};", 3701 AlwaysBreak); 3702 verifyFormat("template <typename T> // T can be A, B or C.\n" 3703 "struct C {};", 3704 AlwaysBreak); 3705 } 3706 3707 TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) { 3708 verifyFormat( 3709 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3710 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3711 verifyFormat( 3712 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3713 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3714 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa());"); 3715 3716 // FIXME: Should we have the extra indent after the second break? 3717 verifyFormat( 3718 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3719 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3720 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3721 3722 verifyFormat( 3723 "aaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb::\n" 3724 " cccccccccccccccccccccccccccccccccccccccccccccc());"); 3725 3726 // Breaking at nested name specifiers is generally not desirable. 3727 verifyFormat( 3728 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3729 " aaaaaaaaaaaaaaaaaaaaaaa);"); 3730 3731 verifyFormat( 3732 "aaaaaaaaaaaaaaaaaa(aaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3733 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 3734 " aaaaaaaaaaaaaaaaaaaaa);", 3735 getLLVMStyleWithColumns(74)); 3736 3737 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 3738 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 3739 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 3740 } 3741 3742 TEST_F(FormatTest, UnderstandsTemplateParameters) { 3743 verifyFormat("A<int> a;"); 3744 verifyFormat("A<A<A<int> > > a;"); 3745 verifyFormat("A<A<A<int, 2>, 3>, 4> a;"); 3746 verifyFormat("bool x = a < 1 || 2 > a;"); 3747 verifyFormat("bool x = 5 < f<int>();"); 3748 verifyFormat("bool x = f<int>() > 5;"); 3749 verifyFormat("bool x = 5 < a<int>::x;"); 3750 verifyFormat("bool x = a < 4 ? a > 2 : false;"); 3751 verifyFormat("bool x = f() ? a < 2 : a > 2;"); 3752 3753 verifyGoogleFormat("A<A<int>> a;"); 3754 verifyGoogleFormat("A<A<A<int>>> a;"); 3755 verifyGoogleFormat("A<A<A<A<int>>>> a;"); 3756 verifyGoogleFormat("A<A<int> > a;"); 3757 verifyGoogleFormat("A<A<A<int> > > a;"); 3758 verifyGoogleFormat("A<A<A<A<int> > > > a;"); 3759 verifyGoogleFormat("A<::A<int>> a;"); 3760 verifyGoogleFormat("A<::A> a;"); 3761 verifyGoogleFormat("A< ::A> a;"); 3762 verifyGoogleFormat("A< ::A<int> > a;"); 3763 EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A> >> a;", getGoogleStyle())); 3764 EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A>> > a;", getGoogleStyle())); 3765 EXPECT_EQ("A<::A<int>> a;", format("A< ::A<int>> a;", getGoogleStyle())); 3766 EXPECT_EQ("A<::A<int>> a;", format("A<::A<int> > a;", getGoogleStyle())); 3767 3768 verifyFormat("test >> a >> b;"); 3769 verifyFormat("test << a >> b;"); 3770 3771 verifyFormat("f<int>();"); 3772 verifyFormat("template <typename T> void f() {}"); 3773 3774 // Not template parameters. 3775 verifyFormat("return a < b && c > d;"); 3776 verifyFormat("void f() {\n" 3777 " while (a < b && c > d) {\n" 3778 " }\n" 3779 "}"); 3780 verifyFormat("template <typename... Types>\n" 3781 "typename enable_if<0 < sizeof...(Types)>::type Foo() {}"); 3782 3783 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3784 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa >> aaaaa);", 3785 getLLVMStyleWithColumns(60)); 3786 } 3787 3788 TEST_F(FormatTest, UnderstandsBinaryOperators) { 3789 verifyFormat("COMPARE(a, ==, b);"); 3790 } 3791 3792 TEST_F(FormatTest, UnderstandsPointersToMembers) { 3793 verifyFormat("int A::*x;"); 3794 verifyFormat("int (S::*func)(void *);"); 3795 verifyFormat("void f() { int (S::*func)(void *); }"); 3796 verifyFormat("typedef bool *(Class::*Member)() const;"); 3797 verifyFormat("void f() {\n" 3798 " (a->*f)();\n" 3799 " a->*x;\n" 3800 " (a.*f)();\n" 3801 " ((*a).*f)();\n" 3802 " a.*x;\n" 3803 "}"); 3804 verifyFormat("void f() {\n" 3805 " (a->*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)(\n" 3806 " aaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb);\n" 3807 "}"); 3808 FormatStyle Style = getLLVMStyle(); 3809 Style.PointerBindsToType = true; 3810 verifyFormat("typedef bool* (Class::*Member)() const;", Style); 3811 } 3812 3813 TEST_F(FormatTest, UnderstandsUnaryOperators) { 3814 verifyFormat("int a = -2;"); 3815 verifyFormat("f(-1, -2, -3);"); 3816 verifyFormat("a[-1] = 5;"); 3817 verifyFormat("int a = 5 + -2;"); 3818 verifyFormat("if (i == -1) {\n}"); 3819 verifyFormat("if (i != -1) {\n}"); 3820 verifyFormat("if (i > -1) {\n}"); 3821 verifyFormat("if (i < -1) {\n}"); 3822 verifyFormat("++(a->f());"); 3823 verifyFormat("--(a->f());"); 3824 verifyFormat("(a->f())++;"); 3825 verifyFormat("a[42]++;"); 3826 verifyFormat("if (!(a->f())) {\n}"); 3827 3828 verifyFormat("a-- > b;"); 3829 verifyFormat("b ? -a : c;"); 3830 verifyFormat("n * sizeof char16;"); 3831 verifyFormat("n * alignof char16;", getGoogleStyle()); 3832 verifyFormat("sizeof(char);"); 3833 verifyFormat("alignof(char);", getGoogleStyle()); 3834 3835 verifyFormat("return -1;"); 3836 verifyFormat("switch (a) {\n" 3837 "case -1:\n" 3838 " break;\n" 3839 "}"); 3840 verifyFormat("#define X -1"); 3841 verifyFormat("#define X -kConstant"); 3842 3843 verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { -5, +3 };"); 3844 verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { +5, -3 };"); 3845 3846 verifyFormat("int a = /* confusing comment */ -1;"); 3847 // FIXME: The space after 'i' is wrong, but hopefully, this is a rare case. 3848 verifyFormat("int a = i /* confusing comment */++;"); 3849 } 3850 3851 TEST_F(FormatTest, IndentsRelativeToUnaryOperators) { 3852 verifyFormat("if (!aaaaaaaaaa( // break\n" 3853 " aaaaa)) {\n" 3854 "}"); 3855 verifyFormat("aaaaaaaaaa(!aaaaaaaaaa( // break\n" 3856 " aaaaa));"); 3857 3858 // Only indent relative to unary operators if the expression is nested. 3859 verifyFormat("*aaa = aaaaaaa( // break\n" 3860 " bbbbbb);"); 3861 } 3862 3863 TEST_F(FormatTest, UnderstandsOverloadedOperators) { 3864 verifyFormat("bool operator<();"); 3865 verifyFormat("bool operator>();"); 3866 verifyFormat("bool operator=();"); 3867 verifyFormat("bool operator==();"); 3868 verifyFormat("bool operator!=();"); 3869 verifyFormat("int operator+();"); 3870 verifyFormat("int operator++();"); 3871 verifyFormat("bool operator();"); 3872 verifyFormat("bool operator()();"); 3873 verifyFormat("bool operator[]();"); 3874 verifyFormat("operator bool();"); 3875 verifyFormat("operator int();"); 3876 verifyFormat("operator void *();"); 3877 verifyFormat("operator SomeType<int>();"); 3878 verifyFormat("operator SomeType<int, int>();"); 3879 verifyFormat("operator SomeType<SomeType<int> >();"); 3880 verifyFormat("void *operator new(std::size_t size);"); 3881 verifyFormat("void *operator new[](std::size_t size);"); 3882 verifyFormat("void operator delete(void *ptr);"); 3883 verifyFormat("void operator delete[](void *ptr);"); 3884 verifyFormat("template <typename AAAAAAA, typename BBBBBBB>\n" 3885 "AAAAAAA operator/(const AAAAAAA &a, BBBBBBB &b);"); 3886 3887 verifyFormat( 3888 "ostream &operator<<(ostream &OutputStream,\n" 3889 " SomeReallyLongType WithSomeReallyLongValue);"); 3890 verifyFormat("bool operator<(const aaaaaaaaaaaaaaaaaaaaa &left,\n" 3891 " const aaaaaaaaaaaaaaaaaaaaa &right) {\n" 3892 " return left.group < right.group;\n" 3893 "}"); 3894 verifyFormat("SomeType &operator=(const SomeType &S);"); 3895 3896 verifyGoogleFormat("operator void*();"); 3897 verifyGoogleFormat("operator SomeType<SomeType<int>>();"); 3898 3899 verifyFormat("using A::operator+;"); 3900 } 3901 3902 TEST_F(FormatTest, UnderstandsNewAndDelete) { 3903 verifyFormat("void f() {\n" 3904 " A *a = new A;\n" 3905 " A *a = new (placement) A;\n" 3906 " delete a;\n" 3907 " delete (A *)a;\n" 3908 "}"); 3909 } 3910 3911 TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) { 3912 verifyFormat("int *f(int *a) {}"); 3913 verifyFormat("int main(int argc, char **argv) {}"); 3914 verifyFormat("Test::Test(int b) : a(b * b) {}"); 3915 verifyIndependentOfContext("f(a, *a);"); 3916 verifyFormat("void g() { f(*a); }"); 3917 verifyIndependentOfContext("int a = b * 10;"); 3918 verifyIndependentOfContext("int a = 10 * b;"); 3919 verifyIndependentOfContext("int a = b * c;"); 3920 verifyIndependentOfContext("int a += b * c;"); 3921 verifyIndependentOfContext("int a -= b * c;"); 3922 verifyIndependentOfContext("int a *= b * c;"); 3923 verifyIndependentOfContext("int a /= b * c;"); 3924 verifyIndependentOfContext("int a = *b;"); 3925 verifyIndependentOfContext("int a = *b * c;"); 3926 verifyIndependentOfContext("int a = b * *c;"); 3927 verifyIndependentOfContext("return 10 * b;"); 3928 verifyIndependentOfContext("return *b * *c;"); 3929 verifyIndependentOfContext("return a & ~b;"); 3930 verifyIndependentOfContext("f(b ? *c : *d);"); 3931 verifyIndependentOfContext("int a = b ? *c : *d;"); 3932 verifyIndependentOfContext("*b = a;"); 3933 verifyIndependentOfContext("a * ~b;"); 3934 verifyIndependentOfContext("a * !b;"); 3935 verifyIndependentOfContext("a * +b;"); 3936 verifyIndependentOfContext("a * -b;"); 3937 verifyIndependentOfContext("a * ++b;"); 3938 verifyIndependentOfContext("a * --b;"); 3939 verifyIndependentOfContext("a[4] * b;"); 3940 verifyIndependentOfContext("a[a * a] = 1;"); 3941 verifyIndependentOfContext("f() * b;"); 3942 verifyIndependentOfContext("a * [self dostuff];"); 3943 verifyIndependentOfContext("int x = a * (a + b);"); 3944 verifyIndependentOfContext("(a *)(a + b);"); 3945 verifyIndependentOfContext("int *pa = (int *)&a;"); 3946 verifyIndependentOfContext("return sizeof(int **);"); 3947 verifyIndependentOfContext("return sizeof(int ******);"); 3948 verifyIndependentOfContext("return (int **&)a;"); 3949 verifyIndependentOfContext("f((*PointerToArray)[10]);"); 3950 verifyFormat("void f(Type (*parameter)[10]) {}"); 3951 verifyGoogleFormat("return sizeof(int**);"); 3952 verifyIndependentOfContext("Type **A = static_cast<Type **>(P);"); 3953 verifyGoogleFormat("Type** A = static_cast<Type**>(P);"); 3954 verifyFormat("auto a = [](int **&, int ***) {};"); 3955 verifyFormat("auto PointerBinding = [](const char *S) {};"); 3956 verifyFormat("typedef typeof(int(int, int)) *MyFunc;"); 3957 3958 verifyIndependentOfContext("InvalidRegions[*R] = 0;"); 3959 3960 verifyIndependentOfContext("A<int *> a;"); 3961 verifyIndependentOfContext("A<int **> a;"); 3962 verifyIndependentOfContext("A<int *, int *> a;"); 3963 verifyIndependentOfContext( 3964 "const char *const p = reinterpret_cast<const char *const>(q);"); 3965 verifyIndependentOfContext("A<int **, int **> a;"); 3966 verifyIndependentOfContext("void f(int *a = d * e, int *b = c * d);"); 3967 verifyFormat("for (char **a = b; *a; ++a) {\n}"); 3968 verifyFormat("for (; a && b;) {\n}"); 3969 3970 verifyFormat( 3971 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 3972 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 3973 3974 verifyGoogleFormat("int main(int argc, char** argv) {}"); 3975 verifyGoogleFormat("A<int*> a;"); 3976 verifyGoogleFormat("A<int**> a;"); 3977 verifyGoogleFormat("A<int*, int*> a;"); 3978 verifyGoogleFormat("A<int**, int**> a;"); 3979 verifyGoogleFormat("f(b ? *c : *d);"); 3980 verifyGoogleFormat("int a = b ? *c : *d;"); 3981 verifyGoogleFormat("Type* t = **x;"); 3982 verifyGoogleFormat("Type* t = *++*x;"); 3983 verifyGoogleFormat("*++*x;"); 3984 verifyGoogleFormat("Type* t = const_cast<T*>(&*x);"); 3985 verifyGoogleFormat("Type* t = x++ * y;"); 3986 verifyGoogleFormat( 3987 "const char* const p = reinterpret_cast<const char* const>(q);"); 3988 3989 verifyIndependentOfContext("a = *(x + y);"); 3990 verifyIndependentOfContext("a = &(x + y);"); 3991 verifyIndependentOfContext("*(x + y).call();"); 3992 verifyIndependentOfContext("&(x + y)->call();"); 3993 verifyFormat("void f() { &(*I).first; }"); 3994 3995 verifyIndependentOfContext("f(b * /* confusing comment */ ++c);"); 3996 verifyFormat( 3997 "int *MyValues = {\n" 3998 " *A, // Operator detection might be confused by the '{'\n" 3999 " *BB // Operator detection might be confused by previous comment\n" 4000 "};"); 4001 4002 verifyIndependentOfContext("if (int *a = &b)"); 4003 verifyIndependentOfContext("if (int &a = *b)"); 4004 verifyIndependentOfContext("if (a & b[i])"); 4005 verifyIndependentOfContext("if (a::b::c::d & b[i])"); 4006 verifyIndependentOfContext("if (*b[i])"); 4007 verifyIndependentOfContext("if (int *a = (&b))"); 4008 verifyIndependentOfContext("while (int *a = &b)"); 4009 verifyIndependentOfContext("size = sizeof *a;"); 4010 verifyFormat("void f() {\n" 4011 " for (const int &v : Values) {\n" 4012 " }\n" 4013 "}"); 4014 verifyFormat("for (int i = a * a; i < 10; ++i) {\n}"); 4015 verifyFormat("for (int i = 0; i < a * a; ++i) {\n}"); 4016 verifyGoogleFormat("for (int i = 0; i * 2 < z; i *= 2) {\n}"); 4017 4018 verifyFormat("#define MACRO \\\n" 4019 " int *i = a * b; \\\n" 4020 " void f(a *b);", 4021 getLLVMStyleWithColumns(19)); 4022 4023 verifyIndependentOfContext("A = new SomeType *[Length];"); 4024 verifyIndependentOfContext("A = new SomeType *[Length]();"); 4025 verifyIndependentOfContext("T **t = new T *;"); 4026 verifyIndependentOfContext("T **t = new T *();"); 4027 verifyGoogleFormat("A = new SomeType* [Length]();"); 4028 verifyGoogleFormat("A = new SomeType* [Length];"); 4029 verifyGoogleFormat("T** t = new T*;"); 4030 verifyGoogleFormat("T** t = new T*();"); 4031 4032 FormatStyle PointerLeft = getLLVMStyle(); 4033 PointerLeft.PointerBindsToType = true; 4034 verifyFormat("delete *x;", PointerLeft); 4035 } 4036 4037 TEST_F(FormatTest, UnderstandsAttributes) { 4038 verifyFormat("SomeType s __attribute__((unused)) (InitValue);"); 4039 } 4040 4041 TEST_F(FormatTest, UnderstandsEllipsis) { 4042 verifyFormat("int printf(const char *fmt, ...);"); 4043 verifyFormat("template <class... Ts> void Foo(Ts... ts) { Foo(ts...); }"); 4044 verifyFormat("template <class... Ts> void Foo(Ts *... ts) {}"); 4045 4046 FormatStyle PointersLeft = getLLVMStyle(); 4047 PointersLeft.PointerBindsToType = true; 4048 verifyFormat("template <class... Ts> void Foo(Ts*... ts) {}", PointersLeft); 4049 } 4050 4051 TEST_F(FormatTest, AdaptivelyFormatsPointersAndReferences) { 4052 EXPECT_EQ("int *a;\n" 4053 "int *a;\n" 4054 "int *a;", 4055 format("int *a;\n" 4056 "int* a;\n" 4057 "int *a;", 4058 getGoogleStyle())); 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 } 4074 4075 TEST_F(FormatTest, UnderstandsRvalueReferences) { 4076 verifyFormat("int f(int &&a) {}"); 4077 verifyFormat("int f(int a, char &&b) {}"); 4078 verifyFormat("void f() { int &&a = b; }"); 4079 verifyGoogleFormat("int f(int a, char&& b) {}"); 4080 verifyGoogleFormat("void f() { int&& a = b; }"); 4081 4082 verifyIndependentOfContext("A<int &&> a;"); 4083 verifyIndependentOfContext("A<int &&, int &&> a;"); 4084 verifyGoogleFormat("A<int&&> a;"); 4085 verifyGoogleFormat("A<int&&, int&&> a;"); 4086 4087 // Not rvalue references: 4088 verifyFormat("template <bool B, bool C> class A {\n" 4089 " static_assert(B && C, \"Something is wrong\");\n" 4090 "};"); 4091 verifyGoogleFormat("#define IF(a, b, c) if (a && (b == c))"); 4092 verifyGoogleFormat("#define WHILE(a, b, c) while (a && (b == c))"); 4093 } 4094 4095 TEST_F(FormatTest, FormatsBinaryOperatorsPrecedingEquals) { 4096 verifyFormat("void f() {\n" 4097 " x[aaaaaaaaa -\n" 4098 " b] = 23;\n" 4099 "}", 4100 getLLVMStyleWithColumns(15)); 4101 } 4102 4103 TEST_F(FormatTest, FormatsCasts) { 4104 verifyFormat("Type *A = static_cast<Type *>(P);"); 4105 verifyFormat("Type *A = (Type *)P;"); 4106 verifyFormat("Type *A = (vector<Type *, int *>)P;"); 4107 verifyFormat("int a = (int)(2.0f);"); 4108 verifyFormat("int a = (int)2.0f;"); 4109 verifyFormat("x[(int32)y];"); 4110 verifyFormat("x = (int32)y;"); 4111 verifyFormat("#define AA(X) sizeof(((X *)NULL)->a)"); 4112 verifyFormat("int a = (int)*b;"); 4113 verifyFormat("int a = (int)2.0f;"); 4114 verifyFormat("int a = (int)~0;"); 4115 verifyFormat("int a = (int)++a;"); 4116 verifyFormat("int a = (int)sizeof(int);"); 4117 verifyFormat("int a = (int)+2;"); 4118 verifyFormat("my_int a = (my_int)2.0f;"); 4119 verifyFormat("my_int a = (my_int)sizeof(int);"); 4120 verifyFormat("return (my_int)aaa;"); 4121 verifyFormat("#define x ((int)-1)"); 4122 verifyFormat("#define p(q) ((int *)&q)"); 4123 4124 // FIXME: Without type knowledge, this can still fall apart miserably. 4125 verifyFormat("void f() { my_int a = (my_int) * b; }"); 4126 verifyFormat("void f() { return P ? (my_int) * P : (my_int)0; }"); 4127 verifyFormat("my_int a = (my_int) ~0;"); 4128 verifyFormat("my_int a = (my_int)++ a;"); 4129 verifyFormat("my_int a = (my_int) + 2;"); 4130 4131 // Don't break after a cast's 4132 verifyFormat("int aaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 4133 " (aaaaaaaaaaaaaaaaaaaaaaaaaa *)(aaaaaaaaaaaaaaaaaaaaaa +\n" 4134 " bbbbbbbbbbbbbbbbbbbbbb);"); 4135 4136 // These are not casts. 4137 verifyFormat("void f(int *) {}"); 4138 verifyFormat("f(foo)->b;"); 4139 verifyFormat("f(foo).b;"); 4140 verifyFormat("f(foo)(b);"); 4141 verifyFormat("f(foo)[b];"); 4142 verifyFormat("[](foo) { return 4; }(bar);"); 4143 verifyFormat("(*funptr)(foo)[4];"); 4144 verifyFormat("funptrs[4](foo)[4];"); 4145 verifyFormat("void f(int *);"); 4146 verifyFormat("void f(int *) = 0;"); 4147 verifyFormat("void f(SmallVector<int>) {}"); 4148 verifyFormat("void f(SmallVector<int>);"); 4149 verifyFormat("void f(SmallVector<int>) = 0;"); 4150 verifyFormat("void f(int i = (kValue) * kMask) {}"); 4151 verifyFormat("void f(int i = (kA * kB) & kMask) {}"); 4152 verifyFormat("int a = sizeof(int) * b;"); 4153 verifyFormat("int a = alignof(int) * b;", getGoogleStyle()); 4154 verifyFormat("template <> void f<int>(int i) SOME_ANNOTATION;"); 4155 verifyFormat("f(\"%\" SOME_MACRO(ll) \"d\");"); 4156 verifyFormat("aaaaa &operator=(const aaaaa &) LLVM_DELETED_FUNCTION;"); 4157 4158 // These are not casts, but at some point were confused with casts. 4159 verifyFormat("virtual void foo(int *) override;"); 4160 verifyFormat("virtual void foo(char &) const;"); 4161 verifyFormat("virtual void foo(int *a, char *) const;"); 4162 verifyFormat("int a = sizeof(int *) + b;"); 4163 verifyFormat("int a = alignof(int *) + b;", getGoogleStyle()); 4164 4165 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *foo = (aaaaaaaaaaaaaaaaa *)\n" 4166 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 4167 // FIXME: The indentation here is not ideal. 4168 verifyFormat( 4169 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4170 " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (*cccccccccccccccc)\n" 4171 " [dddddddddddddddddddddddddddddddddddddddddddddddddddddddd];"); 4172 } 4173 4174 TEST_F(FormatTest, FormatsFunctionTypes) { 4175 verifyFormat("A<bool()> a;"); 4176 verifyFormat("A<SomeType()> a;"); 4177 verifyFormat("A<void (*)(int, std::string)> a;"); 4178 verifyFormat("A<void *(int)>;"); 4179 verifyFormat("void *(*a)(int *, SomeType *);"); 4180 verifyFormat("int (*func)(void *);"); 4181 verifyFormat("void f() { int (*func)(void *); }"); 4182 verifyFormat("template <class CallbackClass>\n" 4183 "using MyCallback = void (CallbackClass::*)(SomeObject *Data);"); 4184 4185 verifyGoogleFormat("A<void*(int*, SomeType*)>;"); 4186 verifyGoogleFormat("void* (*a)(int);"); 4187 verifyGoogleFormat( 4188 "template <class CallbackClass>\n" 4189 "using MyCallback = void (CallbackClass::*)(SomeObject* Data);"); 4190 4191 // Other constructs can look somewhat like function types: 4192 verifyFormat("A<sizeof(*x)> a;"); 4193 verifyFormat("#define DEREF_AND_CALL_F(x) f(*x)"); 4194 verifyFormat("some_var = function(*some_pointer_var)[0];"); 4195 verifyFormat("void f() { function(*some_pointer_var)[0] = 10; }"); 4196 } 4197 4198 TEST_F(FormatTest, BreaksLongDeclarations) { 4199 verifyFormat("typedef LoooooooooooooooooooooooooooooooooooooooongType\n" 4200 " AnotherNameForTheLongType;", 4201 getGoogleStyle()); 4202 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType\n" 4203 " LoooooooooooooooooooooooooooooooooooooooongVariable;", 4204 getGoogleStyle()); 4205 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType const\n" 4206 " LoooooooooooooooooooooooooooooooooooooooongVariable;", 4207 getGoogleStyle()); 4208 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" 4209 " LoooooooooooooooooooooooooooooooongFunctionDeclaration();", 4210 getGoogleStyle()); 4211 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" 4212 "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); 4213 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType const\n" 4214 "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); 4215 4216 // FIXME: Without the comment, this breaks after "(". 4217 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType // break\n" 4218 " (*LoooooooooooooooooooooooooooongFunctionTypeVarialbe)();", 4219 getGoogleStyle()); 4220 4221 verifyFormat("int *someFunction(int LoooooooooooooooooooongParam1,\n" 4222 " int LoooooooooooooooooooongParam2) {}"); 4223 verifyFormat( 4224 "TypeSpecDecl *TypeSpecDecl::Create(ASTContext &C, DeclContext *DC,\n" 4225 " SourceLocation L, IdentifierIn *II,\n" 4226 " Type *T) {}"); 4227 verifyFormat("ReallyLongReturnType<TemplateParam1, TemplateParam2>\n" 4228 "ReallyReallyLongFunctionName(\n" 4229 " const std::string &SomeParameter,\n" 4230 " const SomeType<string, SomeOtherTemplateParameter> &\n" 4231 " ReallyReallyLongParameterName,\n" 4232 " const SomeType<string, SomeOtherTemplateParameter> &\n" 4233 " AnotherLongParameterName) {}"); 4234 verifyFormat("template <typename A>\n" 4235 "SomeLoooooooooooooooooooooongType<\n" 4236 " typename some_namespace::SomeOtherType<A>::Type>\n" 4237 "Function() {}"); 4238 4239 verifyGoogleFormat( 4240 "aaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaa<aaaaaaaaaaaaa, aaaaaaaaaaaa>\n" 4241 " aaaaaaaaaaaaaaaaaaaaaaa;"); 4242 verifyGoogleFormat( 4243 "TypeSpecDecl* TypeSpecDecl::Create(ASTContext& C, DeclContext* DC,\n" 4244 " SourceLocation L) {}"); 4245 verifyGoogleFormat( 4246 "some_namespace::LongReturnType\n" 4247 "long_namespace::SomeVeryLongClass::SomeVeryLongFunction(\n" 4248 " int first_long_parameter, int second_parameter) {}"); 4249 4250 verifyGoogleFormat("template <typename T>\n" 4251 "aaaaaaaa::aaaaa::aaaaaa<T, aaaaaaaaaaaaaaaaaaaaaaaaa>\n" 4252 "aaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaa() {}"); 4253 verifyGoogleFormat("A<A<A>> aaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 4254 " int aaaaaaaaaaaaaaaaaaaaaaa);"); 4255 } 4256 4257 TEST_F(FormatTest, FormatsArrays) { 4258 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa[aaaaaaaaaaaaaaaaaaaaaaaaa]\n" 4259 " [bbbbbbbbbbbbbbbbbbbbbbbbb] = c;"); 4260 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4261 " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;"); 4262 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4263 " [a][bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = cccccccc;"); 4264 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 4265 " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n" 4266 " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;"); 4267 verifyFormat( 4268 "llvm::outs() << \"aaaaaaaaaaaa: \"\n" 4269 " << (*aaaaaaaiaaaaaaa)[aaaaaaaaaaaaaaaaaaaaaaaaa]\n" 4270 " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa];"); 4271 } 4272 4273 TEST_F(FormatTest, LineStartsWithSpecialCharacter) { 4274 verifyFormat("(a)->b();"); 4275 verifyFormat("--a;"); 4276 } 4277 4278 TEST_F(FormatTest, HandlesIncludeDirectives) { 4279 verifyFormat("#include <string>\n" 4280 "#include <a/b/c.h>\n" 4281 "#include \"a/b/string\"\n" 4282 "#include \"string.h\"\n" 4283 "#include \"string.h\"\n" 4284 "#include <a-a>\n" 4285 "#include < path with space >\n" 4286 "#include \"abc.h\" // this is included for ABC\n" 4287 "#include \"some long include\" // with a comment\n" 4288 "#include \"some very long include paaaaaaaaaaaaaaaaaaaaaaath\"", 4289 getLLVMStyleWithColumns(35)); 4290 4291 verifyFormat("#import <string>"); 4292 verifyFormat("#import <a/b/c.h>"); 4293 verifyFormat("#import \"a/b/string\""); 4294 verifyFormat("#import \"string.h\""); 4295 verifyFormat("#import \"string.h\""); 4296 verifyFormat("#if __has_include(<strstream>)\n" 4297 "#include <strstream>\n" 4298 "#endif"); 4299 } 4300 4301 //===----------------------------------------------------------------------===// 4302 // Error recovery tests. 4303 //===----------------------------------------------------------------------===// 4304 4305 TEST_F(FormatTest, IncompleteParameterLists) { 4306 FormatStyle NoBinPacking = getLLVMStyle(); 4307 NoBinPacking.BinPackParameters = false; 4308 verifyFormat("void aaaaaaaaaaaaaaaaaa(int level,\n" 4309 " double *min_x,\n" 4310 " double *max_x,\n" 4311 " double *min_y,\n" 4312 " double *max_y,\n" 4313 " double *min_z,\n" 4314 " double *max_z, ) {}", 4315 NoBinPacking); 4316 } 4317 4318 TEST_F(FormatTest, IncorrectCodeTrailingStuff) { 4319 verifyFormat("void f() { return; }\n42"); 4320 verifyFormat("void f() {\n" 4321 " if (0)\n" 4322 " return;\n" 4323 "}\n" 4324 "42"); 4325 verifyFormat("void f() { return }\n42"); 4326 verifyFormat("void f() {\n" 4327 " if (0)\n" 4328 " return\n" 4329 "}\n" 4330 "42"); 4331 } 4332 4333 TEST_F(FormatTest, IncorrectCodeMissingSemicolon) { 4334 EXPECT_EQ("void f() { return }", format("void f ( ) { return }")); 4335 EXPECT_EQ("void f() {\n" 4336 " if (a)\n" 4337 " return\n" 4338 "}", 4339 format("void f ( ) { if ( a ) return }")); 4340 EXPECT_EQ("namespace N {\n" 4341 "void f()\n" 4342 "}", 4343 format("namespace N { void f() }")); 4344 EXPECT_EQ("namespace N {\n" 4345 "void f() {}\n" 4346 "void g()\n" 4347 "}", 4348 format("namespace N { void f( ) { } void g( ) }")); 4349 } 4350 4351 TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) { 4352 verifyFormat("int aaaaaaaa =\n" 4353 " // Overlylongcomment\n" 4354 " b;", 4355 getLLVMStyleWithColumns(20)); 4356 verifyFormat("function(\n" 4357 " ShortArgument,\n" 4358 " LoooooooooooongArgument);\n", 4359 getLLVMStyleWithColumns(20)); 4360 } 4361 4362 TEST_F(FormatTest, IncorrectAccessSpecifier) { 4363 verifyFormat("public:"); 4364 verifyFormat("class A {\n" 4365 "public\n" 4366 " void f() {}\n" 4367 "};"); 4368 verifyFormat("public\n" 4369 "int qwerty;"); 4370 verifyFormat("public\n" 4371 "B {}"); 4372 verifyFormat("public\n" 4373 "{}"); 4374 verifyFormat("public\n" 4375 "B { int x; }"); 4376 } 4377 4378 TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) { 4379 verifyFormat("{"); 4380 verifyFormat("#})"); 4381 } 4382 4383 TEST_F(FormatTest, IncorrectCodeDoNoWhile) { 4384 verifyFormat("do {\n}"); 4385 verifyFormat("do {\n}\n" 4386 "f();"); 4387 verifyFormat("do {\n}\n" 4388 "wheeee(fun);"); 4389 verifyFormat("do {\n" 4390 " f();\n" 4391 "}"); 4392 } 4393 4394 TEST_F(FormatTest, IncorrectCodeMissingParens) { 4395 verifyFormat("if {\n foo;\n foo();\n}"); 4396 verifyFormat("switch {\n foo;\n foo();\n}"); 4397 verifyFormat("for {\n foo;\n foo();\n}"); 4398 verifyFormat("while {\n foo;\n foo();\n}"); 4399 verifyFormat("do {\n foo;\n foo();\n} while;"); 4400 } 4401 4402 TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) { 4403 verifyFormat("namespace {\n" 4404 "class Foo { Foo (\n" 4405 "};\n" 4406 "} // comment"); 4407 } 4408 4409 TEST_F(FormatTest, IncorrectCodeErrorDetection) { 4410 EXPECT_EQ("{\n {}\n", format("{\n{\n}\n")); 4411 EXPECT_EQ("{\n {}\n", format("{\n {\n}\n")); 4412 EXPECT_EQ("{\n {}\n", format("{\n {\n }\n")); 4413 EXPECT_EQ("{\n {}\n}\n}\n", format("{\n {\n }\n }\n}\n")); 4414 4415 EXPECT_EQ("{\n" 4416 " {\n" 4417 " breakme(\n" 4418 " qwe);\n" 4419 " }\n", 4420 format("{\n" 4421 " {\n" 4422 " breakme(qwe);\n" 4423 "}\n", 4424 getLLVMStyleWithColumns(10))); 4425 } 4426 4427 TEST_F(FormatTest, LayoutCallsInsideBraceInitializers) { 4428 verifyFormat("int x = {\n" 4429 " avariable,\n" 4430 " b(alongervariable)\n" 4431 "};", 4432 getLLVMStyleWithColumns(25)); 4433 } 4434 4435 TEST_F(FormatTest, LayoutBraceInitializersInReturnStatement) { 4436 verifyFormat("return (a)(b) { 1, 2, 3 };"); 4437 } 4438 4439 TEST_F(FormatTest, LayoutCxx11ConstructorBraceInitializers) { 4440 verifyFormat("vector<int> x{ 1, 2, 3, 4 };"); 4441 verifyFormat("vector<T> x{ {}, {}, {}, {} };"); 4442 verifyFormat("f({ 1, 2 });"); 4443 verifyFormat("auto v = Foo{ 1 };"); 4444 verifyFormat("f({ 1, 2 }, { { 2, 3 }, { 4, 5 } }, c, { d });"); 4445 verifyFormat("Class::Class : member{ 1, 2, 3 } {}"); 4446 verifyFormat("new vector<int>{ 1, 2, 3 };"); 4447 verifyFormat("new int[3]{ 1, 2, 3 };"); 4448 verifyFormat("return { arg1, arg2 };"); 4449 verifyFormat("return { arg1, SomeType{ parameter } };"); 4450 verifyFormat("new T{ arg1, arg2 };"); 4451 verifyFormat("f(MyMap[{ composite, key }]);"); 4452 verifyFormat("class Class {\n" 4453 " T member = { arg1, arg2 };\n" 4454 "};"); 4455 verifyFormat( 4456 "foo = aaaaaaaaaaa ? vector<int>{ aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 4457 " aaaaaaaaaaaaaaaaaaaa, aaaaa }\n" 4458 " : vector<int>{ bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 4459 " bbbbbbbbbbbbbbbbbbbb, bbbbb };"); 4460 verifyFormat("DoSomethingWithVector({} /* No data */);"); 4461 verifyFormat("DoSomethingWithVector({ {} /* No data */ }, { { 1, 2 } });"); 4462 verifyFormat( 4463 "someFunction(OtherParam, BracedList{\n" 4464 " // comment 1 (Forcing interesting break)\n" 4465 " param1, param2,\n" 4466 " // comment 2\n" 4467 " param3, param4\n" 4468 " });"); 4469 verifyFormat( 4470 "std::this_thread::sleep_for(\n" 4471 " std::chrono::nanoseconds{ std::chrono::seconds{ 1 } } / 5);"); 4472 4473 FormatStyle NoSpaces = getLLVMStyle(); 4474 NoSpaces.Cpp11BracedListStyle = true; 4475 verifyFormat("vector<int> x{1, 2, 3, 4};", NoSpaces); 4476 verifyFormat("vector<T> x{{}, {}, {}, {}};", NoSpaces); 4477 verifyFormat("f({1, 2});", NoSpaces); 4478 verifyFormat("auto v = Foo{-1};", NoSpaces); 4479 verifyFormat("f({1, 2}, {{2, 3}, {4, 5}}, c, {d});", NoSpaces); 4480 verifyFormat("Class::Class : member{1, 2, 3} {}", NoSpaces); 4481 verifyFormat("new vector<int>{1, 2, 3};", NoSpaces); 4482 verifyFormat("new int[3]{1, 2, 3};", NoSpaces); 4483 verifyFormat("return {arg1, arg2};", NoSpaces); 4484 verifyFormat("return {arg1, SomeType{parameter}};", NoSpaces); 4485 verifyFormat("new T{arg1, arg2};", NoSpaces); 4486 verifyFormat("f(MyMap[{composite, key}]);", NoSpaces); 4487 verifyFormat("class Class {\n" 4488 " T member = {arg1, arg2};\n" 4489 "};", 4490 NoSpaces); 4491 } 4492 4493 TEST_F(FormatTest, FormatsBracedListsinColumnLayout) { 4494 verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4495 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4496 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4497 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4498 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4499 " 1, 22, 333, 4444, 55555, 666666, 7777777 };"); 4500 verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4501 " // line comment\n" 4502 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4503 " 1, 22, 333, 4444, 55555,\n" 4504 " // line comment\n" 4505 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4506 " 1, 22, 333, 4444, 55555, 666666, 7777777 };"); 4507 verifyFormat( 4508 "vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4509 " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" 4510 " 1, 22, 333, 4444, 55555, 666666, // comment\n" 4511 " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" 4512 " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" 4513 " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" 4514 " 7777777 };"); 4515 verifyFormat("static const uint16_t CallerSavedRegs64Bittttt[] = {\n" 4516 " X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,\n" 4517 " X86::R8, X86::R9, X86::R10, X86::R11, 0\n" 4518 "};"); 4519 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4520 " 1, 1, 1, 1 };", 4521 getLLVMStyleWithColumns(39)); 4522 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4523 " 1, 1, 1, 1 };", 4524 getLLVMStyleWithColumns(38)); 4525 verifyFormat("vector<int> aaaaaaaaaaaaaaaaaaaaaa = {\n" 4526 " 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1\n" 4527 "};", 4528 getLLVMStyleWithColumns(40)); 4529 4530 // Trailing commas. 4531 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4532 " 1, 1, 1, 1, };", 4533 getLLVMStyleWithColumns(39)); 4534 verifyFormat("vector<int> x = {\n" 4535 " 1, 1, 1, 1, 1, 1, 1, 1, //\n" 4536 "};", 4537 getLLVMStyleWithColumns(39)); 4538 verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" 4539 " 1, 1, 1, 1,\n" 4540 " /**/ /**/ };", 4541 getLLVMStyleWithColumns(39)); 4542 verifyFormat("return { { aaaaaaaaaaaaaaaaaaaaa }, { aaaaaaaaaaaaaaaaaaa },\n" 4543 " { aaaaaaaaaaaaaaaaaaaaa }, { aaaaaaaaaaaaaaaaa } };", 4544 getLLVMStyleWithColumns(60)); 4545 } 4546 4547 TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) { 4548 verifyFormat("void f() { return 42; }"); 4549 verifyFormat("void f() {\n" 4550 " // Comment\n" 4551 "}"); 4552 verifyFormat("{\n" 4553 "#error {\n" 4554 " int a;\n" 4555 "}"); 4556 verifyFormat("{\n" 4557 " int a;\n" 4558 "#error {\n" 4559 "}"); 4560 verifyFormat("void f() {} // comment"); 4561 verifyFormat("void f() { int a; } // comment"); 4562 verifyFormat("void f() {\n" 4563 "} // comment", 4564 getLLVMStyleWithColumns(15)); 4565 4566 verifyFormat("void f() { return 42; }", getLLVMStyleWithColumns(23)); 4567 verifyFormat("void f() {\n return 42;\n}", getLLVMStyleWithColumns(22)); 4568 4569 verifyFormat("void f() {}", getLLVMStyleWithColumns(11)); 4570 verifyFormat("void f() {\n}", getLLVMStyleWithColumns(10)); 4571 } 4572 4573 TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) { 4574 // Elaborate type variable declarations. 4575 verifyFormat("struct foo a = { bar };\nint n;"); 4576 verifyFormat("class foo a = { bar };\nint n;"); 4577 verifyFormat("union foo a = { bar };\nint n;"); 4578 4579 // Elaborate types inside function definitions. 4580 verifyFormat("struct foo f() {}\nint n;"); 4581 verifyFormat("class foo f() {}\nint n;"); 4582 verifyFormat("union foo f() {}\nint n;"); 4583 4584 // Templates. 4585 verifyFormat("template <class X> void f() {}\nint n;"); 4586 verifyFormat("template <struct X> void f() {}\nint n;"); 4587 verifyFormat("template <union X> void f() {}\nint n;"); 4588 4589 // Actual definitions... 4590 verifyFormat("struct {\n} n;"); 4591 verifyFormat( 4592 "template <template <class T, class Y>, class Z> class X {\n} n;"); 4593 verifyFormat("union Z {\n int n;\n} x;"); 4594 verifyFormat("class MACRO Z {\n} n;"); 4595 verifyFormat("class MACRO(X) Z {\n} n;"); 4596 verifyFormat("class __attribute__(X) Z {\n} n;"); 4597 verifyFormat("class __declspec(X) Z {\n} n;"); 4598 verifyFormat("class A##B##C {\n} n;"); 4599 verifyFormat("class alignas(16) Z {\n} n;"); 4600 4601 // Redefinition from nested context: 4602 verifyFormat("class A::B::C {\n} n;"); 4603 4604 // Template definitions. 4605 verifyFormat( 4606 "template <typename F>\n" 4607 "Matcher(const Matcher<F> &Other,\n" 4608 " typename enable_if_c<is_base_of<F, T>::value &&\n" 4609 " !is_same<F, T>::value>::type * = 0)\n" 4610 " : Implementation(new ImplicitCastMatcher<F>(Other)) {}"); 4611 4612 // FIXME: This is still incorrectly handled at the formatter side. 4613 verifyFormat("template <> struct X < 15, i<3 && 42 < 50 && 33 < 28> {};"); 4614 4615 // FIXME: 4616 // This now gets parsed incorrectly as class definition. 4617 // verifyFormat("class A<int> f() {\n}\nint n;"); 4618 4619 // Elaborate types where incorrectly parsing the structural element would 4620 // break the indent. 4621 verifyFormat("if (true)\n" 4622 " class X x;\n" 4623 "else\n" 4624 " f();\n"); 4625 4626 // This is simply incomplete. Formatting is not important, but must not crash. 4627 verifyFormat("class A:"); 4628 } 4629 4630 TEST_F(FormatTest, DoNotInterfereWithErrorAndWarning) { 4631 EXPECT_EQ("#error Leave all white!!!!! space* alone!\n", 4632 format("#error Leave all white!!!!! space* alone!\n")); 4633 EXPECT_EQ( 4634 "#warning Leave all white!!!!! space* alone!\n", 4635 format("#warning Leave all white!!!!! space* alone!\n")); 4636 EXPECT_EQ("#error 1", format(" # error 1")); 4637 EXPECT_EQ("#warning 1", format(" # warning 1")); 4638 } 4639 4640 TEST_F(FormatTest, FormatHashIfExpressions) { 4641 // FIXME: Come up with a better indentation for #elif. 4642 verifyFormat( 4643 "#if !defined(AAAAAAA) && (defined CCCCCC || defined DDDDDD) && \\\n" 4644 " defined(BBBBBBBB)\n" 4645 "#elif !defined(AAAAAA) && (defined CCCCC || defined DDDDDD) && \\\n" 4646 " defined(BBBBBBBB)\n" 4647 "#endif", 4648 getLLVMStyleWithColumns(65)); 4649 } 4650 4651 TEST_F(FormatTest, MergeHandlingInTheFaceOfPreprocessorDirectives) { 4652 FormatStyle AllowsMergedIf = getGoogleStyle(); 4653 AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; 4654 verifyFormat("void f() { f(); }\n#error E", AllowsMergedIf); 4655 verifyFormat("if (true) return 42;\n#error E", AllowsMergedIf); 4656 verifyFormat("if (true)\n#error E\n return 42;", AllowsMergedIf); 4657 EXPECT_EQ("if (true) return 42;", 4658 format("if (true)\nreturn 42;", AllowsMergedIf)); 4659 FormatStyle ShortMergedIf = AllowsMergedIf; 4660 ShortMergedIf.ColumnLimit = 25; 4661 verifyFormat("#define A \\\n" 4662 " if (true) return 42;", 4663 ShortMergedIf); 4664 verifyFormat("#define A \\\n" 4665 " f(); \\\n" 4666 " if (true)\n" 4667 "#define B", 4668 ShortMergedIf); 4669 verifyFormat("#define A \\\n" 4670 " f(); \\\n" 4671 " if (true)\n" 4672 "g();", 4673 ShortMergedIf); 4674 verifyFormat("{\n" 4675 "#ifdef A\n" 4676 " // Comment\n" 4677 " if (true) continue;\n" 4678 "#endif\n" 4679 " // Comment\n" 4680 " if (true) continue;\n" 4681 "}", 4682 ShortMergedIf); 4683 } 4684 4685 TEST_F(FormatTest, BlockCommentsInControlLoops) { 4686 verifyFormat("if (0) /* a comment in a strange place */ {\n" 4687 " f();\n" 4688 "}"); 4689 verifyFormat("if (0) /* a comment in a strange place */ {\n" 4690 " f();\n" 4691 "} /* another comment */ else /* comment #3 */ {\n" 4692 " g();\n" 4693 "}"); 4694 verifyFormat("while (0) /* a comment in a strange place */ {\n" 4695 " f();\n" 4696 "}"); 4697 verifyFormat("for (;;) /* a comment in a strange place */ {\n" 4698 " f();\n" 4699 "}"); 4700 verifyFormat("do /* a comment in a strange place */ {\n" 4701 " f();\n" 4702 "} /* another comment */ while (0);"); 4703 } 4704 4705 TEST_F(FormatTest, BlockComments) { 4706 EXPECT_EQ("/* */ /* */ /* */\n/* */ /* */ /* */", 4707 format("/* *//* */ /* */\n/* *//* */ /* */")); 4708 EXPECT_EQ("/* */ a /* */ b;", format(" /* */ a/* */ b;")); 4709 EXPECT_EQ("#define A /*123*/ \\\n" 4710 " b\n" 4711 "/* */\n" 4712 "someCall(\n" 4713 " parameter);", 4714 format("#define A /*123*/ b\n" 4715 "/* */\n" 4716 "someCall(parameter);", 4717 getLLVMStyleWithColumns(15))); 4718 4719 EXPECT_EQ("#define A\n" 4720 "/* */ someCall(\n" 4721 " parameter);", 4722 format("#define A\n" 4723 "/* */someCall(parameter);", 4724 getLLVMStyleWithColumns(15))); 4725 EXPECT_EQ("/*\n**\n*/", format("/*\n**\n*/")); 4726 EXPECT_EQ("/*\n" 4727 "*\n" 4728 " * aaaaaa\n" 4729 "*aaaaaa\n" 4730 "*/", 4731 format("/*\n" 4732 "*\n" 4733 " * aaaaaa aaaaaa\n" 4734 "*/", 4735 getLLVMStyleWithColumns(10))); 4736 EXPECT_EQ("/*\n" 4737 "**\n" 4738 "* aaaaaa\n" 4739 "*aaaaaa\n" 4740 "*/", 4741 format("/*\n" 4742 "**\n" 4743 "* aaaaaa aaaaaa\n" 4744 "*/", 4745 getLLVMStyleWithColumns(10))); 4746 4747 FormatStyle NoBinPacking = getLLVMStyle(); 4748 NoBinPacking.BinPackParameters = false; 4749 EXPECT_EQ("someFunction(1, /* comment 1 */\n" 4750 " 2, /* comment 2 */\n" 4751 " 3, /* comment 3 */\n" 4752 " aaaa,\n" 4753 " bbbb);", 4754 format("someFunction (1, /* comment 1 */\n" 4755 " 2, /* comment 2 */ \n" 4756 " 3, /* comment 3 */\n" 4757 "aaaa, bbbb );", 4758 NoBinPacking)); 4759 verifyFormat( 4760 "bool aaaaaaaaaaaaa = /* comment: */ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 4761 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 4762 EXPECT_EQ( 4763 "bool aaaaaaaaaaaaa = /* trailing comment */\n" 4764 " aaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 4765 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;", 4766 format( 4767 "bool aaaaaaaaaaaaa = /* trailing comment */\n" 4768 " aaaaaaaaaaaaaaaaaaaaaaaaaaa||aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 4769 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;")); 4770 EXPECT_EQ( 4771 "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" 4772 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" 4773 "int cccccccccccccccccccccccccccccc; /* comment */\n", 4774 format("int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" 4775 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" 4776 "int cccccccccccccccccccccccccccccc; /* comment */\n")); 4777 4778 verifyFormat("void f(int * /* unused */) {}"); 4779 4780 EXPECT_EQ("/*\n" 4781 " **\n" 4782 " */", 4783 format("/*\n" 4784 " **\n" 4785 " */")); 4786 EXPECT_EQ("/*\n" 4787 " *q\n" 4788 " */", 4789 format("/*\n" 4790 " *q\n" 4791 " */")); 4792 EXPECT_EQ("/*\n" 4793 " * q\n" 4794 " */", 4795 format("/*\n" 4796 " * q\n" 4797 " */")); 4798 EXPECT_EQ("/*\n" 4799 " **/", 4800 format("/*\n" 4801 " **/")); 4802 EXPECT_EQ("/*\n" 4803 " ***/", 4804 format("/*\n" 4805 " ***/")); 4806 } 4807 4808 TEST_F(FormatTest, BlockCommentsInMacros) { 4809 EXPECT_EQ("#define A \\\n" 4810 " { \\\n" 4811 " /* one line */ \\\n" 4812 " someCall();", 4813 format("#define A { \\\n" 4814 " /* one line */ \\\n" 4815 " someCall();", 4816 getLLVMStyleWithColumns(20))); 4817 EXPECT_EQ("#define A \\\n" 4818 " { \\\n" 4819 " /* previous */ \\\n" 4820 " /* one line */ \\\n" 4821 " someCall();", 4822 format("#define A { \\\n" 4823 " /* previous */ \\\n" 4824 " /* one line */ \\\n" 4825 " someCall();", 4826 getLLVMStyleWithColumns(20))); 4827 } 4828 4829 TEST_F(FormatTest, BlockCommentsAtEndOfLine) { 4830 EXPECT_EQ("a = {\n" 4831 " 1111 /* */\n" 4832 "};", 4833 format("a = {1111 /* */\n" 4834 "};", 4835 getLLVMStyleWithColumns(15))); 4836 EXPECT_EQ("a = {\n" 4837 " 1111 /* */\n" 4838 "};", 4839 format("a = {1111 /* */\n" 4840 "};", 4841 getLLVMStyleWithColumns(15))); 4842 4843 // FIXME: The formatting is still wrong here. 4844 EXPECT_EQ("a = {\n" 4845 " 1111 /* a\n" 4846 " */\n" 4847 "};", 4848 format("a = {1111 /* a */\n" 4849 "};", 4850 getLLVMStyleWithColumns(15))); 4851 } 4852 4853 TEST_F(FormatTest, IndentLineCommentsInStartOfBlockAtEndOfFile) { 4854 // FIXME: This is not what we want... 4855 verifyFormat("{\n" 4856 "// a" 4857 "// b"); 4858 } 4859 4860 TEST_F(FormatTest, FormatStarDependingOnContext) { 4861 verifyFormat("void f(int *a);"); 4862 verifyFormat("void f() { f(fint * b); }"); 4863 verifyFormat("class A {\n void f(int *a);\n};"); 4864 verifyFormat("class A {\n int *a;\n};"); 4865 verifyFormat("namespace a {\n" 4866 "namespace b {\n" 4867 "class A {\n" 4868 " void f() {}\n" 4869 " int *a;\n" 4870 "};\n" 4871 "}\n" 4872 "}"); 4873 } 4874 4875 TEST_F(FormatTest, SpecialTokensAtEndOfLine) { 4876 verifyFormat("while"); 4877 verifyFormat("operator"); 4878 } 4879 4880 //===----------------------------------------------------------------------===// 4881 // Objective-C tests. 4882 //===----------------------------------------------------------------------===// 4883 4884 TEST_F(FormatTest, FormatForObjectiveCMethodDecls) { 4885 verifyFormat("- (void)sendAction:(SEL)aSelector to:(BOOL)anObject;"); 4886 EXPECT_EQ("- (NSUInteger)indexOfObject:(id)anObject;", 4887 format("-(NSUInteger)indexOfObject:(id)anObject;")); 4888 EXPECT_EQ("- (NSInteger)Mthod1;", format("-(NSInteger)Mthod1;")); 4889 EXPECT_EQ("+ (id)Mthod2;", format("+(id)Mthod2;")); 4890 EXPECT_EQ("- (NSInteger)Method3:(id)anObject;", 4891 format("-(NSInteger)Method3:(id)anObject;")); 4892 EXPECT_EQ("- (NSInteger)Method4:(id)anObject;", 4893 format("-(NSInteger)Method4:(id)anObject;")); 4894 EXPECT_EQ("- (NSInteger)Method5:(id)anObject:(id)AnotherObject;", 4895 format("-(NSInteger)Method5:(id)anObject:(id)AnotherObject;")); 4896 EXPECT_EQ("- (id)Method6:(id)A:(id)B:(id)C:(id)D;", 4897 format("- (id)Method6:(id)A:(id)B:(id)C:(id)D;")); 4898 EXPECT_EQ( 4899 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;", 4900 format( 4901 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;")); 4902 4903 // Very long objectiveC method declaration. 4904 verifyFormat("- (NSUInteger)indexOfObject:(id)anObject\n" 4905 " inRange:(NSRange)range\n" 4906 " outRange:(NSRange)out_range\n" 4907 " outRange1:(NSRange)out_range1\n" 4908 " outRange2:(NSRange)out_range2\n" 4909 " outRange3:(NSRange)out_range3\n" 4910 " outRange4:(NSRange)out_range4\n" 4911 " outRange5:(NSRange)out_range5\n" 4912 " outRange6:(NSRange)out_range6\n" 4913 " outRange7:(NSRange)out_range7\n" 4914 " outRange8:(NSRange)out_range8\n" 4915 " outRange9:(NSRange)out_range9;"); 4916 4917 verifyFormat("- (int)sum:(vector<int>)numbers;"); 4918 verifyGoogleFormat("- (void)setDelegate:(id<Protocol>)delegate;"); 4919 // FIXME: In LLVM style, there should be a space in front of a '<' for ObjC 4920 // protocol lists (but not for template classes): 4921 //verifyFormat("- (void)setDelegate:(id <Protocol>)delegate;"); 4922 4923 verifyFormat("- (int (*)())foo:(int (*)())f;"); 4924 verifyGoogleFormat("- (int (*)())foo:(int (*)())foo;"); 4925 4926 // If there's no return type (very rare in practice!), LLVM and Google style 4927 // agree. 4928 verifyFormat("- foo;"); 4929 verifyFormat("- foo:(int)f;"); 4930 verifyGoogleFormat("- foo:(int)foo;"); 4931 } 4932 4933 TEST_F(FormatTest, FormatObjCBlocks) { 4934 verifyFormat("int (^Block)(int, int);"); 4935 verifyFormat("int (^Block1)(int, int) = ^(int i, int j)"); 4936 } 4937 4938 TEST_F(FormatTest, FormatObjCInterface) { 4939 verifyFormat("@interface Foo : NSObject <NSSomeDelegate> {\n" 4940 "@public\n" 4941 " int field1;\n" 4942 "@protected\n" 4943 " int field2;\n" 4944 "@private\n" 4945 " int field3;\n" 4946 "@package\n" 4947 " int field4;\n" 4948 "}\n" 4949 "+ (id)init;\n" 4950 "@end"); 4951 4952 verifyGoogleFormat("@interface Foo : NSObject<NSSomeDelegate> {\n" 4953 " @public\n" 4954 " int field1;\n" 4955 " @protected\n" 4956 " int field2;\n" 4957 " @private\n" 4958 " int field3;\n" 4959 " @package\n" 4960 " int field4;\n" 4961 "}\n" 4962 "+ (id)init;\n" 4963 "@end"); 4964 4965 verifyFormat("@interface /* wait for it */ Foo\n" 4966 "+ (id)init;\n" 4967 "// Look, a comment!\n" 4968 "- (int)answerWith:(int)i;\n" 4969 "@end"); 4970 4971 verifyFormat("@interface Foo\n" 4972 "@end\n" 4973 "@interface Bar\n" 4974 "@end"); 4975 4976 verifyFormat("@interface Foo : Bar\n" 4977 "+ (id)init;\n" 4978 "@end"); 4979 4980 verifyFormat("@interface Foo : /**/ Bar /**/ <Baz, /**/ Quux>\n" 4981 "+ (id)init;\n" 4982 "@end"); 4983 4984 verifyGoogleFormat("@interface Foo : Bar<Baz, Quux>\n" 4985 "+ (id)init;\n" 4986 "@end"); 4987 4988 verifyFormat("@interface Foo (HackStuff)\n" 4989 "+ (id)init;\n" 4990 "@end"); 4991 4992 verifyFormat("@interface Foo ()\n" 4993 "+ (id)init;\n" 4994 "@end"); 4995 4996 verifyFormat("@interface Foo (HackStuff) <MyProtocol>\n" 4997 "+ (id)init;\n" 4998 "@end"); 4999 5000 verifyGoogleFormat("@interface Foo (HackStuff)<MyProtocol>\n" 5001 "+ (id)init;\n" 5002 "@end"); 5003 5004 verifyFormat("@interface Foo {\n" 5005 " int _i;\n" 5006 "}\n" 5007 "+ (id)init;\n" 5008 "@end"); 5009 5010 verifyFormat("@interface Foo : Bar {\n" 5011 " int _i;\n" 5012 "}\n" 5013 "+ (id)init;\n" 5014 "@end"); 5015 5016 verifyFormat("@interface Foo : Bar <Baz, Quux> {\n" 5017 " int _i;\n" 5018 "}\n" 5019 "+ (id)init;\n" 5020 "@end"); 5021 5022 verifyFormat("@interface Foo (HackStuff) {\n" 5023 " int _i;\n" 5024 "}\n" 5025 "+ (id)init;\n" 5026 "@end"); 5027 5028 verifyFormat("@interface Foo () {\n" 5029 " int _i;\n" 5030 "}\n" 5031 "+ (id)init;\n" 5032 "@end"); 5033 5034 verifyFormat("@interface Foo (HackStuff) <MyProtocol> {\n" 5035 " int _i;\n" 5036 "}\n" 5037 "+ (id)init;\n" 5038 "@end"); 5039 } 5040 5041 TEST_F(FormatTest, FormatObjCImplementation) { 5042 verifyFormat("@implementation Foo : NSObject {\n" 5043 "@public\n" 5044 " int field1;\n" 5045 "@protected\n" 5046 " int field2;\n" 5047 "@private\n" 5048 " int field3;\n" 5049 "@package\n" 5050 " int field4;\n" 5051 "}\n" 5052 "+ (id)init {\n}\n" 5053 "@end"); 5054 5055 verifyGoogleFormat("@implementation Foo : NSObject {\n" 5056 " @public\n" 5057 " int field1;\n" 5058 " @protected\n" 5059 " int field2;\n" 5060 " @private\n" 5061 " int field3;\n" 5062 " @package\n" 5063 " int field4;\n" 5064 "}\n" 5065 "+ (id)init {\n}\n" 5066 "@end"); 5067 5068 verifyFormat("@implementation Foo\n" 5069 "+ (id)init {\n" 5070 " if (true)\n" 5071 " return nil;\n" 5072 "}\n" 5073 "// Look, a comment!\n" 5074 "- (int)answerWith:(int)i {\n" 5075 " return i;\n" 5076 "}\n" 5077 "+ (int)answerWith:(int)i {\n" 5078 " return i;\n" 5079 "}\n" 5080 "@end"); 5081 5082 verifyFormat("@implementation Foo\n" 5083 "@end\n" 5084 "@implementation Bar\n" 5085 "@end"); 5086 5087 verifyFormat("@implementation Foo : Bar\n" 5088 "+ (id)init {\n}\n" 5089 "- (void)foo {\n}\n" 5090 "@end"); 5091 5092 verifyFormat("@implementation Foo {\n" 5093 " int _i;\n" 5094 "}\n" 5095 "+ (id)init {\n}\n" 5096 "@end"); 5097 5098 verifyFormat("@implementation Foo : Bar {\n" 5099 " int _i;\n" 5100 "}\n" 5101 "+ (id)init {\n}\n" 5102 "@end"); 5103 5104 verifyFormat("@implementation Foo (HackStuff)\n" 5105 "+ (id)init {\n}\n" 5106 "@end"); 5107 verifyFormat("@implementation ObjcClass\n" 5108 "- (void)method;\n" 5109 "{}\n" 5110 "@end"); 5111 } 5112 5113 TEST_F(FormatTest, FormatObjCProtocol) { 5114 verifyFormat("@protocol Foo\n" 5115 "@property(weak) id delegate;\n" 5116 "- (NSUInteger)numberOfThings;\n" 5117 "@end"); 5118 5119 verifyFormat("@protocol MyProtocol <NSObject>\n" 5120 "- (NSUInteger)numberOfThings;\n" 5121 "@end"); 5122 5123 verifyGoogleFormat("@protocol MyProtocol<NSObject>\n" 5124 "- (NSUInteger)numberOfThings;\n" 5125 "@end"); 5126 5127 verifyFormat("@protocol Foo;\n" 5128 "@protocol Bar;\n"); 5129 5130 verifyFormat("@protocol Foo\n" 5131 "@end\n" 5132 "@protocol Bar\n" 5133 "@end"); 5134 5135 verifyFormat("@protocol myProtocol\n" 5136 "- (void)mandatoryWithInt:(int)i;\n" 5137 "@optional\n" 5138 "- (void)optional;\n" 5139 "@required\n" 5140 "- (void)required;\n" 5141 "@optional\n" 5142 "@property(assign) int madProp;\n" 5143 "@end\n"); 5144 5145 verifyFormat("@property(nonatomic, assign, readonly)\n" 5146 " int *looooooooooooooooooooooooooooongNumber;\n" 5147 "@property(nonatomic, assign, readonly)\n" 5148 " NSString *looooooooooooooooooooooooooooongName;"); 5149 } 5150 5151 TEST_F(FormatTest, FormatObjCMethodDeclarations) { 5152 verifyFormat("- (void)doSomethingWith:(GTMFoo *)theFoo\n" 5153 " rect:(NSRect)theRect\n" 5154 " interval:(float)theInterval {\n" 5155 "}"); 5156 verifyFormat("- (void)shortf:(GTMFoo *)theFoo\n" 5157 " longKeyword:(NSRect)theRect\n" 5158 " evenLongerKeyword:(float)theInterval\n" 5159 " error:(NSError **)theError {\n" 5160 "}"); 5161 } 5162 5163 TEST_F(FormatTest, FormatObjCMethodExpr) { 5164 verifyFormat("[foo bar:baz];"); 5165 verifyFormat("return [foo bar:baz];"); 5166 verifyFormat("f([foo bar:baz]);"); 5167 verifyFormat("f(2, [foo bar:baz]);"); 5168 verifyFormat("f(2, a ? b : c);"); 5169 verifyFormat("[[self initWithInt:4] bar:[baz quux:arrrr]];"); 5170 5171 // Unary operators. 5172 verifyFormat("int a = +[foo bar:baz];"); 5173 verifyFormat("int a = -[foo bar:baz];"); 5174 verifyFormat("int a = ![foo bar:baz];"); 5175 verifyFormat("int a = ~[foo bar:baz];"); 5176 verifyFormat("int a = ++[foo bar:baz];"); 5177 verifyFormat("int a = --[foo bar:baz];"); 5178 verifyFormat("int a = sizeof [foo bar:baz];"); 5179 verifyFormat("int a = alignof [foo bar:baz];", getGoogleStyle()); 5180 verifyFormat("int a = &[foo bar:baz];"); 5181 verifyFormat("int a = *[foo bar:baz];"); 5182 // FIXME: Make casts work, without breaking f()[4]. 5183 //verifyFormat("int a = (int)[foo bar:baz];"); 5184 //verifyFormat("return (int)[foo bar:baz];"); 5185 //verifyFormat("(void)[foo bar:baz];"); 5186 verifyFormat("return (MyType *)[self.tableView cellForRowAtIndexPath:cell];"); 5187 5188 // Binary operators. 5189 verifyFormat("[foo bar:baz], [foo bar:baz];"); 5190 verifyFormat("[foo bar:baz] = [foo bar:baz];"); 5191 verifyFormat("[foo bar:baz] *= [foo bar:baz];"); 5192 verifyFormat("[foo bar:baz] /= [foo bar:baz];"); 5193 verifyFormat("[foo bar:baz] %= [foo bar:baz];"); 5194 verifyFormat("[foo bar:baz] += [foo bar:baz];"); 5195 verifyFormat("[foo bar:baz] -= [foo bar:baz];"); 5196 verifyFormat("[foo bar:baz] <<= [foo bar:baz];"); 5197 verifyFormat("[foo bar:baz] >>= [foo bar:baz];"); 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] : [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];"); 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 // Whew! 5221 5222 verifyFormat("return in[42];"); 5223 verifyFormat("for (id foo in [self getStuffFor:bla]) {\n" 5224 "}"); 5225 5226 verifyFormat("[self stuffWithInt:(4 + 2) float:4.5];"); 5227 verifyFormat("[self stuffWithInt:a ? b : c float:4.5];"); 5228 verifyFormat("[self stuffWithInt:a ? [self foo:bar] : c];"); 5229 verifyFormat("[self stuffWithInt:a ? (e ? f : g) : c];"); 5230 verifyFormat("[cond ? obj1 : obj2 methodWithParam:param]"); 5231 verifyFormat("[button setAction:@selector(zoomOut:)];"); 5232 verifyFormat("[color getRed:&r green:&g blue:&b alpha:&a];"); 5233 5234 verifyFormat("arr[[self indexForFoo:a]];"); 5235 verifyFormat("throw [self errorFor:a];"); 5236 verifyFormat("@throw [self errorFor:a];"); 5237 5238 verifyFormat("[(id)foo bar:(id)baz quux:(id)snorf];"); 5239 verifyFormat("[(id)foo bar:(id) ? baz : quux];"); 5240 verifyFormat("4 > 4 ? (id)a : (id)baz;"); 5241 5242 // This tests that the formatter doesn't break after "backing" but before ":", 5243 // which would be at 80 columns. 5244 verifyFormat( 5245 "void f() {\n" 5246 " if ((self = [super initWithContentRect:contentRect\n" 5247 " styleMask:styleMask ?: otherMask\n" 5248 " backing:NSBackingStoreBuffered\n" 5249 " defer:YES]))"); 5250 5251 verifyFormat( 5252 "[foo checkThatBreakingAfterColonWorksOk:\n" 5253 " [bar ifItDoes:reduceOverallLineLengthLikeInThisCase]];"); 5254 5255 verifyFormat("[myObj short:arg1 // Force line break\n" 5256 " longKeyword:arg2 != nil ? arg2 : @\"longKeyword\"\n" 5257 " evenLongerKeyword:arg3 ?: @\"evenLongerKeyword\"\n" 5258 " error:arg4];"); 5259 verifyFormat( 5260 "void f() {\n" 5261 " popup_window_.reset([[RenderWidgetPopupWindow alloc]\n" 5262 " initWithContentRect:NSMakeRect(origin_global.x, origin_global.y,\n" 5263 " pos.width(), pos.height())\n" 5264 " styleMask:NSBorderlessWindowMask\n" 5265 " backing:NSBackingStoreBuffered\n" 5266 " defer:NO]);\n" 5267 "}"); 5268 verifyFormat("[contentsContainer replaceSubview:[subviews objectAtIndex:0]\n" 5269 " with:contentsNativeView];"); 5270 5271 verifyFormat( 5272 "[pboard addTypes:[NSArray arrayWithObject:kBookmarkButtonDragType]\n" 5273 " owner:nillllll];"); 5274 5275 verifyFormat( 5276 "[pboard setData:[NSData dataWithBytes:&button length:sizeof(button)]\n" 5277 " forType:kBookmarkButtonDragType];"); 5278 5279 verifyFormat("[defaultCenter addObserver:self\n" 5280 " selector:@selector(willEnterFullscreen)\n" 5281 " name:kWillEnterFullscreenNotification\n" 5282 " object:nil];"); 5283 verifyFormat("[image_rep drawInRect:drawRect\n" 5284 " fromRect:NSZeroRect\n" 5285 " operation:NSCompositeCopy\n" 5286 " fraction:1.0\n" 5287 " respectFlipped:NO\n" 5288 " hints:nil];"); 5289 5290 verifyFormat( 5291 "scoped_nsobject<NSTextField> message(\n" 5292 " // The frame will be fixed up when |-setMessageText:| is called.\n" 5293 " [[NSTextField alloc] initWithFrame:NSMakeRect(0, 0, 0, 0)]);"); 5294 verifyFormat("[self aaaaaa:bbbbbbbbbbbbb\n" 5295 " aaaaaaaaaa:bbbbbbbbbbbbbbbbb\n" 5296 " aaaaa:bbbbbbbbbbb + bbbbbbbbbbbb\n" 5297 " aaaa:bbb];"); 5298 } 5299 5300 TEST_F(FormatTest, ObjCAt) { 5301 verifyFormat("@autoreleasepool"); 5302 verifyFormat("@catch"); 5303 verifyFormat("@class"); 5304 verifyFormat("@compatibility_alias"); 5305 verifyFormat("@defs"); 5306 verifyFormat("@dynamic"); 5307 verifyFormat("@encode"); 5308 verifyFormat("@end"); 5309 verifyFormat("@finally"); 5310 verifyFormat("@implementation"); 5311 verifyFormat("@import"); 5312 verifyFormat("@interface"); 5313 verifyFormat("@optional"); 5314 verifyFormat("@package"); 5315 verifyFormat("@private"); 5316 verifyFormat("@property"); 5317 verifyFormat("@protected"); 5318 verifyFormat("@protocol"); 5319 verifyFormat("@public"); 5320 verifyFormat("@required"); 5321 verifyFormat("@selector"); 5322 verifyFormat("@synchronized"); 5323 verifyFormat("@synthesize"); 5324 verifyFormat("@throw"); 5325 verifyFormat("@try"); 5326 5327 EXPECT_EQ("@interface", format("@ interface")); 5328 5329 // The precise formatting of this doesn't matter, nobody writes code like 5330 // this. 5331 verifyFormat("@ /*foo*/ interface"); 5332 } 5333 5334 TEST_F(FormatTest, ObjCSnippets) { 5335 verifyFormat("@autoreleasepool {\n" 5336 " foo();\n" 5337 "}"); 5338 verifyFormat("@class Foo, Bar;"); 5339 verifyFormat("@compatibility_alias AliasName ExistingClass;"); 5340 verifyFormat("@dynamic textColor;"); 5341 verifyFormat("char *buf1 = @encode(int *);"); 5342 verifyFormat("char *buf1 = @encode(typeof(4 * 5));"); 5343 verifyFormat("char *buf1 = @encode(int **);"); 5344 verifyFormat("Protocol *proto = @protocol(p1);"); 5345 verifyFormat("SEL s = @selector(foo:);"); 5346 verifyFormat("@synchronized(self) {\n" 5347 " f();\n" 5348 "}"); 5349 5350 verifyFormat("@synthesize dropArrowPosition = dropArrowPosition_;"); 5351 verifyGoogleFormat("@synthesize dropArrowPosition = dropArrowPosition_;"); 5352 5353 verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;"); 5354 verifyFormat("@property(assign, getter=isEditable) BOOL editable;"); 5355 verifyGoogleFormat("@property(assign, getter=isEditable) BOOL editable;"); 5356 5357 verifyFormat("@import foo.bar;\n" 5358 "@import baz;"); 5359 } 5360 5361 TEST_F(FormatTest, ObjCLiterals) { 5362 verifyFormat("@\"String\""); 5363 verifyFormat("@1"); 5364 verifyFormat("@+4.8"); 5365 verifyFormat("@-4"); 5366 verifyFormat("@1LL"); 5367 verifyFormat("@.5"); 5368 verifyFormat("@'c'"); 5369 verifyFormat("@true"); 5370 5371 verifyFormat("NSNumber *smallestInt = @(-INT_MAX - 1);"); 5372 verifyFormat("NSNumber *piOverTwo = @(M_PI / 2);"); 5373 verifyFormat("NSNumber *favoriteColor = @(Green);"); 5374 verifyFormat("NSString *path = @(getenv(\"PATH\"));"); 5375 5376 verifyFormat("@["); 5377 verifyFormat("@[]"); 5378 verifyFormat( 5379 "NSArray *array = @[ @\" Hey \", NSApp, [NSNumber numberWithInt:42] ];"); 5380 verifyFormat("return @[ @3, @[], @[ @4, @5 ] ];"); 5381 verifyFormat("NSArray *array = @[ [foo description] ];"); 5382 5383 verifyFormat("@{"); 5384 verifyFormat("@{}"); 5385 verifyFormat("@{ @\"one\" : @1 }"); 5386 verifyFormat("return @{ @\"one\" : @1 };"); 5387 verifyFormat("@{ @\"one\" : @1, }"); 5388 5389 verifyFormat("@{ @\"one\" : @{ @2 : @1 } }"); 5390 verifyFormat("@{ @\"one\" : @{ @2 : @1 }, }"); 5391 5392 verifyFormat("@{ 1 > 2 ? @\"one\" : @\"two\" : 1 > 2 ? @1 : @2 }"); 5393 verifyFormat("[self setDict:@{}"); 5394 verifyFormat("[self setDict:@{ @1 : @2 }"); 5395 verifyFormat("NSLog(@\"%@\", @{ @1 : @2, @2 : @3 }[@1]);"); 5396 verifyFormat( 5397 "NSDictionary *masses = @{ @\"H\" : @1.0078, @\"He\" : @4.0026 };"); 5398 verifyFormat( 5399 "NSDictionary *settings = @{ AVEncoderKey : @(AVAudioQualityMax) };"); 5400 5401 verifyFormat( 5402 "NSDictionary *d = @{\n" 5403 " @\"nam\" : NSUserNam(),\n" 5404 " @\"dte\" : [NSDate date],\n" 5405 " @\"processInfo\" : [NSProcessInfo processInfo]\n" 5406 "};"); 5407 verifyFormat( 5408 "@{\n" 5409 " NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee : " 5410 "regularFont,\n" 5411 "};"); 5412 verifyFormat( 5413 "NSArray *arguments = @[\n" 5414 " kind == kUserTicket ? @\"--user-store\" : @\"--system-store\",\n" 5415 " @\"--print-tickets\",\n" 5416 " @\"--productid\",\n" 5417 " @\"com.google.Chrome\"\n" 5418 "];"); 5419 verifyGoogleFormat( 5420 "@{\n" 5421 " NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee : " 5422 "regularFont,\n" 5423 "};"); 5424 verifyGoogleFormat( 5425 "NSArray *arguments = @[\n" 5426 " kind == kUserTicket ? @\"--user-store\" : @\"--system-store\",\n" 5427 " @\"--print-tickets\",\n" 5428 " @\"--productid\",\n" 5429 " @\"com.google.Chrome\"\n" 5430 "];"); 5431 } 5432 5433 TEST_F(FormatTest, ReformatRegionAdjustsIndent) { 5434 EXPECT_EQ("{\n" 5435 "{\n" 5436 "a;\n" 5437 "b;\n" 5438 "}\n" 5439 "}", 5440 format("{\n" 5441 "{\n" 5442 "a;\n" 5443 " b;\n" 5444 "}\n" 5445 "}", 5446 13, 2, getLLVMStyle())); 5447 EXPECT_EQ("{\n" 5448 "{\n" 5449 " a;\n" 5450 "b;\n" 5451 "}\n" 5452 "}", 5453 format("{\n" 5454 "{\n" 5455 " a;\n" 5456 "b;\n" 5457 "}\n" 5458 "}", 5459 9, 2, getLLVMStyle())); 5460 EXPECT_EQ("{\n" 5461 "{\n" 5462 "public:\n" 5463 " b;\n" 5464 "}\n" 5465 "}", 5466 format("{\n" 5467 "{\n" 5468 "public:\n" 5469 " b;\n" 5470 "}\n" 5471 "}", 5472 17, 2, getLLVMStyle())); 5473 EXPECT_EQ("{\n" 5474 "{\n" 5475 "a;\n" 5476 "}\n" 5477 "{\n" 5478 " b; //\n" 5479 "}\n" 5480 "}", 5481 format("{\n" 5482 "{\n" 5483 "a;\n" 5484 "}\n" 5485 "{\n" 5486 " b; //\n" 5487 "}\n" 5488 "}", 5489 22, 2, getLLVMStyle())); 5490 EXPECT_EQ(" {\n" 5491 " a; //\n" 5492 " }", 5493 format(" {\n" 5494 "a; //\n" 5495 " }", 5496 4, 2, getLLVMStyle())); 5497 EXPECT_EQ("void f() {}\n" 5498 "void g() {}", 5499 format("void f() {}\n" 5500 "void g() {}", 5501 13, 0, getLLVMStyle())); 5502 EXPECT_EQ("int a; // comment\n" 5503 " // line 2\n" 5504 "int b;", 5505 format("int a; // comment\n" 5506 " // line 2\n" 5507 " int b;", 5508 35, 0, getLLVMStyle())); 5509 EXPECT_EQ(" int a;\n" 5510 " void\n" 5511 " ffffff() {\n" 5512 " }", 5513 format(" int a;\n" 5514 "void ffffff() {}", 5515 11, 0, getLLVMStyleWithColumns(11))); 5516 } 5517 5518 TEST_F(FormatTest, BreakStringLiterals) { 5519 EXPECT_EQ("\"some text \"\n" 5520 "\"other\";", 5521 format("\"some text other\";", getLLVMStyleWithColumns(12))); 5522 EXPECT_EQ("\"some text \"\n" 5523 "\"other\";", 5524 format("\\\n\"some text other\";", getLLVMStyleWithColumns(12))); 5525 EXPECT_EQ( 5526 "#define A \\\n" 5527 " \"some \" \\\n" 5528 " \"text \" \\\n" 5529 " \"other\";", 5530 format("#define A \"some text other\";", getLLVMStyleWithColumns(12))); 5531 EXPECT_EQ( 5532 "#define A \\\n" 5533 " \"so \" \\\n" 5534 " \"text \" \\\n" 5535 " \"other\";", 5536 format("#define A \"so text other\";", getLLVMStyleWithColumns(12))); 5537 5538 EXPECT_EQ("\"some text\"", 5539 format("\"some text\"", getLLVMStyleWithColumns(1))); 5540 EXPECT_EQ("\"some text\"", 5541 format("\"some text\"", getLLVMStyleWithColumns(11))); 5542 EXPECT_EQ("\"some \"\n" 5543 "\"text\"", 5544 format("\"some text\"", getLLVMStyleWithColumns(10))); 5545 EXPECT_EQ("\"some \"\n" 5546 "\"text\"", 5547 format("\"some text\"", getLLVMStyleWithColumns(7))); 5548 EXPECT_EQ("\"some\"\n" 5549 "\" tex\"\n" 5550 "\"t\"", 5551 format("\"some text\"", getLLVMStyleWithColumns(6))); 5552 EXPECT_EQ("\"some\"\n" 5553 "\" tex\"\n" 5554 "\" and\"", 5555 format("\"some tex and\"", getLLVMStyleWithColumns(6))); 5556 EXPECT_EQ("\"some\"\n" 5557 "\"/tex\"\n" 5558 "\"/and\"", 5559 format("\"some/tex/and\"", getLLVMStyleWithColumns(6))); 5560 5561 EXPECT_EQ("variable =\n" 5562 " \"long string \"\n" 5563 " \"literal\";", 5564 format("variable = \"long string literal\";", 5565 getLLVMStyleWithColumns(20))); 5566 5567 EXPECT_EQ("variable = f(\n" 5568 " \"long string \"\n" 5569 " \"literal\",\n" 5570 " short,\n" 5571 " loooooooooooooooooooong);", 5572 format("variable = f(\"long string literal\", short, " 5573 "loooooooooooooooooooong);", 5574 getLLVMStyleWithColumns(20))); 5575 5576 EXPECT_EQ("f(g(\"long string \"\n" 5577 " \"literal\"),\n" 5578 " b);", 5579 format("f(g(\"long string literal\"), b);", 5580 getLLVMStyleWithColumns(20))); 5581 EXPECT_EQ("f(g(\"long string \"\n" 5582 " \"literal\",\n" 5583 " a),\n" 5584 " b);", 5585 format("f(g(\"long string literal\", a), b);", 5586 getLLVMStyleWithColumns(20))); 5587 EXPECT_EQ( 5588 "f(\"one two\".split(\n" 5589 " variable));", 5590 format("f(\"one two\".split(variable));", getLLVMStyleWithColumns(20))); 5591 EXPECT_EQ("f(\"one two three four five six \"\n" 5592 " \"seven\".split(\n" 5593 " really_looooong_variable));", 5594 format("f(\"one two three four five six seven\"." 5595 "split(really_looooong_variable));", 5596 getLLVMStyleWithColumns(33))); 5597 5598 EXPECT_EQ("f(\"some \"\n" 5599 " \"text\",\n" 5600 " other);", 5601 format("f(\"some text\", other);", getLLVMStyleWithColumns(10))); 5602 5603 // Only break as a last resort. 5604 verifyFormat( 5605 "aaaaaaaaaaaaaaaaaaaa(\n" 5606 " aaaaaaaaaaaaaaaaaaaa,\n" 5607 " aaaaaa(\"aaa aaaaa aaa aaa aaaaa aaa aaaaa aaa aaa aaaaaa\"));"); 5608 5609 EXPECT_EQ( 5610 "\"splitmea\"\n" 5611 "\"trandomp\"\n" 5612 "\"oint\"", 5613 format("\"splitmeatrandompoint\"", getLLVMStyleWithColumns(10))); 5614 5615 EXPECT_EQ( 5616 "\"split/\"\n" 5617 "\"pathat/\"\n" 5618 "\"slashes\"", 5619 format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); 5620 5621 EXPECT_EQ( 5622 "\"split/\"\n" 5623 "\"pathat/\"\n" 5624 "\"slashes\"", 5625 format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); 5626 EXPECT_EQ("\"split at \"\n" 5627 "\"spaces/at/\"\n" 5628 "\"slashes.at.any$\"\n" 5629 "\"non-alphanumeric%\"\n" 5630 "\"1111111111characte\"\n" 5631 "\"rs\"", 5632 format("\"split at " 5633 "spaces/at/" 5634 "slashes.at." 5635 "any$non-" 5636 "alphanumeric%" 5637 "1111111111characte" 5638 "rs\"", 5639 getLLVMStyleWithColumns(20))); 5640 5641 // Verify that splitting the strings understands 5642 // Style::AlwaysBreakBeforeMultilineStrings. 5643 EXPECT_EQ("aaaaaaaaaaaa(aaaaaaaaaaaaa,\n" 5644 " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa \"\n" 5645 " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\");", 5646 format("aaaaaaaaaaaa(aaaaaaaaaaaaa, \"aaaaaaaaaaaaaaaaaaaaaa " 5647 "aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa " 5648 "aaaaaaaaaaaaaaaaaaaaaa\");", 5649 getGoogleStyle())); 5650 EXPECT_EQ("return \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 5651 " \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\";", 5652 format("return \"aaaaaaaaaaaaaaaaaaaaaa " 5653 "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaa " 5654 "aaaaaaaaaaaaaaaaaaaaaa\";", 5655 getGoogleStyle())); 5656 EXPECT_EQ("llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 5657 " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";", 5658 format("llvm::outs() << " 5659 "\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa" 5660 "aaaaaaaaaaaaaaaaaaa\";")); 5661 EXPECT_EQ("ffff(\n" 5662 " {\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 5663 " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});", 5664 format("ffff({\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa " 5665 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});", 5666 getGoogleStyle())); 5667 5668 FormatStyle AlignLeft = getLLVMStyleWithColumns(12); 5669 AlignLeft.AlignEscapedNewlinesLeft = true; 5670 EXPECT_EQ( 5671 "#define A \\\n" 5672 " \"some \" \\\n" 5673 " \"text \" \\\n" 5674 " \"other\";", 5675 format("#define A \"some text other\";", AlignLeft)); 5676 } 5677 5678 TEST_F(FormatTest, BreaksWideStringLiterals) { 5679 EXPECT_EQ( 5680 "u8\"utf8 string \"\n" 5681 "u8\"literal\";", 5682 format("u8\"utf8 string literal\";", getGoogleStyleWithColumns(16))); 5683 EXPECT_EQ( 5684 "u\"utf16 string \"\n" 5685 "u\"literal\";", 5686 format("u\"utf16 string literal\";", getGoogleStyleWithColumns(16))); 5687 EXPECT_EQ( 5688 "U\"utf32 string \"\n" 5689 "U\"literal\";", 5690 format("U\"utf32 string literal\";", getGoogleStyleWithColumns(16))); 5691 EXPECT_EQ("L\"wide string \"\n" 5692 "L\"literal\";", 5693 format("L\"wide string literal\";", getGoogleStyleWithColumns(16))); 5694 } 5695 5696 TEST_F(FormatTest, BreaksRawStringLiterals) { 5697 EXPECT_EQ("R\"x(raw )x\"\n" 5698 "R\"x(literal)x\";", 5699 format("R\"x(raw literal)x\";", getGoogleStyleWithColumns(15))); 5700 EXPECT_EQ("uR\"x(raw )x\"\n" 5701 "uR\"x(literal)x\";", 5702 format("uR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); 5703 EXPECT_EQ("u8R\"x(raw )x\"\n" 5704 "u8R\"x(literal)x\";", 5705 format("u8R\"x(raw literal)x\";", getGoogleStyleWithColumns(17))); 5706 EXPECT_EQ("LR\"x(raw )x\"\n" 5707 "LR\"x(literal)x\";", 5708 format("LR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); 5709 EXPECT_EQ("UR\"x(raw )x\"\n" 5710 "UR\"x(literal)x\";", 5711 format("UR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); 5712 } 5713 5714 TEST_F(FormatTest, BreaksStringLiteralsWithin_TMacro) { 5715 FormatStyle Style = getLLVMStyleWithColumns(20); 5716 EXPECT_EQ( 5717 "_T(\"aaaaaaaaaaaaaa\")\n" 5718 "_T(\"aaaaaaaaaaaaaa\")\n" 5719 "_T(\"aaaaaaaaaaaa\")", 5720 format(" _T(\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")", Style)); 5721 EXPECT_EQ("f(x, _T(\"aaaaaaaaa\")\n" 5722 " _T(\"aaaaaa\"),\n" 5723 " z);", 5724 format("f(x, _T(\"aaaaaaaaaaaaaaa\"), z);", Style)); 5725 5726 // FIXME: Handle embedded spaces in one iteration. 5727 // EXPECT_EQ("_T(\"aaaaaaaaaaaaa\")\n" 5728 // "_T(\"aaaaaaaaaaaaa\")\n" 5729 // "_T(\"aaaaaaaaaaaaa\")\n" 5730 // "_T(\"a\")", 5731 // format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", 5732 // getLLVMStyleWithColumns(20))); 5733 EXPECT_EQ( 5734 "_T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", 5735 format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", Style)); 5736 } 5737 5738 TEST_F(FormatTest, DontSplitStringLiteralsWithEscapedNewlines) { 5739 EXPECT_EQ( 5740 "aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5741 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5742 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";", 5743 format("aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5744 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" 5745 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";")); 5746 } 5747 5748 TEST_F(FormatTest, CountsCharactersInMultilineRawStringLiterals) { 5749 EXPECT_EQ("f(g(R\"x(raw literal)x\", a), b);", 5750 format("f(g(R\"x(raw literal)x\", a), b);", getGoogleStyle())); 5751 EXPECT_EQ("fffffffffff(g(R\"x(\n" 5752 "multiline raw string literal xxxxxxxxxxxxxx\n" 5753 ")x\",\n" 5754 " a),\n" 5755 " b);", 5756 format("fffffffffff(g(R\"x(\n" 5757 "multiline raw string literal xxxxxxxxxxxxxx\n" 5758 ")x\", a), b);", 5759 getGoogleStyleWithColumns(20))); 5760 EXPECT_EQ("fffffffffff(\n" 5761 " g(R\"x(qqq\n" 5762 "multiline raw string literal xxxxxxxxxxxxxx\n" 5763 ")x\",\n" 5764 " a),\n" 5765 " b);", 5766 format("fffffffffff(g(R\"x(qqq\n" 5767 "multiline raw string literal xxxxxxxxxxxxxx\n" 5768 ")x\", a), b);", 5769 getGoogleStyleWithColumns(20))); 5770 5771 EXPECT_EQ("fffffffffff(R\"x(\n" 5772 "multiline raw string literal xxxxxxxxxxxxxx\n" 5773 ")x\");", 5774 format("fffffffffff(R\"x(\n" 5775 "multiline raw string literal xxxxxxxxxxxxxx\n" 5776 ")x\");", 5777 getGoogleStyleWithColumns(20))); 5778 EXPECT_EQ("fffffffffff(R\"x(\n" 5779 "multiline raw string literal xxxxxxxxxxxxxx\n" 5780 ")x\" +\n" 5781 " bbbbbb);", 5782 format("fffffffffff(R\"x(\n" 5783 "multiline raw string literal xxxxxxxxxxxxxx\n" 5784 ")x\" + bbbbbb);", 5785 getGoogleStyleWithColumns(20))); 5786 } 5787 5788 TEST_F(FormatTest, SkipsUnknownStringLiterals) { 5789 verifyFormat("string a = \"unterminated;"); 5790 EXPECT_EQ("function(\"unterminated,\n" 5791 " OtherParameter);", 5792 format("function( \"unterminated,\n" 5793 " OtherParameter);")); 5794 } 5795 5796 TEST_F(FormatTest, DoesNotTryToParseUDLiteralsInPreCpp11Code) { 5797 EXPECT_EQ("#define x(_a) printf(\"foo\" _a);", 5798 format("#define x(_a) printf(\"foo\"_a);", getLLVMStyle())); 5799 } 5800 5801 TEST_F(FormatTest, BreakStringLiteralsBeforeUnbreakableTokenSequence) { 5802 EXPECT_EQ("someFunction(\"aaabbbcccd\"\n" 5803 " \"ddeeefff\");", 5804 format("someFunction(\"aaabbbcccdddeeefff\");", 5805 getLLVMStyleWithColumns(25))); 5806 EXPECT_EQ("someFunction1234567890(\n" 5807 " \"aaabbbcccdddeeefff\");", 5808 format("someFunction1234567890(\"aaabbbcccdddeeefff\");", 5809 getLLVMStyleWithColumns(26))); 5810 EXPECT_EQ("someFunction1234567890(\n" 5811 " \"aaabbbcccdddeeeff\"\n" 5812 " \"f\");", 5813 format("someFunction1234567890(\"aaabbbcccdddeeefff\");", 5814 getLLVMStyleWithColumns(25))); 5815 EXPECT_EQ("someFunction1234567890(\n" 5816 " \"aaabbbcccdddeeeff\"\n" 5817 " \"f\");", 5818 format("someFunction1234567890(\"aaabbbcccdddeeefff\");", 5819 getLLVMStyleWithColumns(24))); 5820 EXPECT_EQ("someFunction(\"aaabbbcc \"\n" 5821 " \"ddde \"\n" 5822 " \"efff\");", 5823 format("someFunction(\"aaabbbcc ddde efff\");", 5824 getLLVMStyleWithColumns(25))); 5825 EXPECT_EQ("someFunction(\"aaabbbccc \"\n" 5826 " \"ddeeefff\");", 5827 format("someFunction(\"aaabbbccc ddeeefff\");", 5828 getLLVMStyleWithColumns(25))); 5829 EXPECT_EQ("someFunction1234567890(\n" 5830 " \"aaabb \"\n" 5831 " \"cccdddeeefff\");", 5832 format("someFunction1234567890(\"aaabb cccdddeeefff\");", 5833 getLLVMStyleWithColumns(25))); 5834 EXPECT_EQ("#define A \\\n" 5835 " string s = \\\n" 5836 " \"123456789\" \\\n" 5837 " \"0\"; \\\n" 5838 " int i;", 5839 format("#define A string s = \"1234567890\"; int i;", 5840 getLLVMStyleWithColumns(20))); 5841 // FIXME: Put additional penalties on breaking at non-whitespace locations. 5842 EXPECT_EQ("someFunction(\"aaabbbcc \"\n" 5843 " \"dddeeeff\"\n" 5844 " \"f\");", 5845 format("someFunction(\"aaabbbcc dddeeefff\");", 5846 getLLVMStyleWithColumns(25))); 5847 } 5848 5849 TEST_F(FormatTest, DoNotBreakStringLiteralsInEscapeSequence) { 5850 EXPECT_EQ("\"\\a\"", 5851 format("\"\\a\"", getLLVMStyleWithColumns(3))); 5852 EXPECT_EQ("\"\\\"", 5853 format("\"\\\"", getLLVMStyleWithColumns(2))); 5854 EXPECT_EQ("\"test\"\n" 5855 "\"\\n\"", 5856 format("\"test\\n\"", getLLVMStyleWithColumns(7))); 5857 EXPECT_EQ("\"tes\\\\\"\n" 5858 "\"n\"", 5859 format("\"tes\\\\n\"", getLLVMStyleWithColumns(7))); 5860 EXPECT_EQ("\"\\\\\\\\\"\n" 5861 "\"\\n\"", 5862 format("\"\\\\\\\\\\n\"", getLLVMStyleWithColumns(7))); 5863 EXPECT_EQ("\"\\uff01\"", 5864 format("\"\\uff01\"", getLLVMStyleWithColumns(7))); 5865 EXPECT_EQ("\"\\uff01\"\n" 5866 "\"test\"", 5867 format("\"\\uff01test\"", getLLVMStyleWithColumns(8))); 5868 EXPECT_EQ("\"\\Uff01ff02\"", 5869 format("\"\\Uff01ff02\"", getLLVMStyleWithColumns(11))); 5870 EXPECT_EQ("\"\\x000000000001\"\n" 5871 "\"next\"", 5872 format("\"\\x000000000001next\"", getLLVMStyleWithColumns(16))); 5873 EXPECT_EQ("\"\\x000000000001next\"", 5874 format("\"\\x000000000001next\"", getLLVMStyleWithColumns(15))); 5875 EXPECT_EQ("\"\\x000000000001\"", 5876 format("\"\\x000000000001\"", getLLVMStyleWithColumns(7))); 5877 EXPECT_EQ("\"test\"\n" 5878 "\"\\000000\"\n" 5879 "\"000001\"", 5880 format("\"test\\000000000001\"", getLLVMStyleWithColumns(9))); 5881 EXPECT_EQ("\"test\\000\"\n" 5882 "\"00000000\"\n" 5883 "\"1\"", 5884 format("\"test\\000000000001\"", getLLVMStyleWithColumns(10))); 5885 // FIXME: We probably don't need to care about escape sequences in raw 5886 // literals. 5887 EXPECT_EQ("R\"(\\x)\"\n" 5888 "R\"(\\x00)\"\n", 5889 format("R\"(\\x\\x00)\"\n", getGoogleStyleWithColumns(7))); 5890 } 5891 5892 TEST_F(FormatTest, DoNotCreateUnreasonableUnwrappedLines) { 5893 verifyFormat("void f() {\n" 5894 " return g() {}\n" 5895 " void h() {}"); 5896 verifyFormat("if (foo)\n" 5897 " return { forgot_closing_brace();\n" 5898 "test();"); 5899 verifyFormat("int a[] = { void forgot_closing_brace() { f();\n" 5900 "g();\n" 5901 "}"); 5902 } 5903 5904 TEST_F(FormatTest, FormatsClosingBracesInEmptyNestedBlocks) { 5905 verifyFormat("class X {\n" 5906 " void f() {\n" 5907 " }\n" 5908 "};", 5909 getLLVMStyleWithColumns(12)); 5910 } 5911 5912 TEST_F(FormatTest, ConfigurableIndentWidth) { 5913 FormatStyle EightIndent = getLLVMStyleWithColumns(18); 5914 EightIndent.IndentWidth = 8; 5915 verifyFormat("void f() {\n" 5916 " someFunction();\n" 5917 " if (true) {\n" 5918 " f();\n" 5919 " }\n" 5920 "}", 5921 EightIndent); 5922 verifyFormat("class X {\n" 5923 " void f() {\n" 5924 " }\n" 5925 "};", 5926 EightIndent); 5927 verifyFormat("int x[] = {\n" 5928 " call(),\n" 5929 " call(),\n" 5930 "};", 5931 EightIndent); 5932 } 5933 5934 TEST_F(FormatTest, ConfigurableFunctionDeclarationIndentAfterType) { 5935 verifyFormat("void\n" 5936 "f();", 5937 getLLVMStyleWithColumns(8)); 5938 } 5939 5940 TEST_F(FormatTest, ConfigurableUseOfTab) { 5941 FormatStyle Tab = getLLVMStyleWithColumns(42); 5942 Tab.IndentWidth = 8; 5943 Tab.UseTab = FormatStyle::UT_Always; 5944 Tab.AlignEscapedNewlinesLeft = true; 5945 5946 EXPECT_EQ("if (aaaaaaaa && // q\n" 5947 " bb)\t\t// w\n" 5948 "\t;", 5949 format("if (aaaaaaaa &&// q\n" 5950 "bb)// w\n" 5951 ";", 5952 Tab)); 5953 EXPECT_EQ("if (aaa && bbb) // w\n" 5954 "\t;", 5955 format("if(aaa&&bbb)// w\n" 5956 ";", 5957 Tab)); 5958 5959 verifyFormat("class X {\n" 5960 "\tvoid f() {\n" 5961 "\t\tsomeFunction(parameter1,\n" 5962 "\t\t\t parameter2);\n" 5963 "\t}\n" 5964 "};", 5965 Tab); 5966 verifyFormat("#define A \\\n" 5967 "\tvoid f() { \\\n" 5968 "\t\tsomeFunction( \\\n" 5969 "\t\t parameter1, \\\n" 5970 "\t\t parameter2); \\\n" 5971 "\t}", 5972 Tab); 5973 EXPECT_EQ("void f() {\n" 5974 "\tf();\n" 5975 "\tg();\n" 5976 "}", 5977 format("void f() {\n" 5978 "\tf();\n" 5979 "\tg();\n" 5980 "}", 5981 0, 0, Tab)); 5982 EXPECT_EQ("void f() {\n" 5983 "\tf();\n" 5984 "\tg();\n" 5985 "}", 5986 format("void f() {\n" 5987 "\tf();\n" 5988 "\tg();\n" 5989 "}", 5990 16, 0, Tab)); 5991 EXPECT_EQ("void f() {\n" 5992 " \tf();\n" 5993 "\tg();\n" 5994 "}", 5995 format("void f() {\n" 5996 " \tf();\n" 5997 " \tg();\n" 5998 "}", 5999 21, 0, Tab)); 6000 6001 Tab.TabWidth = 4; 6002 Tab.IndentWidth = 8; 6003 verifyFormat("class TabWidth4Indent8 {\n" 6004 "\t\tvoid f() {\n" 6005 "\t\t\t\tsomeFunction(parameter1,\n" 6006 "\t\t\t\t\t\t\t parameter2);\n" 6007 "\t\t}\n" 6008 "};", 6009 Tab); 6010 6011 Tab.TabWidth = 4; 6012 Tab.IndentWidth = 4; 6013 verifyFormat("class TabWidth4Indent4 {\n" 6014 "\tvoid f() {\n" 6015 "\t\tsomeFunction(parameter1,\n" 6016 "\t\t\t\t\t parameter2);\n" 6017 "\t}\n" 6018 "};", 6019 Tab); 6020 6021 Tab.TabWidth = 8; 6022 Tab.IndentWidth = 4; 6023 verifyFormat("class TabWidth8Indent4 {\n" 6024 " void f() {\n" 6025 "\tsomeFunction(parameter1,\n" 6026 "\t\t parameter2);\n" 6027 " }\n" 6028 "};", 6029 Tab); 6030 6031 Tab.TabWidth = 8; 6032 Tab.IndentWidth = 8; 6033 EXPECT_EQ("/*\n" 6034 "\t a\t\tcomment\n" 6035 "\t in multiple lines\n" 6036 " */", 6037 format(" /*\t \t \n" 6038 " \t \t a\t\tcomment\t \t\n" 6039 " \t \t in multiple lines\t\n" 6040 " \t */", 6041 Tab)); 6042 6043 Tab.UseTab = FormatStyle::UT_ForIndentation; 6044 verifyFormat("T t[] = {\n" 6045 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6046 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6047 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6048 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6049 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 6050 "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6051 "};", 6052 Tab); 6053 verifyFormat("enum A {\n" 6054 "\ta1,\n" 6055 "\ta2,\n" 6056 "\ta3\n" 6057 "};", 6058 Tab); 6059 EXPECT_EQ("if (aaaaaaaa && // q\n" 6060 " bb) // w\n" 6061 "\t;", 6062 format("if (aaaaaaaa &&// q\n" 6063 "bb)// w\n" 6064 ";", 6065 Tab)); 6066 verifyFormat("class X {\n" 6067 "\tvoid f() {\n" 6068 "\t\tsomeFunction(parameter1,\n" 6069 "\t\t parameter2);\n" 6070 "\t}\n" 6071 "};", 6072 Tab); 6073 verifyFormat("{\n" 6074 "\tQ({\n" 6075 "\t\t int a;\n" 6076 "\t\t someFunction(aaaaaaaaaa,\n" 6077 "\t\t bbbbbbbbb);\n" 6078 "\t },\n" 6079 "\t p);\n" 6080 "}", 6081 Tab); 6082 EXPECT_EQ("{\n" 6083 "\t/* aaaa\n" 6084 "\t bbbb */\n" 6085 "}", 6086 format("{\n" 6087 "/* aaaa\n" 6088 " bbbb */\n" 6089 "}", 6090 Tab)); 6091 EXPECT_EQ("{\n" 6092 "\t/*\n" 6093 "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6094 "\t bbbbbbbbbbbbb\n" 6095 "\t*/\n" 6096 "}", 6097 format("{\n" 6098 "/*\n" 6099 " aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" 6100 "*/\n" 6101 "}", 6102 Tab)); 6103 EXPECT_EQ("{\n" 6104 "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6105 "\t// bbbbbbbbbbbbb\n" 6106 "}", 6107 format("{\n" 6108 "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" 6109 "}", 6110 Tab)); 6111 EXPECT_EQ("{\n" 6112 "\t/*\n" 6113 "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n" 6114 "\t bbbbbbbbbbbbb\n" 6115 "\t*/\n" 6116 "}", 6117 format("{\n" 6118 "\t/*\n" 6119 "\t aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" 6120 "\t*/\n" 6121 "}", 6122 Tab)); 6123 EXPECT_EQ("{\n" 6124 "\t/*\n" 6125 "\n" 6126 "\t*/\n" 6127 "}", 6128 format("{\n" 6129 "\t/*\n" 6130 "\n" 6131 "\t*/\n" 6132 "}", 6133 Tab)); 6134 EXPECT_EQ("{\n" 6135 "\t/*\n" 6136 " asdf\n" 6137 "\t*/\n" 6138 "}", 6139 format("{\n" 6140 "\t/*\n" 6141 " asdf\n" 6142 "\t*/\n" 6143 "}", 6144 Tab)); 6145 6146 Tab.UseTab = FormatStyle::UT_Never; 6147 EXPECT_EQ("/*\n" 6148 " a\t\tcomment\n" 6149 " in multiple lines\n" 6150 " */", 6151 format(" /*\t \t \n" 6152 " \t \t a\t\tcomment\t \t\n" 6153 " \t \t in multiple lines\t\n" 6154 " \t */", 6155 Tab)); 6156 EXPECT_EQ("/* some\n" 6157 " comment */", 6158 format(" \t \t /* some\n" 6159 " \t \t comment */", 6160 Tab)); 6161 EXPECT_EQ("int a; /* some\n" 6162 " comment */", 6163 format(" \t \t int a; /* some\n" 6164 " \t \t comment */", 6165 Tab)); 6166 6167 EXPECT_EQ("int a; /* some\n" 6168 "comment */", 6169 format(" \t \t int\ta; /* some\n" 6170 " \t \t comment */", 6171 Tab)); 6172 EXPECT_EQ("f(\"\t\t\"); /* some\n" 6173 " comment */", 6174 format(" \t \t f(\"\t\t\"); /* some\n" 6175 " \t \t comment */", 6176 Tab)); 6177 EXPECT_EQ("{\n" 6178 " /*\n" 6179 " * Comment\n" 6180 " */\n" 6181 " int i;\n" 6182 "}", 6183 format("{\n" 6184 "\t/*\n" 6185 "\t * Comment\n" 6186 "\t */\n" 6187 "\t int i;\n" 6188 "}")); 6189 } 6190 6191 TEST_F(FormatTest, CalculatesOriginalColumn) { 6192 EXPECT_EQ("\"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6193 "q\"; /* some\n" 6194 " comment */", 6195 format(" \"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6196 "q\"; /* some\n" 6197 " comment */", 6198 getLLVMStyle())); 6199 EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n" 6200 "/* some\n" 6201 " comment */", 6202 format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n" 6203 " /* some\n" 6204 " comment */", 6205 getLLVMStyle())); 6206 EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6207 "qqq\n" 6208 "/* some\n" 6209 " comment */", 6210 format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6211 "qqq\n" 6212 " /* some\n" 6213 " comment */", 6214 getLLVMStyle())); 6215 EXPECT_EQ("inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6216 "wwww; /* some\n" 6217 " comment */", 6218 format(" inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" 6219 "wwww; /* some\n" 6220 " comment */", 6221 getLLVMStyle())); 6222 } 6223 6224 TEST_F(FormatTest, ConfigurableSpaceAfterControlStatementKeyword) { 6225 FormatStyle NoSpace = getLLVMStyle(); 6226 NoSpace.SpaceAfterControlStatementKeyword = false; 6227 6228 verifyFormat("while(true)\n" 6229 " continue;", NoSpace); 6230 verifyFormat("for(;;)\n" 6231 " continue;", NoSpace); 6232 verifyFormat("if(true)\n" 6233 " f();\n" 6234 "else if(true)\n" 6235 " f();", NoSpace); 6236 verifyFormat("do {\n" 6237 " do_something();\n" 6238 "} while(something());", NoSpace); 6239 verifyFormat("switch(x) {\n" 6240 "default:\n" 6241 " break;\n" 6242 "}", NoSpace); 6243 } 6244 6245 TEST_F(FormatTest, ConfigurableSpacesInParentheses) { 6246 FormatStyle Spaces = getLLVMStyle(); 6247 6248 Spaces.SpacesInParentheses = true; 6249 verifyFormat("call( x, y, z );", Spaces); 6250 verifyFormat("while ( (bool)1 )\n" 6251 " continue;", Spaces); 6252 verifyFormat("for ( ;; )\n" 6253 " continue;", Spaces); 6254 verifyFormat("if ( true )\n" 6255 " f();\n" 6256 "else if ( true )\n" 6257 " f();", Spaces); 6258 verifyFormat("do {\n" 6259 " do_something( (int)i );\n" 6260 "} while ( something() );", Spaces); 6261 verifyFormat("switch ( x ) {\n" 6262 "default:\n" 6263 " break;\n" 6264 "}", Spaces); 6265 6266 Spaces.SpacesInParentheses = false; 6267 Spaces.SpacesInCStyleCastParentheses = true; 6268 verifyFormat("Type *A = ( Type * )P;", Spaces); 6269 verifyFormat("Type *A = ( vector<Type *, int *> )P;", Spaces); 6270 verifyFormat("x = ( int32 )y;", Spaces); 6271 verifyFormat("int a = ( int )(2.0f);", Spaces); 6272 verifyFormat("#define AA(X) sizeof((( X * )NULL)->a)", Spaces); 6273 verifyFormat("my_int a = ( my_int )sizeof(int);", Spaces); 6274 verifyFormat("#define x (( int )-1)", Spaces); 6275 6276 Spaces.SpacesInParentheses = false; 6277 Spaces.SpaceInEmptyParentheses = true; 6278 verifyFormat("call(x, y, z);", Spaces); 6279 verifyFormat("call( )", Spaces); 6280 6281 // Run the first set of tests again with 6282 // Spaces.SpacesInParentheses = false, 6283 // Spaces.SpaceInEmptyParentheses = true and 6284 // Spaces.SpacesInCStyleCastParentheses = true 6285 Spaces.SpacesInParentheses = false, 6286 Spaces.SpaceInEmptyParentheses = true; 6287 Spaces.SpacesInCStyleCastParentheses = 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 6306 TEST_F(FormatTest, ConfigurableSpaceBeforeAssignmentOperators) { 6307 verifyFormat("int a = 5;"); 6308 verifyFormat("a += 42;"); 6309 verifyFormat("a or_eq 8;"); 6310 6311 FormatStyle Spaces = getLLVMStyle(); 6312 Spaces.SpaceBeforeAssignmentOperators = false; 6313 verifyFormat("int a= 5;", Spaces); 6314 verifyFormat("a+= 42;", Spaces); 6315 verifyFormat("a or_eq 8;", Spaces); 6316 } 6317 6318 TEST_F(FormatTest, LinuxBraceBreaking) { 6319 FormatStyle BreakBeforeBrace = getLLVMStyle(); 6320 BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Linux; 6321 verifyFormat("namespace a\n" 6322 "{\n" 6323 "class A\n" 6324 "{\n" 6325 " void f()\n" 6326 " {\n" 6327 " if (true) {\n" 6328 " a();\n" 6329 " b();\n" 6330 " }\n" 6331 " }\n" 6332 " void g()\n" 6333 " {\n" 6334 " return;\n" 6335 " }\n" 6336 "}\n" 6337 "}", 6338 BreakBeforeBrace); 6339 } 6340 6341 TEST_F(FormatTest, StroustrupBraceBreaking) { 6342 FormatStyle BreakBeforeBrace = getLLVMStyle(); 6343 BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Stroustrup; 6344 verifyFormat("namespace a {\n" 6345 "class A {\n" 6346 " void f()\n" 6347 " {\n" 6348 " if (true) {\n" 6349 " a();\n" 6350 " b();\n" 6351 " }\n" 6352 " }\n" 6353 " void g()\n" 6354 " {\n" 6355 " return;\n" 6356 " }\n" 6357 "}\n" 6358 "}", 6359 BreakBeforeBrace); 6360 } 6361 6362 TEST_F(FormatTest, AllmanBraceBreaking) { 6363 FormatStyle BreakBeforeBrace = getLLVMStyle(); 6364 BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Allman; 6365 verifyFormat("namespace a\n" 6366 "{\n" 6367 "class A\n" 6368 "{\n" 6369 " void f()\n" 6370 " {\n" 6371 " if (true)\n" 6372 " {\n" 6373 " a();\n" 6374 " b();\n" 6375 " }\n" 6376 " }\n" 6377 " void g()\n" 6378 " {\n" 6379 " return;\n" 6380 " }\n" 6381 "}\n" 6382 "}", 6383 BreakBeforeBrace); 6384 6385 verifyFormat("void f()\n" 6386 "{\n" 6387 " if (true)\n" 6388 " {\n" 6389 " a();\n" 6390 " }\n" 6391 " else if (false)\n" 6392 " {\n" 6393 " b();\n" 6394 " }\n" 6395 " else\n" 6396 " {\n" 6397 " c();\n" 6398 " }\n" 6399 "}\n", 6400 BreakBeforeBrace); 6401 6402 verifyFormat("void f()\n" 6403 "{\n" 6404 " for (int i = 0; i < 10; ++i)\n" 6405 " {\n" 6406 " a();\n" 6407 " }\n" 6408 " while (false)\n" 6409 " {\n" 6410 " b();\n" 6411 " }\n" 6412 " do\n" 6413 " {\n" 6414 " c();\n" 6415 " } while (false)\n" 6416 "}\n", 6417 BreakBeforeBrace); 6418 6419 verifyFormat("void f(int a)\n" 6420 "{\n" 6421 " switch (a)\n" 6422 " {\n" 6423 " case 0:\n" 6424 " break;\n" 6425 " case 1:\n" 6426 " {\n" 6427 " break;\n" 6428 " }\n" 6429 " case 2:\n" 6430 " {\n" 6431 " }\n" 6432 " break;\n" 6433 " default:\n" 6434 " break;\n" 6435 " }\n" 6436 "}\n", 6437 BreakBeforeBrace); 6438 6439 verifyFormat("enum X\n" 6440 "{\n" 6441 " Y = 0,\n" 6442 "}\n", 6443 BreakBeforeBrace); 6444 6445 FormatStyle BreakBeforeBraceShortIfs = BreakBeforeBrace; 6446 BreakBeforeBraceShortIfs.AllowShortIfStatementsOnASingleLine = true; 6447 BreakBeforeBraceShortIfs.AllowShortLoopsOnASingleLine = true; 6448 verifyFormat("void f(bool b)\n" 6449 "{\n" 6450 " if (b)\n" 6451 " {\n" 6452 " return;\n" 6453 " }\n" 6454 "}\n", 6455 BreakBeforeBraceShortIfs); 6456 verifyFormat("void f(bool b)\n" 6457 "{\n" 6458 " if (b) return;\n" 6459 "}\n", 6460 BreakBeforeBraceShortIfs); 6461 verifyFormat("void f(bool b)\n" 6462 "{\n" 6463 " while (b)\n" 6464 " {\n" 6465 " return;\n" 6466 " }\n" 6467 "}\n", 6468 BreakBeforeBraceShortIfs); 6469 } 6470 6471 TEST_F(FormatTest, CatchExceptionReferenceBinding) { 6472 verifyFormat("void f() {\n" 6473 " try {\n" 6474 " }\n" 6475 " catch (const Exception &e) {\n" 6476 " }\n" 6477 "}\n", 6478 getLLVMStyle()); 6479 } 6480 6481 TEST_F(FormatTest, UnderstandsPragmas) { 6482 verifyFormat("#pragma omp reduction(| : var)"); 6483 verifyFormat("#pragma omp reduction(+ : var)"); 6484 } 6485 6486 bool allStylesEqual(ArrayRef<FormatStyle> Styles) { 6487 for (size_t i = 1; i < Styles.size(); ++i) 6488 if (!(Styles[0] == Styles[i])) 6489 return false; 6490 return true; 6491 } 6492 6493 TEST_F(FormatTest, GetsPredefinedStyleByName) { 6494 FormatStyle Styles[3]; 6495 6496 Styles[0] = getLLVMStyle(); 6497 EXPECT_TRUE(getPredefinedStyle("LLVM", &Styles[1])); 6498 EXPECT_TRUE(getPredefinedStyle("lLvM", &Styles[2])); 6499 EXPECT_TRUE(allStylesEqual(Styles)); 6500 6501 Styles[0] = getGoogleStyle(); 6502 EXPECT_TRUE(getPredefinedStyle("Google", &Styles[1])); 6503 EXPECT_TRUE(getPredefinedStyle("gOOgle", &Styles[2])); 6504 EXPECT_TRUE(allStylesEqual(Styles)); 6505 6506 Styles[0] = getChromiumStyle(); 6507 EXPECT_TRUE(getPredefinedStyle("Chromium", &Styles[1])); 6508 EXPECT_TRUE(getPredefinedStyle("cHRoMiUM", &Styles[2])); 6509 EXPECT_TRUE(allStylesEqual(Styles)); 6510 6511 Styles[0] = getMozillaStyle(); 6512 EXPECT_TRUE(getPredefinedStyle("Mozilla", &Styles[1])); 6513 EXPECT_TRUE(getPredefinedStyle("moZILla", &Styles[2])); 6514 EXPECT_TRUE(allStylesEqual(Styles)); 6515 6516 Styles[0] = getWebKitStyle(); 6517 EXPECT_TRUE(getPredefinedStyle("WebKit", &Styles[1])); 6518 EXPECT_TRUE(getPredefinedStyle("wEbKit", &Styles[2])); 6519 EXPECT_TRUE(allStylesEqual(Styles)); 6520 6521 EXPECT_FALSE(getPredefinedStyle("qwerty", &Styles[0])); 6522 } 6523 6524 TEST_F(FormatTest, ParsesConfiguration) { 6525 FormatStyle Style = {}; 6526 #define CHECK_PARSE(TEXT, FIELD, VALUE) \ 6527 EXPECT_NE(VALUE, Style.FIELD); \ 6528 EXPECT_EQ(0, parseConfiguration(TEXT, &Style).value()); \ 6529 EXPECT_EQ(VALUE, Style.FIELD) 6530 6531 #define CHECK_PARSE_BOOL(FIELD) \ 6532 Style.FIELD = false; \ 6533 EXPECT_EQ(0, parseConfiguration(#FIELD ": true", &Style).value()); \ 6534 EXPECT_TRUE(Style.FIELD); \ 6535 EXPECT_EQ(0, parseConfiguration(#FIELD ": false", &Style).value()); \ 6536 EXPECT_FALSE(Style.FIELD); 6537 6538 CHECK_PARSE_BOOL(AlignEscapedNewlinesLeft); 6539 CHECK_PARSE_BOOL(AlignTrailingComments); 6540 CHECK_PARSE_BOOL(AllowAllParametersOfDeclarationOnNextLine); 6541 CHECK_PARSE_BOOL(AllowShortIfStatementsOnASingleLine); 6542 CHECK_PARSE_BOOL(AllowShortLoopsOnASingleLine); 6543 CHECK_PARSE_BOOL(AlwaysBreakTemplateDeclarations); 6544 CHECK_PARSE_BOOL(BinPackParameters); 6545 CHECK_PARSE_BOOL(BreakBeforeBinaryOperators); 6546 CHECK_PARSE_BOOL(BreakConstructorInitializersBeforeComma); 6547 CHECK_PARSE_BOOL(ConstructorInitializerAllOnOneLineOrOnePerLine); 6548 CHECK_PARSE_BOOL(DerivePointerBinding); 6549 CHECK_PARSE_BOOL(IndentCaseLabels); 6550 CHECK_PARSE_BOOL(ObjCSpaceBeforeProtocolList); 6551 CHECK_PARSE_BOOL(PointerBindsToType); 6552 CHECK_PARSE_BOOL(Cpp11BracedListStyle); 6553 CHECK_PARSE_BOOL(IndentFunctionDeclarationAfterType); 6554 CHECK_PARSE_BOOL(SpacesInParentheses); 6555 CHECK_PARSE_BOOL(SpaceInEmptyParentheses); 6556 CHECK_PARSE_BOOL(SpacesInCStyleCastParentheses); 6557 CHECK_PARSE_BOOL(SpaceAfterControlStatementKeyword); 6558 CHECK_PARSE_BOOL(SpaceBeforeAssignmentOperators); 6559 6560 CHECK_PARSE("AccessModifierOffset: -1234", AccessModifierOffset, -1234); 6561 CHECK_PARSE("ConstructorInitializerIndentWidth: 1234", 6562 ConstructorInitializerIndentWidth, 1234u); 6563 CHECK_PARSE("ColumnLimit: 1234", ColumnLimit, 1234u); 6564 CHECK_PARSE("MaxEmptyLinesToKeep: 1234", MaxEmptyLinesToKeep, 1234u); 6565 CHECK_PARSE("PenaltyExcessCharacter: 1234", PenaltyExcessCharacter, 1234u); 6566 CHECK_PARSE("PenaltyReturnTypeOnItsOwnLine: 1234", 6567 PenaltyReturnTypeOnItsOwnLine, 1234u); 6568 CHECK_PARSE("SpacesBeforeTrailingComments: 1234", 6569 SpacesBeforeTrailingComments, 1234u); 6570 CHECK_PARSE("IndentWidth: 32", IndentWidth, 32u); 6571 CHECK_PARSE("ContinuationIndentWidth: 11", ContinuationIndentWidth, 11u); 6572 6573 Style.Standard = FormatStyle::LS_Auto; 6574 CHECK_PARSE("Standard: Cpp03", Standard, FormatStyle::LS_Cpp03); 6575 CHECK_PARSE("Standard: Cpp11", Standard, FormatStyle::LS_Cpp11); 6576 CHECK_PARSE("Standard: C++03", Standard, FormatStyle::LS_Cpp03); 6577 CHECK_PARSE("Standard: C++11", Standard, FormatStyle::LS_Cpp11); 6578 CHECK_PARSE("Standard: Auto", Standard, FormatStyle::LS_Auto); 6579 6580 Style.UseTab = FormatStyle::UT_ForIndentation; 6581 CHECK_PARSE("UseTab: false", UseTab, FormatStyle::UT_Never); 6582 CHECK_PARSE("UseTab: true", UseTab, FormatStyle::UT_Always); 6583 CHECK_PARSE("UseTab: Never", UseTab, FormatStyle::UT_Never); 6584 CHECK_PARSE("UseTab: ForIndentation", UseTab, FormatStyle::UT_ForIndentation); 6585 CHECK_PARSE("UseTab: Always", UseTab, FormatStyle::UT_Always); 6586 6587 Style.ColumnLimit = 123; 6588 FormatStyle BaseStyle = getLLVMStyle(); 6589 CHECK_PARSE("BasedOnStyle: LLVM", ColumnLimit, BaseStyle.ColumnLimit); 6590 CHECK_PARSE("BasedOnStyle: LLVM\nColumnLimit: 1234", ColumnLimit, 1234u); 6591 6592 Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup; 6593 CHECK_PARSE("BreakBeforeBraces: Attach", BreakBeforeBraces, 6594 FormatStyle::BS_Attach); 6595 CHECK_PARSE("BreakBeforeBraces: Linux", BreakBeforeBraces, 6596 FormatStyle::BS_Linux); 6597 CHECK_PARSE("BreakBeforeBraces: Stroustrup", BreakBeforeBraces, 6598 FormatStyle::BS_Stroustrup); 6599 6600 Style.NamespaceIndentation = FormatStyle::NI_All; 6601 CHECK_PARSE("NamespaceIndentation: None", NamespaceIndentation, 6602 FormatStyle::NI_None); 6603 CHECK_PARSE("NamespaceIndentation: Inner", NamespaceIndentation, 6604 FormatStyle::NI_Inner); 6605 CHECK_PARSE("NamespaceIndentation: All", NamespaceIndentation, 6606 FormatStyle::NI_All); 6607 6608 #undef CHECK_PARSE 6609 #undef CHECK_PARSE_BOOL 6610 } 6611 6612 TEST_F(FormatTest, ConfigurationRoundTripTest) { 6613 FormatStyle Style = getLLVMStyle(); 6614 std::string YAML = configurationAsText(Style); 6615 FormatStyle ParsedStyle = {}; 6616 EXPECT_EQ(0, parseConfiguration(YAML, &ParsedStyle).value()); 6617 EXPECT_EQ(Style, ParsedStyle); 6618 } 6619 6620 TEST_F(FormatTest, WorksFor8bitEncodings) { 6621 EXPECT_EQ("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 \"\n" 6622 "\"\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \"\n" 6623 "\"\xe7\xe8\xec\xed\xfe\xfe \"\n" 6624 "\"\xef\xee\xf0\xf3...\"", 6625 format("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 " 6626 "\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \xe7\xe8\xec\xed\xfe\xfe " 6627 "\xef\xee\xf0\xf3...\"", 6628 getLLVMStyleWithColumns(12))); 6629 } 6630 6631 // FIXME: Encode Cyrillic and CJK characters below to appease MS compilers. 6632 #if !defined(_MSC_VER) 6633 6634 TEST_F(FormatTest, CountsUTF8CharactersProperly) { 6635 verifyFormat("\"Однажды в студёную зимнюю пору...\"", 6636 getLLVMStyleWithColumns(35)); 6637 verifyFormat("\"一 二 三 四 五 六 七 八 九 十\"", 6638 getLLVMStyleWithColumns(31)); 6639 verifyFormat("// Однажды в студёную зимнюю пору...", 6640 getLLVMStyleWithColumns(36)); 6641 verifyFormat("// 一 二 三 四 五 六 七 八 九 十", 6642 getLLVMStyleWithColumns(32)); 6643 verifyFormat("/* Однажды в студёную зимнюю пору... */", 6644 getLLVMStyleWithColumns(39)); 6645 verifyFormat("/* 一 二 三 四 五 六 七 八 九 十 */", 6646 getLLVMStyleWithColumns(35)); 6647 } 6648 6649 TEST_F(FormatTest, SplitsUTF8Strings) { 6650 EXPECT_EQ( 6651 "\"Однажды, в \"\n" 6652 "\"студёную \"\n" 6653 "\"зимнюю \"\n" 6654 "\"пору,\"", 6655 format("\"Однажды, в студёную зимнюю пору,\"", 6656 getLLVMStyleWithColumns(13))); 6657 EXPECT_EQ("\"一 二 三 \"\n" 6658 "\"四 五六 \"\n" 6659 "\"七 八 九 \"\n" 6660 "\"十\"", 6661 format("\"一 二 三 四 五六 七 八 九 十\"", 6662 getLLVMStyleWithColumns(11))); 6663 EXPECT_EQ("\"一\t二 \"\n" 6664 "\"\t三 \"\n" 6665 "\"四 五\t六 \"\n" 6666 "\"\t七 \"\n" 6667 "\"八九十\tqq\"", 6668 format("\"一\t二 \t三 四 五\t六 \t七 八九十\tqq\"", 6669 getLLVMStyleWithColumns(11))); 6670 } 6671 6672 6673 TEST_F(FormatTest, HandlesDoubleWidthCharsInMultiLineStrings) { 6674 EXPECT_EQ("const char *sssss =\n" 6675 " \"一二三四五六七八\\\n" 6676 " 九 十\";", 6677 format("const char *sssss = \"一二三四五六七八\\\n" 6678 " 九 十\";", 6679 getLLVMStyleWithColumns(30))); 6680 } 6681 6682 TEST_F(FormatTest, SplitsUTF8LineComments) { 6683 EXPECT_EQ("// Я из лесу\n" 6684 "// вышел; был\n" 6685 "// сильный\n" 6686 "// мороз.", 6687 format("// Я из лесу вышел; был сильный мороз.", 6688 getLLVMStyleWithColumns(13))); 6689 EXPECT_EQ("// 一二三\n" 6690 "// 四五六七\n" 6691 "// 八 九\n" 6692 "// 十", 6693 format("// 一二三 四五六七 八 九 十", getLLVMStyleWithColumns(9))); 6694 } 6695 6696 TEST_F(FormatTest, SplitsUTF8BlockComments) { 6697 EXPECT_EQ("/* Гляжу,\n" 6698 " * поднимается\n" 6699 " * медленно в\n" 6700 " * гору\n" 6701 " * Лошадка,\n" 6702 " * везущая\n" 6703 " * хворосту\n" 6704 " * воз. */", 6705 format("/* Гляжу, поднимается медленно в гору\n" 6706 " * Лошадка, везущая хворосту воз. */", 6707 getLLVMStyleWithColumns(13))); 6708 EXPECT_EQ( 6709 "/* 一二三\n" 6710 " * 四五六七\n" 6711 " * 八 九\n" 6712 " * 十 */", 6713 format("/* 一二三 四五六七 八 九 十 */", getLLVMStyleWithColumns(9))); 6714 EXPECT_EQ("/* �������� ��������\n" 6715 " * ��������\n" 6716 " * ������-�� */", 6717 format("/* �������� �������� �������� ������-�� */", getLLVMStyleWithColumns(12))); 6718 } 6719 6720 #endif // _MSC_VER 6721 6722 TEST_F(FormatTest, ConstructorInitializerIndentWidth) { 6723 FormatStyle Style = getLLVMStyle(); 6724 6725 Style.ConstructorInitializerIndentWidth = 4; 6726 verifyFormat( 6727 "SomeClass::Constructor()\n" 6728 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 6729 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 6730 Style); 6731 6732 Style.ConstructorInitializerIndentWidth = 2; 6733 verifyFormat( 6734 "SomeClass::Constructor()\n" 6735 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 6736 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 6737 Style); 6738 6739 Style.ConstructorInitializerIndentWidth = 0; 6740 verifyFormat( 6741 "SomeClass::Constructor()\n" 6742 ": aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 6743 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 6744 Style); 6745 6746 Style.BreakConstructorInitializersBeforeComma = true; 6747 Style.ConstructorInitializerIndentWidth = 4; 6748 verifyFormat("SomeClass::Constructor()\n" 6749 " : a(a)\n" 6750 " , b(b)\n" 6751 " , c(c) {}", 6752 Style); 6753 6754 Style.ConstructorInitializerIndentWidth = 2; 6755 verifyFormat("SomeClass::Constructor()\n" 6756 " : a(a)\n" 6757 " , b(b)\n" 6758 " , c(c) {}", 6759 Style); 6760 6761 Style.ConstructorInitializerIndentWidth = 0; 6762 verifyFormat("SomeClass::Constructor()\n" 6763 ": a(a)\n" 6764 ", b(b)\n" 6765 ", c(c) {}", 6766 Style); 6767 6768 Style.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 6769 Style.ConstructorInitializerIndentWidth = 4; 6770 verifyFormat( 6771 "SomeClass::Constructor()\n" 6772 " : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa) {}", 6773 Style); 6774 Style.ConstructorInitializerIndentWidth = 4; 6775 Style.ColumnLimit = 60; 6776 verifyFormat("SomeClass::Constructor()\n" 6777 " : aaaaaaaa(aaaaaaaa)\n" 6778 " , aaaaaaaa(aaaaaaaa)\n" 6779 " , aaaaaaaa(aaaaaaaa) {}", 6780 Style); 6781 } 6782 6783 TEST_F(FormatTest, FormatsWithWebKitStyle) { 6784 FormatStyle Style = getWebKitStyle(); 6785 6786 // Don't indent in outer namespaces. 6787 verifyFormat("namespace outer {\n" 6788 "int i;\n" 6789 "namespace inner {\n" 6790 " int i;\n" 6791 "} // namespace inner\n" 6792 "} // namespace outer\n" 6793 "namespace other_outer {\n" 6794 "int i;\n" 6795 "}", 6796 Style); 6797 6798 // Don't indent case labels. 6799 verifyFormat("switch (variable) {\n" 6800 "case 1:\n" 6801 "case 2:\n" 6802 " doSomething();\n" 6803 " break;\n" 6804 "default:\n" 6805 " ++variable;\n" 6806 "}", 6807 Style); 6808 6809 // Wrap before binary operators. 6810 EXPECT_EQ( 6811 "void f()\n" 6812 "{\n" 6813 " if (aaaaaaaaaaaaaaaa\n" 6814 " && bbbbbbbbbbbbbbbbbbbbbbbb\n" 6815 " && (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n" 6816 " return;\n" 6817 "}", 6818 format( 6819 "void f() {\n" 6820 "if (aaaaaaaaaaaaaaaa\n" 6821 "&& bbbbbbbbbbbbbbbbbbbbbbbb\n" 6822 "&& (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n" 6823 "return;\n" 6824 "}", 6825 Style)); 6826 6827 // Constructor initializers are formatted one per line with the "," on the 6828 // new line. 6829 verifyFormat("Constructor()\n" 6830 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 6831 " , aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaa, // break\n" 6832 " aaaaaaaaaaaaaa)\n" 6833 " , aaaaaaaaaaaaaaaaaaaaaaa()\n{\n}", 6834 Style); 6835 6836 // Access specifiers should be aligned left. 6837 verifyFormat("class C {\n" 6838 "public:\n" 6839 " int i;\n" 6840 "};", 6841 Style); 6842 6843 // Do not align comments. 6844 verifyFormat("int a; // Do not\n" 6845 "double b; // align comments.", 6846 Style); 6847 6848 // Accept input's line breaks. 6849 EXPECT_EQ("if (aaaaaaaaaaaaaaa\n" 6850 " || bbbbbbbbbbbbbbb) {\n" 6851 " i++;\n" 6852 "}", 6853 format("if (aaaaaaaaaaaaaaa\n" 6854 "|| bbbbbbbbbbbbbbb) { i++; }", 6855 Style)); 6856 EXPECT_EQ("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) {\n" 6857 " i++;\n" 6858 "}", 6859 format("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) { i++; }", Style)); 6860 } 6861 6862 TEST_F(FormatTest, FormatsProtocolBufferDefinitions) { 6863 // It seems that clang-format can format protocol buffer definitions 6864 // (see https://code.google.com/p/protobuf/). 6865 verifyFormat("message SomeMessage {\n" 6866 " required int32 field1 = 1;\n" 6867 " optional string field2 = 2 [default = \"2\"]\n" 6868 "}"); 6869 } 6870 6871 TEST_F(FormatTest, FormatsLambdas) { 6872 verifyFormat("int c = [b]() mutable {\n" 6873 " return [&b] { return b++; }();\n" 6874 "}();\n"); 6875 verifyFormat("int c = [&] {\n" 6876 " [=] { return b++; }();\n" 6877 "}();\n"); 6878 verifyFormat("int c = [&, &a, a] {\n" 6879 " [=, c, &d] { return b++; }();\n" 6880 "}();\n"); 6881 verifyFormat("int c = [&a, &a, a] {\n" 6882 " [=, a, b, &c] { return b++; }();\n" 6883 "}();\n"); 6884 verifyFormat("auto c = { [&a, &a, a] {\n" 6885 " [=, a, b, &c] { return b++; }();\n" 6886 "} }\n"); 6887 verifyFormat("auto c = { [&a, &a, a] { [=, a, b, &c] {}(); } }\n"); 6888 verifyFormat("void f() {\n" 6889 " other(x.begin(), x.end(), [&](int, int) { return 1; });\n" 6890 "}\n"); 6891 verifyFormat("void f() {\n" 6892 " other(x.begin(), //\n" 6893 " x.end(), //\n" 6894 " [&](int, int) { return 1; });\n" 6895 "}\n"); 6896 6897 // Not lambdas. 6898 verifyFormat("constexpr char hello[]{ \"hello\" };"); 6899 verifyFormat("double &operator[](int i) { return 0; }\n" 6900 "int i;"); 6901 } 6902 6903 TEST_F(FormatTest, FormatsBlocks) { 6904 // FIXME: Make whitespace formatting consistent. Ask a ObjC dev how 6905 // it would ideally look. 6906 verifyFormat("[operation setCompletionBlock:^{ [self onOperationDone]; }];"); 6907 verifyFormat("int i = {[operation setCompletionBlock : ^{ [self " 6908 "onOperationDone]; }] };"); 6909 } 6910 6911 TEST_F(FormatTest, SupportsCRLF) { 6912 EXPECT_EQ("int a;\r\n" 6913 "int b;\r\n" 6914 "int c;\r\n", 6915 format("int a;\r\n" 6916 " int b;\r\n" 6917 " int c;\r\n", 6918 getLLVMStyle())); 6919 EXPECT_EQ("int a;\r\n" 6920 "int b;\r\n" 6921 "int c;\r\n", 6922 format("int a;\r\n" 6923 " int b;\n" 6924 " int c;\r\n", 6925 getLLVMStyle())); 6926 EXPECT_EQ("int a;\n" 6927 "int b;\n" 6928 "int c;\n", 6929 format("int a;\r\n" 6930 " int b;\n" 6931 " int c;\n", 6932 getLLVMStyle())); 6933 EXPECT_EQ("\"aaaaaaa \"\r\n" 6934 "\"bbbbbbb\";\r\n", 6935 format("\"aaaaaaa bbbbbbb\";\r\n", getLLVMStyleWithColumns(10))); 6936 EXPECT_EQ("#define A \\\r\n" 6937 " b; \\\r\n" 6938 " c; \\\r\n" 6939 " d;\r\n", 6940 format("#define A \\\r\n" 6941 " b; \\\r\n" 6942 " c; d; \r\n", 6943 getGoogleStyle())); 6944 } 6945 6946 TEST_F(FormatTest, MunchSemicolonAfterBlocks) { 6947 verifyFormat("MY_CLASS(C) {\n" 6948 " int i;\n" 6949 " int j;\n" 6950 "};"); 6951 } 6952 6953 TEST_F(FormatTest, ConfigurableContinuationIndentWidth) { 6954 FormatStyle TwoIndent = getLLVMStyleWithColumns(15); 6955 TwoIndent.ContinuationIndentWidth = 2; 6956 6957 EXPECT_EQ("int i =\n" 6958 " longFunction(\n" 6959 " arg);", 6960 format("int i = longFunction(arg);", TwoIndent)); 6961 6962 FormatStyle SixIndent = getLLVMStyleWithColumns(20); 6963 SixIndent.ContinuationIndentWidth = 6; 6964 6965 EXPECT_EQ("int i =\n" 6966 " longFunction(\n" 6967 " arg);", 6968 format("int i = longFunction(arg);", SixIndent)); 6969 } 6970 6971 } // end namespace tooling 6972 } // end namespace clang 6973