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