FormatTest.cpp revision 7ff96ed7336b4f0efef05c10fd5ce5143918d4e1
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 "../Tooling/RewriterTestContext.h" 14#include "clang/Lex/Lexer.h" 15#include "llvm/Support/Debug.h" 16#include "gtest/gtest.h" 17 18namespace clang { 19namespace format { 20 21class FormatTest : public ::testing::Test { 22protected: 23 std::string format(llvm::StringRef Code, unsigned Offset, unsigned Length, 24 const FormatStyle &Style) { 25 DEBUG(llvm::errs() << "---\n"); 26 RewriterTestContext Context; 27 FileID ID = Context.createInMemoryFile("input.cc", Code); 28 SourceLocation Start = 29 Context.Sources.getLocForStartOfFile(ID).getLocWithOffset(Offset); 30 std::vector<CharSourceRange> Ranges( 31 1, 32 CharSourceRange::getCharRange(Start, Start.getLocWithOffset(Length))); 33 Lexer Lex(ID, Context.Sources.getBuffer(ID), Context.Sources, 34 getFormattingLangOpts()); 35 tooling::Replacements Replace = reformat( 36 Style, Lex, Context.Sources, Ranges, new IgnoringDiagConsumer()); 37 ReplacementCount = Replace.size(); 38 EXPECT_TRUE(applyAllReplacements(Replace, Context.Rewrite)); 39 DEBUG(llvm::errs() << "\n" << Context.getRewrittenText(ID) << "\n\n"); 40 return Context.getRewrittenText(ID); 41 } 42 43 std::string 44 format(llvm::StringRef Code, const FormatStyle &Style = getLLVMStyle()) { 45 return format(Code, 0, Code.size(), Style); 46 } 47 48 std::string messUp(llvm::StringRef Code) { 49 std::string MessedUp(Code.str()); 50 bool InComment = false; 51 bool InPreprocessorDirective = false; 52 bool JustReplacedNewline = false; 53 for (unsigned i = 0, e = MessedUp.size() - 1; i != e; ++i) { 54 if (MessedUp[i] == '/' && MessedUp[i + 1] == '/') { 55 if (JustReplacedNewline) 56 MessedUp[i - 1] = '\n'; 57 InComment = true; 58 } else if (MessedUp[i] == '#' && (JustReplacedNewline || i == 0)) { 59 if (i != 0) 60 MessedUp[i - 1] = '\n'; 61 InPreprocessorDirective = true; 62 } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') { 63 MessedUp[i] = ' '; 64 MessedUp[i + 1] = ' '; 65 } else if (MessedUp[i] == '\n') { 66 if (InComment) { 67 InComment = false; 68 } else if (InPreprocessorDirective) { 69 InPreprocessorDirective = false; 70 } else { 71 JustReplacedNewline = true; 72 MessedUp[i] = ' '; 73 } 74 } else if (MessedUp[i] != ' ') { 75 JustReplacedNewline = false; 76 } 77 } 78 return MessedUp; 79 } 80 81 FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) { 82 FormatStyle Style = getLLVMStyle(); 83 Style.ColumnLimit = ColumnLimit; 84 return Style; 85 } 86 87 FormatStyle getGoogleStyleWithColumns(unsigned ColumnLimit) { 88 FormatStyle Style = getGoogleStyle(); 89 Style.ColumnLimit = ColumnLimit; 90 return Style; 91 } 92 93 void verifyFormat(llvm::StringRef Code, 94 const FormatStyle &Style = getLLVMStyle()) { 95 EXPECT_EQ(Code.str(), format(messUp(Code), Style)); 96 } 97 98 void verifyGoogleFormat(llvm::StringRef Code) { 99 verifyFormat(Code, getGoogleStyle()); 100 } 101 102 void verifyIndependentOfContext(llvm::StringRef text) { 103 verifyFormat(text); 104 verifyFormat(llvm::Twine("void f() { " + text + " }").str()); 105 } 106 107 int ReplacementCount; 108}; 109 110TEST_F(FormatTest, MessUp) { 111 EXPECT_EQ("1 2 3", messUp("1 2 3")); 112 EXPECT_EQ("1 2 3\n", messUp("1\n2\n3\n")); 113 EXPECT_EQ("a\n//b\nc", messUp("a\n//b\nc")); 114 EXPECT_EQ("a\n#b\nc", messUp("a\n#b\nc")); 115 EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne")); 116} 117 118//===----------------------------------------------------------------------===// 119// Basic function tests. 120//===----------------------------------------------------------------------===// 121 122TEST_F(FormatTest, DoesNotChangeCorrectlyFormatedCode) { 123 EXPECT_EQ(";", format(";")); 124} 125 126TEST_F(FormatTest, FormatsGlobalStatementsAt0) { 127 EXPECT_EQ("int i;", format(" int i;")); 128 EXPECT_EQ("\nint i;", format(" \n\t \r int i;")); 129 EXPECT_EQ("int i;\nint j;", format(" int i; int j;")); 130 EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;")); 131} 132 133TEST_F(FormatTest, FormatsUnwrappedLinesAtFirstFormat) { 134 EXPECT_EQ("int i;", format("int\ni;")); 135} 136 137TEST_F(FormatTest, FormatsNestedBlockStatements) { 138 EXPECT_EQ("{\n {\n {}\n }\n}", format("{{{}}}")); 139} 140 141TEST_F(FormatTest, FormatsNestedCall) { 142 verifyFormat("Method(f1, f2(f3));"); 143 verifyFormat("Method(f1(f2, f3()));"); 144 verifyFormat("Method(f1(f2, (f3())));"); 145} 146 147TEST_F(FormatTest, NestedNameSpecifiers) { 148 verifyFormat("vector< ::Type> v;"); 149 verifyFormat("::ns::SomeFunction(::ns::SomeOtherFunction())"); 150} 151 152TEST_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 167TEST_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 175TEST_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 197TEST_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 204TEST_F(FormatTest, ReformatsMovedLines) { 205 EXPECT_EQ( 206 "template <typename T> T *getFETokenInfo() const {\n" 207 " return static_cast<T *>(FETokenInfo);\n" 208 "}\n" 209 " int a; // <- Should not be formatted", 210 format( 211 "template<typename T>\n" 212 "T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); }\n" 213 " int a; // <- Should not be formatted", 214 9, 5, getLLVMStyle())); 215} 216 217//===----------------------------------------------------------------------===// 218// Tests for control statements. 219//===----------------------------------------------------------------------===// 220 221TEST_F(FormatTest, FormatIfWithoutCompountStatement) { 222 verifyFormat("if (true)\n f();\ng();"); 223 verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();"); 224 verifyFormat("if (a)\n if (b) {\n f();\n }\ng();"); 225 226 FormatStyle AllowsMergedIf = getGoogleStyle(); 227 AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; 228 verifyFormat("if (a)\n" 229 " // comment\n" 230 " f();", 231 AllowsMergedIf); 232 233 verifyFormat("if (a) // Can't merge this\n" 234 " f();\n", 235 AllowsMergedIf); 236 verifyFormat("if (a) /* still don't merge */\n" 237 " f();", 238 AllowsMergedIf); 239 verifyFormat("if (a) { // Never merge this\n" 240 " f();\n" 241 "}", 242 AllowsMergedIf); 243 verifyFormat("if (a) { /* Never merge this */\n" 244 " f();\n" 245 "}", 246 AllowsMergedIf); 247 248 AllowsMergedIf.ColumnLimit = 14; 249 verifyFormat("if (a) return;", AllowsMergedIf); 250 verifyFormat("if (aaaaaaaaa)\n" 251 " return;", 252 AllowsMergedIf); 253 254 AllowsMergedIf.ColumnLimit = 13; 255 verifyFormat("if (a)\n return;", AllowsMergedIf); 256} 257 258TEST_F(FormatTest, ParseIfElse) { 259 verifyFormat("if (true)\n" 260 " if (true)\n" 261 " if (true)\n" 262 " f();\n" 263 " else\n" 264 " g();\n" 265 " else\n" 266 " h();\n" 267 "else\n" 268 " i();"); 269 verifyFormat("if (true)\n" 270 " if (true)\n" 271 " if (true) {\n" 272 " if (true)\n" 273 " f();\n" 274 " } else {\n" 275 " g();\n" 276 " }\n" 277 " else\n" 278 " h();\n" 279 "else {\n" 280 " i();\n" 281 "}"); 282} 283 284TEST_F(FormatTest, ElseIf) { 285 verifyFormat("if (a) {\n} else if (b) {\n}"); 286 verifyFormat("if (a)\n" 287 " f();\n" 288 "else if (b)\n" 289 " g();\n" 290 "else\n" 291 " h();"); 292} 293 294TEST_F(FormatTest, FormatsForLoop) { 295 verifyFormat( 296 "for (int VeryVeryLongLoopVariable = 0; VeryVeryLongLoopVariable < 10;\n" 297 " ++VeryVeryLongLoopVariable)\n" 298 " ;"); 299 verifyFormat("for (;;)\n" 300 " f();"); 301 verifyFormat("for (;;) {\n}"); 302 verifyFormat("for (;;) {\n" 303 " f();\n" 304 "}"); 305 verifyFormat("for (int i = 0; (i < 10); ++i) {\n}"); 306 307 verifyFormat( 308 "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n" 309 " E = UnwrappedLines.end();\n" 310 " I != E; ++I) {\n}"); 311 312 verifyFormat( 313 "for (MachineFun::iterator IIII = PrevIt, EEEE = F.end(); IIII != EEEE;\n" 314 " ++IIIII) {\n}"); 315 verifyFormat("for (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaa =\n" 316 " aaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa;\n" 317 " aaaaaaaaaaa != aaaaaaaaaaaaaaaaaaa; ++aaaaaaaaaaa) {\n}"); 318 verifyFormat("for (llvm::ArrayRef<NamedDecl *>::iterator\n" 319 " I = FD->getDeclsInPrototypeScope().begin(),\n" 320 " E = FD->getDeclsInPrototypeScope().end();\n" 321 " I != E; ++I) {\n}"); 322 323 // FIXME: Not sure whether we want extra identation in line 3 here: 324 verifyFormat( 325 "for (aaaaaaaaaaaaaaaaa aaaaaaaaaaa = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;\n" 326 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa !=\n" 327 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 328 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 329 " ++aaaaaaaaaaa) {\n}"); 330 verifyFormat("for (int aaaaaaaaaaa = 1; aaaaaaaaaaa <= bbbbbbbbbbbbbbb;\n" 331 " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n" 332 "}"); 333 verifyFormat("for (some_namespace::SomeIterator iter( // force break\n" 334 " aaaaaaaaaa);\n" 335 " iter; ++iter) {\n" 336 "}"); 337 338 FormatStyle NoBinPacking = getLLVMStyle(); 339 NoBinPacking.BinPackParameters = false; 340 verifyFormat("for (int aaaaaaaaaaa = 1;\n" 341 " aaaaaaaaaaa <= aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa,\n" 342 " aaaaaaaaaaaaaaaa,\n" 343 " aaaaaaaaaaaaaaaa,\n" 344 " aaaaaaaaaaaaaaaa);\n" 345 " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n" 346 "}", 347 NoBinPacking); 348 verifyFormat( 349 "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n" 350 " E = UnwrappedLines.end();\n" 351 " I != E;\n" 352 " ++I) {\n}", 353 NoBinPacking); 354} 355 356TEST_F(FormatTest, RangeBasedForLoops) { 357 verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" 358 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 359 verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaa :\n" 360 " aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa, aaaaaaaaaaaaa)) {\n}"); 361 verifyFormat("for (const aaaaaaaaaaaaaaaaaaaaa &aaaaaaaaa :\n" 362 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 363} 364 365TEST_F(FormatTest, FormatsWhileLoop) { 366 verifyFormat("while (true) {\n}"); 367 verifyFormat("while (true)\n" 368 " f();"); 369 verifyFormat("while () {\n}"); 370 verifyFormat("while () {\n" 371 " f();\n" 372 "}"); 373} 374 375TEST_F(FormatTest, FormatsDoWhile) { 376 verifyFormat("do {\n" 377 " do_something();\n" 378 "} while (something());"); 379 verifyFormat("do\n" 380 " do_something();\n" 381 "while (something());"); 382} 383 384TEST_F(FormatTest, FormatsSwitchStatement) { 385 verifyFormat("switch (x) {\n" 386 "case 1:\n" 387 " f();\n" 388 " break;\n" 389 "case kFoo:\n" 390 "case ns::kBar:\n" 391 "case kBaz:\n" 392 " break;\n" 393 "default:\n" 394 " g();\n" 395 " break;\n" 396 "}"); 397 verifyFormat("switch (x) {\n" 398 "case 1: {\n" 399 " f();\n" 400 " break;\n" 401 "}\n" 402 "}"); 403 verifyFormat("switch (x) {\n" 404 "case 1: {\n" 405 " f();\n" 406 " {\n" 407 " g();\n" 408 " h();\n" 409 " }\n" 410 " break;\n" 411 "}\n" 412 "}"); 413 verifyFormat("switch (x) {\n" 414 "case 1: {\n" 415 " f();\n" 416 " if (foo) {\n" 417 " g();\n" 418 " h();\n" 419 " }\n" 420 " break;\n" 421 "}\n" 422 "}"); 423 verifyFormat("switch (x) {\n" 424 "case 1: {\n" 425 " f();\n" 426 " g();\n" 427 "} break;\n" 428 "}"); 429 verifyFormat("switch (test)\n" 430 " ;"); 431 verifyFormat("switch (x) {\n" 432 "default: {\n" 433 " // Do nothing.\n" 434 "}\n" 435 "}"); 436 verifyFormat("switch (x) {\n" 437 "// comment\n" 438 "// if 1, do f()\n" 439 "case 1:\n" 440 " f();\n" 441 "}"); 442 verifyFormat("switch (x) {\n" 443 "case 1:\n" 444 " // Do amazing stuff\n" 445 " {\n" 446 " f();\n" 447 " g();\n" 448 " }\n" 449 " break;\n" 450 "}"); 451 verifyFormat("#define A \\\n" 452 " switch (x) { \\\n" 453 " case a: \\\n" 454 " foo = b; \\\n" 455 " }", getLLVMStyleWithColumns(20)); 456 457 verifyGoogleFormat("switch (x) {\n" 458 " case 1:\n" 459 " f();\n" 460 " break;\n" 461 " case kFoo:\n" 462 " case ns::kBar:\n" 463 " case kBaz:\n" 464 " break;\n" 465 " default:\n" 466 " g();\n" 467 " break;\n" 468 "}"); 469 verifyGoogleFormat("switch (x) {\n" 470 " case 1: {\n" 471 " f();\n" 472 " break;\n" 473 " }\n" 474 "}"); 475 verifyGoogleFormat("switch (test)\n" 476 " ;"); 477} 478 479TEST_F(FormatTest, FormatsLabels) { 480 verifyFormat("void f() {\n" 481 " some_code();\n" 482 "test_label:\n" 483 " some_other_code();\n" 484 " {\n" 485 " some_more_code();\n" 486 " another_label:\n" 487 " some_more_code();\n" 488 " }\n" 489 "}"); 490 verifyFormat("some_code();\n" 491 "test_label:\n" 492 "some_other_code();"); 493} 494 495//===----------------------------------------------------------------------===// 496// Tests for comments. 497//===----------------------------------------------------------------------===// 498 499TEST_F(FormatTest, UnderstandsSingleLineComments) { 500 verifyFormat("//* */"); 501 verifyFormat("// line 1\n" 502 "// line 2\n" 503 "void f() {}\n"); 504 505 verifyFormat("void f() {\n" 506 " // Doesn't do anything\n" 507 "}"); 508 verifyFormat("void f(int i, // some comment (probably for i)\n" 509 " int j, // some comment (probably for j)\n" 510 " int k); // some comment (probably for k)"); 511 verifyFormat("void f(int i,\n" 512 " // some comment (probably for j)\n" 513 " int j,\n" 514 " // some comment (probably for k)\n" 515 " int k);"); 516 517 verifyFormat("int i // This is a fancy variable\n" 518 " = 5; // with nicely aligned comment."); 519 520 verifyFormat("// Leading comment.\n" 521 "int a; // Trailing comment."); 522 verifyFormat("int a; // Trailing comment\n" 523 " // on 2\n" 524 " // or 3 lines.\n" 525 "int b;"); 526 verifyFormat("int a; // Trailing comment\n" 527 "\n" 528 "// Leading comment.\n" 529 "int b;"); 530 verifyFormat("int a; // Comment.\n" 531 " // More details.\n" 532 "int bbbb; // Another comment."); 533 verifyFormat( 534 "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; // comment\n" 535 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // comment\n" 536 "int cccccccccccccccccccccccccccccc; // comment\n" 537 "int ddd; // looooooooooooooooooooooooong comment\n" 538 "int aaaaaaaaaaaaaaaaaaaaaaa; // comment\n" 539 "int bbbbbbbbbbbbbbbbbbbbb; // comment\n" 540 "int ccccccccccccccccccc; // comment"); 541 542 verifyFormat("#include \"a\" // comment\n" 543 "#include \"a/b/c\" // comment"); 544 verifyFormat("#include <a> // comment\n" 545 "#include <a/b/c> // comment"); 546 547 verifyFormat("enum E {\n" 548 " // comment\n" 549 " VAL_A, // comment\n" 550 " VAL_B\n" 551 "};"); 552 553 verifyFormat( 554 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 555 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // Trailing comment"); 556 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 557 " // Comment inside a statement.\n" 558 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 559 verifyFormat( 560 "bool aaaaaaaaaaaaa = // comment\n" 561 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 562 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 563 564 verifyFormat("int aaaa; // aaaaa\n" 565 "int aa; // aaaaaaa", 566 getLLVMStyleWithColumns(20)); 567 568 EXPECT_EQ("void f() { // This does something ..\n" 569 "}\n" 570 "int a; // This is unrelated", 571 format("void f() { // This does something ..\n" 572 " }\n" 573 "int a; // This is unrelated")); 574 EXPECT_EQ("void f() { // This does something ..\n" 575 "} // awesome..\n" 576 "\n" 577 "int a; // This is unrelated", 578 format("void f() { // This does something ..\n" 579 " } // awesome..\n" 580 " \n" 581 "int a; // This is unrelated")); 582 583 EXPECT_EQ("int i; // single line trailing comment", 584 format("int i;\\\n// single line trailing comment")); 585 586 verifyGoogleFormat("int a; // Trailing comment."); 587 588 verifyFormat("someFunction(anotherFunction( // Force break.\n" 589 " parameter));"); 590 591 verifyGoogleFormat("#endif // HEADER_GUARD"); 592 593 verifyFormat("const char *test[] = {\n" 594 " // A\n" 595 " \"aaaa\",\n" 596 " // B\n" 597 " \"aaaaa\",\n" 598 "};"); 599 verifyGoogleFormat( 600 "aaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 601 " aaaaaaaaaaaaaaaaaaaaaa); // 81 cols with this comment"); 602 EXPECT_EQ("D(a, {\n" 603 " // test\n" 604 " int a;\n" 605 "});", 606 format("D(a, {\n" 607 "// test\n" 608 "int a;\n" 609 "});")); 610} 611 612TEST_F(FormatTest, CanFormatCommentsLocally) { 613 EXPECT_EQ("int a; // comment\n" 614 "int b; // comment", 615 format("int a; // comment\n" 616 "int b; // comment", 617 0, 0, getLLVMStyle())); 618 EXPECT_EQ("int a; // comment\n" 619 " // line 2\n" 620 "int b;", 621 format("int a; // comment\n" 622 " // line 2\n" 623 "int b;", 624 28, 0, getLLVMStyle())); 625 EXPECT_EQ("int aaaaaa; // comment\n" 626 "int b;\n" 627 "int c; // unrelated comment", 628 format("int aaaaaa; // comment\n" 629 "int b;\n" 630 "int c; // unrelated comment", 631 31, 0, getLLVMStyle())); 632} 633 634TEST_F(FormatTest, RemovesTrailingWhitespaceOfComments) { 635 EXPECT_EQ("// comment", format("// comment ")); 636 EXPECT_EQ("int aaaaaaa, bbbbbbb; // comment", 637 format("int aaaaaaa, bbbbbbb; // comment ", 638 getLLVMStyleWithColumns(33))); 639} 640 641TEST_F(FormatTest, UnderstandsMultiLineComments) { 642 verifyFormat("f(/*test=*/ true);"); 643 EXPECT_EQ( 644 "f(aaaaaaaaaaaaaaaaaaaaaaaaa, /* Trailing comment for aa... */\n" 645 " bbbbbbbbbbbbbbbbbbbbbbbbb);", 646 format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \\\n/* Trailing comment for aa... */\n" 647 " bbbbbbbbbbbbbbbbbbbbbbbbb);")); 648 EXPECT_EQ( 649 "f(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 650 " /* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);", 651 format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \n" 652 "/* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);")); 653 654 FormatStyle NoBinPacking = getLLVMStyle(); 655 NoBinPacking.BinPackParameters = false; 656 verifyFormat("aaaaaaaa(/* parameter 1 */ aaaaaa,\n" 657 " /* parameter 2 */ aaaaaa,\n" 658 " /* parameter 3 */ aaaaaa,\n" 659 " /* parameter 4 */ aaaaaa);", 660 NoBinPacking); 661} 662 663TEST_F(FormatTest, AlignsMultiLineComments) { 664 EXPECT_EQ("/*\n" 665 " * Really multi-line\n" 666 " * comment.\n" 667 " */\n" 668 "void f() {}", 669 format(" /*\n" 670 " * Really multi-line\n" 671 " * comment.\n" 672 " */\n" 673 " void f() {}")); 674 EXPECT_EQ("class C {\n" 675 " /*\n" 676 " * Another multi-line\n" 677 " * comment.\n" 678 " */\n" 679 " void f() {}\n" 680 "};", 681 format("class C {\n" 682 "/*\n" 683 " * Another multi-line\n" 684 " * comment.\n" 685 " */\n" 686 "void f() {}\n" 687 "};")); 688 EXPECT_EQ("/*\n" 689 " 1. This is a comment with non-trivial formatting.\n" 690 " 1.1. We have to indent/outdent all lines equally\n" 691 " 1.1.1. to keep the formatting.\n" 692 " */", 693 format(" /*\n" 694 " 1. This is a comment with non-trivial formatting.\n" 695 " 1.1. We have to indent/outdent all lines equally\n" 696 " 1.1.1. to keep the formatting.\n" 697 " */")); 698 EXPECT_EQ("/*\n" 699 " Don't try to outdent if there's not enough inentation.\n" 700 " */", 701 format(" /*\n" 702 " Don't try to outdent if there's not enough inentation.\n" 703 " */")); 704} 705 706TEST_F(FormatTest, SplitsLongCxxComments) { 707 EXPECT_EQ("// A comment that\n" 708 "// doesn't fit on\n" 709 "// one line", 710 format("// A comment that doesn't fit on one line", 711 getLLVMStyleWithColumns(20))); 712 EXPECT_EQ("// a b c d\n" 713 "// e f g\n" 714 "// h i j k", 715 format("// a b c d e f g h i j k", 716 getLLVMStyleWithColumns(10))); 717 EXPECT_EQ("// a b c d\n" 718 "// e f g\n" 719 "// h i j k", 720 format("\\\n// a b c d e f g h i j k", 721 getLLVMStyleWithColumns(10))); 722 EXPECT_EQ("if (true) // A comment that\n" 723 " // doesn't fit on\n" 724 " // one line", 725 format("if (true) // A comment that doesn't fit on one line ", 726 getLLVMStyleWithColumns(30))); 727 EXPECT_EQ("// Don't_touch_leading_whitespace", 728 format("// Don't_touch_leading_whitespace", 729 getLLVMStyleWithColumns(20))); 730 EXPECT_EQ( 731 "//Don't add leading\n" 732 "//whitespace", 733 format("//Don't add leading whitespace", getLLVMStyleWithColumns(20))); 734 EXPECT_EQ("// A comment before\n" 735 "// a macro\n" 736 "// definition\n" 737 "#define a b", 738 format("// A comment before a macro definition\n" 739 "#define a b", 740 getLLVMStyleWithColumns(20))); 741} 742 743TEST_F(FormatTest, ParsesCommentsAdjacentToPPDirectives) { 744 EXPECT_EQ("namespace {}\n// Test\n#define A", 745 format("namespace {}\n // Test\n#define A")); 746 EXPECT_EQ("namespace {}\n/* Test */\n#define A", 747 format("namespace {}\n /* Test */\n#define A")); 748 EXPECT_EQ("namespace {}\n/* Test */ #define A", 749 format("namespace {}\n /* Test */ #define A")); 750} 751 752TEST_F(FormatTest, SplitsLongLinesInComments) { 753 EXPECT_EQ("/* This is a long\n" 754 " * comment that\n" 755 " * doesn't\n" 756 " * fit on one line.\n" 757 " */", 758 format("/* " 759 "This is a long " 760 "comment that " 761 "doesn't " 762 "fit on one line. */", 763 getLLVMStyleWithColumns(20))); 764 EXPECT_EQ("/* a b c d\n" 765 " * e f g\n" 766 " * h i j k\n" 767 " */", 768 format("/* a b c d e f g h i j k */", 769 getLLVMStyleWithColumns(10))); 770 EXPECT_EQ("/* a b c d\n" 771 " * e f g\n" 772 " * h i j k\n" 773 " */", 774 format("\\\n/* a b c d e f g h i j k */", 775 getLLVMStyleWithColumns(10))); 776 EXPECT_EQ("/*\n" 777 "This is a long\n" 778 "comment that doesn't\n" 779 "fit on one line.\n" 780 "*/", 781 format("/*\n" 782 "This is a long " 783 "comment that doesn't " 784 "fit on one line. \n" 785 "*/", getLLVMStyleWithColumns(20))); 786 EXPECT_EQ("/*\n" 787 " * This is a long\n" 788 " * comment that\n" 789 " * doesn't fit on\n" 790 " * one line.\n" 791 " */", 792 format("/* \n" 793 " * This is a long " 794 " comment that " 795 " doesn't fit on " 796 " one line. \n" 797 " */", getLLVMStyleWithColumns(20))); 798 EXPECT_EQ("/*\n" 799 " * This_is_a_comment_with_words_that_dont_fit_on_one_line\n" 800 " * so_it_should_be_broken\n" 801 " * wherever_a_space_occurs\n" 802 " */", 803 format("/*\n" 804 " * This_is_a_comment_with_words_that_dont_fit_on_one_line " 805 " so_it_should_be_broken " 806 " wherever_a_space_occurs \n" 807 " */", 808 getLLVMStyleWithColumns(20))); 809 EXPECT_EQ("/*\n" 810 " * This_comment_can_not_be_broken_into_lines\n" 811 " */", 812 format("/*\n" 813 " * This_comment_can_not_be_broken_into_lines\n" 814 " */", 815 getLLVMStyleWithColumns(20))); 816 EXPECT_EQ("{\n" 817 " /*\n" 818 " This is another\n" 819 " long comment that\n" 820 " doesn't fit on one\n" 821 " line 1234567890\n" 822 " */\n" 823 "}", 824 format("{\n" 825 "/*\n" 826 "This is another " 827 " long comment that " 828 " doesn't fit on one" 829 " line 1234567890\n" 830 "*/\n" 831 "}", getLLVMStyleWithColumns(20))); 832 EXPECT_EQ("{\n" 833 " /*\n" 834 " * This i s\n" 835 " * another comment\n" 836 " * t hat doesn' t\n" 837 " * fit on one l i\n" 838 " * n e\n" 839 " */\n" 840 "}", 841 format("{\n" 842 "/*\n" 843 " * This i s" 844 " another comment" 845 " t hat doesn' t" 846 " fit on one l i" 847 " n e\n" 848 " */\n" 849 "}", getLLVMStyleWithColumns(20))); 850 EXPECT_EQ("/*\n" 851 " * This is a long\n" 852 " * comment that\n" 853 " * doesn't fit on\n" 854 " * one line\n" 855 " */", 856 format(" /*\n" 857 " * This is a long comment that doesn't fit on one line\n" 858 " */", getLLVMStyleWithColumns(20))); 859 EXPECT_EQ("{\n" 860 " if (something) /* This is a\n" 861 "long comment */\n" 862 " ;\n" 863 "}", 864 format("{\n" 865 " if (something) /* This is a long comment */\n" 866 " ;\n" 867 "}", 868 getLLVMStyleWithColumns(30))); 869} 870 871TEST_F(FormatTest, SplitsLongLinesInCommentsInPreprocessor) { 872 EXPECT_EQ("#define X \\\n" 873 " /* \\\n" 874 " Test \\\n" 875 " Macro comment \\\n" 876 " with a long \\\n" 877 " line \\\n" 878 " */ \\\n" 879 " A + B", 880 format("#define X \\\n" 881 " /*\n" 882 " Test\n" 883 " Macro comment with a long line\n" 884 " */ \\\n" 885 " A + B", 886 getLLVMStyleWithColumns(20))); 887 EXPECT_EQ("#define X \\\n" 888 " /* Macro comment \\\n" 889 " with a long \\\n" 890 " line */ \\\n" 891 " A + B", 892 format("#define X \\\n" 893 " /* Macro comment with a long\n" 894 " line */ \\\n" 895 " A + B", 896 getLLVMStyleWithColumns(20))); 897 EXPECT_EQ("#define X \\\n" 898 " /* Macro comment \\\n" 899 " * with a long \\\n" 900 " * line */ \\\n" 901 " A + B", 902 format("#define X \\\n" 903 " /* Macro comment with a long line */ \\\n" 904 " A + B", 905 getLLVMStyleWithColumns(20))); 906} 907 908TEST_F(FormatTest, CommentsInStaticInitializers) { 909 EXPECT_EQ( 910 "static SomeType type = { aaaaaaaaaaaaaaaaaaaa, /* comment */\n" 911 " aaaaaaaaaaaaaaaaaaaa /* comment */,\n" 912 " /* comment */ aaaaaaaaaaaaaaaaaaaa,\n" 913 " aaaaaaaaaaaaaaaaaaaa, // comment\n" 914 " aaaaaaaaaaaaaaaaaaaa };", 915 format("static SomeType type = { aaaaaaaaaaaaaaaaaaaa , /* comment */\n" 916 " aaaaaaaaaaaaaaaaaaaa /* comment */ ,\n" 917 " /* comment */ aaaaaaaaaaaaaaaaaaaa ,\n" 918 " aaaaaaaaaaaaaaaaaaaa , // comment\n" 919 " aaaaaaaaaaaaaaaaaaaa };")); 920 verifyFormat("static SomeType type = { aaaaaaaaaaa, // comment for aa...\n" 921 " bbbbbbbbbbb, ccccccccccc };"); 922 verifyFormat("static SomeType type = { aaaaaaaaaaa,\n" 923 " // comment for bb....\n" 924 " bbbbbbbbbbb, ccccccccccc };"); 925 verifyGoogleFormat( 926 "static SomeType type = { aaaaaaaaaaa, // comment for aa...\n" 927 " bbbbbbbbbbb, ccccccccccc };"); 928 verifyGoogleFormat("static SomeType type = { aaaaaaaaaaa,\n" 929 " // comment for bb....\n" 930 " bbbbbbbbbbb, ccccccccccc };"); 931 932 verifyFormat("S s = { { a, b, c }, // Group #1\n" 933 " { d, e, f }, // Group #2\n" 934 " { g, h, i } }; // Group #3"); 935 verifyFormat("S s = { { // Group #1\n" 936 " a, b, c },\n" 937 " { // Group #2\n" 938 " d, e, f },\n" 939 " { // Group #3\n" 940 " g, h, i } };"); 941 942 EXPECT_EQ("S s = {\n" 943 " // Some comment\n" 944 " a,\n" 945 "\n" 946 " // Comment after empty line\n" 947 " b\n" 948 "}", 949 format("S s = {\n" 950 " // Some comment\n" 951 " a,\n" 952 " \n" 953 " // Comment after empty line\n" 954 " b\n" 955 "}")); 956 EXPECT_EQ("S s = { a, b };", format("S s = {\n" 957 " a,\n" 958 "\n" 959 " b\n" 960 "};")); 961 verifyFormat("const uint8_t aaaaaaaaaaaaaaaaaaaaaa[0] = {\n" 962 " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" 963 " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" 964 " 0x00, 0x00, 0x00, 0x00 // comment\n" 965 "};"); 966} 967 968//===----------------------------------------------------------------------===// 969// Tests for classes, namespaces, etc. 970//===----------------------------------------------------------------------===// 971 972TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) { 973 verifyFormat("class A {\n};"); 974} 975 976TEST_F(FormatTest, UnderstandsAccessSpecifiers) { 977 verifyFormat("class A {\n" 978 "public:\n" 979 "public: // comment\n" 980 "protected:\n" 981 "private:\n" 982 " void f() {}\n" 983 "};"); 984 verifyGoogleFormat("class A {\n" 985 " public:\n" 986 " protected:\n" 987 " private:\n" 988 " void f() {}\n" 989 "};"); 990} 991 992TEST_F(FormatTest, SeparatesLogicalBlocks) { 993 EXPECT_EQ("class A {\n" 994 "public:\n" 995 " void f();\n" 996 "\n" 997 "private:\n" 998 " void g() {}\n" 999 " // test\n" 1000 "protected:\n" 1001 " int h;\n" 1002 "};", 1003 format("class A {\n" 1004 "public:\n" 1005 "void f();\n" 1006 "private:\n" 1007 "void g() {}\n" 1008 "// test\n" 1009 "protected:\n" 1010 "int h;\n" 1011 "};")); 1012} 1013 1014TEST_F(FormatTest, FormatsClasses) { 1015 verifyFormat("class A : public B {\n};"); 1016 verifyFormat("class A : public ::B {\n};"); 1017 1018 verifyFormat( 1019 "class AAAAAAAAAAAAAAAAAAAA : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" 1020 " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {\n" 1021 "};\n"); 1022 verifyFormat("class AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n" 1023 " : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" 1024 " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {\n" 1025 "};\n"); 1026 verifyFormat( 1027 "class A : public B, public C, public D, public E, public F, public G {\n" 1028 "};"); 1029 verifyFormat("class AAAAAAAAAAAA : public B,\n" 1030 " public C,\n" 1031 " public D,\n" 1032 " public E,\n" 1033 " public F,\n" 1034 " public G {\n" 1035 "};"); 1036 1037 verifyFormat("class\n" 1038 " ReallyReallyLongClassName {\n};", 1039 getLLVMStyleWithColumns(32)); 1040} 1041 1042TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) { 1043 verifyFormat("class A {\n} a, b;"); 1044 verifyFormat("struct A {\n} a, b;"); 1045 verifyFormat("union A {\n} a;"); 1046} 1047 1048TEST_F(FormatTest, FormatsEnum) { 1049 verifyFormat("enum {\n" 1050 " Zero,\n" 1051 " One = 1,\n" 1052 " Two = One + 1,\n" 1053 " Three = (One + Two),\n" 1054 " Four = (Zero && (One ^ Two)) | (One << Two),\n" 1055 " Five = (One, Two, Three, Four, 5)\n" 1056 "};"); 1057 verifyFormat("enum Enum {\n" 1058 "};"); 1059 verifyFormat("enum {\n" 1060 "};"); 1061 verifyFormat("enum X E {\n} d;"); 1062 verifyFormat("enum __attribute__((...)) E {\n} d;"); 1063 verifyFormat("enum __declspec__((...)) E {\n} d;"); 1064 verifyFormat("enum X f() {\n a();\n return 42;\n}"); 1065} 1066 1067TEST_F(FormatTest, FormatsBitfields) { 1068 verifyFormat("struct Bitfields {\n" 1069 " unsigned sClass : 8;\n" 1070 " unsigned ValueKind : 2;\n" 1071 "};"); 1072} 1073 1074TEST_F(FormatTest, FormatsNamespaces) { 1075 verifyFormat("namespace some_namespace {\n" 1076 "class A {\n};\n" 1077 "void f() { f(); }\n" 1078 "}"); 1079 verifyFormat("namespace {\n" 1080 "class A {\n};\n" 1081 "void f() { f(); }\n" 1082 "}"); 1083 verifyFormat("inline namespace X {\n" 1084 "class A {\n};\n" 1085 "void f() { f(); }\n" 1086 "}"); 1087 verifyFormat("using namespace some_namespace;\n" 1088 "class A {\n};\n" 1089 "void f() { f(); }"); 1090 1091 // This code is more common than we thought; if we 1092 // layout this correctly the semicolon will go into 1093 // its own line, which is undesireable. 1094 verifyFormat("namespace {\n};"); 1095 verifyFormat("namespace {\n" 1096 "class A {\n" 1097 "};\n" 1098 "};"); 1099} 1100 1101TEST_F(FormatTest, FormatsExternC) { verifyFormat("extern \"C\" {\nint a;"); } 1102 1103TEST_F(FormatTest, FormatsInlineASM) { 1104 verifyFormat("asm(\"xyz\" : \"=a\"(a), \"=d\"(b) : \"a\"(data));"); 1105 verifyFormat( 1106 "asm(\"movq\\t%%rbx, %%rsi\\n\\t\"\n" 1107 " \"cpuid\\n\\t\"\n" 1108 " \"xchgq\\t%%rbx, %%rsi\\n\\t\"\n" 1109 " : \"=a\" (*rEAX), \"=S\" (*rEBX), \"=c\" (*rECX), \"=d\" (*rEDX)\n" 1110 " : \"a\"(value));"); 1111} 1112 1113TEST_F(FormatTest, FormatTryCatch) { 1114 // FIXME: Handle try-catch explicitly in the UnwrappedLineParser, then we'll 1115 // also not create single-line-blocks. 1116 verifyFormat("try {\n" 1117 " throw a * b;\n" 1118 "}\n" 1119 "catch (int a) {\n" 1120 " // Do nothing.\n" 1121 "}\n" 1122 "catch (...) {\n" 1123 " exit(42);\n" 1124 "}"); 1125 1126 // Function-level try statements. 1127 verifyFormat("int f() try { return 4; }\n" 1128 "catch (...) {\n" 1129 " return 5;\n" 1130 "}"); 1131 verifyFormat("class A {\n" 1132 " int a;\n" 1133 " A() try : a(0) {}\n" 1134 " catch (...) {\n" 1135 " throw;\n" 1136 " }\n" 1137 "};\n"); 1138} 1139 1140TEST_F(FormatTest, FormatObjCTryCatch) { 1141 verifyFormat("@try {\n" 1142 " f();\n" 1143 "}\n" 1144 "@catch (NSException e) {\n" 1145 " @throw;\n" 1146 "}\n" 1147 "@finally {\n" 1148 " exit(42);\n" 1149 "}"); 1150} 1151 1152TEST_F(FormatTest, StaticInitializers) { 1153 verifyFormat("static SomeClass SC = { 1, 'a' };"); 1154 1155 // FIXME: Format like enums if the static initializer does not fit on a line. 1156 verifyFormat( 1157 "static SomeClass WithALoooooooooooooooooooongName = {\n" 1158 " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" 1159 "};"); 1160 1161 verifyFormat( 1162 "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n" 1163 " looooooooooooooooooooooooooooooooooongname,\n" 1164 " looooooooooooooooooooooooooooooong };"); 1165 // Allow bin-packing in static initializers as this would often lead to 1166 // terrible results, e.g.: 1167 verifyGoogleFormat( 1168 "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n" 1169 " looooooooooooooooooooooooooooooooooongname,\n" 1170 " looooooooooooooooooooooooooooooong };"); 1171} 1172 1173TEST_F(FormatTest, NestedStaticInitializers) { 1174 verifyFormat("static A x = { { {} } };\n"); 1175 verifyFormat("static A x = { { { init1, init2, init3, init4 },\n" 1176 " { init1, init2, init3, init4 } } };"); 1177 1178 verifyFormat("somes Status::global_reps[3] = {\n" 1179 " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n" 1180 " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" 1181 " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" 1182 "};"); 1183 verifyGoogleFormat("somes Status::global_reps[3] = {\n" 1184 " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n" 1185 " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" 1186 " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" 1187 "};"); 1188 verifyFormat( 1189 "CGRect cg_rect = { { rect.fLeft, rect.fTop },\n" 1190 " { rect.fRight - rect.fLeft, rect.fBottom - rect.fTop" 1191 " } };"); 1192 1193 verifyFormat( 1194 "SomeArrayOfSomeType a = { { { 1, 2, 3 }, { 1, 2, 3 },\n" 1195 " { 111111111111111111111111111111,\n" 1196 " 222222222222222222222222222222,\n" 1197 " 333333333333333333333333333333 },\n" 1198 " { 1, 2, 3 }, { 1, 2, 3 } } };"); 1199 verifyFormat( 1200 "SomeArrayOfSomeType a = { { { 1, 2, 3 } }, { { 1, 2, 3 } },\n" 1201 " { { 111111111111111111111111111111,\n" 1202 " 222222222222222222222222222222,\n" 1203 " 333333333333333333333333333333 } },\n" 1204 " { { 1, 2, 3 } }, { { 1, 2, 3 } } };"); 1205 1206 // FIXME: We might at some point want to handle this similar to parameter 1207 // lists, where we have an option to put each on a single line. 1208 verifyFormat( 1209 "struct {\n" 1210 " unsigned bit;\n" 1211 " const char *const name;\n" 1212 "} kBitsToOs[] = { { kOsMac, \"Mac\" }, { kOsWin, \"Windows\" },\n" 1213 " { kOsLinux, \"Linux\" }, { kOsCrOS, \"Chrome OS\" } };"); 1214} 1215 1216TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) { 1217 verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro(" 1218 " \\\n" 1219 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)"); 1220} 1221 1222TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) { 1223 verifyFormat( 1224 "virtual void write(ELFWriter *writerrr,\n" 1225 " OwningPtr<FileOutputBuffer> &buffer) = 0;"); 1226} 1227 1228TEST_F(FormatTest, LayoutUnknownPPDirective) { 1229 EXPECT_EQ("#123 \"A string literal\"", 1230 format(" # 123 \"A string literal\"")); 1231 EXPECT_EQ("#;", format("#;")); 1232 verifyFormat("#\n;\n;\n;"); 1233} 1234 1235TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) { 1236 EXPECT_EQ("#line 42 \"test\"\n", 1237 format("# \\\n line \\\n 42 \\\n \"test\"\n")); 1238 EXPECT_EQ("#define A B\n", format("# \\\n define \\\n A \\\n B\n", 1239 getLLVMStyleWithColumns(12))); 1240} 1241 1242TEST_F(FormatTest, EndOfFileEndsPPDirective) { 1243 EXPECT_EQ("#line 42 \"test\"", 1244 format("# \\\n line \\\n 42 \\\n \"test\"")); 1245 EXPECT_EQ("#define A B", format("# \\\n define \\\n A \\\n B")); 1246} 1247 1248TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) { 1249 verifyFormat("#define A(BB)", getLLVMStyleWithColumns(13)); 1250 verifyFormat("#define A( \\\n BB)", getLLVMStyleWithColumns(12)); 1251 verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12)); 1252 // FIXME: We never break before the macro name. 1253 verifyFormat("#define AA(\\\n B)", getLLVMStyleWithColumns(12)); 1254 1255 verifyFormat("#define A A\n#define A A"); 1256 verifyFormat("#define A(X) A\n#define A A"); 1257 1258 verifyFormat("#define Something Other", getLLVMStyleWithColumns(23)); 1259 verifyFormat("#define Something \\\n Other", getLLVMStyleWithColumns(22)); 1260} 1261 1262TEST_F(FormatTest, HandlePreprocessorDirectiveContext) { 1263 EXPECT_EQ("// somecomment\n" 1264 "#include \"a.h\"\n" 1265 "#define A( \\\n" 1266 " A, B)\n" 1267 "#include \"b.h\"\n" 1268 "// somecomment\n", 1269 format(" // somecomment\n" 1270 " #include \"a.h\"\n" 1271 "#define A(A,\\\n" 1272 " B)\n" 1273 " #include \"b.h\"\n" 1274 " // somecomment\n", 1275 getLLVMStyleWithColumns(13))); 1276} 1277 1278TEST_F(FormatTest, LayoutSingleHash) { EXPECT_EQ("#\na;", format("#\na;")); } 1279 1280TEST_F(FormatTest, LayoutCodeInMacroDefinitions) { 1281 EXPECT_EQ("#define A \\\n" 1282 " c; \\\n" 1283 " e;\n" 1284 "f;", 1285 format("#define A c; e;\n" 1286 "f;", 1287 getLLVMStyleWithColumns(14))); 1288} 1289 1290TEST_F(FormatTest, LayoutRemainingTokens) { EXPECT_EQ("{}", format("{}")); } 1291 1292TEST_F(FormatTest, LayoutSingleUnwrappedLineInMacro) { 1293 EXPECT_EQ("# define A\\\n b;", 1294 format("# define A b;", 11, 2, getLLVMStyleWithColumns(11))); 1295} 1296 1297TEST_F(FormatTest, MacroDefinitionInsideStatement) { 1298 EXPECT_EQ("int x,\n" 1299 "#define A\n" 1300 " y;", 1301 format("int x,\n#define A\ny;")); 1302} 1303 1304TEST_F(FormatTest, HashInMacroDefinition) { 1305 verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11)); 1306 verifyFormat("#define A \\\n" 1307 " { \\\n" 1308 " f(#c);\\\n" 1309 " }", 1310 getLLVMStyleWithColumns(11)); 1311 1312 verifyFormat("#define A(X) \\\n" 1313 " void function##X()", 1314 getLLVMStyleWithColumns(22)); 1315 1316 verifyFormat("#define A(a, b, c) \\\n" 1317 " void a##b##c()", 1318 getLLVMStyleWithColumns(22)); 1319 1320 verifyFormat("#define A void # ## #", getLLVMStyleWithColumns(22)); 1321} 1322 1323TEST_F(FormatTest, RespectWhitespaceInMacroDefinitions) { 1324 verifyFormat("#define A (1)"); 1325} 1326 1327TEST_F(FormatTest, EmptyLinesInMacroDefinitions) { 1328 EXPECT_EQ("#define A b;", format("#define A \\\n" 1329 " \\\n" 1330 " b;", 1331 getLLVMStyleWithColumns(25))); 1332 EXPECT_EQ("#define A \\\n" 1333 " \\\n" 1334 " a; \\\n" 1335 " b;", 1336 format("#define A \\\n" 1337 " \\\n" 1338 " a; \\\n" 1339 " b;", 1340 getLLVMStyleWithColumns(11))); 1341 EXPECT_EQ("#define A \\\n" 1342 " a; \\\n" 1343 " \\\n" 1344 " b;", 1345 format("#define A \\\n" 1346 " a; \\\n" 1347 " \\\n" 1348 " b;", 1349 getLLVMStyleWithColumns(11))); 1350} 1351 1352TEST_F(FormatTest, MacroDefinitionsWithIncompleteCode) { 1353 verifyFormat("#define A :"); 1354 1355 // FIXME: Improve formatting of case labels in macros. 1356 verifyFormat("#define SOMECASES \\\n" 1357 " case 1: \\\n" 1358 " case 2\n", 1359 getLLVMStyleWithColumns(20)); 1360 1361 verifyFormat("#define A template <typename T>"); 1362 verifyFormat("#define STR(x) #x\n" 1363 "f(STR(this_is_a_string_literal{));"); 1364} 1365 1366TEST_F(FormatTest, MacroCallsWithoutTrailingSemicolon) { 1367 EXPECT_EQ("INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n" 1368 "INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n" 1369 "INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n" 1370 "class X {\n" 1371 "};\n" 1372 "INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n" 1373 "int *createScopDetectionPass() { return 0; }", 1374 format(" INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n" 1375 " INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n" 1376 " INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n" 1377 " class X {};\n" 1378 " INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n" 1379 " int *createScopDetectionPass() { return 0; }")); 1380 // FIXME: We could probably treat IPC_BEGIN_MESSAGE_MAP/IPC_END_MESSAGE_MAP as 1381 // braces, so that inner block is indented one level more. 1382 EXPECT_EQ("int q() {\n" 1383 " IPC_BEGIN_MESSAGE_MAP(WebKitTestController, message)\n" 1384 " IPC_MESSAGE_HANDLER(xxx, qqq)\n" 1385 " IPC_END_MESSAGE_MAP()\n" 1386 "}", 1387 format("int q() {\n" 1388 " IPC_BEGIN_MESSAGE_MAP(WebKitTestController, message)\n" 1389 " IPC_MESSAGE_HANDLER(xxx, qqq)\n" 1390 " IPC_END_MESSAGE_MAP()\n" 1391 "}")); 1392 EXPECT_EQ("int q() {\n" 1393 " f(x);\n" 1394 " f(x) {}\n" 1395 " f(x)->g();\n" 1396 " f(x)->*g();\n" 1397 " f(x).g();\n" 1398 " f(x) = x;\n" 1399 " f(x) += x;\n" 1400 " f(x) -= x;\n" 1401 " f(x) *= x;\n" 1402 " f(x) /= x;\n" 1403 " f(x) %= x;\n" 1404 " f(x) &= x;\n" 1405 " f(x) |= x;\n" 1406 " f(x) ^= x;\n" 1407 " f(x) >>= x;\n" 1408 " f(x) <<= x;\n" 1409 " f(x)[y].z();\n" 1410 " LOG(INFO) << x;\n" 1411 " ifstream(x) >> x;\n" 1412 "}\n", 1413 format("int q() {\n" 1414 " f(x)\n;\n" 1415 " f(x)\n {}\n" 1416 " f(x)\n->g();\n" 1417 " f(x)\n->*g();\n" 1418 " f(x)\n.g();\n" 1419 " f(x)\n = x;\n" 1420 " f(x)\n += x;\n" 1421 " f(x)\n -= x;\n" 1422 " f(x)\n *= x;\n" 1423 " f(x)\n /= x;\n" 1424 " f(x)\n %= x;\n" 1425 " f(x)\n &= x;\n" 1426 " f(x)\n |= x;\n" 1427 " f(x)\n ^= x;\n" 1428 " f(x)\n >>= x;\n" 1429 " f(x)\n <<= x;\n" 1430 " f(x)\n[y].z();\n" 1431 " LOG(INFO)\n << x;\n" 1432 " ifstream(x)\n >> x;\n" 1433 "}\n")); 1434 EXPECT_EQ("int q() {\n" 1435 " f(x)\n" 1436 " if (1) {\n" 1437 " }\n" 1438 " f(x)\n" 1439 " while (1) {\n" 1440 " }\n" 1441 " f(x)\n" 1442 " g(x);\n" 1443 " f(x)\n" 1444 " try {\n" 1445 " q();\n" 1446 " }\n" 1447 " catch (...) {\n" 1448 " }\n" 1449 "}\n", 1450 format("int q() {\n" 1451 "f(x)\n" 1452 "if (1) {}\n" 1453 "f(x)\n" 1454 "while (1) {}\n" 1455 "f(x)\n" 1456 "g(x);\n" 1457 "f(x)\n" 1458 "try { q(); } catch (...) {}\n" 1459 "}\n")); 1460 EXPECT_EQ("class A {\n" 1461 " A() : t(0) {}\n" 1462 " A(X x)\n" // FIXME: function-level try blocks are broken. 1463 " try : t(0) {\n" 1464 " }\n" 1465 " catch (...) {\n" 1466 " }\n" 1467 "};", 1468 format("class A {\n" 1469 " A()\n : t(0) {}\n" 1470 " A(X x)\n" 1471 " try : t(0) {} catch (...) {}\n" 1472 "};")); 1473} 1474 1475TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) { 1476 EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}")); 1477} 1478 1479TEST_F(FormatTest, FormatHashIfNotAtStartOfLine) { 1480 verifyFormat("{\n { a #c; }\n}"); 1481} 1482 1483TEST_F(FormatTest, FormatUnbalancedStructuralElements) { 1484 EXPECT_EQ("#define A \\\n { \\\n {\nint i;", 1485 format("#define A { {\nint i;", getLLVMStyleWithColumns(11))); 1486 EXPECT_EQ("#define A \\\n } \\\n }\nint i;", 1487 format("#define A } }\nint i;", getLLVMStyleWithColumns(11))); 1488} 1489 1490TEST_F(FormatTest, EscapedNewlineAtStartOfTokenInMacroDefinition) { 1491 EXPECT_EQ( 1492 "#define A \\\n int i; \\\n int j;", 1493 format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11))); 1494} 1495 1496TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) { 1497 verifyFormat("#define A \\\n" 1498 " int v( \\\n" 1499 " a); \\\n" 1500 " int i;", 1501 getLLVMStyleWithColumns(11)); 1502} 1503 1504TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) { 1505 EXPECT_EQ( 1506 "#define ALooooooooooooooooooooooooooooooooooooooongMacro(" 1507 " \\\n" 1508 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" 1509 "\n" 1510 "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" 1511 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n", 1512 format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro(" 1513 "\\\n" 1514 "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" 1515 " \n" 1516 " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" 1517 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n")); 1518} 1519 1520TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) { 1521 EXPECT_EQ("int\n" 1522 "#define A\n" 1523 " a;", 1524 format("int\n#define A\na;")); 1525 verifyFormat("functionCallTo(\n" 1526 " someOtherFunction(\n" 1527 " withSomeParameters, whichInSequence,\n" 1528 " areLongerThanALine(andAnotherCall,\n" 1529 "#define A B\n" 1530 " withMoreParamters,\n" 1531 " whichStronglyInfluenceTheLayout),\n" 1532 " andMoreParameters),\n" 1533 " trailing);", 1534 getLLVMStyleWithColumns(69)); 1535} 1536 1537TEST_F(FormatTest, LayoutBlockInsideParens) { 1538 EXPECT_EQ("functionCall({\n" 1539 " int i;\n" 1540 "});", 1541 format(" functionCall ( {int i;} );")); 1542} 1543 1544TEST_F(FormatTest, LayoutBlockInsideStatement) { 1545 EXPECT_EQ("SOME_MACRO { int i; }\n" 1546 "int i;", 1547 format(" SOME_MACRO {int i;} int i;")); 1548} 1549 1550TEST_F(FormatTest, LayoutNestedBlocks) { 1551 verifyFormat("void AddOsStrings(unsigned bitmask) {\n" 1552 " struct s {\n" 1553 " int i;\n" 1554 " };\n" 1555 " s kBitsToOs[] = { { 10 } };\n" 1556 " for (int i = 0; i < 10; ++i)\n" 1557 " return;\n" 1558 "}"); 1559} 1560 1561TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) { 1562 EXPECT_EQ("{}", format("{}")); 1563 1564 // Negative test for enum. 1565 verifyFormat("enum E {\n};"); 1566 1567 // Note that when there's a missing ';', we still join... 1568 verifyFormat("enum E {}"); 1569} 1570 1571//===----------------------------------------------------------------------===// 1572// Line break tests. 1573//===----------------------------------------------------------------------===// 1574 1575TEST_F(FormatTest, FormatsFunctionDefinition) { 1576 verifyFormat("void f(int a, int b, int c, int d, int e, int f, int g," 1577 " int h, int j, int f,\n" 1578 " int c, int ddddddddddddd) {}"); 1579} 1580 1581TEST_F(FormatTest, FormatsAwesomeMethodCall) { 1582 verifyFormat( 1583 "SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n" 1584 " parameter, parameter, parameter)),\n" 1585 " SecondLongCall(parameter));"); 1586} 1587 1588TEST_F(FormatTest, PreventConfusingIndents) { 1589 verifyFormat( 1590 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1591 " aaaaaaaaaaaaaaaaaaaaaaaa(\n" 1592 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 1593 " aaaaaaaaaaaaaaaaaaaaaaaa);"); 1594 verifyFormat( 1595 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[\n" 1596 " aaaaaaaaaaaaaaaaaaaaaaaa[\n" 1597 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa],\n" 1598 " aaaaaaaaaaaaaaaaaaaaaaaa];"); 1599 verifyFormat( 1600 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" 1601 " aaaaaaaaaaaaaaaaaaaaaaaa<\n" 1602 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>,\n" 1603 " aaaaaaaaaaaaaaaaaaaaaaaa>;"); 1604 verifyFormat("int a = bbbb && ccc && fffff(\n" 1605 "#define A Just forcing a new line\n" 1606 " ddd);"); 1607} 1608 1609TEST_F(FormatTest, ExpressionIndentation) { 1610 verifyFormat("bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 1611 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 1612 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 1613 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 1614 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +\n" 1615 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb &&\n" 1616 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 1617 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >\n" 1618 " ccccccccccccccccccccccccccccccccccccccccc;"); 1619 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 1620 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 1621 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 1622 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 1623 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 1624 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 1625 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 1626 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 1627 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" 1628 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 1629 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" 1630 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); 1631} 1632 1633TEST_F(FormatTest, ConstructorInitializers) { 1634 verifyFormat("Constructor() : Initializer(FitsOnTheLine) {}"); 1635 verifyFormat("Constructor() : Inttializer(FitsOnTheLine) {}", 1636 getLLVMStyleWithColumns(45)); 1637 verifyFormat("Constructor()\n" 1638 " : Inttializer(FitsOnTheLine) {}", 1639 getLLVMStyleWithColumns(44)); 1640 verifyFormat("Constructor()\n" 1641 " : Inttializer(FitsOnTheLine) {}", 1642 getLLVMStyleWithColumns(43)); 1643 1644 verifyFormat( 1645 "SomeClass::Constructor()\n" 1646 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); 1647 1648 verifyFormat( 1649 "SomeClass::Constructor()\n" 1650 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 1651 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}"); 1652 verifyFormat( 1653 "SomeClass::Constructor()\n" 1654 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 1655 " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); 1656 1657 verifyFormat("Constructor()\n" 1658 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 1659 " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1660 " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 1661 " aaaaaaaaaaaaaaaaaaaaaaa() {}"); 1662 1663 verifyFormat("Constructor()\n" 1664 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1665 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 1666 1667 verifyFormat("Constructor(int Parameter = 0)\n" 1668 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa),\n" 1669 " aaaaaaaaaaaa(aaaaaaaaaaaaaaaaa) {}"); 1670 1671 // Here a line could be saved by splitting the second initializer onto two 1672 // lines, but that is not desireable. 1673 verifyFormat("Constructor()\n" 1674 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n" 1675 " aaaaaaaaaaa(aaaaaaaaaaa),\n" 1676 " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 1677 1678 FormatStyle OnePerLine = getLLVMStyle(); 1679 OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 1680 verifyFormat("SomeClass::Constructor()\n" 1681 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 1682 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 1683 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 1684 OnePerLine); 1685 verifyFormat("SomeClass::Constructor()\n" 1686 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), // Some comment\n" 1687 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" 1688 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", 1689 OnePerLine); 1690 verifyFormat("MyClass::MyClass(int var)\n" 1691 " : some_var_(var), // 4 space indent\n" 1692 " some_other_var_(var + 1) { // lined up\n" 1693 "}", 1694 OnePerLine); 1695 verifyFormat("Constructor()\n" 1696 " : aaaaa(aaaaaa),\n" 1697 " aaaaa(aaaaaa),\n" 1698 " aaaaa(aaaaaa),\n" 1699 " aaaaa(aaaaaa),\n" 1700 " aaaaa(aaaaaa) {}", 1701 OnePerLine); 1702 verifyFormat("Constructor()\n" 1703 " : aaaaa(aaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaa,\n" 1704 " aaaaaaaaaaaaaaaaaaaaaa) {}", 1705 OnePerLine); 1706} 1707 1708TEST_F(FormatTest, MemoizationTests) { 1709 // This breaks if the memoization lookup does not take \c Indent and 1710 // \c LastSpace into account. 1711 verifyFormat( 1712 "extern CFRunLoopTimerRef\n" 1713 "CFRunLoopTimerCreate(CFAllocatorRef allocato, CFAbsoluteTime fireDate,\n" 1714 " CFTimeInterval interval, CFOptionFlags flags,\n" 1715 " CFIndex order, CFRunLoopTimerCallBack callout,\n" 1716 " CFRunLoopTimerContext *context) {}"); 1717 1718 // Deep nesting somewhat works around our memoization. 1719 verifyFormat( 1720 "aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 1721 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 1722 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 1723 " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" 1724 " aaaaa())))))))))))))))))))))))))))))))))))))));", 1725 getLLVMStyleWithColumns(65)); 1726 1727 // This test takes VERY long when memoization is broken. 1728 FormatStyle OnePerLine = getLLVMStyle(); 1729 OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; 1730 OnePerLine.BinPackParameters = false; 1731 std::string input = "Constructor()\n" 1732 " : aaaa(a,\n"; 1733 for (unsigned i = 0, e = 80; i != e; ++i) { 1734 input += " a,\n"; 1735 } 1736 input += " a) {}"; 1737 verifyFormat(input, OnePerLine); 1738} 1739 1740TEST_F(FormatTest, BreaksAsHighAsPossible) { 1741 verifyFormat( 1742 "void f() {\n" 1743 " if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n" 1744 " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n" 1745 " f();\n" 1746 "}"); 1747 verifyFormat("if (Intervals[i].getRange().getFirst() <\n" 1748 " Intervals[i - 1].getRange().getLast()) {\n}"); 1749} 1750 1751TEST_F(FormatTest, BreaksFunctionDeclarations) { 1752 // Principially, we break function declarations in a certain order: 1753 // 1) break amongst arguments. 1754 verifyFormat("Aaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccc,\n" 1755 " Cccccccccccccc cccccccccccccc);"); 1756 1757 // 2) break after return type. 1758 verifyFormat( 1759 "Aaaaaaaaaaaaaaaaaaaaaaaa\n" 1760 " bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccccccccccccccc);"); 1761 1762 // 3) break after (. 1763 verifyFormat( 1764 "Aaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb(\n" 1765 " Cccccccccccccccccccccccccccccc cccccccccccccccccccccccccccccccc);"); 1766 1767 // 4) break before after nested name specifiers. 1768 verifyFormat( 1769 "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 1770 " SomeClasssssssssssssssssssssssssssssssssssssss::\n" 1771 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc);"); 1772 1773 // However, there are exceptions, if a sufficient amount of lines can be 1774 // saved. 1775 // FIXME: The precise cut-offs wrt. the number of saved lines might need some 1776 // more adjusting. 1777 verifyFormat("Aaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" 1778 " Cccccccccccccc cccccccccc,\n" 1779 " Cccccccccccccc cccccccccc,\n" 1780 " Cccccccccccccc cccccccccc,\n" 1781 " Cccccccccccccc cccccccccc);"); 1782 verifyFormat( 1783 "Aaaaaaaaaaaaaaaaaa\n" 1784 " bbbbbbbbbbb(Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 1785 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 1786 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);"); 1787 verifyFormat( 1788 "Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" 1789 " Cccccccccccccc cccccccccc,\n" 1790 " Cccccccccccccc cccccccccc,\n" 1791 " Cccccccccccccc cccccccccc,\n" 1792 " Cccccccccccccc cccccccccc,\n" 1793 " Cccccccccccccc cccccccccc,\n" 1794 " Cccccccccccccc cccccccccc);"); 1795 verifyFormat("Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n" 1796 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 1797 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 1798 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" 1799 " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);"); 1800 1801 // Break after multi-line parameters. 1802 verifyFormat("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1803 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 1804 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1805 " bbbb bbbb);"); 1806} 1807 1808TEST_F(FormatTest, BreaksDesireably) { 1809 verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" 1810 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" 1811 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {\n}"); 1812 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1813 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)) {\n" 1814 "}"); 1815 1816 verifyFormat( 1817 "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1818 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); 1819 1820 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1821 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1822 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 1823 1824 verifyFormat( 1825 "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1826 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" 1827 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1828 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));"); 1829 1830 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 1831 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 1832 1833 verifyFormat( 1834 "void f() {\n" 1835 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" 1836 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" 1837 "}"); 1838 verifyFormat( 1839 "aaaaaa(new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1840 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 1841 verifyFormat( 1842 "aaaaaa(aaa, new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1843 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 1844 verifyFormat( 1845 "aaaaaaaaaaaaaaaaa(\n" 1846 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1847 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 1848 1849 // This test case breaks on an incorrect memoization, i.e. an optimization not 1850 // taking into account the StopAt value. 1851 verifyFormat( 1852 "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 1853 " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 1854 " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" 1855 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 1856 1857 verifyFormat("{\n {\n {\n" 1858 " Annotation.SpaceRequiredBefore =\n" 1859 " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n" 1860 " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n" 1861 " }\n }\n}"); 1862} 1863 1864TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { 1865 FormatStyle NoBinPacking = getGoogleStyle(); 1866 NoBinPacking.BinPackParameters = false; 1867 verifyFormat("f(aaaaaaaaaaaaaaaaaaaa,\n" 1868 " aaaaaaaaaaaaaaaaaaaa,\n" 1869 " aaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaa);", 1870 NoBinPacking); 1871 verifyFormat("aaaaaaa(aaaaaaaaaaaaa,\n" 1872 " aaaaaaaaaaaaa,\n" 1873 " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));", 1874 NoBinPacking); 1875 verifyFormat( 1876 "aaaaaaaa(aaaaaaaaaaaaa,\n" 1877 " aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1878 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" 1879 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1880 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));", 1881 NoBinPacking); 1882 verifyFormat("aaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" 1883 " .aaaaaaaaaaaaaaaaaa();", 1884 NoBinPacking); 1885 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 1886 " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);", 1887 NoBinPacking); 1888 1889 verifyFormat( 1890 "aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 1891 " aaaaaaaaaaaa,\n" 1892 " aaaaaaaaaaaa);", 1893 NoBinPacking); 1894 verifyFormat( 1895 "somefunction(someotherFunction(ddddddddddddddddddddddddddddddddddd,\n" 1896 " ddddddddddddddddddddddddddddd),\n" 1897 " test);", 1898 NoBinPacking); 1899 1900 verifyFormat("std::vector<aaaaaaaaaaaaaaaaaaaaaaa,\n" 1901 " aaaaaaaaaaaaaaaaaaaaaaa,\n" 1902 " aaaaaaaaaaaaaaaaaaaaaaa> aaaaaaaaaaaaaaaaaa;", 1903 NoBinPacking); 1904 verifyFormat("a(\"a\"\n" 1905 " \"a\",\n" 1906 " a);"); 1907 1908 NoBinPacking.AllowAllParametersOfDeclarationOnNextLine = false; 1909 verifyFormat("void aaaaaaaaaa(aaaaaaaaa,\n" 1910 " aaaaaaaaa,\n" 1911 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", 1912 NoBinPacking); 1913 verifyFormat( 1914 "void f() {\n" 1915 " aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" 1916 " .aaaaaaa();\n" 1917 "}", 1918 NoBinPacking); 1919} 1920 1921TEST_F(FormatTest, FormatsBuilderPattern) { 1922 verifyFormat( 1923 "return llvm::StringSwitch<Reference::Kind>(name)\n" 1924 " .StartsWith(\".eh_frame_hdr\", ORDER_EH_FRAMEHDR)\n" 1925 " .StartsWith(\".eh_frame\", ORDER_EH_FRAME).StartsWith(\".init\", ORDER_INIT)\n" 1926 " .StartsWith(\".fini\", ORDER_FINI).StartsWith(\".hash\", ORDER_HASH)\n" 1927 " .Default(ORDER_TEXT);\n"); 1928 1929 verifyFormat("return aaaaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa() <\n" 1930 " aaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa();"); 1931 verifyFormat( 1932 "aaaaaaa->aaaaaaa\n" 1933 " ->aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 1934 " ->aaaaaaaa(aaaaaaaaaaaaaaa);"); 1935 verifyFormat( 1936 "aaaaaaaaaaaaaaaaaaa()->aaaaaa(bbbbb)->aaaaaaaaaaaaaaaaaaa( // break\n" 1937 " aaaaaaaaaaaaaa);"); 1938 verifyFormat( 1939 "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa = aaaaaa->aaaaaaaaaaaa()\n" 1940 " ->aaaaaaaaaaaaaaaa(\n" 1941 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 1942 " ->aaaaaaaaaaaaaaaaa();"); 1943} 1944 1945TEST_F(FormatTest, DoesNotBreakTrailingAnnotation) { 1946 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 1947 " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); 1948 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" 1949 " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); 1950 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" 1951 " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}"); 1952 verifyFormat( 1953 "void aaaaaaaaaaaaaaaaaa()\n" 1954 " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n" 1955 " aaaaaaaaaaaaaaaaaaaaaaaaa));"); 1956 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 1957 " __attribute__((unused));"); 1958 verifyFormat( 1959 "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 1960 " GUARDED_BY(aaaaaaaaaaaa);"); 1961} 1962 1963TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) { 1964 verifyFormat( 1965 "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 1966 " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {\n}"); 1967 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" 1968 " ccccccccccccccccccccccccc) {\n}"); 1969 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" 1970 " ccccccccccccccccccccccccc) {\n}"); 1971 verifyFormat( 1972 "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n" 1973 " ccccccccccccccccccccccccc) {\n}"); 1974 verifyFormat("return aaaa & AAAAAAAAAAAAAAAAAAAAAAAAAAAAA ||\n" 1975 " bbbb & BBBBBBBBBBBBBBBBBBBBBBBBBBBBB ||\n" 1976 " cccc & CCCCCCCCCCCCCCCCCCCCCCCCCC ||\n" 1977 " dddd & DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD;"); 1978 verifyFormat("if ((aaaaaaaaaa != aaaaaaaaaaaaaaa ||\n" 1979 " aaaaaaaaaaaaaaaaaaaaaaaa() >= aaaaaaaaaaaaaaaaaaaa) &&\n" 1980 " aaaaaaaaaaaaaaa != aa) {\n}"); 1981} 1982 1983TEST_F(FormatTest, BreaksAfterAssignments) { 1984 verifyFormat( 1985 "unsigned Cost =\n" 1986 " TTI.getMemoryOpCost(I->getOpcode(), VectorTy, SI->getAlignment(),\n" 1987 " SI->getPointerAddressSpaceee());\n"); 1988 verifyFormat( 1989 "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n" 1990 " Line.Tokens.front().Tok.getLo(), Line.Tokens.back().Tok.getLoc());"); 1991 1992 verifyFormat( 1993 "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa()\n" 1994 " .aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);"); 1995} 1996 1997TEST_F(FormatTest, AlignsAfterAssignments) { 1998 verifyFormat( 1999 "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2000 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 2001 verifyFormat( 2002 "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2003 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 2004 verifyFormat( 2005 "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2006 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 2007 verifyFormat( 2008 "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2009 " aaaaaaaaaaaaaaaaaaaaaaaaa);"); 2010 verifyFormat("double LooooooooooooooooooooooooongResult =\n" 2011 " aaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaa +\n" 2012 " aaaaaaaaaaaaaaaaaaaaaaaa;"); 2013} 2014 2015TEST_F(FormatTest, AlignsAfterReturn) { 2016 verifyFormat( 2017 "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2018 " aaaaaaaaaaaaaaaaaaaaaaaaa;"); 2019 verifyFormat( 2020 "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" 2021 " aaaaaaaaaaaaaaaaaaaaaaaaa);"); 2022 verifyFormat( 2023 "return aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" 2024 " aaaaaaaaaaaaaaaaaaaaaa();"); 2025 verifyFormat( 2026 "return (aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" 2027 " aaaaaaaaaaaaaaaaaaaaaa());"); 2028 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2029 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2030 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2031 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) &&\n" 2032 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 2033} 2034 2035TEST_F(FormatTest, BreaksConditionalExpressions) { 2036 verifyFormat( 2037 "aaaa(aaaaaaaaaaaaaaaaaaaa,\n" 2038 " aaaaaaaaaaaaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2039 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2040 verifyFormat( 2041 "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2042 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2043 verifyFormat( 2044 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaa ? aaaa(aaaaaa)\n" 2045 " : aaaaaaaaaaaaa);"); 2046 verifyFormat( 2047 "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2048 " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2049 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2050 " aaaaaaaaaaaaa);"); 2051 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2052 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2053 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2054 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2055 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2056 verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2057 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2058 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2059 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2060 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2061 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" 2062 " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2063 2064 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2065 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2066 " : aaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 2067 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaa =\n" 2068 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2069 " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2070 " : aaaaaaaaaaaaaaaa;"); 2071 verifyFormat( 2072 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2073 " ? aaaaaaaaaaaaaaa\n" 2074 " : aaaaaaaaaaaaaaa;"); 2075 verifyFormat("f(aaaaaaaaaaaaaaaa == // force break\n" 2076 " aaaaaaaaa\n" 2077 " ? b\n" 2078 " : c);"); 2079 verifyFormat( 2080 "unsigned Indent =\n" 2081 " format(TheLine.First, IndentForLevel[TheLine.Level] >= 0\n" 2082 " ? IndentForLevel[TheLine.Level]\n" 2083 " : TheLine * 2,\n" 2084 " TheLine.InPPDirective, PreviousEndOfLineColumn);", 2085 getLLVMStyleWithColumns(70)); 2086 2087 FormatStyle NoBinPacking = getLLVMStyle(); 2088 NoBinPacking.BinPackParameters = false; 2089 verifyFormat( 2090 "void f() {\n" 2091 " g(aaa,\n" 2092 " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" 2093 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2094 " ? aaaaaaaaaaaaaaa\n" 2095 " : aaaaaaaaaaaaaaa);\n" 2096 "}", 2097 NoBinPacking); 2098} 2099 2100TEST_F(FormatTest, DeclarationsOfMultipleVariables) { 2101 verifyFormat("bool aaaaaaaaaaaaaaaaa = aaaaaa->aaaaaaaaaaaaaaaaa(),\n" 2102 " aaaaaaaaaaa = aaaaaa->aaaaaaaaaaa();"); 2103 verifyFormat("bool a = true, b = false;"); 2104 2105 verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaa =\n" 2106 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa),\n" 2107 " bbbbbbbbbbbbbbbbbbbbbbbbb =\n" 2108 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(bbbbbbbbbbbbbbbb);"); 2109 verifyFormat( 2110 "bool aaaaaaaaaaaaaaaaaaaaa =\n" 2111 " bbbbbbbbbbbbbbbbbbbbbbbbbbbb && cccccccccccccccccccccccccccc,\n" 2112 " d = e && f;"); 2113 verifyFormat("aaaaaaaaa a = aaaaaaaaaaaaaaaaaaaa, b = bbbbbbbbbbbbbbbbbbbb,\n" 2114 " c = cccccccccccccccccccc, d = dddddddddddddddddddd;"); 2115 verifyFormat("aaaaaaaaa *a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" 2116 " *c = ccccccccccccccccccc, *d = ddddddddddddddddddd;"); 2117 verifyFormat("aaaaaaaaa ***a = aaaaaaaaaaaaaaaaaaa, ***b = bbbbbbbbbbbbbbb,\n" 2118 " ***c = ccccccccccccccccccc, ***d = ddddddddddddddd;"); 2119 // FIXME: If multiple variables are defined, the "*" needs to move to the new 2120 // line. Also fix indent for breaking after the type, this looks bad. 2121 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" 2122 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa = aaaaaaaaaaaaaaaaaaa,\n" 2123 " *b = bbbbbbbbbbbbbbbbbbb;"); 2124 2125 // Not ideal, but pointer-with-type does not allow much here. 2126 verifyGoogleFormat( 2127 "aaaaaaaaa* a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" 2128 " *b = bbbbbbbbbbbbbbbbbbb, *d = ddddddddddddddddddd;"); 2129} 2130 2131TEST_F(FormatTest, ConditionalExpressionsInBrackets) { 2132 verifyFormat("arr[foo ? bar : baz];"); 2133 verifyFormat("f()[foo ? bar : baz];"); 2134 verifyFormat("(a + b)[foo ? bar : baz];"); 2135 verifyFormat("arr[foo ? (4 > 5 ? 4 : 5) : 5 < 5 ? 5 : 7];"); 2136} 2137 2138TEST_F(FormatTest, AlignsStringLiterals) { 2139 verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n" 2140 " \"short literal\");"); 2141 verifyFormat( 2142 "looooooooooooooooooooooooongFunction(\n" 2143 " \"short literal\"\n" 2144 " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");"); 2145 verifyFormat("someFunction(\"Always break between multi-line\"\n" 2146 " \" string literals\",\n" 2147 " and, other, parameters);"); 2148 EXPECT_EQ("fun + \"1243\" /* comment */\n" 2149 " \"5678\";", 2150 format("fun + \"1243\" /* comment */\n" 2151 " \"5678\";", 2152 getLLVMStyleWithColumns(28))); 2153 EXPECT_EQ( 2154 "aaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" 2155 " \"aaaaaaaaaaaaaaaaaaaaa\"\n" 2156 " \"aaaaaaaaaaaaaaaa\";", 2157 format("aaaaaa =" 2158 "\"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa " 2159 "aaaaaaaaaaaaaaaaaaaaa\" " 2160 "\"aaaaaaaaaaaaaaaa\";")); 2161 verifyFormat("a = a + \"a\"\n" 2162 " \"a\"\n" 2163 " \"a\";"); 2164 2165 verifyFormat( 2166 "#define LL_FORMAT \"ll\"\n" 2167 "printf(\"aaaaa: %d, bbbbbb: %\" LL_FORMAT \"d, cccccccc: %\" LL_FORMAT\n" 2168 " \"d, ddddddddd: %\" LL_FORMAT \"d\");"); 2169} 2170 2171TEST_F(FormatTest, AlignsPipes) { 2172 verifyFormat( 2173 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2174 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2175 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 2176 verifyFormat( 2177 "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n" 2178 " << aaaaaaaaaaaaaaaaaaaa;"); 2179 verifyFormat( 2180 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2181 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 2182 verifyFormat( 2183 "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" 2184 " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n" 2185 " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";"); 2186 verifyFormat( 2187 "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2188 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2189 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 2190 2191 verifyFormat("return out << \"somepacket = {\\n\"\n" 2192 " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n" 2193 " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n" 2194 " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n" 2195 " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n" 2196 " << \"}\";"); 2197 2198 verifyFormat( 2199 "llvm::outs() << \"aaaaaaaaaaaaaaaaa = \" << aaaaaaaaaaaaaaaaa\n" 2200 " << \"bbbbbbbbbbbbbbbbb = \" << bbbbbbbbbbbbbbbbb\n" 2201 " << \"ccccccccccccccccc = \" << ccccccccccccccccc\n" 2202 " << \"ddddddddddddddddd = \" << ddddddddddddddddd\n" 2203 " << \"eeeeeeeeeeeeeeeee = \" << eeeeeeeeeeeeeeeee;"); 2204 verifyFormat("llvm::outs() << aaaaaaaaaaaaaaaaaaaaaaaa << \"=\"\n" 2205 " << bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); 2206 2207 verifyFormat( 2208 "llvm::errs() << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2209 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 2210} 2211 2212TEST_F(FormatTest, UnderstandsEquals) { 2213 verifyFormat( 2214 "aaaaaaaaaaaaaaaaa =\n" 2215 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 2216 verifyFormat( 2217 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 2218 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 2219 verifyFormat( 2220 "if (a) {\n" 2221 " f();\n" 2222 "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 2223 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" 2224 "}"); 2225 2226 verifyFormat("if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 2227 " 100000000 + 10000000) {\n}"); 2228} 2229 2230TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) { 2231 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" 2232 " .looooooooooooooooooooooooooooooooooooooongFunction();"); 2233 2234 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" 2235 " ->looooooooooooooooooooooooooooooooooooooongFunction();"); 2236 2237 verifyFormat( 2238 "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n" 2239 " Parameter2);"); 2240 2241 verifyFormat( 2242 "ShortObject->shortFunction(\n" 2243 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n" 2244 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);"); 2245 2246 verifyFormat("loooooooooooooongFunction(\n" 2247 " LoooooooooooooongObject->looooooooooooooooongFunction());"); 2248 2249 verifyFormat( 2250 "function(LoooooooooooooooooooooooooooooooooooongObject\n" 2251 " ->loooooooooooooooooooooooooooooooooooooooongFunction());"); 2252 2253 verifyFormat("EXPECT_CALL(SomeObject, SomeFunction(Parameter))\n" 2254 " .WillRepeatedly(Return(SomeValue));"); 2255 verifyFormat("SomeMap[std::pair(aaaaaaaaaaaa, bbbbbbbbbbbbbbb)]\n" 2256 " .insert(ccccccccccccccccccccccc);"); 2257 verifyFormat( 2258 "aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2259 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" 2260 " .aaaaaaaaaaaaaaa(\n" 2261 " aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2262 " aaaaaaaaaaaaaaaaaaaaaaaaaaa));"); 2263 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2264 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2265 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2266 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()) {\n" 2267 "}"); 2268 2269 // Here, it is not necessary to wrap at "." or "->". 2270 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n" 2271 " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); 2272 verifyFormat( 2273 "aaaaaaaaaaa->aaaaaaaaa(\n" 2274 " aaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2275 " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n"); 2276 2277 verifyFormat( 2278 "aaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2279 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa().aaaaaaaaaaaaaaaaa());"); 2280 verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() *\n" 2281 " aaaaaaaaa()->aaaaaa()->aaaaa());"); 2282 verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() ||\n" 2283 " aaaaaaaaa()->aaaaaa()->aaaaa());"); 2284 2285 // FIXME: Should we break before .a()? 2286 verifyFormat("aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2287 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).a();"); 2288 2289 FormatStyle NoBinPacking = getLLVMStyle(); 2290 NoBinPacking.BinPackParameters = false; 2291 verifyFormat("aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 2292 " .aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 2293 " .aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa,\n" 2294 " aaaaaaaaaaaaaaaaaaa,\n" 2295 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", 2296 NoBinPacking); 2297} 2298 2299TEST_F(FormatTest, WrapsTemplateDeclarations) { 2300 verifyFormat("template <typename T>\n" 2301 "virtual void loooooooooooongFunction(int Param1, int Param2);"); 2302 verifyFormat( 2303 "template <typename T>\n" 2304 "using comment_to_xml_conversion = comment_to_xml_conversion<T, int>;"); 2305 verifyFormat("template <typename T>\n" 2306 "void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n" 2307 " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);"); 2308 verifyFormat( 2309 "template <typename T>\n" 2310 "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n" 2311 " int Paaaaaaaaaaaaaaaaaaaaram2);"); 2312 verifyFormat( 2313 "template <typename T>\n" 2314 "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n" 2315 " aaaaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaaaaa,\n" 2316 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2317 verifyFormat("template <typename T>\n" 2318 "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2319 " int aaaaaaaaaaaaaaaaaaaaaa);"); 2320 verifyFormat( 2321 "template <typename T1, typename T2 = char, typename T3 = char,\n" 2322 " typename T4 = char>\n" 2323 "void f();"); 2324 verifyFormat( 2325 "aaaaaaaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa>(\n" 2326 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2327 2328 verifyFormat("a<aaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaa>(\n" 2329 " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));"); 2330} 2331 2332TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) { 2333 verifyFormat( 2334 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 2335 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 2336 verifyFormat( 2337 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 2338 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2339 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa());"); 2340 2341 // FIXME: Should we have an extra indent after the second break? 2342 verifyFormat( 2343 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 2344 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 2345 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 2346 2347 // FIXME: Look into whether we should indent 4 from the start or 4 from 2348 // "bbbbb..." here instead of what we are doing now. 2349 verifyFormat( 2350 "aaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb::\n" 2351 " cccccccccccccccccccccccccccccccccccccccccccccc());"); 2352 2353 // Breaking at nested name specifiers is generally not desirable. 2354 verifyFormat( 2355 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2356 " aaaaaaaaaaaaaaaaaaaaaaa);"); 2357 2358 verifyFormat( 2359 "aaaaaaaaaaaaaaaaaa(aaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 2360 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2361 " aaaaaaaaaaaaaaaaaaaaa);", 2362 getLLVMStyleWithColumns(74)); 2363 2364 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" 2365 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 2366 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 2367} 2368 2369TEST_F(FormatTest, UnderstandsTemplateParameters) { 2370 verifyFormat("A<int> a;"); 2371 verifyFormat("A<A<A<int> > > a;"); 2372 verifyFormat("A<A<A<int, 2>, 3>, 4> a;"); 2373 verifyFormat("bool x = a < 1 || 2 > a;"); 2374 verifyFormat("bool x = 5 < f<int>();"); 2375 verifyFormat("bool x = f<int>() > 5;"); 2376 verifyFormat("bool x = 5 < a<int>::x;"); 2377 verifyFormat("bool x = a < 4 ? a > 2 : false;"); 2378 verifyFormat("bool x = f() ? a < 2 : a > 2;"); 2379 2380 verifyGoogleFormat("A<A<int>> a;"); 2381 verifyGoogleFormat("A<A<A<int>>> a;"); 2382 verifyGoogleFormat("A<A<A<A<int>>>> a;"); 2383 verifyGoogleFormat("A<A<int> > a;"); 2384 verifyGoogleFormat("A<A<A<int> > > a;"); 2385 verifyGoogleFormat("A<A<A<A<int> > > > a;"); 2386 EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A> >> a;", getGoogleStyle())); 2387 EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A>> > a;", getGoogleStyle())); 2388 2389 verifyFormat("test >> a >> b;"); 2390 verifyFormat("test << a >> b;"); 2391 2392 verifyFormat("f<int>();"); 2393 verifyFormat("template <typename T> void f() {}"); 2394} 2395 2396TEST_F(FormatTest, UnderstandsBinaryOperators) { 2397 verifyFormat("COMPARE(a, ==, b);"); 2398} 2399 2400TEST_F(FormatTest, UnderstandsPointersToMembers) { 2401 verifyFormat("int A::*x;"); 2402 // FIXME: Recognize pointers to member functions. 2403 //verifyFormat("int (S::*func)(void *);"); 2404 verifyFormat("int(S::*func)(void *);"); 2405 verifyFormat("(a->*f)();"); 2406 verifyFormat("a->*x;"); 2407 verifyFormat("(a.*f)();"); 2408 verifyFormat("((*a).*f)();"); 2409 verifyFormat("a.*x;"); 2410} 2411 2412TEST_F(FormatTest, UnderstandsUnaryOperators) { 2413 verifyFormat("int a = -2;"); 2414 verifyFormat("f(-1, -2, -3);"); 2415 verifyFormat("a[-1] = 5;"); 2416 verifyFormat("int a = 5 + -2;"); 2417 verifyFormat("if (i == -1) {\n}"); 2418 verifyFormat("if (i != -1) {\n}"); 2419 verifyFormat("if (i > -1) {\n}"); 2420 verifyFormat("if (i < -1) {\n}"); 2421 verifyFormat("++(a->f());"); 2422 verifyFormat("--(a->f());"); 2423 verifyFormat("(a->f())++;"); 2424 verifyFormat("a[42]++;"); 2425 verifyFormat("if (!(a->f())) {\n}"); 2426 2427 verifyFormat("a-- > b;"); 2428 verifyFormat("b ? -a : c;"); 2429 verifyFormat("n * sizeof char16;"); 2430 verifyFormat("n * alignof char16;"); 2431 verifyFormat("sizeof(char);"); 2432 verifyFormat("alignof(char);"); 2433 2434 verifyFormat("return -1;"); 2435 verifyFormat("switch (a) {\n" 2436 "case -1:\n" 2437 " break;\n" 2438 "}"); 2439 verifyFormat("#define X -1"); 2440 verifyFormat("#define X -kConstant"); 2441 2442 verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { -5, +3 };"); 2443 verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { +5, -3 };"); 2444 2445 verifyFormat("int a = /* confusing comment */ -1;"); 2446 // FIXME: The space after 'i' is wrong, but hopefully, this is a rare case. 2447 verifyFormat("int a = i /* confusing comment */++;"); 2448} 2449 2450TEST_F(FormatTest, UndestandsOverloadedOperators) { 2451 verifyFormat("bool operator<();"); 2452 verifyFormat("bool operator>();"); 2453 verifyFormat("bool operator=();"); 2454 verifyFormat("bool operator==();"); 2455 verifyFormat("bool operator!=();"); 2456 verifyFormat("int operator+();"); 2457 verifyFormat("int operator++();"); 2458 verifyFormat("bool operator();"); 2459 verifyFormat("bool operator()();"); 2460 verifyFormat("bool operator[]();"); 2461 verifyFormat("operator bool();"); 2462 verifyFormat("operator int();"); 2463 verifyFormat("operator void *();"); 2464 verifyFormat("operator SomeType<int>();"); 2465 verifyFormat("operator SomeType<int, int>();"); 2466 verifyFormat("operator SomeType<SomeType<int> >();"); 2467 verifyFormat("void *operator new(std::size_t size);"); 2468 verifyFormat("void *operator new[](std::size_t size);"); 2469 verifyFormat("void operator delete(void *ptr);"); 2470 verifyFormat("void operator delete[](void *ptr);"); 2471 2472 verifyFormat( 2473 "ostream &operator<<(ostream &OutputStream,\n" 2474 " SomeReallyLongType WithSomeReallyLongValue);"); 2475 verifyFormat("bool operator<(const aaaaaaaaaaaaaaaaaaaaa &left,\n" 2476 " const aaaaaaaaaaaaaaaaaaaaa &right) {\n" 2477 " return left.group < right.group;\n" 2478 "}"); 2479 verifyFormat("SomeType &operator=(const SomeType &S);"); 2480 2481 verifyGoogleFormat("operator void*();"); 2482 verifyGoogleFormat("operator SomeType<SomeType<int>>();"); 2483} 2484 2485TEST_F(FormatTest, UnderstandsNewAndDelete) { 2486 verifyFormat("void f() {\n" 2487 " A *a = new A;\n" 2488 " A *a = new (placement) A;\n" 2489 " delete a;\n" 2490 " delete (A *)a;\n" 2491 "}"); 2492} 2493 2494TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) { 2495 verifyFormat("int *f(int *a) {}"); 2496 verifyFormat("int main(int argc, char **argv) {}"); 2497 verifyFormat("Test::Test(int b) : a(b * b) {}"); 2498 verifyIndependentOfContext("f(a, *a);"); 2499 verifyFormat("void g() { f(*a); }"); 2500 verifyIndependentOfContext("int a = b * 10;"); 2501 verifyIndependentOfContext("int a = 10 * b;"); 2502 verifyIndependentOfContext("int a = b * c;"); 2503 verifyIndependentOfContext("int a += b * c;"); 2504 verifyIndependentOfContext("int a -= b * c;"); 2505 verifyIndependentOfContext("int a *= b * c;"); 2506 verifyIndependentOfContext("int a /= b * c;"); 2507 verifyIndependentOfContext("int a = *b;"); 2508 verifyIndependentOfContext("int a = *b * c;"); 2509 verifyIndependentOfContext("int a = b * *c;"); 2510 verifyIndependentOfContext("return 10 * b;"); 2511 verifyIndependentOfContext("return *b * *c;"); 2512 verifyIndependentOfContext("return a & ~b;"); 2513 verifyIndependentOfContext("f(b ? *c : *d);"); 2514 verifyIndependentOfContext("int a = b ? *c : *d;"); 2515 verifyIndependentOfContext("*b = a;"); 2516 verifyIndependentOfContext("a * ~b;"); 2517 verifyIndependentOfContext("a * !b;"); 2518 verifyIndependentOfContext("a * +b;"); 2519 verifyIndependentOfContext("a * -b;"); 2520 verifyIndependentOfContext("a * ++b;"); 2521 verifyIndependentOfContext("a * --b;"); 2522 verifyIndependentOfContext("a[4] * b;"); 2523 verifyIndependentOfContext("a[a * a] = 1;"); 2524 verifyIndependentOfContext("f() * b;"); 2525 verifyIndependentOfContext("a * [self dostuff];"); 2526 verifyIndependentOfContext("int x = a * (a + b);"); 2527 verifyIndependentOfContext("(a *)(a + b);"); 2528 verifyIndependentOfContext("int *pa = (int *)&a;"); 2529 verifyIndependentOfContext("return sizeof(int **);"); 2530 verifyIndependentOfContext("return sizeof(int ******);"); 2531 verifyIndependentOfContext("return (int **&)a;"); 2532 verifyFormat("void f(Type (*parameter)[10]) {}"); 2533 verifyGoogleFormat("return sizeof(int**);"); 2534 verifyIndependentOfContext("Type **A = static_cast<Type **>(P);"); 2535 verifyGoogleFormat("Type** A = static_cast<Type**>(P);"); 2536 // FIXME: The newline is wrong. 2537 verifyFormat("auto a = [](int **&, int ***) {}\n;"); 2538 2539 verifyIndependentOfContext("InvalidRegions[*R] = 0;"); 2540 2541 verifyIndependentOfContext("A<int *> a;"); 2542 verifyIndependentOfContext("A<int **> a;"); 2543 verifyIndependentOfContext("A<int *, int *> a;"); 2544 verifyIndependentOfContext( 2545 "const char *const p = reinterpret_cast<const char *const>(q);"); 2546 verifyIndependentOfContext("A<int **, int **> a;"); 2547 verifyIndependentOfContext("void f(int *a = d * e, int *b = c * d);"); 2548 verifyFormat("for (char **a = b; *a; ++a) {\n}"); 2549 verifyFormat("for (; a && b;) {\n}"); 2550 2551 verifyFormat( 2552 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" 2553 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); 2554 2555 verifyGoogleFormat("int main(int argc, char** argv) {}"); 2556 verifyGoogleFormat("A<int*> a;"); 2557 verifyGoogleFormat("A<int**> a;"); 2558 verifyGoogleFormat("A<int*, int*> a;"); 2559 verifyGoogleFormat("A<int**, int**> a;"); 2560 verifyGoogleFormat("f(b ? *c : *d);"); 2561 verifyGoogleFormat("int a = b ? *c : *d;"); 2562 verifyGoogleFormat("Type* t = **x;"); 2563 verifyGoogleFormat("Type* t = *++*x;"); 2564 verifyGoogleFormat("*++*x;"); 2565 verifyGoogleFormat("Type* t = const_cast<T*>(&*x);"); 2566 verifyGoogleFormat("Type* t = x++ * y;"); 2567 verifyGoogleFormat( 2568 "const char* const p = reinterpret_cast<const char* const>(q);"); 2569 2570 verifyIndependentOfContext("a = *(x + y);"); 2571 verifyIndependentOfContext("a = &(x + y);"); 2572 verifyIndependentOfContext("*(x + y).call();"); 2573 verifyIndependentOfContext("&(x + y)->call();"); 2574 verifyFormat("void f() { &(*I).first; }"); 2575 2576 verifyIndependentOfContext("f(b * /* confusing comment */ ++c);"); 2577 verifyFormat( 2578 "int *MyValues = {\n" 2579 " *A, // Operator detection might be confused by the '{'\n" 2580 " *BB // Operator detection might be confused by previous comment\n" 2581 "};"); 2582 2583 verifyIndependentOfContext("if (int *a = &b)"); 2584 verifyIndependentOfContext("if (int &a = *b)"); 2585 verifyIndependentOfContext("if (a & b[i])"); 2586 verifyIndependentOfContext("if (a::b::c::d & b[i])"); 2587 verifyIndependentOfContext("if (*b[i])"); 2588 verifyIndependentOfContext("if (int *a = (&b))"); 2589 verifyIndependentOfContext("while (int *a = &b)"); 2590 verifyFormat("void f() {\n" 2591 " for (const int &v : Values) {\n" 2592 " }\n" 2593 "}"); 2594 verifyFormat("for (int i = a * a; i < 10; ++i) {\n}"); 2595 verifyFormat("for (int i = 0; i < a * a; ++i) {\n}"); 2596 2597 verifyIndependentOfContext("A = new SomeType *[Length];"); 2598 verifyIndependentOfContext("A = new SomeType *[Length]();"); 2599 verifyGoogleFormat("A = new SomeType* [Length]();"); 2600 verifyGoogleFormat("A = new SomeType* [Length];"); 2601} 2602 2603TEST_F(FormatTest, UnderstandsEllipsis) { 2604 verifyFormat("int printf(const char *fmt, ...);"); 2605 verifyFormat("template <class... Ts> void Foo(Ts... ts) { Foo(ts...); }"); 2606} 2607 2608TEST_F(FormatTest, AdaptivelyFormatsPointersAndReferences) { 2609 EXPECT_EQ("int *a;\n" 2610 "int *a;\n" 2611 "int *a;", 2612 format("int *a;\n" 2613 "int* a;\n" 2614 "int *a;", 2615 getGoogleStyle())); 2616 EXPECT_EQ("int* a;\n" 2617 "int* a;\n" 2618 "int* a;", 2619 format("int* a;\n" 2620 "int* a;\n" 2621 "int *a;", 2622 getGoogleStyle())); 2623 EXPECT_EQ("int *a;\n" 2624 "int *a;\n" 2625 "int *a;", 2626 format("int *a;\n" 2627 "int * a;\n" 2628 "int * a;", 2629 getGoogleStyle())); 2630} 2631 2632TEST_F(FormatTest, UnderstandsRvalueReferences) { 2633 verifyFormat("int f(int &&a) {}"); 2634 verifyFormat("int f(int a, char &&b) {}"); 2635 verifyFormat("void f() { int &&a = b; }"); 2636 verifyGoogleFormat("int f(int a, char&& b) {}"); 2637 verifyGoogleFormat("void f() { int&& a = b; }"); 2638 2639 // FIXME: These require somewhat deeper changes in template arguments 2640 // formatting. 2641 // verifyIndependentOfContext("A<int &&> a;"); 2642 // verifyIndependentOfContext("A<int &&, int &&> a;"); 2643 // verifyGoogleFormat("A<int&&> a;"); 2644 // verifyGoogleFormat("A<int&&, int&&> a;"); 2645} 2646 2647TEST_F(FormatTest, FormatsBinaryOperatorsPrecedingEquals) { 2648 verifyFormat("void f() {\n" 2649 " x[aaaaaaaaa -\n" 2650 " b] = 23;\n" 2651 "}", 2652 getLLVMStyleWithColumns(15)); 2653} 2654 2655TEST_F(FormatTest, FormatsCasts) { 2656 verifyFormat("Type *A = static_cast<Type *>(P);"); 2657 verifyFormat("Type *A = (Type *)P;"); 2658 verifyFormat("Type *A = (vector<Type *, int *>)P;"); 2659 verifyFormat("int a = (int)(2.0f);"); 2660 2661 // FIXME: These also need to be identified. 2662 verifyFormat("int a = (int) 2.0f;"); 2663 verifyFormat("int a = (int) * b;"); 2664 2665 // These are not casts. 2666 verifyFormat("void f(int *) {}"); 2667 verifyFormat("f(foo)->b;"); 2668 verifyFormat("f(foo).b;"); 2669 verifyFormat("f(foo)(b);"); 2670 verifyFormat("f(foo)[b];"); 2671 verifyFormat("[](foo) { return 4; }(bar)];"); 2672 verifyFormat("(*funptr)(foo)[4];"); 2673 verifyFormat("funptrs[4](foo)[4];"); 2674 verifyFormat("void f(int *);"); 2675 verifyFormat("void f(int *) = 0;"); 2676 verifyFormat("void f(SmallVector<int>) {}"); 2677 verifyFormat("void f(SmallVector<int>);"); 2678 verifyFormat("void f(SmallVector<int>) = 0;"); 2679 verifyFormat("void f(int i = (kValue) * kMask) {}"); 2680 verifyFormat("void f(int i = (kA * kB) & kMask) {}"); 2681 verifyFormat("int a = sizeof(int) * b;"); 2682 verifyFormat("int a = alignof(int) * b;"); 2683 2684 // These are not casts, but at some point were confused with casts. 2685 verifyFormat("virtual void foo(int *) override;"); 2686 verifyFormat("virtual void foo(char &) const;"); 2687 verifyFormat("virtual void foo(int *a, char *) const;"); 2688 verifyFormat("int a = sizeof(int *) + b;"); 2689 verifyFormat("int a = alignof(int *) + b;"); 2690} 2691 2692TEST_F(FormatTest, FormatsFunctionTypes) { 2693 verifyFormat("A<bool()> a;"); 2694 verifyFormat("A<SomeType()> a;"); 2695 verifyFormat("A<void(*)(int, std::string)> a;"); 2696 verifyFormat("A<void *(int)>;"); 2697 verifyFormat("void *(*a)(int *, SomeType *);"); 2698 2699 // FIXME: Inconsistent. 2700 verifyFormat("int (*func)(void *);"); 2701 verifyFormat("void f() { int(*func)(void *); }"); 2702 2703 verifyGoogleFormat("A<void*(int*, SomeType*)>;"); 2704 verifyGoogleFormat("void* (*a)(int);"); 2705} 2706 2707TEST_F(FormatTest, BreaksLongDeclarations) { 2708 verifyFormat("typedef LoooooooooooooooooooooooooooooooooooooooongType\n" 2709 " AnotherNameForTheLongType;"); 2710 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType\n" 2711 " LoooooooooooooooooooooooooooooooooooooooongVariable;"); 2712 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" 2713 " LoooooooooooooooooooooooooooooooongFunctionDeclaration();"); 2714 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" 2715 "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); 2716 2717 // FIXME: Without the comment, this breaks after "(". 2718 verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType // break\n" 2719 " (*LoooooooooooooooooooooooooooongFunctionTypeVarialbe)();"); 2720 2721 verifyFormat("int *someFunction(int LoooooooooooooooooooongParam1,\n" 2722 " int LoooooooooooooooooooongParam2) {}"); 2723 verifyFormat( 2724 "TypeSpecDecl *TypeSpecDecl::Create(ASTContext &C, DeclContext *DC,\n" 2725 " SourceLocation L, IdentifierIn *II,\n" 2726 " Type *T) {}"); 2727 verifyFormat("ReallyLongReturnType<TemplateParam1, TemplateParam2>\n" 2728 "ReallyReallyLongFunctionName(\n" 2729 " const std::string &SomeParameter,\n" 2730 " const SomeType<string, SomeOtherTemplateParameter> &\n" 2731 " ReallyReallyLongParameterName,\n" 2732 " const SomeType<string, SomeOtherTemplateParameter> &\n" 2733 " AnotherLongParameterName) {}"); 2734 verifyFormat( 2735 "aaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaa<aaaaaaaaaaaaa, aaaaaaaaaaaa>\n" 2736 " aaaaaaaaaaaaaaaaaaaaaaa;"); 2737 2738 verifyGoogleFormat( 2739 "TypeSpecDecl* TypeSpecDecl::Create(ASTContext& C, DeclContext* DC,\n" 2740 " SourceLocation L) {}"); 2741 verifyGoogleFormat( 2742 "some_namespace::LongReturnType\n" 2743 "long_namespace::SomeVeryLongClass::SomeVeryLongFunction(\n" 2744 " int first_long_parameter, int second_parameter) {}"); 2745 2746 verifyGoogleFormat("template <typename T>\n" 2747 "aaaaaaaa::aaaaa::aaaaaa<T, aaaaaaaaaaaaaaaaaaaaaaaaa>\n" 2748 "aaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaa() {}"); 2749 verifyGoogleFormat("A<A<A>> aaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" 2750 " int aaaaaaaaaaaaaaaaaaaaaaa);"); 2751} 2752 2753TEST_F(FormatTest, LineStartsWithSpecialCharacter) { 2754 verifyFormat("(a)->b();"); 2755 verifyFormat("--a;"); 2756} 2757 2758TEST_F(FormatTest, HandlesIncludeDirectives) { 2759 verifyFormat("#include <string>\n" 2760 "#include <a/b/c.h>\n" 2761 "#include \"a/b/string\"\n" 2762 "#include \"string.h\"\n" 2763 "#include \"string.h\"\n" 2764 "#include <a-a>\n" 2765 "#include < path with space >\n" 2766 "#include \"abc.h\" // this is included for ABC\n" 2767 "#include \"some very long include paaaaaaaaaaaaaaaaaaaaaaath\"", 2768 getLLVMStyleWithColumns(35)); 2769 2770 verifyFormat("#import <string>"); 2771 verifyFormat("#import <a/b/c.h>"); 2772 verifyFormat("#import \"a/b/string\""); 2773 verifyFormat("#import \"string.h\""); 2774 verifyFormat("#import \"string.h\""); 2775} 2776 2777//===----------------------------------------------------------------------===// 2778// Error recovery tests. 2779//===----------------------------------------------------------------------===// 2780 2781TEST_F(FormatTest, IncompleteParameterLists) { 2782 FormatStyle NoBinPacking = getLLVMStyle(); 2783 NoBinPacking.BinPackParameters = false; 2784 verifyFormat("void aaaaaaaaaaaaaaaaaa(int level,\n" 2785 " double *min_x,\n" 2786 " double *max_x,\n" 2787 " double *min_y,\n" 2788 " double *max_y,\n" 2789 " double *min_z,\n" 2790 " double *max_z, ) {}", 2791 NoBinPacking); 2792} 2793 2794TEST_F(FormatTest, IncorrectCodeTrailingStuff) { 2795 verifyFormat("void f() { return; }\n42"); 2796 verifyFormat("void f() {\n" 2797 " if (0)\n" 2798 " return;\n" 2799 "}\n" 2800 "42"); 2801 verifyFormat("void f() { return }\n42"); 2802 verifyFormat("void f() {\n" 2803 " if (0)\n" 2804 " return\n" 2805 "}\n" 2806 "42"); 2807} 2808 2809TEST_F(FormatTest, IncorrectCodeMissingSemicolon) { 2810 EXPECT_EQ("void f() { return }", format("void f ( ) { return }")); 2811 EXPECT_EQ("void f() {\n" 2812 " if (a)\n" 2813 " return\n" 2814 "}", 2815 format("void f ( ) { if ( a ) return }")); 2816 EXPECT_EQ("namespace N { void f() }", format("namespace N { void f() }")); 2817 EXPECT_EQ("namespace N {\n" 2818 "void f() {}\n" 2819 "void g()\n" 2820 "}", 2821 format("namespace N { void f( ) { } void g( ) }")); 2822} 2823 2824TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) { 2825 verifyFormat("int aaaaaaaa =\n" 2826 " // Overlylongcomment\n" 2827 " b;", 2828 getLLVMStyleWithColumns(20)); 2829 verifyFormat("function(\n" 2830 " ShortArgument,\n" 2831 " LoooooooooooongArgument);\n", 2832 getLLVMStyleWithColumns(20)); 2833} 2834 2835TEST_F(FormatTest, IncorrectAccessSpecifier) { 2836 verifyFormat("public:"); 2837 verifyFormat("class A {\n" 2838 "public\n" 2839 " void f() {}\n" 2840 "};"); 2841 verifyFormat("public\n" 2842 "int qwerty;"); 2843 verifyFormat("public\n" 2844 "B {}"); 2845 verifyFormat("public\n" 2846 "{}"); 2847 verifyFormat("public\n" 2848 "B { int x; }"); 2849} 2850 2851TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) { 2852 verifyFormat("{"); 2853 verifyFormat("#})"); 2854} 2855 2856TEST_F(FormatTest, IncorrectCodeDoNoWhile) { 2857 verifyFormat("do {\n}"); 2858 verifyFormat("do {\n}\n" 2859 "f();"); 2860 verifyFormat("do {\n}\n" 2861 "wheeee(fun);"); 2862 verifyFormat("do {\n" 2863 " f();\n" 2864 "}"); 2865} 2866 2867TEST_F(FormatTest, IncorrectCodeMissingParens) { 2868 verifyFormat("if {\n foo;\n foo();\n}"); 2869 verifyFormat("switch {\n foo;\n foo();\n}"); 2870 verifyFormat("for {\n foo;\n foo();\n}"); 2871 verifyFormat("while {\n foo;\n foo();\n}"); 2872 verifyFormat("do {\n foo;\n foo();\n} while;"); 2873} 2874 2875TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) { 2876 verifyFormat("namespace {\n" 2877 "class Foo { Foo ( }; } // comment"); 2878} 2879 2880TEST_F(FormatTest, IncorrectCodeErrorDetection) { 2881 EXPECT_EQ("{\n{}\n", format("{\n{\n}\n")); 2882 EXPECT_EQ("{\n {}\n", format("{\n {\n}\n")); 2883 EXPECT_EQ("{\n {}\n", format("{\n {\n }\n")); 2884 EXPECT_EQ("{\n {}\n }\n}\n", format("{\n {\n }\n }\n}\n")); 2885 2886 EXPECT_EQ("{\n" 2887 " {\n" 2888 " breakme(\n" 2889 " qwe);\n" 2890 "}\n", 2891 format("{\n" 2892 " {\n" 2893 " breakme(qwe);\n" 2894 "}\n", 2895 getLLVMStyleWithColumns(10))); 2896} 2897 2898TEST_F(FormatTest, LayoutCallsInsideBraceInitializers) { 2899 verifyFormat("int x = {\n" 2900 " avariable,\n" 2901 " b(alongervariable)\n" 2902 "};", 2903 getLLVMStyleWithColumns(25)); 2904} 2905 2906TEST_F(FormatTest, LayoutBraceInitializersInReturnStatement) { 2907 verifyFormat("return (a)(b) { 1, 2, 3 };"); 2908} 2909 2910TEST_F(FormatTest, LayoutTokensFollowingBlockInParentheses) { 2911 // FIXME: This is bad, find a better and more generic solution. 2912 verifyFormat( 2913 "Aaa({\n" 2914 " int i;\n" 2915 "},\n" 2916 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" 2917 " ccccccccccccccccc));"); 2918} 2919 2920TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) { 2921 verifyFormat("void f() { return 42; }"); 2922 verifyFormat("void f() {\n" 2923 " // Comment\n" 2924 "}"); 2925 verifyFormat("{\n" 2926 "#error {\n" 2927 " int a;\n" 2928 "}"); 2929 verifyFormat("{\n" 2930 " int a;\n" 2931 "#error {\n" 2932 "}"); 2933 2934 verifyFormat("void f() { return 42; }", getLLVMStyleWithColumns(23)); 2935 verifyFormat("void f() {\n return 42;\n}", getLLVMStyleWithColumns(22)); 2936 2937 verifyFormat("void f() {}", getLLVMStyleWithColumns(11)); 2938 verifyFormat("void f() {\n}", getLLVMStyleWithColumns(10)); 2939} 2940 2941TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) { 2942 // Elaborate type variable declarations. 2943 verifyFormat("struct foo a = { bar };\nint n;"); 2944 verifyFormat("class foo a = { bar };\nint n;"); 2945 verifyFormat("union foo a = { bar };\nint n;"); 2946 2947 // Elaborate types inside function definitions. 2948 verifyFormat("struct foo f() {}\nint n;"); 2949 verifyFormat("class foo f() {}\nint n;"); 2950 verifyFormat("union foo f() {}\nint n;"); 2951 2952 // Templates. 2953 verifyFormat("template <class X> void f() {}\nint n;"); 2954 verifyFormat("template <struct X> void f() {}\nint n;"); 2955 verifyFormat("template <union X> void f() {}\nint n;"); 2956 2957 // Actual definitions... 2958 verifyFormat("struct {\n} n;"); 2959 verifyFormat( 2960 "template <template <class T, class Y>, class Z> class X {\n} n;"); 2961 verifyFormat("union Z {\n int n;\n} x;"); 2962 verifyFormat("class MACRO Z {\n} n;"); 2963 verifyFormat("class MACRO(X) Z {\n} n;"); 2964 verifyFormat("class __attribute__(X) Z {\n} n;"); 2965 verifyFormat("class __declspec(X) Z {\n} n;"); 2966 verifyFormat("class A##B##C {\n} n;"); 2967 2968 // Redefinition from nested context: 2969 verifyFormat("class A::B::C {\n} n;"); 2970 2971 // Template definitions. 2972 // FIXME: This is still incorrectly handled at the formatter side. 2973 verifyFormat("template <> struct X < 15, i < 3 && 42 < 50 && 33<28> {\n};"); 2974 2975 // FIXME: 2976 // This now gets parsed incorrectly as class definition. 2977 // verifyFormat("class A<int> f() {\n}\nint n;"); 2978 2979 // Elaborate types where incorrectly parsing the structural element would 2980 // break the indent. 2981 verifyFormat("if (true)\n" 2982 " class X x;\n" 2983 "else\n" 2984 " f();\n"); 2985 2986 // This is simply incomplete. Formatting is not important, but must not crash. 2987 verifyFormat("class A:"); 2988} 2989 2990TEST_F(FormatTest, DoNotInterfereWithErrorAndWarning) { 2991 verifyFormat("#error Leave all white!!!!! space* alone!\n"); 2992 verifyFormat("#warning Leave all white!!!!! space* alone!\n"); 2993 EXPECT_EQ("#error 1", format(" # error 1")); 2994 EXPECT_EQ("#warning 1", format(" # warning 1")); 2995} 2996 2997TEST_F(FormatTest, FormatHashIfExpressions) { 2998 // FIXME: Come up with a better indentation for #elif. 2999 verifyFormat( 3000 "#if !defined(AAAAAAA) && (defined CCCCCC || defined DDDDDD) && \\\n" 3001 " defined(BBBBBBBB)\n" 3002 "#elif !defined(AAAAAA) && (defined CCCCC || defined DDDDDD) && \\\n" 3003 " defined(BBBBBBBB)\n" 3004 "#endif", 3005 getLLVMStyleWithColumns(65)); 3006} 3007 3008TEST_F(FormatTest, MergeHandlingInTheFaceOfPreprocessorDirectives) { 3009 FormatStyle AllowsMergedIf = getGoogleStyle(); 3010 AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; 3011 verifyFormat("void f() { f(); }\n#error E", AllowsMergedIf); 3012 verifyFormat("if (true) return 42;\n#error E", AllowsMergedIf); 3013 verifyFormat("if (true)\n#error E\n return 42;", AllowsMergedIf); 3014 EXPECT_EQ("if (true) return 42;", 3015 format("if (true)\nreturn 42;", AllowsMergedIf)); 3016 FormatStyle ShortMergedIf = AllowsMergedIf; 3017 ShortMergedIf.ColumnLimit = 25; 3018 verifyFormat("#define A \\\n" 3019 " if (true) return 42;", 3020 ShortMergedIf); 3021 verifyFormat("#define A \\\n" 3022 " f(); \\\n" 3023 " if (true)\n" 3024 "#define B", 3025 ShortMergedIf); 3026 verifyFormat("#define A \\\n" 3027 " f(); \\\n" 3028 " if (true)\n" 3029 "g();", 3030 ShortMergedIf); 3031 verifyFormat("{\n" 3032 "#ifdef A\n" 3033 " // Comment\n" 3034 " if (true) continue;\n" 3035 "#endif\n" 3036 " // Comment\n" 3037 " if (true) continue;", 3038 ShortMergedIf); 3039} 3040 3041TEST_F(FormatTest, BlockCommentsInControlLoops) { 3042 verifyFormat("if (0) /* a comment in a strange place */ {\n" 3043 " f();\n" 3044 "}"); 3045 verifyFormat("if (0) /* a comment in a strange place */ {\n" 3046 " f();\n" 3047 "} /* another comment */ else /* comment #3 */ {\n" 3048 " g();\n" 3049 "}"); 3050 verifyFormat("while (0) /* a comment in a strange place */ {\n" 3051 " f();\n" 3052 "}"); 3053 verifyFormat("for (;;) /* a comment in a strange place */ {\n" 3054 " f();\n" 3055 "}"); 3056 verifyFormat("do /* a comment in a strange place */ {\n" 3057 " f();\n" 3058 "} /* another comment */ while (0);"); 3059} 3060 3061TEST_F(FormatTest, BlockComments) { 3062 EXPECT_EQ("/* */ /* */ /* */\n/* */ /* */ /* */", 3063 format("/* *//* */ /* */\n/* *//* */ /* */")); 3064 EXPECT_EQ("/* */ a /* */ b;", format(" /* */ a/* */ b;")); 3065 EXPECT_EQ("#define A /*123*/\\\n" 3066 " b\n" 3067 "/* */\n" 3068 "someCall(\n" 3069 " parameter);", 3070 format("#define A /*123*/ b\n" 3071 "/* */\n" 3072 "someCall(parameter);", 3073 getLLVMStyleWithColumns(15))); 3074 3075 EXPECT_EQ("#define A\n" 3076 "/* */ someCall(\n" 3077 " parameter);", 3078 format("#define A\n" 3079 "/* */someCall(parameter);", 3080 getLLVMStyleWithColumns(15))); 3081 3082 FormatStyle NoBinPacking = getLLVMStyle(); 3083 NoBinPacking.BinPackParameters = false; 3084 EXPECT_EQ("someFunction(1, /* comment 1 */\n" 3085 " 2, /* comment 2 */\n" 3086 " 3, /* comment 3 */\n" 3087 " aaaa,\n" 3088 " bbbb);", 3089 format("someFunction (1, /* comment 1 */\n" 3090 " 2, /* comment 2 */ \n" 3091 " 3, /* comment 3 */\n" 3092 "aaaa, bbbb );", 3093 NoBinPacking)); 3094 verifyFormat( 3095 "bool aaaaaaaaaaaaa = /* comment: */ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 3096 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); 3097 EXPECT_EQ( 3098 "bool aaaaaaaaaaaaa = /* trailing comment */\n" 3099 " aaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 3100 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;", 3101 format( 3102 "bool aaaaaaaaaaaaa = /* trailing comment */\n" 3103 " aaaaaaaaaaaaaaaaaaaaaaaaaaa||aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" 3104 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;")); 3105 EXPECT_EQ( 3106 "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" 3107 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" 3108 "int cccccccccccccccccccccccccccccc; /* comment */\n", 3109 format("int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" 3110 "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" 3111 "int cccccccccccccccccccccccccccccc; /* comment */\n")); 3112} 3113 3114TEST_F(FormatTest, BlockCommentsInMacros) { 3115 EXPECT_EQ("#define A \\\n" 3116 " { \\\n" 3117 " /* one line */ \\\n" 3118 " someCall();", 3119 format("#define A { \\\n" 3120 " /* one line */ \\\n" 3121 " someCall();", 3122 getLLVMStyleWithColumns(20))); 3123 EXPECT_EQ("#define A \\\n" 3124 " { \\\n" 3125 " /* previous */ \\\n" 3126 " /* one line */ \\\n" 3127 " someCall();", 3128 format("#define A { \\\n" 3129 " /* previous */ \\\n" 3130 " /* one line */ \\\n" 3131 " someCall();", 3132 getLLVMStyleWithColumns(20))); 3133} 3134 3135TEST_F(FormatTest, IndentLineCommentsInStartOfBlockAtEndOfFile) { 3136 // FIXME: This is not what we want... 3137 verifyFormat("{\n" 3138 "// a" 3139 "// b"); 3140} 3141 3142TEST_F(FormatTest, FormatStarDependingOnContext) { 3143 verifyFormat("void f(int *a);"); 3144 verifyFormat("void f() { f(fint * b); }"); 3145 verifyFormat("class A {\n void f(int *a);\n};"); 3146 verifyFormat("class A {\n int *a;\n};"); 3147 verifyFormat("namespace a {\n" 3148 "namespace b {\n" 3149 "class A {\n" 3150 " void f() {}\n" 3151 " int *a;\n" 3152 "};\n" 3153 "}\n" 3154 "}"); 3155} 3156 3157TEST_F(FormatTest, SpecialTokensAtEndOfLine) { 3158 verifyFormat("while"); 3159 verifyFormat("operator"); 3160} 3161 3162//===----------------------------------------------------------------------===// 3163// Objective-C tests. 3164//===----------------------------------------------------------------------===// 3165 3166TEST_F(FormatTest, FormatForObjectiveCMethodDecls) { 3167 verifyFormat("- (void)sendAction:(SEL)aSelector to:(BOOL)anObject;"); 3168 EXPECT_EQ("- (NSUInteger)indexOfObject:(id)anObject;", 3169 format("-(NSUInteger)indexOfObject:(id)anObject;")); 3170 EXPECT_EQ("- (NSInteger)Mthod1;", format("-(NSInteger)Mthod1;")); 3171 EXPECT_EQ("+ (id)Mthod2;", format("+(id)Mthod2;")); 3172 EXPECT_EQ("- (NSInteger)Method3:(id)anObject;", 3173 format("-(NSInteger)Method3:(id)anObject;")); 3174 EXPECT_EQ("- (NSInteger)Method4:(id)anObject;", 3175 format("-(NSInteger)Method4:(id)anObject;")); 3176 EXPECT_EQ("- (NSInteger)Method5:(id)anObject:(id)AnotherObject;", 3177 format("-(NSInteger)Method5:(id)anObject:(id)AnotherObject;")); 3178 EXPECT_EQ("- (id)Method6:(id)A:(id)B:(id)C:(id)D;", 3179 format("- (id)Method6:(id)A:(id)B:(id)C:(id)D;")); 3180 EXPECT_EQ( 3181 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;", 3182 format( 3183 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;")); 3184 3185 // Very long objectiveC method declaration. 3186 verifyFormat("- (NSUInteger)indexOfObject:(id)anObject\n" 3187 " inRange:(NSRange)range\n" 3188 " outRange:(NSRange)out_range\n" 3189 " outRange1:(NSRange)out_range1\n" 3190 " outRange2:(NSRange)out_range2\n" 3191 " outRange3:(NSRange)out_range3\n" 3192 " outRange4:(NSRange)out_range4\n" 3193 " outRange5:(NSRange)out_range5\n" 3194 " outRange6:(NSRange)out_range6\n" 3195 " outRange7:(NSRange)out_range7\n" 3196 " outRange8:(NSRange)out_range8\n" 3197 " outRange9:(NSRange)out_range9;"); 3198 3199 verifyFormat("- (int)sum:(vector<int>)numbers;"); 3200 verifyGoogleFormat("- (void)setDelegate:(id<Protocol>)delegate;"); 3201 // FIXME: In LLVM style, there should be a space in front of a '<' for ObjC 3202 // protocol lists (but not for template classes): 3203 //verifyFormat("- (void)setDelegate:(id <Protocol>)delegate;"); 3204 3205 verifyFormat("- (int(*)())foo:(int(*)())f;"); 3206 verifyGoogleFormat("- (int(*)())foo:(int(*)())foo;"); 3207 3208 // If there's no return type (very rare in practice!), LLVM and Google style 3209 // agree. 3210 verifyFormat("- foo;"); 3211 verifyFormat("- foo:(int)f;"); 3212 verifyGoogleFormat("- foo:(int)foo;"); 3213} 3214 3215TEST_F(FormatTest, FormatObjCBlocks) { 3216 verifyFormat("int (^Block)(int, int);"); 3217 verifyFormat("int (^Block1)(int, int) = ^(int i, int j)"); 3218} 3219 3220TEST_F(FormatTest, FormatObjCInterface) { 3221 verifyFormat("@interface Foo : NSObject <NSSomeDelegate> {\n" 3222 "@public\n" 3223 " int field1;\n" 3224 "@protected\n" 3225 " int field2;\n" 3226 "@private\n" 3227 " int field3;\n" 3228 "@package\n" 3229 " int field4;\n" 3230 "}\n" 3231 "+ (id)init;\n" 3232 "@end"); 3233 3234 verifyGoogleFormat("@interface Foo : NSObject<NSSomeDelegate> {\n" 3235 " @public\n" 3236 " int field1;\n" 3237 " @protected\n" 3238 " int field2;\n" 3239 " @private\n" 3240 " int field3;\n" 3241 " @package\n" 3242 " int field4;\n" 3243 "}\n" 3244 "+ (id)init;\n" 3245 "@end"); 3246 3247 verifyFormat("@interface /* wait for it */ Foo\n" 3248 "+ (id)init;\n" 3249 "// Look, a comment!\n" 3250 "- (int)answerWith:(int)i;\n" 3251 "@end"); 3252 3253 verifyFormat("@interface Foo\n" 3254 "@end\n" 3255 "@interface Bar\n" 3256 "@end"); 3257 3258 verifyFormat("@interface Foo : Bar\n" 3259 "+ (id)init;\n" 3260 "@end"); 3261 3262 verifyFormat("@interface Foo : /**/ Bar /**/ <Baz, /**/ Quux>\n" 3263 "+ (id)init;\n" 3264 "@end"); 3265 3266 verifyGoogleFormat("@interface Foo : Bar<Baz, Quux>\n" 3267 "+ (id)init;\n" 3268 "@end"); 3269 3270 verifyFormat("@interface Foo (HackStuff)\n" 3271 "+ (id)init;\n" 3272 "@end"); 3273 3274 verifyFormat("@interface Foo ()\n" 3275 "+ (id)init;\n" 3276 "@end"); 3277 3278 verifyFormat("@interface Foo (HackStuff) <MyProtocol>\n" 3279 "+ (id)init;\n" 3280 "@end"); 3281 3282 verifyGoogleFormat("@interface Foo (HackStuff)<MyProtocol>\n" 3283 "+ (id)init;\n" 3284 "@end"); 3285 3286 verifyFormat("@interface Foo {\n" 3287 " int _i;\n" 3288 "}\n" 3289 "+ (id)init;\n" 3290 "@end"); 3291 3292 verifyFormat("@interface Foo : Bar {\n" 3293 " int _i;\n" 3294 "}\n" 3295 "+ (id)init;\n" 3296 "@end"); 3297 3298 verifyFormat("@interface Foo : Bar <Baz, Quux> {\n" 3299 " int _i;\n" 3300 "}\n" 3301 "+ (id)init;\n" 3302 "@end"); 3303 3304 verifyFormat("@interface Foo (HackStuff) {\n" 3305 " int _i;\n" 3306 "}\n" 3307 "+ (id)init;\n" 3308 "@end"); 3309 3310 verifyFormat("@interface Foo () {\n" 3311 " int _i;\n" 3312 "}\n" 3313 "+ (id)init;\n" 3314 "@end"); 3315 3316 verifyFormat("@interface Foo (HackStuff) <MyProtocol> {\n" 3317 " int _i;\n" 3318 "}\n" 3319 "+ (id)init;\n" 3320 "@end"); 3321} 3322 3323TEST_F(FormatTest, FormatObjCImplementation) { 3324 verifyFormat("@implementation Foo : NSObject {\n" 3325 "@public\n" 3326 " int field1;\n" 3327 "@protected\n" 3328 " int field2;\n" 3329 "@private\n" 3330 " int field3;\n" 3331 "@package\n" 3332 " int field4;\n" 3333 "}\n" 3334 "+ (id)init {\n}\n" 3335 "@end"); 3336 3337 verifyGoogleFormat("@implementation Foo : NSObject {\n" 3338 " @public\n" 3339 " int field1;\n" 3340 " @protected\n" 3341 " int field2;\n" 3342 " @private\n" 3343 " int field3;\n" 3344 " @package\n" 3345 " int field4;\n" 3346 "}\n" 3347 "+ (id)init {\n}\n" 3348 "@end"); 3349 3350 verifyFormat("@implementation Foo\n" 3351 "+ (id)init {\n" 3352 " if (true)\n" 3353 " return nil;\n" 3354 "}\n" 3355 "// Look, a comment!\n" 3356 "- (int)answerWith:(int)i {\n" 3357 " return i;\n" 3358 "}\n" 3359 "+ (int)answerWith:(int)i {\n" 3360 " return i;\n" 3361 "}\n" 3362 "@end"); 3363 3364 verifyFormat("@implementation Foo\n" 3365 "@end\n" 3366 "@implementation Bar\n" 3367 "@end"); 3368 3369 verifyFormat("@implementation Foo : Bar\n" 3370 "+ (id)init {\n}\n" 3371 "- (void)foo {\n}\n" 3372 "@end"); 3373 3374 verifyFormat("@implementation Foo {\n" 3375 " int _i;\n" 3376 "}\n" 3377 "+ (id)init {\n}\n" 3378 "@end"); 3379 3380 verifyFormat("@implementation Foo : Bar {\n" 3381 " int _i;\n" 3382 "}\n" 3383 "+ (id)init {\n}\n" 3384 "@end"); 3385 3386 verifyFormat("@implementation Foo (HackStuff)\n" 3387 "+ (id)init {\n}\n" 3388 "@end"); 3389} 3390 3391TEST_F(FormatTest, FormatObjCProtocol) { 3392 verifyFormat("@protocol Foo\n" 3393 "@property(weak) id delegate;\n" 3394 "- (NSUInteger)numberOfThings;\n" 3395 "@end"); 3396 3397 verifyFormat("@protocol MyProtocol <NSObject>\n" 3398 "- (NSUInteger)numberOfThings;\n" 3399 "@end"); 3400 3401 verifyGoogleFormat("@protocol MyProtocol<NSObject>\n" 3402 "- (NSUInteger)numberOfThings;\n" 3403 "@end"); 3404 3405 verifyFormat("@protocol Foo;\n" 3406 "@protocol Bar;\n"); 3407 3408 verifyFormat("@protocol Foo\n" 3409 "@end\n" 3410 "@protocol Bar\n" 3411 "@end"); 3412 3413 verifyFormat("@protocol myProtocol\n" 3414 "- (void)mandatoryWithInt:(int)i;\n" 3415 "@optional\n" 3416 "- (void)optional;\n" 3417 "@required\n" 3418 "- (void)required;\n" 3419 "@optional\n" 3420 "@property(assign) int madProp;\n" 3421 "@end\n"); 3422} 3423 3424TEST_F(FormatTest, FormatObjCMethodDeclarations) { 3425 verifyFormat("- (void)doSomethingWith:(GTMFoo *)theFoo\n" 3426 " rect:(NSRect)theRect\n" 3427 " interval:(float)theInterval {\n" 3428 "}"); 3429 verifyFormat("- (void)shortf:(GTMFoo *)theFoo\n" 3430 " longKeyword:(NSRect)theRect\n" 3431 " evenLongerKeyword:(float)theInterval\n" 3432 " error:(NSError **)theError {\n" 3433 "}"); 3434} 3435 3436TEST_F(FormatTest, FormatObjCMethodExpr) { 3437 verifyFormat("[foo bar:baz];"); 3438 verifyFormat("return [foo bar:baz];"); 3439 verifyFormat("f([foo bar:baz]);"); 3440 verifyFormat("f(2, [foo bar:baz]);"); 3441 verifyFormat("f(2, a ? b : c);"); 3442 verifyFormat("[[self initWithInt:4] bar:[baz quux:arrrr]];"); 3443 3444 // Unary operators. 3445 verifyFormat("int a = +[foo bar:baz];"); 3446 verifyFormat("int a = -[foo bar:baz];"); 3447 verifyFormat("int a = ![foo bar:baz];"); 3448 verifyFormat("int a = ~[foo bar:baz];"); 3449 verifyFormat("int a = ++[foo bar:baz];"); 3450 verifyFormat("int a = --[foo bar:baz];"); 3451 verifyFormat("int a = sizeof [foo bar:baz];"); 3452 verifyFormat("int a = alignof [foo bar:baz];"); 3453 verifyFormat("int a = &[foo bar:baz];"); 3454 verifyFormat("int a = *[foo bar:baz];"); 3455 // FIXME: Make casts work, without breaking f()[4]. 3456 //verifyFormat("int a = (int)[foo bar:baz];"); 3457 //verifyFormat("return (int)[foo bar:baz];"); 3458 //verifyFormat("(void)[foo bar:baz];"); 3459 verifyFormat("return (MyType *)[self.tableView cellForRowAtIndexPath:cell];"); 3460 3461 // Binary operators. 3462 verifyFormat("[foo bar:baz], [foo bar:baz];"); 3463 verifyFormat("[foo bar:baz] = [foo bar:baz];"); 3464 verifyFormat("[foo bar:baz] *= [foo bar:baz];"); 3465 verifyFormat("[foo bar:baz] /= [foo bar:baz];"); 3466 verifyFormat("[foo bar:baz] %= [foo bar:baz];"); 3467 verifyFormat("[foo bar:baz] += [foo bar:baz];"); 3468 verifyFormat("[foo bar:baz] -= [foo bar:baz];"); 3469 verifyFormat("[foo bar:baz] <<= [foo bar:baz];"); 3470 verifyFormat("[foo bar:baz] >>= [foo bar:baz];"); 3471 verifyFormat("[foo bar:baz] &= [foo bar:baz];"); 3472 verifyFormat("[foo bar:baz] ^= [foo bar:baz];"); 3473 verifyFormat("[foo bar:baz] |= [foo bar:baz];"); 3474 verifyFormat("[foo bar:baz] ? [foo bar:baz] : [foo bar:baz];"); 3475 verifyFormat("[foo bar:baz] || [foo bar:baz];"); 3476 verifyFormat("[foo bar:baz] && [foo bar:baz];"); 3477 verifyFormat("[foo bar:baz] | [foo bar:baz];"); 3478 verifyFormat("[foo bar:baz] ^ [foo bar:baz];"); 3479 verifyFormat("[foo bar:baz] & [foo bar:baz];"); 3480 verifyFormat("[foo bar:baz] == [foo bar:baz];"); 3481 verifyFormat("[foo bar:baz] != [foo bar:baz];"); 3482 verifyFormat("[foo bar:baz] >= [foo bar:baz];"); 3483 verifyFormat("[foo bar:baz] <= [foo bar:baz];"); 3484 verifyFormat("[foo bar:baz] > [foo bar:baz];"); 3485 verifyFormat("[foo bar:baz] < [foo bar:baz];"); 3486 verifyFormat("[foo bar:baz] >> [foo bar:baz];"); 3487 verifyFormat("[foo bar:baz] << [foo bar:baz];"); 3488 verifyFormat("[foo bar:baz] - [foo bar:baz];"); 3489 verifyFormat("[foo bar:baz] + [foo bar:baz];"); 3490 verifyFormat("[foo bar:baz] * [foo bar:baz];"); 3491 verifyFormat("[foo bar:baz] / [foo bar:baz];"); 3492 verifyFormat("[foo bar:baz] % [foo bar:baz];"); 3493 // Whew! 3494 3495 verifyFormat("return in[42];"); 3496 verifyFormat("for (id foo in [self getStuffFor:bla]) {\n" 3497 "}"); 3498 3499 verifyFormat("[self stuffWithInt:(4 + 2) float:4.5];"); 3500 verifyFormat("[self stuffWithInt:a ? b : c float:4.5];"); 3501 verifyFormat("[self stuffWithInt:a ? [self foo:bar] : c];"); 3502 verifyFormat("[self stuffWithInt:a ? (e ? f : g) : c];"); 3503 verifyFormat("[cond ? obj1 : obj2 methodWithParam:param]"); 3504 verifyFormat("[button setAction:@selector(zoomOut:)];"); 3505 verifyFormat("[color getRed:&r green:&g blue:&b alpha:&a];"); 3506 3507 verifyFormat("arr[[self indexForFoo:a]];"); 3508 verifyFormat("throw [self errorFor:a];"); 3509 verifyFormat("@throw [self errorFor:a];"); 3510 3511 // This tests that the formatter doesn't break after "backing" but before ":", 3512 // which would be at 80 columns. 3513 verifyFormat( 3514 "void f() {\n" 3515 " if ((self = [super initWithContentRect:contentRect\n" 3516 " styleMask:styleMask\n" 3517 " backing:NSBackingStoreBuffered\n" 3518 " defer:YES]))"); 3519 3520 verifyFormat( 3521 "[foo checkThatBreakingAfterColonWorksOk:\n" 3522 " [bar ifItDoes:reduceOverallLineLengthLikeInThisCase]];"); 3523 3524 verifyFormat("[myObj short:arg1 // Force line break\n" 3525 " longKeyword:arg2\n" 3526 " evenLongerKeyword:arg3\n" 3527 " error:arg4];"); 3528 verifyFormat( 3529 "void f() {\n" 3530 " popup_window_.reset([[RenderWidgetPopupWindow alloc]\n" 3531 " initWithContentRect:NSMakeRect(origin_global.x, origin_global.y,\n" 3532 " pos.width(), pos.height())\n" 3533 " styleMask:NSBorderlessWindowMask\n" 3534 " backing:NSBackingStoreBuffered\n" 3535 " defer:NO]);\n" 3536 "}"); 3537 verifyFormat("[contentsContainer replaceSubview:[subviews objectAtIndex:0]\n" 3538 " with:contentsNativeView];"); 3539 3540 verifyFormat( 3541 "[pboard addTypes:[NSArray arrayWithObject:kBookmarkButtonDragType]\n" 3542 " owner:nillllll];"); 3543 3544 verifyFormat( 3545 "[pboard setData:[NSData dataWithBytes:&button length:sizeof(button)]\n" 3546 " forType:kBookmarkButtonDragType];"); 3547 3548 verifyFormat("[defaultCenter addObserver:self\n" 3549 " selector:@selector(willEnterFullscreen)\n" 3550 " name:kWillEnterFullscreenNotification\n" 3551 " object:nil];"); 3552 verifyFormat("[image_rep drawInRect:drawRect\n" 3553 " fromRect:NSZeroRect\n" 3554 " operation:NSCompositeCopy\n" 3555 " fraction:1.0\n" 3556 " respectFlipped:NO\n" 3557 " hints:nil];"); 3558 3559 verifyFormat( 3560 "scoped_nsobject<NSTextField> message(\n" 3561 " // The frame will be fixed up when |-setMessageText:| is called.\n" 3562 " [[NSTextField alloc] initWithFrame:NSMakeRect(0, 0, 0, 0)]);"); 3563} 3564 3565TEST_F(FormatTest, ObjCAt) { 3566 verifyFormat("@autoreleasepool"); 3567 verifyFormat("@catch"); 3568 verifyFormat("@class"); 3569 verifyFormat("@compatibility_alias"); 3570 verifyFormat("@defs"); 3571 verifyFormat("@dynamic"); 3572 verifyFormat("@encode"); 3573 verifyFormat("@end"); 3574 verifyFormat("@finally"); 3575 verifyFormat("@implementation"); 3576 verifyFormat("@import"); 3577 verifyFormat("@interface"); 3578 verifyFormat("@optional"); 3579 verifyFormat("@package"); 3580 verifyFormat("@private"); 3581 verifyFormat("@property"); 3582 verifyFormat("@protected"); 3583 verifyFormat("@protocol"); 3584 verifyFormat("@public"); 3585 verifyFormat("@required"); 3586 verifyFormat("@selector"); 3587 verifyFormat("@synchronized"); 3588 verifyFormat("@synthesize"); 3589 verifyFormat("@throw"); 3590 verifyFormat("@try"); 3591 3592 EXPECT_EQ("@interface", format("@ interface")); 3593 3594 // The precise formatting of this doesn't matter, nobody writes code like 3595 // this. 3596 verifyFormat("@ /*foo*/ interface"); 3597} 3598 3599TEST_F(FormatTest, ObjCSnippets) { 3600 verifyFormat("@autoreleasepool {\n" 3601 " foo();\n" 3602 "}"); 3603 verifyFormat("@class Foo, Bar;"); 3604 verifyFormat("@compatibility_alias AliasName ExistingClass;"); 3605 verifyFormat("@dynamic textColor;"); 3606 verifyFormat("char *buf1 = @encode(int *);"); 3607 verifyFormat("char *buf1 = @encode(typeof(4 * 5));"); 3608 verifyFormat("char *buf1 = @encode(int **);"); 3609 verifyFormat("Protocol *proto = @protocol(p1);"); 3610 verifyFormat("SEL s = @selector(foo:);"); 3611 verifyFormat("@synchronized(self) {\n" 3612 " f();\n" 3613 "}"); 3614 3615 verifyFormat("@synthesize dropArrowPosition = dropArrowPosition_;"); 3616 verifyGoogleFormat("@synthesize dropArrowPosition = dropArrowPosition_;"); 3617 3618 verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;"); 3619 verifyFormat("@property(assign, getter=isEditable) BOOL editable;"); 3620 verifyGoogleFormat("@property(assign, getter=isEditable) BOOL editable;"); 3621} 3622 3623TEST_F(FormatTest, ObjCLiterals) { 3624 verifyFormat("@\"String\""); 3625 verifyFormat("@1"); 3626 verifyFormat("@+4.8"); 3627 verifyFormat("@-4"); 3628 verifyFormat("@1LL"); 3629 verifyFormat("@.5"); 3630 verifyFormat("@'c'"); 3631 verifyFormat("@true"); 3632 3633 verifyFormat("NSNumber *smallestInt = @(-INT_MAX - 1);"); 3634 verifyFormat("NSNumber *piOverTwo = @(M_PI / 2);"); 3635 verifyFormat("NSNumber *favoriteColor = @(Green);"); 3636 verifyFormat("NSString *path = @(getenv(\"PATH\"));"); 3637 3638 verifyFormat("@["); 3639 verifyFormat("@[]"); 3640 verifyFormat( 3641 "NSArray *array = @[ @\" Hey \", NSApp, [NSNumber numberWithInt:42] ];"); 3642 verifyFormat("return @[ @3, @[], @[ @4, @5 ] ];"); 3643 3644 verifyFormat("@{"); 3645 verifyFormat("@{}"); 3646 verifyFormat("@{ @\"one\" : @1 }"); 3647 verifyFormat("return @{ @\"one\" : @1 };"); 3648 verifyFormat("@{ @\"one\" : @1, }"); 3649 3650 // FIXME: Breaking in cases where we think there's a structural error 3651 // showed that we're incorrectly parsing this code. We need to fix the 3652 // parsing here. 3653 verifyFormat("@{ @\"one\" : @\n" 3654 "{ @2 : @1 }\n" 3655 "}"); 3656 verifyFormat("@{ @\"one\" : @\n" 3657 "{ @2 : @1 }\n" 3658 ",\n" 3659 "}"); 3660 3661 verifyFormat("@{ 1 > 2 ? @\"one\" : @\"two\" : 1 > 2 ? @1 : @2 }"); 3662 verifyFormat("[self setDict:@{}"); 3663 verifyFormat("[self setDict:@{ @1 : @2 }"); 3664 verifyFormat("NSLog(@\"%@\", @{ @1 : @2, @2 : @3 }[@1]);"); 3665 verifyFormat( 3666 "NSDictionary *masses = @{ @\"H\" : @1.0078, @\"He\" : @4.0026 };"); 3667 verifyFormat( 3668 "NSDictionary *settings = @{ AVEncoderKey : @(AVAudioQualityMax) };"); 3669 3670 // FIXME: Nested and multi-line array and dictionary literals need more work. 3671 verifyFormat( 3672 "NSDictionary *d = @{ @\"nam\" : NSUserNam(), @\"dte\" : [NSDate date],\n" 3673 " @\"processInfo\" : [NSProcessInfo processInfo] };"); 3674} 3675 3676TEST_F(FormatTest, ReformatRegionAdjustsIndent) { 3677 EXPECT_EQ("{\n" 3678 "{\n" 3679 "a;\n" 3680 "b;\n" 3681 "}\n" 3682 "}", 3683 format("{\n" 3684 "{\n" 3685 "a;\n" 3686 " b;\n" 3687 "}\n" 3688 "}", 3689 13, 2, getLLVMStyle())); 3690 EXPECT_EQ("{\n" 3691 "{\n" 3692 " a;\n" 3693 "b;\n" 3694 "}\n" 3695 "}", 3696 format("{\n" 3697 "{\n" 3698 " a;\n" 3699 "b;\n" 3700 "}\n" 3701 "}", 3702 9, 2, getLLVMStyle())); 3703 EXPECT_EQ("{\n" 3704 "{\n" 3705 "public:\n" 3706 " b;\n" 3707 "}\n" 3708 "}", 3709 format("{\n" 3710 "{\n" 3711 "public:\n" 3712 " b;\n" 3713 "}\n" 3714 "}", 3715 17, 2, getLLVMStyle())); 3716 EXPECT_EQ("{\n" 3717 "{\n" 3718 "a;\n" 3719 "}\n" 3720 "{\n" 3721 " b;\n" 3722 "}\n" 3723 "}", 3724 format("{\n" 3725 "{\n" 3726 "a;\n" 3727 "}\n" 3728 "{\n" 3729 " b;\n" 3730 "}\n" 3731 "}", 3732 22, 2, getLLVMStyle())); 3733 EXPECT_EQ(" {\n" 3734 " a;\n" 3735 " }", 3736 format(" {\n" 3737 "a;\n" 3738 " }", 3739 4, 2, getLLVMStyle())); 3740 EXPECT_EQ("void f() {}\n" 3741 "void g() {}", 3742 format("void f() {}\n" 3743 "void g() {}", 3744 13, 0, getLLVMStyle())); 3745 EXPECT_EQ("int a; // comment\n" 3746 " // line 2\n" 3747 "int b;", 3748 format("int a; // comment\n" 3749 " // line 2\n" 3750 " int b;", 3751 35, 0, getLLVMStyle())); 3752} 3753 3754TEST_F(FormatTest, BreakStringLiterals) { 3755 EXPECT_EQ("\"some text \"\n" 3756 "\"other\";", 3757 format("\"some text other\";", getLLVMStyleWithColumns(12))); 3758 EXPECT_EQ("\"some text \"\n" 3759 "\"other\";", 3760 format("\\\n\"some text other\";", getLLVMStyleWithColumns(12))); 3761 EXPECT_EQ( 3762 "#define A \\\n" 3763 " \"some \" \\\n" 3764 " \"text \" \\\n" 3765 " \"other\";", 3766 format("#define A \"some text other\";", getLLVMStyleWithColumns(12))); 3767 EXPECT_EQ( 3768 "#define A \\\n" 3769 " \"so \" \\\n" 3770 " \"text \" \\\n" 3771 " \"other\";", 3772 format("#define A \"so text other\";", getLLVMStyleWithColumns(12))); 3773 3774 EXPECT_EQ("\"some text\"", 3775 format("\"some text\"", getLLVMStyleWithColumns(1))); 3776 EXPECT_EQ("\"some text\"", 3777 format("\"some text\"", getLLVMStyleWithColumns(11))); 3778 EXPECT_EQ("\"some \"\n" 3779 "\"text\"", 3780 format("\"some text\"", getLLVMStyleWithColumns(10))); 3781 EXPECT_EQ("\"some \"\n" 3782 "\"text\"", 3783 format("\"some text\"", getLLVMStyleWithColumns(7))); 3784 EXPECT_EQ("\"some\"\n" 3785 "\" tex\"\n" 3786 "\"t\"", 3787 format("\"some text\"", getLLVMStyleWithColumns(6))); 3788 EXPECT_EQ("\"some\"\n" 3789 "\" tex\"\n" 3790 "\" and\"", 3791 format("\"some tex and\"", getLLVMStyleWithColumns(6))); 3792 EXPECT_EQ("\"some\"\n" 3793 "\"/tex\"\n" 3794 "\"/and\"", 3795 format("\"some/tex/and\"", getLLVMStyleWithColumns(6))); 3796 3797 EXPECT_EQ("variable =\n" 3798 " \"long string \"\n" 3799 " \"literal\";", 3800 format("variable = \"long string literal\";", 3801 getLLVMStyleWithColumns(20))); 3802 3803 EXPECT_EQ("variable = f(\n" 3804 " \"long string \"\n" 3805 " \"literal\",\n" 3806 " short,\n" 3807 " loooooooooooooooooooong);", 3808 format("variable = f(\"long string literal\", short, " 3809 "loooooooooooooooooooong);", 3810 getLLVMStyleWithColumns(20))); 3811 EXPECT_EQ( 3812 "f(\"one two\".split(\n" 3813 " variable));", 3814 format("f(\"one two\".split(variable));", getLLVMStyleWithColumns(20))); 3815 EXPECT_EQ("f(\"one two three four five six \"\n" 3816 " \"seven\".split(\n" 3817 " really_looooong_variable));", 3818 format("f(\"one two three four five six seven\"." 3819 "split(really_looooong_variable));", 3820 getLLVMStyleWithColumns(33))); 3821 3822 EXPECT_EQ("f(\"some \"\n" 3823 " \"text\",\n" 3824 " other);", 3825 format("f(\"some text\", other);", getLLVMStyleWithColumns(10))); 3826 3827 // Only break as a last resort. 3828 verifyFormat( 3829 "aaaaaaaaaaaaaaaaaaaa(\n" 3830 " aaaaaaaaaaaaaaaaaaaa,\n" 3831 " aaaaaa(\"aaa aaaaa aaa aaa aaaaa aaa aaaaa aaa aaa aaaaaa\"));"); 3832 3833 EXPECT_EQ( 3834 "\"splitmea\"\n" 3835 "\"trandomp\"\n" 3836 "\"oint\"", 3837 format("\"splitmeatrandompoint\"", getLLVMStyleWithColumns(10))); 3838 3839 EXPECT_EQ( 3840 "\"split/\"\n" 3841 "\"pathat/\"\n" 3842 "\"slashes\"", 3843 format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); 3844 3845 FormatStyle AlignLeft = getLLVMStyleWithColumns(12); 3846 AlignLeft.AlignEscapedNewlinesLeft = true; 3847 EXPECT_EQ( 3848 "#define A \\\n" 3849 " \"some \" \\\n" 3850 " \"text \" \\\n" 3851 " \"other\";", 3852 format("#define A \"some text other\";", AlignLeft)); 3853} 3854 3855TEST_F(FormatTest, DoNotBreakStringLiteralsInEscapeSequence) { 3856 EXPECT_EQ("\"\\a\"", 3857 format("\"\\a\"", getLLVMStyleWithColumns(3))); 3858 EXPECT_EQ("\"\\\"", 3859 format("\"\\\"", getLLVMStyleWithColumns(2))); 3860 EXPECT_EQ("\"test\"\n" 3861 "\"\\n\"", 3862 format("\"test\\n\"", getLLVMStyleWithColumns(7))); 3863 EXPECT_EQ("\"tes\\\\\"\n" 3864 "\"n\"", 3865 format("\"tes\\\\n\"", getLLVMStyleWithColumns(7))); 3866 EXPECT_EQ("\"\\\\\\\\\"\n" 3867 "\"\\n\"", 3868 format("\"\\\\\\\\\\n\"", getLLVMStyleWithColumns(7))); 3869 EXPECT_EQ("\"\\uff01\"", 3870 format("\"\\uff01\"", getLLVMStyleWithColumns(7))); 3871 EXPECT_EQ("\"\\uff01\"\n" 3872 "\"test\"", 3873 format("\"\\uff01test\"", getLLVMStyleWithColumns(8))); 3874 EXPECT_EQ("\"\\Uff01ff02\"", 3875 format("\"\\Uff01ff02\"", getLLVMStyleWithColumns(11))); 3876 EXPECT_EQ("\"\\x000000000001\"\n" 3877 "\"next\"", 3878 format("\"\\x000000000001next\"", getLLVMStyleWithColumns(16))); 3879 EXPECT_EQ("\"\\x000000000001next\"", 3880 format("\"\\x000000000001next\"", getLLVMStyleWithColumns(15))); 3881 EXPECT_EQ("\"\\x000000000001\"", 3882 format("\"\\x000000000001\"", getLLVMStyleWithColumns(7))); 3883 EXPECT_EQ("\"test\"\n" 3884 "\"\\000000\"\n" 3885 "\"000001\"", 3886 format("\"test\\000000000001\"", getLLVMStyleWithColumns(9))); 3887 EXPECT_EQ("\"test\\000\"\n" 3888 "\"00000000\"\n" 3889 "\"1\"", 3890 format("\"test\\000000000001\"", getLLVMStyleWithColumns(10))); 3891 EXPECT_EQ("R\"(\\x\\x00)\"\n", 3892 format("R\"(\\x\\x00)\"\n", getLLVMStyleWithColumns(7))); 3893} 3894 3895TEST_F(FormatTest, DoNotCreateUnreasonableUnwrappedLines) { 3896 verifyFormat("void f() {\n" 3897 " return g() {}\n" 3898 " void h() {}"); 3899 verifyFormat("if (foo)\n" 3900 " return { forgot_closing_brace();\n" 3901 "test();"); 3902 verifyFormat("int a[] = { void forgot_closing_brace()\n" 3903 "{\n" 3904 " f();\n" 3905 " g();\n" 3906 "}"); 3907} 3908 3909} // end namespace tooling 3910} // end namespace clang 3911