From c72c57c9e9b69944e3e009cd5e209634839581d3 Mon Sep 17 00:00:00 2001 From: dim Date: Mon, 8 Apr 2013 18:45:10 +0000 Subject: Vendor import of clang trunk r178860: http://llvm.org/svn/llvm-project/cfe/trunk@178860 --- unittests/Format/FormatTest.cpp | 3590 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 3590 insertions(+) create mode 100644 unittests/Format/FormatTest.cpp (limited to 'unittests/Format/FormatTest.cpp') diff --git a/unittests/Format/FormatTest.cpp b/unittests/Format/FormatTest.cpp new file mode 100644 index 0000000..e01034b --- /dev/null +++ b/unittests/Format/FormatTest.cpp @@ -0,0 +1,3590 @@ +//===- unittest/Format/FormatTest.cpp - Formatting unit tests -------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#define DEBUG_TYPE "format-test" + +#include "clang/Format/Format.h" +#include "../Tooling/RewriterTestContext.h" +#include "clang/Lex/Lexer.h" +#include "llvm/Support/Debug.h" +#include "gtest/gtest.h" + +namespace clang { +namespace format { + +class FormatTest : public ::testing::Test { +protected: + std::string format(llvm::StringRef Code, unsigned Offset, unsigned Length, + const FormatStyle &Style) { + DEBUG(llvm::errs() << "---\n"); + RewriterTestContext Context; + FileID ID = Context.createInMemoryFile("input.cc", Code); + SourceLocation Start = + Context.Sources.getLocForStartOfFile(ID).getLocWithOffset(Offset); + std::vector Ranges( + 1, + CharSourceRange::getCharRange(Start, Start.getLocWithOffset(Length))); + Lexer Lex(ID, Context.Sources.getBuffer(ID), Context.Sources, + getFormattingLangOpts()); + tooling::Replacements Replace = reformat( + Style, Lex, Context.Sources, Ranges, new IgnoringDiagConsumer()); + ReplacementCount = Replace.size(); + EXPECT_TRUE(applyAllReplacements(Replace, Context.Rewrite)); + DEBUG(llvm::errs() << "\n" << Context.getRewrittenText(ID) << "\n\n"); + return Context.getRewrittenText(ID); + } + + std::string + format(llvm::StringRef Code, const FormatStyle &Style = getLLVMStyle()) { + return format(Code, 0, Code.size(), Style); + } + + std::string messUp(llvm::StringRef Code) { + std::string MessedUp(Code.str()); + bool InComment = false; + bool InPreprocessorDirective = false; + bool JustReplacedNewline = false; + for (unsigned i = 0, e = MessedUp.size() - 1; i != e; ++i) { + if (MessedUp[i] == '/' && MessedUp[i + 1] == '/') { + if (JustReplacedNewline) + MessedUp[i - 1] = '\n'; + InComment = true; + } else if (MessedUp[i] == '#' && (JustReplacedNewline || i == 0)) { + if (i != 0) + MessedUp[i - 1] = '\n'; + InPreprocessorDirective = true; + } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') { + MessedUp[i] = ' '; + MessedUp[i + 1] = ' '; + } else if (MessedUp[i] == '\n') { + if (InComment) { + InComment = false; + } else if (InPreprocessorDirective) { + InPreprocessorDirective = false; + } else { + JustReplacedNewline = true; + MessedUp[i] = ' '; + } + } else if (MessedUp[i] != ' ') { + JustReplacedNewline = false; + } + } + return MessedUp; + } + + FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) { + FormatStyle Style = getLLVMStyle(); + Style.ColumnLimit = ColumnLimit; + return Style; + } + + FormatStyle getGoogleStyleWithColumns(unsigned ColumnLimit) { + FormatStyle Style = getGoogleStyle(); + Style.ColumnLimit = ColumnLimit; + return Style; + } + + void verifyFormat(llvm::StringRef Code, + const FormatStyle &Style = getLLVMStyle()) { + EXPECT_EQ(Code.str(), format(messUp(Code), Style)); + } + + void verifyGoogleFormat(llvm::StringRef Code) { + verifyFormat(Code, getGoogleStyle()); + } + + void verifyIndependentOfContext(llvm::StringRef text) { + verifyFormat(text); + verifyFormat(llvm::Twine("void f() { " + text + " }").str()); + } + + int ReplacementCount; +}; + +TEST_F(FormatTest, MessUp) { + EXPECT_EQ("1 2 3", messUp("1 2 3")); + EXPECT_EQ("1 2 3\n", messUp("1\n2\n3\n")); + EXPECT_EQ("a\n//b\nc", messUp("a\n//b\nc")); + EXPECT_EQ("a\n#b\nc", messUp("a\n#b\nc")); + EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne")); +} + +//===----------------------------------------------------------------------===// +// Basic function tests. +//===----------------------------------------------------------------------===// + +TEST_F(FormatTest, DoesNotChangeCorrectlyFormatedCode) { + EXPECT_EQ(";", format(";")); +} + +TEST_F(FormatTest, FormatsGlobalStatementsAt0) { + EXPECT_EQ("int i;", format(" int i;")); + EXPECT_EQ("\nint i;", format(" \n\t \r int i;")); + EXPECT_EQ("int i;\nint j;", format(" int i; int j;")); + EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;")); +} + +TEST_F(FormatTest, FormatsUnwrappedLinesAtFirstFormat) { + EXPECT_EQ("int i;", format("int\ni;")); +} + +TEST_F(FormatTest, FormatsNestedBlockStatements) { + EXPECT_EQ("{\n {\n {}\n }\n}", format("{{{}}}")); +} + +TEST_F(FormatTest, FormatsNestedCall) { + verifyFormat("Method(f1, f2(f3));"); + verifyFormat("Method(f1(f2, f3()));"); + verifyFormat("Method(f1(f2, (f3())));"); +} + +TEST_F(FormatTest, NestedNameSpecifiers) { + verifyFormat("vector< ::Type> v;"); + verifyFormat("::ns::SomeFunction(::ns::SomeOtherFunction())"); +} + +TEST_F(FormatTest, OnlyGeneratesNecessaryReplacements) { + EXPECT_EQ("if (a) {\n" + " f();\n" + "}", + format("if(a){f();}")); + EXPECT_EQ(4, ReplacementCount); + EXPECT_EQ("if (a) {\n" + " f();\n" + "}", + format("if (a) {\n" + " f();\n" + "}")); + EXPECT_EQ(0, ReplacementCount); +} + +TEST_F(FormatTest, RemovesTrailingWhitespaceOfFormattedLine) { + EXPECT_EQ("int a;\nint b;", format("int a; \nint b;", 0, 0, getLLVMStyle())); + EXPECT_EQ("int a;", format("int a; ")); + EXPECT_EQ("int a;\n", format("int a; \n \n \n ")); + EXPECT_EQ("int a;\nint b; ", + format("int a; \nint b; ", 0, 0, getLLVMStyle())); +} + +TEST_F(FormatTest, FormatsCorrectRegionForLeadingWhitespace) { + EXPECT_EQ("int b;\nint a;", + format("int b;\n int a;", 7, 0, getLLVMStyle())); + EXPECT_EQ("int b;\n int a;", + format("int b;\n int a;", 6, 0, getLLVMStyle())); + + EXPECT_EQ("#define A \\\n" + " int a; \\\n" + " int b;", + format("#define A \\\n" + " int a; \\\n" + " int b;", + 26, 0, getLLVMStyleWithColumns(12))); + EXPECT_EQ("#define A \\\n" + " int a; \\\n" + " int b;", + format("#define A \\\n" + " int a; \\\n" + " int b;", + 25, 0, getLLVMStyleWithColumns(12))); +} + +TEST_F(FormatTest, RemovesWhitespaceWhenTriggeredOnEmptyLine) { + EXPECT_EQ("int a;\n\n int b;", + format("int a;\n \n\n int b;", 7, 0, getLLVMStyle())); + EXPECT_EQ("int a;\n\n int b;", + format("int a;\n \n\n int b;", 9, 0, getLLVMStyle())); +} + +TEST_F(FormatTest, ReformatsMovedLines) { + EXPECT_EQ( + "template T *getFETokenInfo() const {\n" + " return static_cast(FETokenInfo);\n" + "}\n" + " int a; // <- Should not be formatted", + format( + "template\n" + "T *getFETokenInfo() const { return static_cast(FETokenInfo); }\n" + " int a; // <- Should not be formatted", + 9, 5, getLLVMStyle())); +} + +//===----------------------------------------------------------------------===// +// Tests for control statements. +//===----------------------------------------------------------------------===// + +TEST_F(FormatTest, FormatIfWithoutCompountStatement) { + verifyFormat("if (true)\n f();\ng();"); + verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();"); + verifyFormat("if (a)\n if (b) {\n f();\n }\ng();"); + + FormatStyle AllowsMergedIf = getGoogleStyle(); + AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; + verifyFormat("if (a)\n" + " // comment\n" + " f();", + AllowsMergedIf); + + verifyFormat("if (a) // Can't merge this\n" + " f();\n", + AllowsMergedIf); + verifyFormat("if (a) /* still don't merge */\n" + " f();", + AllowsMergedIf); + verifyFormat("if (a) { // Never merge this\n" + " f();\n" + "}", + AllowsMergedIf); + verifyFormat("if (a) { /* Never merge this */\n" + " f();\n" + "}", + AllowsMergedIf); + + AllowsMergedIf.ColumnLimit = 14; + verifyFormat("if (a) return;", AllowsMergedIf); + verifyFormat("if (aaaaaaaaa)\n" + " return;", + AllowsMergedIf); + + AllowsMergedIf.ColumnLimit = 13; + verifyFormat("if (a)\n return;", AllowsMergedIf); +} + +TEST_F(FormatTest, ParseIfElse) { + verifyFormat("if (true)\n" + " if (true)\n" + " if (true)\n" + " f();\n" + " else\n" + " g();\n" + " else\n" + " h();\n" + "else\n" + " i();"); + verifyFormat("if (true)\n" + " if (true)\n" + " if (true) {\n" + " if (true)\n" + " f();\n" + " } else {\n" + " g();\n" + " }\n" + " else\n" + " h();\n" + "else {\n" + " i();\n" + "}"); +} + +TEST_F(FormatTest, ElseIf) { + verifyFormat("if (a) {\n} else if (b) {\n}"); + verifyFormat("if (a)\n" + " f();\n" + "else if (b)\n" + " g();\n" + "else\n" + " h();"); +} + +TEST_F(FormatTest, FormatsForLoop) { + verifyFormat( + "for (int VeryVeryLongLoopVariable = 0; VeryVeryLongLoopVariable < 10;\n" + " ++VeryVeryLongLoopVariable)\n" + " ;"); + verifyFormat("for (;;)\n" + " f();"); + verifyFormat("for (;;) {\n}"); + verifyFormat("for (;;) {\n" + " f();\n" + "}"); + + verifyFormat( + "for (std::vector::iterator I = UnwrappedLines.begin(),\n" + " E = UnwrappedLines.end();\n" + " I != E; ++I) {\n}"); + + verifyFormat( + "for (MachineFun::iterator IIII = PrevIt, EEEE = F.end(); IIII != EEEE;\n" + " ++IIIII) {\n}"); + verifyFormat("for (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaa =\n" + " aaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa;\n" + " aaaaaaaaaaa != aaaaaaaaaaaaaaaaaaa; ++aaaaaaaaaaa) {\n}"); + verifyFormat("for (llvm::ArrayRef::iterator\n" + " I = FD->getDeclsInPrototypeScope().begin(),\n" + " E = FD->getDeclsInPrototypeScope().end();\n" + " I != E; ++I) {\n}"); + + // FIXME: Not sure whether we want extra identation in line 3 here: + verifyFormat( + "for (aaaaaaaaaaaaaaaaa aaaaaaaaaaa = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa !=\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" + " ++aaaaaaaaaaa) {\n}"); + verifyFormat("for (int aaaaaaaaaaa = 1; aaaaaaaaaaa <= bbbbbbbbbbbbbbb;\n" + " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n" + "}"); + verifyFormat("for (some_namespace::SomeIterator iter( // force break\n" + " aaaaaaaaaa);\n" + " iter; ++iter) {\n" + "}"); + + FormatStyle NoBinPacking = getLLVMStyle(); + NoBinPacking.BinPackParameters = false; + verifyFormat("for (int aaaaaaaaaaa = 1;\n" + " aaaaaaaaaaa <= aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa);\n" + " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n" + "}", + NoBinPacking); + verifyFormat( + "for (std::vector::iterator I = UnwrappedLines.begin(),\n" + " E = UnwrappedLines.end();\n" + " I != E;\n" + " ++I) {\n}", + NoBinPacking); +} + +TEST_F(FormatTest, RangeBasedForLoops) { + verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); + verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa, aaaaaaaaaaaaa)) {\n}"); + verifyFormat("for (const aaaaaaaaaaaaaaaaaaaaa &aaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); +} + +TEST_F(FormatTest, FormatsWhileLoop) { + verifyFormat("while (true) {\n}"); + verifyFormat("while (true)\n" + " f();"); + verifyFormat("while () {\n}"); + verifyFormat("while () {\n" + " f();\n" + "}"); +} + +TEST_F(FormatTest, FormatsDoWhile) { + verifyFormat("do {\n" + " do_something();\n" + "} while (something());"); + verifyFormat("do\n" + " do_something();\n" + "while (something());"); +} + +TEST_F(FormatTest, FormatsSwitchStatement) { + verifyFormat("switch (x) {\n" + "case 1:\n" + " f();\n" + " break;\n" + "case kFoo:\n" + "case ns::kBar:\n" + "case kBaz:\n" + " break;\n" + "default:\n" + " g();\n" + " break;\n" + "}"); + verifyFormat("switch (x) {\n" + "case 1: {\n" + " f();\n" + " break;\n" + "}\n" + "}"); + verifyFormat("switch (x) {\n" + "case 1: {\n" + " f();\n" + " {\n" + " g();\n" + " h();\n" + " }\n" + " break;\n" + "}\n" + "}"); + verifyFormat("switch (x) {\n" + "case 1: {\n" + " f();\n" + " if (foo) {\n" + " g();\n" + " h();\n" + " }\n" + " break;\n" + "}\n" + "}"); + verifyFormat("switch (x) {\n" + "case 1: {\n" + " f();\n" + " g();\n" + "} break;\n" + "}"); + verifyFormat("switch (test)\n" + " ;"); + verifyFormat("switch (x) {\n" + "default: {\n" + " // Do nothing.\n" + "}"); + verifyFormat("switch (x) {\n" + "// if 1, do f()\n" + "case 1:\n" + " f();\n" + "}"); + verifyFormat("switch (x) {\n" + "case 1:\n" + " // Do amazing stuff\n" + " {\n" + " f();\n" + " g();\n" + " }\n" + " break;\n" + "}"); + verifyFormat("#define A \\\n" + " switch (x) { \\\n" + " case a: \\\n" + " foo = b; \\\n" + " }", getLLVMStyleWithColumns(20)); + + verifyGoogleFormat("switch (x) {\n" + " case 1:\n" + " f();\n" + " break;\n" + " case kFoo:\n" + " case ns::kBar:\n" + " case kBaz:\n" + " break;\n" + " default:\n" + " g();\n" + " break;\n" + "}"); + verifyGoogleFormat("switch (x) {\n" + " case 1: {\n" + " f();\n" + " break;\n" + " }\n" + "}"); + verifyGoogleFormat("switch (test)\n" + " ;"); +} + +TEST_F(FormatTest, FormatsLabels) { + verifyFormat("void f() {\n" + " some_code();\n" + "test_label:\n" + " some_other_code();\n" + " {\n" + " some_more_code();\n" + " another_label:\n" + " some_more_code();\n" + " }\n" + "}"); + verifyFormat("some_code();\n" + "test_label:\n" + "some_other_code();"); +} + +//===----------------------------------------------------------------------===// +// Tests for comments. +//===----------------------------------------------------------------------===// + +TEST_F(FormatTest, UnderstandsSingleLineComments) { + verifyFormat("//* */"); + verifyFormat("// line 1\n" + "// line 2\n" + "void f() {}\n"); + + verifyFormat("void f() {\n" + " // Doesn't do anything\n" + "}"); + verifyFormat("void f(int i, // some comment (probably for i)\n" + " int j, // some comment (probably for j)\n" + " int k); // some comment (probably for k)"); + verifyFormat("void f(int i,\n" + " // some comment (probably for j)\n" + " int j,\n" + " // some comment (probably for k)\n" + " int k);"); + + verifyFormat("int i // This is a fancy variable\n" + " = 5; // with nicely aligned comment."); + + verifyFormat("// Leading comment.\n" + "int a; // Trailing comment."); + verifyFormat("int a; // Trailing comment\n" + " // on 2\n" + " // or 3 lines.\n" + "int b;"); + verifyFormat("int a; // Trailing comment\n" + "\n" + "// Leading comment.\n" + "int b;"); + verifyFormat("int a; // Comment.\n" + " // More details.\n" + "int bbbb; // Another comment."); + verifyFormat( + "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; // comment\n" + "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // comment\n" + "int cccccccccccccccccccccccccccccc; // comment\n" + "int ddd; // looooooooooooooooooooooooong comment\n" + "int aaaaaaaaaaaaaaaaaaaaaaa; // comment\n" + "int bbbbbbbbbbbbbbbbbbbbb; // comment\n" + "int ccccccccccccccccccc; // comment"); + + verifyFormat("#include \"a\" // comment\n" + "#include \"a/b/c\" // comment"); + verifyFormat("#include // comment\n" + "#include // comment"); + + verifyFormat("enum E {\n" + " // comment\n" + " VAL_A, // comment\n" + " VAL_B\n" + "};"); + + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // Trailing comment"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " // Comment inside a statement.\n" + " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); + verifyFormat( + "bool aaaaaaaaaaaaa = // comment\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + + verifyFormat("int aaaa; // aaaaa\n" + "int aa; // aaaaaaa", + getLLVMStyleWithColumns(20)); + + EXPECT_EQ("void f() { // This does something ..\n" + "}\n" + "int a; // This is unrelated", + format("void f() { // This does something ..\n" + " }\n" + "int a; // This is unrelated")); + EXPECT_EQ("void f() { // This does something ..\n" + "} // awesome..\n" + "\n" + "int a; // This is unrelated", + format("void f() { // This does something ..\n" + " } // awesome..\n" + " \n" + "int a; // This is unrelated")); + + EXPECT_EQ("int i; // single line trailing comment", + format("int i;\\\n// single line trailing comment")); + + verifyGoogleFormat("int a; // Trailing comment."); + + verifyFormat("someFunction(anotherFunction( // Force break.\n" + " parameter));"); + + verifyGoogleFormat("#endif // HEADER_GUARD"); + + verifyFormat("const char *test[] = {\n" + " // A\n" + " \"aaaa\",\n" + " // B\n" + " \"aaaaa\",\n" + "};"); + verifyGoogleFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaa); // 81 cols with this comment"); + EXPECT_EQ("D(a, {\n" + " // test\n" + " int a;\n" + "});", + format("D(a, {\n" + "// test\n" + "int a;\n" + "});")); +} + +TEST_F(FormatTest, CanFormatCommentsLocally) { + EXPECT_EQ("int a; // comment\n" + "int b; // comment", + format("int a; // comment\n" + "int b; // comment", + 0, 0, getLLVMStyle())); + EXPECT_EQ("int a; // comment\n" + " // line 2\n" + "int b;", + format("int a; // comment\n" + " // line 2\n" + "int b;", + 28, 0, getLLVMStyle())); +} + +TEST_F(FormatTest, RemovesTrailingWhitespaceOfComments) { + EXPECT_EQ("// comment", format("// comment ")); + EXPECT_EQ("int aaaaaaa, bbbbbbb; // comment", + format("int aaaaaaa, bbbbbbb; // comment ", + getLLVMStyleWithColumns(33))); +} + +TEST_F(FormatTest, UnderstandsMultiLineComments) { + verifyFormat("f(/*test=*/ true);"); + EXPECT_EQ( + "f(aaaaaaaaaaaaaaaaaaaaaaaaa, /* Trailing comment for aa... */\n" + " bbbbbbbbbbbbbbbbbbbbbbbbb);", + format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , /* Trailing comment for aa... */\n" + " bbbbbbbbbbbbbbbbbbbbbbbbb);")); + EXPECT_EQ( + "f(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " /* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);", + format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \n" + "/* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);")); + + FormatStyle NoBinPacking = getLLVMStyle(); + NoBinPacking.BinPackParameters = false; + verifyFormat("aaaaaaaa(/* parameter 1 */ aaaaaa,\n" + " /* parameter 2 */ aaaaaa,\n" + " /* parameter 3 */ aaaaaa,\n" + " /* parameter 4 */ aaaaaa);", + NoBinPacking); +} + +TEST_F(FormatTest, AlignsMultiLineComments) { + EXPECT_EQ("/*\n" + " * Really multi-line\n" + " * comment.\n" + " */\n" + "void f() {}", + format(" /*\n" + " * Really multi-line\n" + " * comment.\n" + " */\n" + " void f() {}")); + EXPECT_EQ("class C {\n" + " /*\n" + " * Another multi-line\n" + " * comment.\n" + " */\n" + " void f() {}\n" + "};", + format("class C {\n" + "/*\n" + " * Another multi-line\n" + " * comment.\n" + " */\n" + "void f() {}\n" + "};")); + EXPECT_EQ("/*\n" + " 1. This is a comment with non-trivial formatting.\n" + " 1.1. We have to indent/outdent all lines equally\n" + " 1.1.1. to keep the formatting.\n" + " */", + format(" /*\n" + " 1. This is a comment with non-trivial formatting.\n" + " 1.1. We have to indent/outdent all lines equally\n" + " 1.1.1. to keep the formatting.\n" + " */")); + EXPECT_EQ("/*\n" + " Don't try to outdent if there's not enough inentation.\n" + " */", + format(" /*\n" + " Don't try to outdent if there's not enough inentation.\n" + " */")); +} + +TEST_F(FormatTest, SplitsLongCxxComments) { + EXPECT_EQ("// A comment that\n" + "// doesn't fit on\n" + "// one line", + format("// A comment that doesn't fit on one line", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("if (true) // A comment that\n" + " // doesn't fit on\n" + " // one line", + format("if (true) // A comment that doesn't fit on one line ", + getLLVMStyleWithColumns(30))); + EXPECT_EQ("// Don't_touch_leading_whitespace", + format("// Don't_touch_leading_whitespace", + getLLVMStyleWithColumns(20))); + EXPECT_EQ( + "//Don't add leading\n" + "//whitespace", + format("//Don't add leading whitespace", getLLVMStyleWithColumns(20))); + EXPECT_EQ("// A comment before\n" + "// a macro\n" + "// definition\n" + "#define a b", + format("// A comment before a macro definition\n" + "#define a b", + getLLVMStyleWithColumns(20))); +} + +TEST_F(FormatTest, ParsesCommentsAdjacentToPPDirectives) { + EXPECT_EQ("namespace {}\n// Test\n#define A", + format("namespace {}\n // Test\n#define A")); + EXPECT_EQ("namespace {}\n/* Test */\n#define A", + format("namespace {}\n /* Test */\n#define A")); + EXPECT_EQ("namespace {}\n/* Test */ #define A", + format("namespace {}\n /* Test */ #define A")); +} + +TEST_F(FormatTest, SplitsLongLinesInComments) { + EXPECT_EQ("/* This is a long\n" + " * comment that\n" + " * doesn't\n" + " * fit on one line.\n" + " */", + format("/* " + "This is a long " + "comment that " + "doesn't " + "fit on one line. */", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("/*\n" + "This is a long\n" + "comment that doesn't\n" + "fit on one line.\n" + "*/", + format("/*\n" + "This is a long " + "comment that doesn't " + "fit on one line. \n" + "*/", getLLVMStyleWithColumns(20))); + EXPECT_EQ("/*\n" + " * This is a long\n" + " * comment that\n" + " * doesn't fit on\n" + " * one line.\n" + " */", + format("/* \n" + " * This is a long " + " comment that " + " doesn't fit on " + " one line. \n" + " */", getLLVMStyleWithColumns(20))); + EXPECT_EQ("/*\n" + " * This_is_a_comment_with_words_that_dont_fit_on_one_line\n" + " * so_it_should_be_broken\n" + " * wherever_a_space_occurs\n" + " */", + format("/*\n" + " * This_is_a_comment_with_words_that_dont_fit_on_one_line " + " so_it_should_be_broken " + " wherever_a_space_occurs \n" + " */", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("/*\n" + " * This_comment_can_not_be_broken_into_lines\n" + " */", + format("/*\n" + " * This_comment_can_not_be_broken_into_lines\n" + " */", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("{\n" + " /*\n" + " This is another\n" + " long comment that\n" + " doesn't fit on one\n" + " line 1234567890\n" + " */\n" + "}", + format("{\n" + "/*\n" + "This is another " + " long comment that " + " doesn't fit on one" + " line 1234567890\n" + "*/\n" + "}", getLLVMStyleWithColumns(20))); + EXPECT_EQ("{\n" + " /*\n" + " * This i s\n" + " * another comment\n" + " * t hat doesn' t\n" + " * fit on one l i\n" + " * n e\n" + " */\n" + "}", + format("{\n" + "/*\n" + " * This i s" + " another comment" + " t hat doesn' t" + " fit on one l i" + " n e\n" + " */\n" + "}", getLLVMStyleWithColumns(20))); + EXPECT_EQ("/*\n" + " * This is a long\n" + " * comment that\n" + " * doesn't fit on\n" + " * one line\n" + " */", + format(" /*\n" + " * This is a long comment that doesn't fit on one line\n" + " */", getLLVMStyleWithColumns(20))); + EXPECT_EQ("{\n" + " if (something) /* This is a\n" + "long comment */\n" + " ;\n" + "}", + format("{\n" + " if (something) /* This is a long comment */\n" + " ;\n" + "}", + getLLVMStyleWithColumns(30))); +} + +TEST_F(FormatTest, SplitsLongLinesInCommentsInPreprocessor) { + EXPECT_EQ("#define X \\\n" + " /* \\\n" + " Test \\\n" + " Macro comment \\\n" + " with a long \\\n" + " line \\\n" + // FIXME: We should look at the length of the last line of the token + // instead of the full token's length. + //" */ \\\n" + " */\\\n" + " A + B", + format("#define X \\\n" + " /*\n" + " Test\n" + " Macro comment with a long line\n" + " */ \\\n" + " A + B", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("#define X \\\n" + " /* Macro comment \\\n" + " with a long \\\n" + // FIXME: We should look at the length of the last line of the token + // instead of the full token's length. + //" line */ \\\n" + " line */\\\n" + " A + B", + format("#define X \\\n" + " /* Macro comment with a long\n" + " line */ \\\n" + " A + B", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("#define X \\\n" + " /* Macro comment \\\n" + " * with a long \\\n" + // FIXME: We should look at the length of the last line of the token + // instead of the full token's length. + //" * line */ \\\n" + " * line */\\\n" + " A + B", + format("#define X \\\n" + " /* Macro comment with a long line */ \\\n" + " A + B", + getLLVMStyleWithColumns(20))); +} + +TEST_F(FormatTest, CommentsInStaticInitializers) { + EXPECT_EQ( + "static SomeType type = { aaaaaaaaaaaaaaaaaaaa, /* comment */\n" + " aaaaaaaaaaaaaaaaaaaa /* comment */,\n" + " /* comment */ aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaa, // comment\n" + " aaaaaaaaaaaaaaaaaaaa };", + format("static SomeType type = { aaaaaaaaaaaaaaaaaaaa , /* comment */\n" + " aaaaaaaaaaaaaaaaaaaa /* comment */ ,\n" + " /* comment */ aaaaaaaaaaaaaaaaaaaa ,\n" + " aaaaaaaaaaaaaaaaaaaa , // comment\n" + " aaaaaaaaaaaaaaaaaaaa };")); + verifyFormat("static SomeType type = { aaaaaaaaaaa, // comment for aa...\n" + " bbbbbbbbbbb, ccccccccccc };"); + verifyFormat("static SomeType type = { aaaaaaaaaaa,\n" + " // comment for bb....\n" + " bbbbbbbbbbb, ccccccccccc };"); + verifyGoogleFormat( + "static SomeType type = { aaaaaaaaaaa, // comment for aa...\n" + " bbbbbbbbbbb, ccccccccccc };"); + verifyGoogleFormat("static SomeType type = { aaaaaaaaaaa,\n" + " // comment for bb....\n" + " bbbbbbbbbbb, ccccccccccc };"); + + verifyFormat("S s = { { a, b, c }, // Group #1\n" + " { d, e, f }, // Group #2\n" + " { g, h, i } }; // Group #3"); + verifyFormat("S s = { { // Group #1\n" + " a, b, c },\n" + " { // Group #2\n" + " d, e, f },\n" + " { // Group #3\n" + " g, h, i } };"); + + EXPECT_EQ("S s = {\n" + " // Some comment\n" + " a,\n" + "\n" + " // Comment after empty line\n" + " b\n" + "}", + format("S s = {\n" + " // Some comment\n" + " a,\n" + " \n" + " // Comment after empty line\n" + " b\n" + "}")); + EXPECT_EQ("S s = { a, b };", format("S s = {\n" + " a,\n" + "\n" + " b\n" + "};")); + verifyFormat("const uint8_t aaaaaaaaaaaaaaaaaaaaaa[0] = {\n" + " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" + " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" + " 0x00, 0x00, 0x00, 0x00 // comment\n" + "};"); +} + +//===----------------------------------------------------------------------===// +// Tests for classes, namespaces, etc. +//===----------------------------------------------------------------------===// + +TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) { + verifyFormat("class A {\n};"); +} + +TEST_F(FormatTest, UnderstandsAccessSpecifiers) { + verifyFormat("class A {\n" + "public:\n" + "protected:\n" + "private:\n" + " void f() {}\n" + "};"); + verifyGoogleFormat("class A {\n" + " public:\n" + " protected:\n" + " private:\n" + " void f() {}\n" + "};"); +} + +TEST_F(FormatTest, SeparatesLogicalBlocks) { + EXPECT_EQ("class A {\n" + "public:\n" + " void f();\n" + "\n" + "private:\n" + " void g() {}\n" + " // test\n" + "protected:\n" + " int h;\n" + "};", + format("class A {\n" + "public:\n" + "void f();\n" + "private:\n" + "void g() {}\n" + "// test\n" + "protected:\n" + "int h;\n" + "};")); +} + +TEST_F(FormatTest, FormatsDerivedClass) { + verifyFormat("class A : public B {\n};"); + verifyFormat("class A : public ::B {\n};"); + + verifyFormat( + "class AAAAAAAAAAAAAAAAAAAA : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" + " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {\n" + "};\n"); + verifyFormat("class AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA :\n" + " public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" + " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {\n" + "};\n"); + verifyFormat( + "class A : public B, public C, public D, public E, public F, public G {\n" + "};"); + verifyFormat("class AAAAAAAAAAAA : public B,\n" + " public C,\n" + " public D,\n" + " public E,\n" + " public F,\n" + " public G {\n" + "};"); +} + +TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) { + verifyFormat("class A {\n} a, b;"); + verifyFormat("struct A {\n} a, b;"); + verifyFormat("union A {\n} a;"); +} + +TEST_F(FormatTest, FormatsEnum) { + verifyFormat("enum {\n" + " Zero,\n" + " One = 1,\n" + " Two = One + 1,\n" + " Three = (One + Two),\n" + " Four = (Zero && (One ^ Two)) | (One << Two),\n" + " Five = (One, Two, Three, Four, 5)\n" + "};"); + verifyFormat("enum Enum {\n" + "};"); + verifyFormat("enum {\n" + "};"); + verifyFormat("enum X E {\n} d;"); + verifyFormat("enum __attribute__((...)) E {\n} d;"); + verifyFormat("enum __declspec__((...)) E {\n} d;"); + verifyFormat("enum X f() {\n a();\n return 42;\n}"); +} + +TEST_F(FormatTest, FormatsBitfields) { + verifyFormat("struct Bitfields {\n" + " unsigned sClass : 8;\n" + " unsigned ValueKind : 2;\n" + "};"); +} + +TEST_F(FormatTest, FormatsNamespaces) { + verifyFormat("namespace some_namespace {\n" + "class A {\n};\n" + "void f() { f(); }\n" + "}"); + verifyFormat("namespace {\n" + "class A {\n};\n" + "void f() { f(); }\n" + "}"); + verifyFormat("inline namespace X {\n" + "class A {\n};\n" + "void f() { f(); }\n" + "}"); + verifyFormat("using namespace some_namespace;\n" + "class A {\n};\n" + "void f() { f(); }"); + + // This code is more common than we thought; if we + // layout this correctly the semicolon will go into + // its own line, which is undesireable. + verifyFormat("namespace {\n};"); + verifyFormat("namespace {\n" + "class A {\n" + "};\n" + "};"); +} + +TEST_F(FormatTest, FormatsExternC) { verifyFormat("extern \"C\" {\nint a;"); } + +TEST_F(FormatTest, FormatsInlineASM) { + verifyFormat("asm(\"xyz\" : \"=a\"(a), \"=d\"(b) : \"a\"(data));"); + verifyFormat( + "asm(\"movq\\t%%rbx, %%rsi\\n\\t\"\n" + " \"cpuid\\n\\t\"\n" + " \"xchgq\\t%%rbx, %%rsi\\n\\t\"\n" + " : \"=a\" (*rEAX), \"=S\" (*rEBX), \"=c\" (*rECX), \"=d\" (*rEDX)\n" + " : \"a\"(value));"); +} + +TEST_F(FormatTest, FormatTryCatch) { + // FIXME: Handle try-catch explicitly in the UnwrappedLineParser, then we'll + // also not create single-line-blocks. + verifyFormat("try {\n" + " throw a * b;\n" + "}\n" + "catch (int a) {\n" + " // Do nothing.\n" + "}\n" + "catch (...) {\n" + " exit(42);\n" + "}"); + + // Function-level try statements. + verifyFormat("int f() try { return 4; }\n" + "catch (...) {\n" + " return 5;\n" + "}"); + verifyFormat("class A {\n" + " int a;\n" + " A() try : a(0) {}\n" + " catch (...) {\n" + " throw;\n" + " }\n" + "};\n"); +} + +TEST_F(FormatTest, FormatObjCTryCatch) { + verifyFormat("@try {\n" + " f();\n" + "}\n" + "@catch (NSException e) {\n" + " @throw;\n" + "}\n" + "@finally {\n" + " exit(42);\n" + "}"); +} + +TEST_F(FormatTest, StaticInitializers) { + verifyFormat("static SomeClass SC = { 1, 'a' };"); + + // FIXME: Format like enums if the static initializer does not fit on a line. + verifyFormat( + "static SomeClass WithALoooooooooooooooooooongName = {\n" + " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" + "};"); + + verifyFormat( + "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n" + " looooooooooooooooooooooooooooooooooongname,\n" + " looooooooooooooooooooooooooooooong };"); + // Allow bin-packing in static initializers as this would often lead to + // terrible results, e.g.: + verifyGoogleFormat( + "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n" + " looooooooooooooooooooooooooooooooooongname,\n" + " looooooooooooooooooooooooooooooong };"); +} + +TEST_F(FormatTest, NestedStaticInitializers) { + verifyFormat("static A x = { { {} } };\n"); + verifyFormat("static A x = { { { init1, init2, init3, init4 },\n" + " { init1, init2, init3, init4 } } };"); + + verifyFormat("somes Status::global_reps[3] = {\n" + " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n" + " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" + " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" + "};"); + verifyGoogleFormat("somes Status::global_reps[3] = {\n" + " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n" + " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" + " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" + "};"); + verifyFormat( + "CGRect cg_rect = { { rect.fLeft, rect.fTop },\n" + " { rect.fRight - rect.fLeft, rect.fBottom - rect.fTop" + " } };"); + + verifyFormat( + "SomeArrayOfSomeType a = { { { 1, 2, 3 }, { 1, 2, 3 },\n" + " { 111111111111111111111111111111,\n" + " 222222222222222222222222222222,\n" + " 333333333333333333333333333333 },\n" + " { 1, 2, 3 }, { 1, 2, 3 } } };"); + verifyFormat( + "SomeArrayOfSomeType a = { { { 1, 2, 3 } }, { { 1, 2, 3 } },\n" + " { { 111111111111111111111111111111,\n" + " 222222222222222222222222222222,\n" + " 333333333333333333333333333333 } },\n" + " { { 1, 2, 3 } }, { { 1, 2, 3 } } };"); + + // FIXME: We might at some point want to handle this similar to parameter + // lists, where we have an option to put each on a single line. + verifyFormat( + "struct {\n" + " unsigned bit;\n" + " const char *const name;\n" + "} kBitsToOs[] = { { kOsMac, \"Mac\" }, { kOsWin, \"Windows\" },\n" + " { kOsLinux, \"Linux\" }, { kOsCrOS, \"Chrome OS\" } };"); +} + +TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) { + verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro(" + " \\\n" + " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)"); +} + +TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) { + verifyFormat( + "virtual void\n" + "write(ELFWriter *writerrr, OwningPtr &buffer) = 0;"); +} + +TEST_F(FormatTest, LayoutUnknownPPDirective) { + EXPECT_EQ("#123 \"A string literal\"", + format(" # 123 \"A string literal\"")); + EXPECT_EQ("#;", format("#;")); + verifyFormat("#\n;\n;\n;"); +} + +TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) { + EXPECT_EQ("#line 42 \"test\"\n", + format("# \\\n line \\\n 42 \\\n \"test\"\n")); + EXPECT_EQ("#define A B\n", format("# \\\n define \\\n A \\\n B\n", + getLLVMStyleWithColumns(12))); +} + +TEST_F(FormatTest, EndOfFileEndsPPDirective) { + EXPECT_EQ("#line 42 \"test\"", + format("# \\\n line \\\n 42 \\\n \"test\"")); + EXPECT_EQ("#define A B", format("# \\\n define \\\n A \\\n B")); +} + +TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) { + verifyFormat("#define A(BB)", getLLVMStyleWithColumns(13)); + verifyFormat("#define A( \\\n BB)", getLLVMStyleWithColumns(12)); + verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12)); + // FIXME: We never break before the macro name. + verifyFormat("#define AA(\\\n B)", getLLVMStyleWithColumns(12)); + + verifyFormat("#define A A\n#define A A"); + verifyFormat("#define A(X) A\n#define A A"); + + verifyFormat("#define Something Other", getLLVMStyleWithColumns(23)); + verifyFormat("#define Something \\\n Other", getLLVMStyleWithColumns(22)); +} + +TEST_F(FormatTest, HandlePreprocessorDirectiveContext) { + EXPECT_EQ("// somecomment\n" + "#include \"a.h\"\n" + "#define A( \\\n" + " A, B)\n" + "#include \"b.h\"\n" + "// somecomment\n", + format(" // somecomment\n" + " #include \"a.h\"\n" + "#define A(A,\\\n" + " B)\n" + " #include \"b.h\"\n" + " // somecomment\n", + getLLVMStyleWithColumns(13))); +} + +TEST_F(FormatTest, LayoutSingleHash) { EXPECT_EQ("#\na;", format("#\na;")); } + +TEST_F(FormatTest, LayoutCodeInMacroDefinitions) { + EXPECT_EQ("#define A \\\n" + " c; \\\n" + " e;\n" + "f;", + format("#define A c; e;\n" + "f;", + getLLVMStyleWithColumns(14))); +} + +TEST_F(FormatTest, LayoutRemainingTokens) { EXPECT_EQ("{}", format("{}")); } + +TEST_F(FormatTest, LayoutSingleUnwrappedLineInMacro) { + EXPECT_EQ("# define A\\\n b;", + format("# define A b;", 11, 2, getLLVMStyleWithColumns(11))); +} + +TEST_F(FormatTest, MacroDefinitionInsideStatement) { + EXPECT_EQ("int x,\n" + "#define A\n" + " y;", + format("int x,\n#define A\ny;")); +} + +TEST_F(FormatTest, HashInMacroDefinition) { + verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11)); + verifyFormat("#define A \\\n" + " { \\\n" + " f(#c);\\\n" + " }", + getLLVMStyleWithColumns(11)); + + verifyFormat("#define A(X) \\\n" + " void function##X()", + getLLVMStyleWithColumns(22)); + + verifyFormat("#define A(a, b, c) \\\n" + " void a##b##c()", + getLLVMStyleWithColumns(22)); + + verifyFormat("#define A void # ## #", getLLVMStyleWithColumns(22)); +} + +TEST_F(FormatTest, RespectWhitespaceInMacroDefinitions) { + verifyFormat("#define A (1)"); +} + +TEST_F(FormatTest, EmptyLinesInMacroDefinitions) { + EXPECT_EQ("#define A b;", format("#define A \\\n" + " \\\n" + " b;", + getLLVMStyleWithColumns(25))); + EXPECT_EQ("#define A \\\n" + " \\\n" + " a; \\\n" + " b;", + format("#define A \\\n" + " \\\n" + " a; \\\n" + " b;", + getLLVMStyleWithColumns(11))); + EXPECT_EQ("#define A \\\n" + " a; \\\n" + " \\\n" + " b;", + format("#define A \\\n" + " a; \\\n" + " \\\n" + " b;", + getLLVMStyleWithColumns(11))); +} + +TEST_F(FormatTest, MacroDefinitionsWithIncompleteCode) { + verifyFormat("#define A :"); + + // FIXME: Improve formatting of case labels in macros. + verifyFormat("#define SOMECASES \\\n" + " case 1: \\\n" + " case 2\n", + getLLVMStyleWithColumns(20)); + + verifyFormat("#define A template "); + verifyFormat("#define STR(x) #x\n" + "f(STR(this_is_a_string_literal{));"); +} + +TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) { + EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}")); +} + +TEST_F(FormatTest, FormatHashIfNotAtStartOfLine) { + verifyFormat("{\n { a #c; }\n}"); +} + +TEST_F(FormatTest, FormatUnbalancedStructuralElements) { + EXPECT_EQ("#define A \\\n { \\\n {\nint i;", + format("#define A { {\nint i;", getLLVMStyleWithColumns(11))); + EXPECT_EQ("#define A \\\n } \\\n }\nint i;", + format("#define A } }\nint i;", getLLVMStyleWithColumns(11))); +} + +TEST_F(FormatTest, EscapedNewlineAtStartOfTokenInMacroDefinition) { + EXPECT_EQ( + "#define A \\\n int i; \\\n int j;", + format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11))); +} + +TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) { + verifyFormat("#define A \\\n" + " int v( \\\n" + " a); \\\n" + " int i;", + getLLVMStyleWithColumns(11)); +} + +TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) { + EXPECT_EQ( + "#define ALooooooooooooooooooooooooooooooooooooooongMacro(" + " \\\n" + " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" + "\n" + "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" + " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n", + format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro(" + "\\\n" + "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n" + " \n" + " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n" + " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n")); +} + +TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) { + EXPECT_EQ("int\n" + "#define A\n" + "a;", + format("int\n#define A\na;")); + verifyFormat("functionCallTo(\n" + " someOtherFunction(\n" + " withSomeParameters, whichInSequence,\n" + " areLongerThanALine(andAnotherCall,\n" + "#define A B\n" + " withMoreParamters,\n" + " whichStronglyInfluenceTheLayout),\n" + " andMoreParameters),\n" + " trailing);", + getLLVMStyleWithColumns(69)); +} + +TEST_F(FormatTest, LayoutBlockInsideParens) { + EXPECT_EQ("functionCall({\n" + " int i;\n" + "});", + format(" functionCall ( {int i;} );")); +} + +TEST_F(FormatTest, LayoutBlockInsideStatement) { + EXPECT_EQ("SOME_MACRO { int i; }\n" + "int i;", + format(" SOME_MACRO {int i;} int i;")); +} + +TEST_F(FormatTest, LayoutNestedBlocks) { + verifyFormat("void AddOsStrings(unsigned bitmask) {\n" + " struct s {\n" + " int i;\n" + " };\n" + " s kBitsToOs[] = { { 10 } };\n" + " for (int i = 0; i < 10; ++i)\n" + " return;\n" + "}"); +} + +TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) { + EXPECT_EQ("{}", format("{}")); + + // Negative test for enum. + verifyFormat("enum E {\n};"); + + // Note that when there's a missing ';', we still join... + verifyFormat("enum E {}"); +} + +//===----------------------------------------------------------------------===// +// Line break tests. +//===----------------------------------------------------------------------===// + +TEST_F(FormatTest, FormatsFunctionDefinition) { + verifyFormat("void f(int a, int b, int c, int d, int e, int f, int g," + " int h, int j, int f,\n" + " int c, int ddddddddddddd) {}"); +} + +TEST_F(FormatTest, FormatsAwesomeMethodCall) { + verifyFormat( + "SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n" + " parameter, parameter, parameter)),\n" + " SecondLongCall(parameter));"); +} + +TEST_F(FormatTest, PreventConfusingIndents) { + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[\n" + " aaaaaaaaaaaaaaaaaaaaaaaa[\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa],\n" + " aaaaaaaaaaaaaaaaaaaaaaaa];"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" + " aaaaaaaaaaaaaaaaaaaaaaaa<\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>,\n" + " aaaaaaaaaaaaaaaaaaaaaaaa>;"); + verifyFormat("int a = bbbb && ccc && fffff(\n" + "#define A Just forcing a new line\n" + " ddd);"); +} + +TEST_F(FormatTest, ConstructorInitializers) { + verifyFormat("Constructor() : Initializer(FitsOnTheLine) {}"); + verifyFormat("Constructor() : Inttializer(FitsOnTheLine) {}", + getLLVMStyleWithColumns(45)); + verifyFormat("Constructor()\n" + " : Inttializer(FitsOnTheLine) {}", + getLLVMStyleWithColumns(44)); + verifyFormat("Constructor()\n" + " : Inttializer(FitsOnTheLine) {}", + getLLVMStyleWithColumns(43)); + + verifyFormat( + "SomeClass::Constructor()\n" + " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); + + verifyFormat( + "SomeClass::Constructor()\n" + " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}"); + verifyFormat( + "SomeClass::Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}"); + + verifyFormat("Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaa() {}"); + + verifyFormat("Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); + + verifyFormat("Constructor(int Parameter = 0)\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaa(aaaaaaaaaaaaaaaaa) {}"); + + // Here a line could be saved by splitting the second initializer onto two + // lines, but that is not desireable. + verifyFormat("Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaa(aaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); + + FormatStyle OnePerLine = getLLVMStyle(); + OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true; + verifyFormat("SomeClass::Constructor()\n" + " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", + OnePerLine); + verifyFormat("SomeClass::Constructor()\n" + " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), // Some comment\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", + OnePerLine); + verifyFormat("MyClass::MyClass(int var)\n" + " : some_var_(var), // 4 space indent\n" + " some_other_var_(var + 1) { // lined up\n" + "}", + OnePerLine); + verifyFormat("Constructor()\n" + " : aaaaa(aaaaaa),\n" + " aaaaa(aaaaaa),\n" + " aaaaa(aaaaaa),\n" + " aaaaa(aaaaaa),\n" + " aaaaa(aaaaaa) {}", + OnePerLine); + + // This test takes VERY long when memoization is broken. + OnePerLine.BinPackParameters = false; + std::string input = "Constructor()\n" + " : aaaa(a,\n"; + for (unsigned i = 0, e = 80; i != e; ++i) { + input += " a,\n"; + } + input += " a) {}"; + verifyFormat(input, OnePerLine); +} + +TEST_F(FormatTest, BreaksAsHighAsPossible) { + verifyFormat( + "void f() {\n" + " if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n" + " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n" + " f();\n" + "}"); + verifyFormat("if (Intervals[i].getRange().getFirst() <\n" + " Intervals[i - 1].getRange().getLast()) {\n}"); +} + +TEST_F(FormatTest, BreaksDesireably) { + verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" + " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n" + " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {\n}"); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)) {\n" + "}"); + + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}"); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); + + verifyFormat( + "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" + " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));"); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" + " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + verifyFormat( + "void f() {\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" + "}"); + verifyFormat( + "aaaaaa(new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); + verifyFormat( + "aaaaaa(aaa, new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); + verifyFormat( + "aaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + // This test case breaks on an incorrect memoization, i.e. an optimization not + // taking into account the StopAt value. + verifyFormat( + "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" + " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n" + " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + verifyFormat("{\n {\n {\n" + " Annotation.SpaceRequiredBefore =\n" + " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n" + " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n" + " }\n }\n}"); +} + +TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { + FormatStyle NoBinPacking = getGoogleStyle(); + NoBinPacking.BinPackParameters = false; + verifyFormat("f(aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaa);", + NoBinPacking); + verifyFormat("aaaaaaa(aaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));", + NoBinPacking); + verifyFormat( + "aaaaaaaa(aaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n" + " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));", + NoBinPacking); + verifyFormat("aaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" + " .aaaaaaaaaaaaaaaaaa();", + NoBinPacking); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);", + NoBinPacking); + + verifyFormat( + "aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaa,\n" + " aaaaaaaaaaaa);", + NoBinPacking); + verifyFormat( + "somefunction(someotherFunction(ddddddddddddddddddddddddddddddddddd,\n" + " ddddddddddddddddddddddddddddd),\n" + " test);", + NoBinPacking); + + verifyFormat("std::vector aaaaaaaaaaaaaaaaaa;", + NoBinPacking); + verifyFormat("a(\"a\"\n" + " \"a\",\n" + " a);"); + + NoBinPacking.AllowAllParametersOfDeclarationOnNextLine = false; + verifyFormat("void aaaaaaaaaa(aaaaaaaaa,\n" + " aaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", + NoBinPacking); + verifyFormat( + "void f() {\n" + " aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" + " .aaaaaaa();\n" + "}", + NoBinPacking); +} + +TEST_F(FormatTest, FormatsBuilderPattern) { + verifyFormat( + "return llvm::StringSwitch(name)\n" + " .StartsWith(\".eh_frame_hdr\", ORDER_EH_FRAMEHDR)\n" + " .StartsWith(\".eh_frame\", ORDER_EH_FRAME).StartsWith(\".init\", ORDER_INIT)\n" + " .StartsWith(\".fini\", ORDER_FINI).StartsWith(\".hash\", ORDER_HASH)\n" + " .Default(ORDER_TEXT);\n"); + + verifyFormat("return aaaaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa() <\n" + " aaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa();"); + verifyFormat( + "aaaaaaa->aaaaaaa\n" + " ->aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " ->aaaaaaaa(aaaaaaaaaaaaaaa);"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaa()->aaaaaa(bbbbb)->aaaaaaaaaaaaaaaaaaa( // break\n" + " aaaaaaaaaaaaaa);"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa = aaaaaa->aaaaaaaaaaaa()\n" + " ->aaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " ->aaaaaaaaaaaaaaaaa();"); +} + +TEST_F(FormatTest, DoesNotBreakTrailingAnnotation) { + verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); + verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" + " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); + verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" + " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}"); + verifyFormat( + "void aaaaaaaaaaaaaaaaaa()\n" + " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa));"); + verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " __attribute__((unused));"); + + // FIXME: This is bad indentation, but generally hard to distinguish from a + // function declaration. + verifyFormat( + "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + "GUARDED_BY(aaaaaaaaaaaa);"); +} + +TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) { + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n" + " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {\n}"); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" + " ccccccccccccccccccccccccc) {\n}"); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n" + " ccccccccccccccccccccccccc) {\n}"); + verifyFormat( + "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n" + " ccccccccccccccccccccccccc) {\n}"); + verifyFormat("return aaaa & AAAAAAAAAAAAAAAAAAAAAAAAAAAAA ||\n" + " bbbb & BBBBBBBBBBBBBBBBBBBBBBBBBBBBB ||\n" + " cccc & CCCCCCCCCCCCCCCCCCCCCCCCCC ||\n" + " dddd & DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD;"); + verifyFormat("if ((aaaaaaaaaa != aaaaaaaaaaaaaaa ||\n" + " aaaaaaaaaaaaaaaaaaaaaaaa() >= aaaaaaaaaaaaaaaaaaaa) &&\n" + " aaaaaaaaaaaaaaa != aa) {\n}"); +} + +TEST_F(FormatTest, BreaksAfterAssignments) { + verifyFormat( + "unsigned Cost =\n" + " TTI.getMemoryOpCost(I->getOpcode(), VectorTy, SI->getAlignment(),\n" + " SI->getPointerAddressSpaceee());\n"); + verifyFormat( + "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n" + " Line.Tokens.front().Tok.getLo(), Line.Tokens.back().Tok.getLoc());"); + + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa()\n" + " .aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);"); +} + +TEST_F(FormatTest, AlignsAfterAssignments) { + verifyFormat( + "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat("double LooooooooooooooooooooooooongResult =\n" + " aaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaa;"); +} + +TEST_F(FormatTest, AlignsAfterReturn) { + verifyFormat( + "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat( + "return aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" + " aaaaaaaaaaaaaaaaaaaaaa();"); + verifyFormat( + "return (aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n" + " aaaaaaaaaaaaaaaaaaaaaa());"); +} + +TEST_F(FormatTest, BreaksConditionalExpressions) { + verifyFormat( + "aaaa(aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat( + "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaa ? aaaa(aaaaaa)\n" + " : aaaaaaaaaaaaa);"); + verifyFormat( + "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaa);"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaaa;"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaa;"); + verifyFormat("f(aaaaaaaaaaaaaaaa == // force break\n" + " aaaaaaaaa\n" + " ? b\n" + " : c);"); + verifyFormat( + "unsigned Indent =\n" + " format(TheLine.First, IndentForLevel[TheLine.Level] >= 0\n" + " ? IndentForLevel[TheLine.Level]\n" + " : TheLine * 2,\n" + " TheLine.InPPDirective, PreviousEndOfLineColumn);", + getLLVMStyleWithColumns(70)); + + FormatStyle NoBinPacking = getLLVMStyle(); + NoBinPacking.BinPackParameters = false; + verifyFormat( + "void f() {\n" + " g(aaa,\n" + " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaa);\n" + "}", + NoBinPacking); +} + +TEST_F(FormatTest, DeclarationsOfMultipleVariables) { + verifyFormat("bool aaaaaaaaaaaaaaaaa = aaaaaa->aaaaaaaaaaaaaaaaa(),\n" + " aaaaaaaaaaa = aaaaaa->aaaaaaaaaaa();"); + verifyFormat("bool a = true, b = false;"); + + verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa),\n" + " bbbbbbbbbbbbbbbbbbbbbbbbb =\n" + " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(bbbbbbbbbbbbbbbb);"); + verifyFormat( + "bool aaaaaaaaaaaaaaaaaaaaa =\n" + " bbbbbbbbbbbbbbbbbbbbbbbbbbbb && cccccccccccccccccccccccccccc,\n" + " d = e && f;"); + verifyFormat("aaaaaaaaa a = aaaaaaaaaaaaaaaaaaaa, b = bbbbbbbbbbbbbbbbbbbb,\n" + " c = cccccccccccccccccccc, d = dddddddddddddddddddd;"); + verifyFormat("aaaaaaaaa *a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" + " *c = ccccccccccccccccccc, *d = ddddddddddddddddddd;"); + verifyFormat("aaaaaaaaa ***a = aaaaaaaaaaaaaaaaaaa, ***b = bbbbbbbbbbbbbbb,\n" + " ***c = ccccccccccccccccccc, ***d = ddddddddddddddd;"); + // FIXME: If multiple variables are defined, the "*" needs to move to the new + // line. Also fix indent for breaking after the type, this looks bad. + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa = aaaaaaaaaaaaaaaaaaa,\n" + " *b = bbbbbbbbbbbbbbbbbbb;"); + + // Not ideal, but pointer-with-type does not allow much here. + verifyGoogleFormat( + "aaaaaaaaa* a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n" + " *b = bbbbbbbbbbbbbbbbbbb, *d = ddddddddddddddddddd;"); +} + +TEST_F(FormatTest, ConditionalExpressionsInBrackets) { + verifyFormat("arr[foo ? bar : baz];"); + verifyFormat("f()[foo ? bar : baz];"); + verifyFormat("(a + b)[foo ? bar : baz];"); + verifyFormat("arr[foo ? (4 > 5 ? 4 : 5) : 5 < 5 ? 5 : 7];"); +} + +TEST_F(FormatTest, AlignsStringLiterals) { + verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n" + " \"short literal\");"); + verifyFormat( + "looooooooooooooooooooooooongFunction(\n" + " \"short literal\"\n" + " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");"); + verifyFormat("someFunction(\"Always break between multi-line\"\n" + " \" string literals\",\n" + " and, other, parameters);"); + EXPECT_EQ("fun + \"1243\" /* comment */\n" + " \"5678\";", + format("fun + \"1243\" /* comment */\n" + " \"5678\";", + getLLVMStyleWithColumns(28))); + EXPECT_EQ( + "aaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" + " \"aaaaaaaaaaaaaaaaaaaaa\"\n" + " \"aaaaaaaaaaaaaaaa\";", + format("aaaaaa =" + "\"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa " + "aaaaaaaaaaaaaaaaaaaaa\" " + "\"aaaaaaaaaaaaaaaa\";")); + verifyFormat("a = a + \"a\"\n" + " \"a\"\n" + " \"a\";"); + + verifyFormat( + "#define LL_FORMAT \"ll\"\n" + "printf(\"aaaaa: %d, bbbbbb: %\" LL_FORMAT \"d, cccccccc: %\" LL_FORMAT\n" + " \"d, ddddddddd: %\" LL_FORMAT \"d\");"); +} + +TEST_F(FormatTest, AlignsPipes) { + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n" + " << aaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" + " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n" + " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";"); + verifyFormat( + "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + + verifyFormat("return out << \"somepacket = {\\n\"\n" + " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n" + " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n" + " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n" + " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n" + " << \"}\";"); + + verifyFormat( + "llvm::outs() << \"aaaaaaaaaaaaaaaaa = \" << aaaaaaaaaaaaaaaaa\n" + " << \"bbbbbbbbbbbbbbbbb = \" << bbbbbbbbbbbbbbbbb\n" + " << \"ccccccccccccccccc = \" << ccccccccccccccccc\n" + " << \"ddddddddddddddddd = \" << ddddddddddddddddd\n" + " << \"eeeeeeeeeeeeeeeee = \" << eeeeeeeeeeeeeeeee;"); + verifyFormat("llvm::outs() << aaaaaaaaaaaaaaaaaaaaaaaa << \"=\"\n" + " << bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); + + verifyFormat( + "llvm::errs() << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); +} + +TEST_F(FormatTest, UnderstandsEquals) { + verifyFormat( + "aaaaaaaaaaaaaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); + verifyFormat( + "if (a) {\n" + " f();\n" + "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" + "}"); + + verifyFormat("if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " 100000000 + 10000000) {\n}"); +} + +TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) { + verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" + " .looooooooooooooooooooooooooooooooooooooongFunction();"); + + verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n" + " ->looooooooooooooooooooooooooooooooooooooongFunction();"); + + verifyFormat( + "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n" + " Parameter2);"); + + verifyFormat( + "ShortObject->shortFunction(\n" + " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n" + " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);"); + + verifyFormat("loooooooooooooongFunction(\n" + " LoooooooooooooongObject->looooooooooooooooongFunction());"); + + verifyFormat( + "function(LoooooooooooooooooooooooooooooooooooongObject\n" + " ->loooooooooooooooooooooooooooooooooooooooongFunction());"); + + verifyFormat("EXPECT_CALL(SomeObject, SomeFunction(Parameter))\n" + " .WillRepeatedly(Return(SomeValue));"); + verifyFormat("SomeMap[std::pair(aaaaaaaaaaaa, bbbbbbbbbbbbbbb)]\n" + " .insert(ccccccccccccccccccccccc);"); + verifyFormat( + "aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " .aaaaaaaaaaaaaaa(\n" + " aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa));"); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()) {\n" + "}"); + + // Here, it is not necessary to wrap at "." or "->". + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n" + " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}"); + verifyFormat( + "aaaaaaaaaaa->aaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n"); + + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa().aaaaaaaaaaaaaaaaa());"); + verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() *\n" + " aaaaaaaaa()->aaaaaa()->aaaaa());"); + verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() ||\n" + " aaaaaaaaa()->aaaaaa()->aaaaa());"); + + // FIXME: Should we break before .a()? + verifyFormat("aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).a();"); + + FormatStyle NoBinPacking = getLLVMStyle(); + NoBinPacking.BinPackParameters = false; + verifyFormat("aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" + " .aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" + " .aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", + NoBinPacking); +} + +TEST_F(FormatTest, WrapsTemplateDeclarations) { + verifyFormat("template \n" + "virtual void loooooooooooongFunction(int Param1, int Param2);"); + verifyFormat( + "template \n" + "using comment_to_xml_conversion = comment_to_xml_conversion;"); + verifyFormat("template \n" + "void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n" + " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);"); + verifyFormat( + "template \n" + "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n" + " int Paaaaaaaaaaaaaaaaaaaaram2);"); + verifyFormat( + "template \n" + "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat("template \n" + "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " int aaaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat( + "template \n" + "void f();"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + verifyFormat("a(\n" + " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));"); +} + +TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) { + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa());"); + + // FIXME: Should we have an extra indent after the second break? + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); + + // FIXME: Look into whether we should indent 4 from the start or 4 from + // "bbbbb..." here instead of what we are doing now. + verifyFormat( + "aaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb::\n" + " cccccccccccccccccccccccccccccccccccccccccccccc());"); + + // Breaking at nested name specifiers is generally not desirable. + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaa);"); + + verifyFormat( + "aaaaaaaaaaaaaaaaaa(aaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaa);", + getLLVMStyleWithColumns(74)); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); +} + +TEST_F(FormatTest, UnderstandsTemplateParameters) { + verifyFormat("A a;"); + verifyFormat("A > > a;"); + verifyFormat("A, 3>, 4> a;"); + verifyFormat("bool x = a < 1 || 2 > a;"); + verifyFormat("bool x = 5 < f();"); + verifyFormat("bool x = f() > 5;"); + verifyFormat("bool x = 5 < a::x;"); + verifyFormat("bool x = a < 4 ? a > 2 : false;"); + verifyFormat("bool x = f() ? a < 2 : a > 2;"); + + verifyGoogleFormat("A> a;"); + verifyGoogleFormat("A>> a;"); + verifyGoogleFormat("A>>> a;"); + verifyGoogleFormat("A > a;"); + verifyGoogleFormat("A > > a;"); + verifyGoogleFormat("A > > > a;"); + EXPECT_EQ("A>> a;", format("A >> a;", getGoogleStyle())); + EXPECT_EQ("A>> a;", format("A> > a;", getGoogleStyle())); + + verifyFormat("test >> a >> b;"); + verifyFormat("test << a >> b;"); + + verifyFormat("f();"); + verifyFormat("template void f() {}"); +} + +TEST_F(FormatTest, UnderstandsBinaryOperators) { + verifyFormat("COMPARE(a, ==, b);"); +} + +TEST_F(FormatTest, UnderstandsPointersToMembers) { + verifyFormat("int A::*x;"); + // FIXME: Recognize pointers to member functions. + //verifyFormat("int (S::*func)(void *);"); + verifyFormat("int(S::*func)(void *);"); + verifyFormat("(a->*f)();"); + verifyFormat("a->*x;"); + verifyFormat("(a.*f)();"); + verifyFormat("((*a).*f)();"); + verifyFormat("a.*x;"); +} + +TEST_F(FormatTest, UnderstandsUnaryOperators) { + verifyFormat("int a = -2;"); + verifyFormat("f(-1, -2, -3);"); + verifyFormat("a[-1] = 5;"); + verifyFormat("int a = 5 + -2;"); + verifyFormat("if (i == -1) {\n}"); + verifyFormat("if (i != -1) {\n}"); + verifyFormat("if (i > -1) {\n}"); + verifyFormat("if (i < -1) {\n}"); + verifyFormat("++(a->f());"); + verifyFormat("--(a->f());"); + verifyFormat("(a->f())++;"); + verifyFormat("a[42]++;"); + verifyFormat("if (!(a->f())) {\n}"); + + verifyFormat("a-- > b;"); + verifyFormat("b ? -a : c;"); + verifyFormat("n * sizeof char16;"); + verifyFormat("n * alignof char16;"); + verifyFormat("sizeof(char);"); + verifyFormat("alignof(char);"); + + verifyFormat("return -1;"); + verifyFormat("switch (a) {\n" + "case -1:\n" + " break;\n" + "}"); + verifyFormat("#define X -1"); + verifyFormat("#define X -kConstant"); + + verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { -5, +3 };"); + verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { +5, -3 };"); + + verifyFormat("int a = /* confusing comment */ -1;"); + // FIXME: The space after 'i' is wrong, but hopefully, this is a rare case. + verifyFormat("int a = i /* confusing comment */++;"); +} + +TEST_F(FormatTest, UndestandsOverloadedOperators) { + verifyFormat("bool operator<();"); + verifyFormat("bool operator>();"); + verifyFormat("bool operator=();"); + verifyFormat("bool operator==();"); + verifyFormat("bool operator!=();"); + verifyFormat("int operator+();"); + verifyFormat("int operator++();"); + verifyFormat("bool operator();"); + verifyFormat("bool operator()();"); + verifyFormat("bool operator[]();"); + verifyFormat("operator bool();"); + verifyFormat("operator int();"); + verifyFormat("operator void *();"); + verifyFormat("operator SomeType();"); + verifyFormat("operator SomeType();"); + verifyFormat("operator SomeType >();"); + verifyFormat("void *operator new(std::size_t size);"); + verifyFormat("void *operator new[](std::size_t size);"); + verifyFormat("void operator delete(void *ptr);"); + verifyFormat("void operator delete[](void *ptr);"); + + verifyFormat( + "ostream &operator<<(ostream &OutputStream,\n" + " SomeReallyLongType WithSomeReallyLongValue);"); + + verifyGoogleFormat("operator void*();"); + verifyGoogleFormat("operator SomeType>();"); +} + +TEST_F(FormatTest, UnderstandsNewAndDelete) { + verifyFormat("void f() {\n" + " A *a = new A;\n" + " A *a = new (placement) A;\n" + " delete a;\n" + " delete (A *)a;\n" + "}"); +} + +TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) { + verifyFormat("int *f(int *a) {}"); + verifyFormat("int main(int argc, char **argv) {}"); + verifyFormat("Test::Test(int b) : a(b * b) {}"); + verifyIndependentOfContext("f(a, *a);"); + verifyFormat("void g() { f(*a); }"); + verifyIndependentOfContext("int a = b * 10;"); + verifyIndependentOfContext("int a = 10 * b;"); + verifyIndependentOfContext("int a = b * c;"); + verifyIndependentOfContext("int a += b * c;"); + verifyIndependentOfContext("int a -= b * c;"); + verifyIndependentOfContext("int a *= b * c;"); + verifyIndependentOfContext("int a /= b * c;"); + verifyIndependentOfContext("int a = *b;"); + verifyIndependentOfContext("int a = *b * c;"); + verifyIndependentOfContext("int a = b * *c;"); + verifyIndependentOfContext("return 10 * b;"); + verifyIndependentOfContext("return *b * *c;"); + verifyIndependentOfContext("return a & ~b;"); + verifyIndependentOfContext("f(b ? *c : *d);"); + verifyIndependentOfContext("int a = b ? *c : *d;"); + verifyIndependentOfContext("*b = a;"); + verifyIndependentOfContext("a * ~b;"); + verifyIndependentOfContext("a * !b;"); + verifyIndependentOfContext("a * +b;"); + verifyIndependentOfContext("a * -b;"); + verifyIndependentOfContext("a * ++b;"); + verifyIndependentOfContext("a * --b;"); + verifyIndependentOfContext("a[4] * b;"); + verifyIndependentOfContext("a[a * a] = 1;"); + verifyIndependentOfContext("f() * b;"); + verifyIndependentOfContext("a * [self dostuff];"); + verifyIndependentOfContext("int x = a * (a + b);"); + verifyIndependentOfContext("(a *)(a + b);"); + verifyIndependentOfContext("int *pa = (int *)&a;"); + verifyIndependentOfContext("return sizeof(int **);"); + verifyIndependentOfContext("return sizeof(int ******);"); + verifyIndependentOfContext("return (int **&)a;"); + verifyFormat("void f(Type (*parameter)[10]) {}"); + verifyGoogleFormat("return sizeof(int**);"); + verifyIndependentOfContext("Type **A = static_cast(P);"); + verifyGoogleFormat("Type** A = static_cast(P);"); + // FIXME: The newline is wrong. + verifyFormat("auto a = [](int **&, int ***) {}\n;"); + + verifyIndependentOfContext("InvalidRegions[*R] = 0;"); + + verifyIndependentOfContext("A a;"); + verifyIndependentOfContext("A a;"); + verifyIndependentOfContext("A a;"); + verifyIndependentOfContext( + "const char *const p = reinterpret_cast(q);"); + verifyIndependentOfContext("A a;"); + verifyIndependentOfContext("void f(int *a = d * e, int *b = c * d);"); + verifyFormat("for (char **a = b; *a; ++a) {\n}"); + + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + verifyGoogleFormat("int main(int argc, char** argv) {}"); + verifyGoogleFormat("A a;"); + verifyGoogleFormat("A a;"); + verifyGoogleFormat("A a;"); + verifyGoogleFormat("A a;"); + verifyGoogleFormat("f(b ? *c : *d);"); + verifyGoogleFormat("int a = b ? *c : *d;"); + verifyGoogleFormat("Type* t = **x;"); + verifyGoogleFormat("Type* t = *++*x;"); + verifyGoogleFormat("*++*x;"); + verifyGoogleFormat("Type* t = const_cast(&*x);"); + verifyGoogleFormat("Type* t = x++ * y;"); + verifyGoogleFormat( + "const char* const p = reinterpret_cast(q);"); + + verifyIndependentOfContext("a = *(x + y);"); + verifyIndependentOfContext("a = &(x + y);"); + verifyIndependentOfContext("*(x + y).call();"); + verifyIndependentOfContext("&(x + y)->call();"); + verifyFormat("void f() { &(*I).first; }"); + + verifyIndependentOfContext("f(b * /* confusing comment */ ++c);"); + verifyFormat( + "int *MyValues = {\n" + " *A, // Operator detection might be confused by the '{'\n" + " *BB // Operator detection might be confused by previous comment\n" + "};"); + + verifyIndependentOfContext("if (int *a = &b)"); + verifyIndependentOfContext("if (int &a = *b)"); + verifyIndependentOfContext("if (a & b[i])"); + verifyIndependentOfContext("if (a::b::c::d & b[i])"); + verifyIndependentOfContext("if (*b[i])"); + verifyIndependentOfContext("if (int *a = (&b))"); + verifyIndependentOfContext("while (int *a = &b)"); + verifyFormat("void f() {\n" + " for (const int &v : Values) {\n" + " }\n" + "}"); + verifyFormat("for (int i = a * a; i < 10; ++i) {\n}"); + verifyFormat("for (int i = 0; i < a * a; ++i) {\n}"); + + verifyIndependentOfContext("A = new SomeType *[Length];"); + verifyIndependentOfContext("A = new SomeType *[Length]();"); + verifyGoogleFormat("A = new SomeType* [Length]();"); + verifyGoogleFormat("A = new SomeType* [Length];"); +} + +TEST_F(FormatTest, AdaptivelyFormatsPointersAndReferences) { + EXPECT_EQ("int *a;\n" + "int *a;\n" + "int *a;", + format("int *a;\n" + "int* a;\n" + "int *a;", + getGoogleStyle())); + EXPECT_EQ("int* a;\n" + "int* a;\n" + "int* a;", + format("int* a;\n" + "int* a;\n" + "int *a;", + getGoogleStyle())); + EXPECT_EQ("int *a;\n" + "int *a;\n" + "int *a;", + format("int *a;\n" + "int * a;\n" + "int * a;", + getGoogleStyle())); +} + +TEST_F(FormatTest, UnderstandsRvalueReferences) { + verifyFormat("int f(int &&a) {}"); + verifyFormat("int f(int a, char &&b) {}"); + verifyFormat("void f() { int &&a = b; }"); + verifyGoogleFormat("int f(int a, char&& b) {}"); + verifyGoogleFormat("void f() { int&& a = b; }"); + + // FIXME: These require somewhat deeper changes in template arguments + // formatting. + // verifyIndependentOfContext("A a;"); + // verifyIndependentOfContext("A a;"); + // verifyGoogleFormat("A a;"); + // verifyGoogleFormat("A a;"); +} + +TEST_F(FormatTest, FormatsBinaryOperatorsPrecedingEquals) { + verifyFormat("void f() {\n" + " x[aaaaaaaaa -\n" + " b] = 23;\n" + "}", + getLLVMStyleWithColumns(15)); +} + +TEST_F(FormatTest, FormatsCasts) { + verifyFormat("Type *A = static_cast(P);"); + verifyFormat("Type *A = (Type *)P;"); + verifyFormat("Type *A = (vector)P;"); + verifyFormat("int a = (int)(2.0f);"); + + // FIXME: These also need to be identified. + verifyFormat("int a = (int) 2.0f;"); + verifyFormat("int a = (int) * b;"); + + // These are not casts. + verifyFormat("void f(int *) {}"); + verifyFormat("f(foo)->b;"); + verifyFormat("f(foo).b;"); + verifyFormat("f(foo)(b);"); + verifyFormat("f(foo)[b];"); + verifyFormat("[](foo) { return 4; }(bar)];"); + verifyFormat("(*funptr)(foo)[4];"); + verifyFormat("funptrs[4](foo)[4];"); + verifyFormat("void f(int *);"); + verifyFormat("void f(int *) = 0;"); + verifyFormat("void f(SmallVector) {}"); + verifyFormat("void f(SmallVector);"); + verifyFormat("void f(SmallVector) = 0;"); + verifyFormat("void f(int i = (kValue) * kMask) {}"); + verifyFormat("void f(int i = (kA * kB) & kMask) {}"); + verifyFormat("int a = sizeof(int) * b;"); + verifyFormat("int a = alignof(int) * b;"); + + // These are not casts, but at some point were confused with casts. + verifyFormat("virtual void foo(int *) override;"); + verifyFormat("virtual void foo(char &) const;"); + verifyFormat("virtual void foo(int *a, char *) const;"); + verifyFormat("int a = sizeof(int *) + b;"); + verifyFormat("int a = alignof(int *) + b;"); +} + +TEST_F(FormatTest, FormatsFunctionTypes) { + verifyFormat("A a;"); + verifyFormat("A a;"); + verifyFormat("A a;"); + verifyFormat("A;"); + verifyFormat("void *(*a)(int *, SomeType *);"); + + // FIXME: Inconsistent. + verifyFormat("int (*func)(void *);"); + verifyFormat("void f() { int(*func)(void *); }"); + + verifyGoogleFormat("A;"); + verifyGoogleFormat("void* (*a)(int);"); +} + +TEST_F(FormatTest, BreaksLongDeclarations) { + verifyFormat("int *someFunction(int LoooooooooooooooooooongParam1,\n" + " int LoooooooooooooooooooongParam2) {}"); + verifyFormat( + "TypeSpecDecl *\n" + "TypeSpecDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation L,\n" + " IdentifierIn *II, Type *T) {}"); + verifyFormat("ReallyLongReturnType\n" + "ReallyReallyLongFunctionName(\n" + " const std::string &SomeParameter,\n" + " const SomeType &\n" + " ReallyReallyLongParameterName,\n" + " const SomeType &\n" + " AnotherLongParameterName) {}"); + verifyFormat( + "aaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaa\n" + "aaaaaaaaaaaaaaaaaaaaaaa;"); + + verifyGoogleFormat( + "TypeSpecDecl* TypeSpecDecl::Create(ASTContext& C, DeclContext* DC,\n" + " SourceLocation L) {}"); + verifyGoogleFormat( + "some_namespace::LongReturnType\n" + "long_namespace::SomeVeryLongClass::SomeVeryLongFunction(\n" + " int first_long_parameter, int second_parameter) {}"); + + verifyGoogleFormat("template \n" + "aaaaaaaa::aaaaa::aaaaaa\n" + "aaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaa() {}"); + verifyGoogleFormat("A> aaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " int aaaaaaaaaaaaaaaaaaaaaaa);"); +} + +TEST_F(FormatTest, LineStartsWithSpecialCharacter) { + verifyFormat("(a)->b();"); + verifyFormat("--a;"); +} + +TEST_F(FormatTest, HandlesIncludeDirectives) { + verifyFormat("#include \n" + "#include \n" + "#include \"a/b/string\"\n" + "#include \"string.h\"\n" + "#include \"string.h\"\n" + "#include \n" + "#include < path with space >\n" + "#include \"some very long include paaaaaaaaaaaaaaaaaaaaaaath\"", + getLLVMStyleWithColumns(35)); + + verifyFormat("#import "); + verifyFormat("#import "); + verifyFormat("#import \"a/b/string\""); + verifyFormat("#import \"string.h\""); + verifyFormat("#import \"string.h\""); +} + +//===----------------------------------------------------------------------===// +// Error recovery tests. +//===----------------------------------------------------------------------===// + +TEST_F(FormatTest, IncompleteParameterLists) { + FormatStyle NoBinPacking = getLLVMStyle(); + NoBinPacking.BinPackParameters = false; + verifyFormat("void aaaaaaaaaaaaaaaaaa(int level,\n" + " double *min_x,\n" + " double *max_x,\n" + " double *min_y,\n" + " double *max_y,\n" + " double *min_z,\n" + " double *max_z, ) {}", + NoBinPacking); +} + +TEST_F(FormatTest, IncorrectCodeTrailingStuff) { + verifyFormat("void f() { return; }\n42"); + verifyFormat("void f() {\n" + " if (0)\n" + " return;\n" + "}\n" + "42"); + verifyFormat("void f() { return }\n42"); + verifyFormat("void f() {\n" + " if (0)\n" + " return\n" + "}\n" + "42"); +} + +TEST_F(FormatTest, IncorrectCodeMissingSemicolon) { + EXPECT_EQ("void f() { return }", format("void f ( ) { return }")); + EXPECT_EQ("void f() {\n" + " if (a)\n" + " return\n" + "}", + format("void f ( ) { if ( a ) return }")); + EXPECT_EQ("namespace N { void f() }", format("namespace N { void f() }")); + EXPECT_EQ("namespace N {\n" + "void f() {}\n" + "void g()\n" + "}", + format("namespace N { void f( ) { } void g( ) }")); +} + +TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) { + verifyFormat("int aaaaaaaa =\n" + " // Overlylongcomment\n" + " b;", + getLLVMStyleWithColumns(20)); + verifyFormat("function(\n" + " ShortArgument,\n" + " LoooooooooooongArgument);\n", + getLLVMStyleWithColumns(20)); +} + +TEST_F(FormatTest, IncorrectAccessSpecifier) { + verifyFormat("public:"); + verifyFormat("class A {\n" + "public\n" + " void f() {}\n" + "};"); + verifyFormat("public\n" + "int qwerty;"); + verifyFormat("public\n" + "B {}"); + verifyFormat("public\n" + "{}"); + verifyFormat("public\n" + "B { int x; }"); +} + +TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) { + verifyFormat("{"); + verifyFormat("#})"); +} + +TEST_F(FormatTest, IncorrectCodeDoNoWhile) { + verifyFormat("do {\n}"); + verifyFormat("do {\n}\n" + "f();"); + verifyFormat("do {\n}\n" + "wheeee(fun);"); + verifyFormat("do {\n" + " f();\n" + "}"); +} + +TEST_F(FormatTest, IncorrectCodeMissingParens) { + verifyFormat("if {\n foo;\n foo();\n}"); + verifyFormat("switch {\n foo;\n foo();\n}"); + verifyFormat("for {\n foo;\n foo();\n}"); + verifyFormat("while {\n foo;\n foo();\n}"); + verifyFormat("do {\n foo;\n foo();\n} while;"); +} + +TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) { + verifyFormat("namespace {\n" + "class Foo { Foo ( }; } // comment"); +} + +TEST_F(FormatTest, IncorrectCodeErrorDetection) { + EXPECT_EQ("{\n{}\n", format("{\n{\n}\n")); + EXPECT_EQ("{\n {}\n", format("{\n {\n}\n")); + EXPECT_EQ("{\n {}\n", format("{\n {\n }\n")); + EXPECT_EQ("{\n {}\n }\n}\n", format("{\n {\n }\n }\n}\n")); + + EXPECT_EQ("{\n" + " {\n" + " breakme(\n" + " qwe);\n" + "}\n", + format("{\n" + " {\n" + " breakme(qwe);\n" + "}\n", + getLLVMStyleWithColumns(10))); +} + +TEST_F(FormatTest, LayoutCallsInsideBraceInitializers) { + verifyFormat("int x = {\n" + " avariable,\n" + " b(alongervariable)\n" + "};", + getLLVMStyleWithColumns(25)); +} + +TEST_F(FormatTest, LayoutBraceInitializersInReturnStatement) { + verifyFormat("return (a)(b) { 1, 2, 3 };"); +} + +TEST_F(FormatTest, LayoutTokensFollowingBlockInParentheses) { + // FIXME: This is bad, find a better and more generic solution. + verifyFormat( + "Aaa({\n" + " int i;\n" + "},\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" + " ccccccccccccccccc));"); +} + +TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) { + verifyFormat("void f() { return 42; }"); + verifyFormat("void f() {\n" + " // Comment\n" + "}"); + verifyFormat("{\n" + "#error {\n" + " int a;\n" + "}"); + verifyFormat("{\n" + " int a;\n" + "#error {\n" + "}"); + + verifyFormat("void f() { return 42; }", getLLVMStyleWithColumns(23)); + verifyFormat("void f() {\n return 42;\n}", getLLVMStyleWithColumns(22)); + + verifyFormat("void f() {}", getLLVMStyleWithColumns(11)); + verifyFormat("void f() {\n}", getLLVMStyleWithColumns(10)); +} + +TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) { + // Elaborate type variable declarations. + verifyFormat("struct foo a = { bar };\nint n;"); + verifyFormat("class foo a = { bar };\nint n;"); + verifyFormat("union foo a = { bar };\nint n;"); + + // Elaborate types inside function definitions. + verifyFormat("struct foo f() {}\nint n;"); + verifyFormat("class foo f() {}\nint n;"); + verifyFormat("union foo f() {}\nint n;"); + + // Templates. + verifyFormat("template void f() {}\nint n;"); + verifyFormat("template void f() {}\nint n;"); + verifyFormat("template void f() {}\nint n;"); + + // Actual definitions... + verifyFormat("struct {\n} n;"); + verifyFormat( + "template