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