blob: 495fc7fee176fbb46ccc29912fa7a22e2141a5a6 [file] [log] [blame]
Daniel Jasperbac016b2012-12-03 18:12:45 +00001//===- 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
Chandler Carruth1050e8b2012-12-04 09:45:34 +000010#include "clang/Format/Format.h"
Daniel Jasperbac016b2012-12-03 18:12:45 +000011#include "../Tooling/RewriterTestContext.h"
12#include "clang/Lex/Lexer.h"
Daniel Jasperbac016b2012-12-03 18:12:45 +000013#include "gtest/gtest.h"
14
15namespace clang {
16namespace format {
17
18class FormatTest : public ::testing::Test {
19protected:
20 std::string format(llvm::StringRef Code, unsigned Offset, unsigned Length,
21 const FormatStyle &Style) {
22 RewriterTestContext Context;
23 FileID ID = Context.createInMemoryFile("input.cc", Code);
24 SourceLocation Start =
25 Context.Sources.getLocForStartOfFile(ID).getLocWithOffset(Offset);
26 std::vector<CharSourceRange> Ranges(
27 1,
28 CharSourceRange::getCharRange(Start, Start.getLocWithOffset(Length)));
29 LangOptions LangOpts;
30 LangOpts.CPlusPlus = 1;
Daniel Jasperba3d3072013-01-02 17:21:36 +000031 LangOpts.CPlusPlus11 = 1;
Nico Weberefcfe732013-01-07 15:17:23 +000032 LangOpts.ObjC1 = 1;
Nico Weber6092d4e2013-01-07 19:05:19 +000033 LangOpts.ObjC2 = 1;
Daniel Jasperbac016b2012-12-03 18:12:45 +000034 Lexer Lex(ID, Context.Sources.getBuffer(ID), Context.Sources, LangOpts);
Daniel Jaspercd162382013-01-07 13:26:07 +000035 tooling::Replacements Replace = reformat(Style, Lex, Context.Sources,
36 Ranges);
Daniel Jasperbac016b2012-12-03 18:12:45 +000037 EXPECT_TRUE(applyAllReplacements(Replace, Context.Rewrite));
38 return Context.getRewrittenText(ID);
39 }
40
41 std::string format(llvm::StringRef Code,
42 const FormatStyle &Style = getLLVMStyle()) {
43 return format(Code, 0, Code.size(), Style);
44 }
45
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000046 std::string messUp(llvm::StringRef Code) {
47 std::string MessedUp(Code.str());
48 bool InComment = false;
49 bool JustReplacedNewline = false;
50 for (unsigned i = 0, e = MessedUp.size() - 1; i != e; ++i) {
51 if (MessedUp[i] == '/' && MessedUp[i + 1] == '/') {
52 if (JustReplacedNewline)
53 MessedUp[i - 1] = '\n';
54 InComment = true;
Manuel Klimekd4397b92013-01-04 23:34:14 +000055 } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') {
56 MessedUp[i] = ' ';
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000057 } else if (MessedUp[i] == '\n') {
58 if (InComment) {
59 InComment = false;
60 } else {
61 JustReplacedNewline = true;
62 MessedUp[i] = ' ';
63 }
Manuel Klimekd4397b92013-01-04 23:34:14 +000064 } else if (MessedUp[i] != ' ') {
65 JustReplacedNewline = false;
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000066 }
Daniel Jasperbac016b2012-12-03 18:12:45 +000067 }
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000068 return MessedUp;
69 }
70
Manuel Klimek060143e2013-01-02 18:33:23 +000071 FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) {
72 FormatStyle Style = getLLVMStyle();
73 Style.ColumnLimit = ColumnLimit;
74 return Style;
75 }
76
77 void verifyFormat(llvm::StringRef Code,
78 const FormatStyle &Style = getLLVMStyle()) {
79 EXPECT_EQ(Code.str(), format(messUp(Code), Style));
Daniel Jasperbac016b2012-12-03 18:12:45 +000080 }
81
82 void verifyGoogleFormat(llvm::StringRef Code) {
Manuel Klimek060143e2013-01-02 18:33:23 +000083 verifyFormat(Code, getGoogleStyle());
Daniel Jasperbac016b2012-12-03 18:12:45 +000084 }
85};
86
Alexander Kornienko15757312012-12-06 18:03:27 +000087//===----------------------------------------------------------------------===//
88// Basic function tests.
89//===----------------------------------------------------------------------===//
90
Daniel Jasperbac016b2012-12-03 18:12:45 +000091TEST_F(FormatTest, DoesNotChangeCorrectlyFormatedCode) {
92 EXPECT_EQ(";", format(";"));
93}
94
95TEST_F(FormatTest, FormatsGlobalStatementsAt0) {
96 EXPECT_EQ("int i;", format(" int i;"));
97 EXPECT_EQ("\nint i;", format(" \n\t \r int i;"));
98 EXPECT_EQ("int i;\nint j;", format(" int i; int j;"));
99 EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;"));
100}
101
102TEST_F(FormatTest, FormatsUnwrappedLinesAtFirstFormat) {
103 EXPECT_EQ("int i;", format("int\ni;"));
104}
105
106TEST_F(FormatTest, FormatsNestedBlockStatements) {
107 EXPECT_EQ("{\n {\n {\n }\n }\n}", format("{{{}}}"));
108}
109
Alexander Kornienko15757312012-12-06 18:03:27 +0000110TEST_F(FormatTest, FormatsNestedCall) {
111 verifyFormat("Method(f1, f2(f3));");
112 verifyFormat("Method(f1(f2, f3()));");
113}
114
Alexander Kornienko15757312012-12-06 18:03:27 +0000115//===----------------------------------------------------------------------===//
116// Tests for control statements.
117//===----------------------------------------------------------------------===//
118
119TEST_F(FormatTest, FormatIfWithoutCompountStatement) {
120 verifyFormat("if (true)\n f();\ng();");
121 verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();");
122 verifyFormat("if (a)\n if (b) {\n f();\n }\ng();");
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000123 verifyFormat("if (a)\n"
124 " // comment\n"
125 " f();");
Alexander Kornienko15757312012-12-06 18:03:27 +0000126}
127
128TEST_F(FormatTest, ParseIfElse) {
129 verifyFormat("if (true)\n"
130 " if (true)\n"
131 " if (true)\n"
132 " f();\n"
133 " else\n"
134 " g();\n"
135 " else\n"
136 " h();\n"
137 "else\n"
138 " i();");
139 verifyFormat("if (true)\n"
140 " if (true)\n"
141 " if (true) {\n"
142 " if (true)\n"
143 " f();\n"
144 " } else {\n"
145 " g();\n"
146 " }\n"
147 " else\n"
148 " h();\n"
149 "else {\n"
150 " i();\n"
151 "}");
152}
153
154TEST_F(FormatTest, ElseIf) {
155 verifyFormat("if (a) {\n"
156 "} else if (b) {\n"
157 "}");
158 verifyFormat("if (a)\n"
159 " f();\n"
160 "else if (b)\n"
161 " g();\n"
162 "else\n"
163 " h();");
164}
165
Daniel Jasperbac016b2012-12-03 18:12:45 +0000166TEST_F(FormatTest, FormatsForLoop) {
167 verifyFormat(
168 "for (int VeryVeryLongLoopVariable = 0; VeryVeryLongLoopVariable < 10;\n"
Alexander Kornienko2e97cfc2012-12-05 15:06:06 +0000169 " ++VeryVeryLongLoopVariable)\n"
170 " ;");
171 verifyFormat("for (;;)\n"
172 " f();");
173 verifyFormat("for (;;) {\n"
174 "}");
175 verifyFormat("for (;;) {\n"
176 " f();\n"
177 "}");
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000178
179 verifyFormat(
180 "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n"
181 " E = UnwrappedLines.end();\n"
182 " I != E; ++I) {\n}");
183
184 verifyFormat(
185 "for (MachineFun::iterator IIII = PrevIt, EEEE = F.end(); IIII != EEEE;\n"
186 " ++IIIII) {\n}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000187}
188
189TEST_F(FormatTest, FormatsWhileLoop) {
190 verifyFormat("while (true) {\n}");
Alexander Kornienko2e97cfc2012-12-05 15:06:06 +0000191 verifyFormat("while (true)\n"
192 " f();");
193 verifyFormat("while () {\n"
194 "}");
195 verifyFormat("while () {\n"
196 " f();\n"
197 "}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000198}
199
Alexander Kornienko15757312012-12-06 18:03:27 +0000200TEST_F(FormatTest, FormatsDoWhile) {
201 verifyFormat("do {\n"
202 " do_something();\n"
203 "} while (something());");
204 verifyFormat("do\n"
205 " do_something();\n"
206 "while (something());");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000207}
208
Alexander Kornienko15757312012-12-06 18:03:27 +0000209TEST_F(FormatTest, FormatsSwitchStatement) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000210 verifyFormat("switch (x) {\n"
211 "case 1:\n"
212 " f();\n"
213 " break;\n"
214 "case kFoo:\n"
215 "case ns::kBar:\n"
216 "case kBaz:\n"
217 " break;\n"
218 "default:\n"
219 " g();\n"
220 " break;\n"
221 "}");
222 verifyFormat("switch (x) {\n"
223 "case 1: {\n"
224 " f();\n"
225 " break;\n"
226 "}\n"
227 "}");
228 verifyFormat("switch (test)\n"
229 " ;");
Alexander Kornienko15757312012-12-06 18:03:27 +0000230 verifyGoogleFormat("switch (x) {\n"
231 " case 1:\n"
232 " f();\n"
233 " break;\n"
234 " case kFoo:\n"
235 " case ns::kBar:\n"
236 " case kBaz:\n"
237 " break;\n"
238 " default:\n"
239 " g();\n"
240 " break;\n"
241 "}");
242 verifyGoogleFormat("switch (x) {\n"
243 " case 1: {\n"
244 " f();\n"
245 " break;\n"
246 " }\n"
247 "}");
248 verifyGoogleFormat("switch (test)\n"
249 " ;");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000250}
251
Alexander Kornienko15757312012-12-06 18:03:27 +0000252TEST_F(FormatTest, FormatsLabels) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000253 verifyFormat("void f() {\n"
254 " some_code();\n"
255 "test_label:\n"
256 " some_other_code();\n"
257 " {\n"
258 " some_more_code();\n"
259 " another_label:\n"
260 " some_more_code();\n"
261 " }\n"
262 "}");
263 verifyFormat("some_code();\n"
264 "test_label:\n"
265 "some_other_code();");
266}
267
Alexander Kornienko15757312012-12-06 18:03:27 +0000268//===----------------------------------------------------------------------===//
269// Tests for comments.
270//===----------------------------------------------------------------------===//
271
272TEST_F(FormatTest, UnderstandsSingleLineComments) {
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000273 verifyFormat("// line 1\n"
274 "// line 2\n"
275 "void f() {\n}\n");
Alexander Kornienko15757312012-12-06 18:03:27 +0000276
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000277 verifyFormat("void f() {\n"
278 " // Doesn't do anything\n"
279 "}");
Alexander Kornienko15757312012-12-06 18:03:27 +0000280
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000281 verifyFormat("int i // This is a fancy variable\n"
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000282 " = 5;");
Alexander Kornienko15757312012-12-06 18:03:27 +0000283
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000284 verifyFormat("enum E {\n"
285 " // comment\n"
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000286 " VAL_A, // comment\n"
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000287 " VAL_B\n"
288 "};");
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000289
290 verifyFormat(
291 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000292 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // Trailing comment");
Daniel Jasper043835a2013-01-09 09:33:39 +0000293 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
294 " // Comment inside a statement.\n"
295 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;");
Manuel Klimek6cf58142013-01-07 08:54:53 +0000296
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000297 EXPECT_EQ("int i; // single line trailing comment",
Manuel Klimek6cf58142013-01-07 08:54:53 +0000298 format("int i;\\\n// single line trailing comment"));
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000299
300 verifyGoogleFormat("int a; // Trailing comment.");
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000301}
302
303TEST_F(FormatTest, UnderstandsMultiLineComments) {
Alexander Kornienko15757312012-12-06 18:03:27 +0000304 verifyFormat("f(/*test=*/ true);");
305}
306
Alexander Kornienko15757312012-12-06 18:03:27 +0000307//===----------------------------------------------------------------------===//
308// Tests for classes, namespaces, etc.
309//===----------------------------------------------------------------------===//
310
311TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) {
312 verifyFormat("class A {\n};");
313}
314
315TEST_F(FormatTest, UnderstandsAccessSpecifiers) {
316 verifyFormat("class A {\n"
317 "public:\n"
318 "protected:\n"
319 "private:\n"
320 " void f() {\n"
321 " }\n"
322 "};");
323 verifyGoogleFormat("class A {\n"
324 " public:\n"
325 " protected:\n"
326 " private:\n"
327 " void f() {\n"
328 " }\n"
329 "};");
330}
331
332TEST_F(FormatTest, FormatsDerivedClass) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000333 verifyFormat("class A : public B {\n"
334 "};");
Daniel Jasperc74e2792012-12-07 09:52:15 +0000335 verifyFormat("class A : public ::B {\n"
336 "};");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000337}
338
Manuel Klimekde768542013-01-07 18:10:23 +0000339TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) {
340 verifyFormat("class A {\n"
341 "} a, b;");
342 verifyFormat("struct A {\n"
343 "} a, b;");
344}
345
Alexander Kornienko15757312012-12-06 18:03:27 +0000346TEST_F(FormatTest, FormatsEnum) {
Alexander Kornienkoa166e732012-12-04 14:46:19 +0000347 verifyFormat("enum {\n"
348 " Zero,\n"
349 " One = 1,\n"
350 " Two = One + 1,\n"
351 " Three = (One + Two),\n"
352 " Four = (Zero && (One ^ Two)) | (One << Two),\n"
353 " Five = (One, Two, Three, Four, 5)\n"
354 "};");
355 verifyFormat("enum Enum {\n"
356 "};");
357 verifyFormat("enum {\n"
358 "};");
359}
360
Alexander Kornienko15757312012-12-06 18:03:27 +0000361TEST_F(FormatTest, FormatsNamespaces) {
362 verifyFormat("namespace some_namespace {\n"
363 "class A {\n"
364 "};\n"
365 "void f() {\n"
366 " f();\n"
367 "}\n"
368 "}");
369 verifyFormat("namespace {\n"
370 "class A {\n"
371 "};\n"
372 "void f() {\n"
373 " f();\n"
374 "}\n"
375 "}");
Dmitri Gribenko1f94f2b2012-12-30 21:27:25 +0000376 verifyFormat("inline namespace X {\n"
377 "class A {\n"
378 "};\n"
379 "void f() {\n"
380 " f();\n"
381 "}\n"
382 "}");
Alexander Kornienko15757312012-12-06 18:03:27 +0000383 verifyFormat("using namespace some_namespace;\n"
384 "class A {\n"
385 "};\n"
386 "void f() {\n"
387 " f();\n"
388 "}");
389}
390
Nico Webera9ccdd12013-01-07 16:36:17 +0000391TEST_F(FormatTest, FormatTryCatch) {
392 verifyFormat("try {\n"
393 " throw a * b;\n"
394 "}\n"
395 "catch (int a) {\n"
396 " // Do nothing.\n"
397 "}\n"
398 "catch (...) {\n"
399 " exit(42);\n"
400 "}");
401
402 // Function-level try statements.
403 verifyFormat("int f() try {\n"
404 " return 4;\n"
405 "}\n"
406 "catch (...) {\n"
407 " return 5;\n"
408 "}");
409 verifyFormat("class A {\n"
410 " int a;\n"
411 " A() try : a(0) {\n"
412 " }\n"
413 " catch (...) {\n"
414 " throw;\n"
415 " }\n"
416 "};\n");
417}
418
419TEST_F(FormatTest, FormatObjCTryCatch) {
420 verifyFormat("@try {\n"
421 " f();\n"
422 "}\n"
423 "@catch (NSException e) {\n"
424 " @throw;\n"
425 "}\n"
426 "@finally {\n"
427 " exit(42);\n"
428 "}");
429}
430
Nico Weber6092d4e2013-01-07 19:05:19 +0000431TEST_F(FormatTest, FormatObjCInterface) {
432 verifyFormat("@interface Foo : NSObject<NSSomeDelegate> {\n"
433 "@public\n"
434 " int field1;\n"
435 "@protected\n"
436 " int field2;\n"
437 "@private\n"
438 " int field3;\n"
439 "@package\n"
440 " int field4;\n"
441 "}\n"
442 "+ (id)init;\n"
443 "@end");
444
445 verifyGoogleFormat("@interface Foo : NSObject<NSSomeDelegate> {\n"
446 " @public\n"
447 " int field1;\n"
448 " @protected\n"
449 " int field2;\n"
450 " @private\n"
451 " int field3;\n"
452 " @package\n"
453 " int field4;\n"
454 "}\n"
455 "+ (id)init;\n"
456 "@end");
457}
458
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000459TEST_F(FormatTest, StaticInitializers) {
460 verifyFormat("static SomeClass SC = { 1, 'a' };");
461
462 // FIXME: Format like enums if the static initializer does not fit on a line.
463 verifyFormat(
Daniel Jasper9cda8002013-01-07 13:08:40 +0000464 "static SomeClass WithALoooooooooooooooooooongName = {\n"
465 " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" };");
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000466}
467
Manuel Klimeka080a182013-01-02 16:30:12 +0000468TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) {
469 verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro("
470 " \\\n"
471 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)");
472}
473
Daniel Jasper71607512013-01-07 10:48:50 +0000474TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) {
Daniel Jaspercd162382013-01-07 13:26:07 +0000475 verifyFormat("virtual void write(ELFWriter *writerrr,\n"
476 " OwningPtr<FileOutputBuffer> &buffer) = 0;");
Daniel Jasper71607512013-01-07 10:48:50 +0000477}
478
Manuel Klimeka080a182013-01-02 16:30:12 +0000479TEST_F(FormatTest, BreaksOnHashWhenDirectiveIsInvalid) {
480 EXPECT_EQ("#\n;", format("#;"));
Manuel Klimekdd5b1012013-01-07 10:03:37 +0000481 verifyFormat("#\n;\n;\n;");
Manuel Klimeka080a182013-01-02 16:30:12 +0000482}
483
484TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) {
485 EXPECT_EQ("#line 42 \"test\"\n",
486 format("# \\\n line \\\n 42 \\\n \"test\"\n"));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000487 EXPECT_EQ("#define A \\\n B\n",
488 format("# \\\n define \\\n A \\\n B\n",
489 getLLVMStyleWithColumns(12)));
Manuel Klimeka080a182013-01-02 16:30:12 +0000490}
491
492TEST_F(FormatTest, EndOfFileEndsPPDirective) {
493 EXPECT_EQ("#line 42 \"test\"",
494 format("# \\\n line \\\n 42 \\\n \"test\""));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000495 EXPECT_EQ("#define A \\\n B",
496 format("# \\\n define \\\n A \\\n B",
497 getLLVMStyleWithColumns(12)));
Manuel Klimeka080a182013-01-02 16:30:12 +0000498}
499
Manuel Klimek060143e2013-01-02 18:33:23 +0000500TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) {
Manuel Klimekd544c572013-01-07 09:24:17 +0000501 // If the macro fits in one line, we still do not get the full
502 // line, as only the next line decides whether we need an escaped newline and
503 // thus use the last column.
504 verifyFormat("#define A(B)", getLLVMStyleWithColumns(13));
Manuel Klimek060143e2013-01-02 18:33:23 +0000505
Manuel Klimekd544c572013-01-07 09:24:17 +0000506 verifyFormat("#define A( \\\n B)", getLLVMStyleWithColumns(12));
507 verifyFormat("#define AA(\\\n B)", getLLVMStyleWithColumns(12));
Manuel Klimek060143e2013-01-02 18:33:23 +0000508 verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12));
509}
510
511TEST_F(FormatTest, HandlePreprocessorDirectiveContext) {
Manuel Klimekd4397b92013-01-04 23:34:14 +0000512 EXPECT_EQ("// some comment\n"
513 "#include \"a.h\"\n"
514 "#define A(A,\\\n"
515 " B)\n"
516 "#include \"b.h\"\n"
517 "// some comment\n",
518 format(" // some comment\n"
519 " #include \"a.h\"\n"
520 "#define A(A,\\\n"
521 " B)\n"
522 " #include \"b.h\"\n"
523 " // some comment\n", getLLVMStyleWithColumns(13)));
Manuel Klimek060143e2013-01-02 18:33:23 +0000524}
525
Manuel Klimekd4397b92013-01-04 23:34:14 +0000526TEST_F(FormatTest, LayoutSingleHash) {
527 EXPECT_EQ("#\na;", format("#\na;"));
528}
529
530TEST_F(FormatTest, LayoutCodeInMacroDefinitions) {
531 EXPECT_EQ("#define A \\\n"
532 " c; \\\n"
533 " e;\n"
534 "f;", format("#define A c; e;\n"
535 "f;", getLLVMStyleWithColumns(14)));
536}
537
538TEST_F(FormatTest, LayoutRemainingTokens) {
539 EXPECT_EQ("{\n}", format("{}"));
540}
541
542TEST_F(FormatTest, LayoutSingleUnwrappedLineInMacro) {
Daniel Jasper26f7e782013-01-08 14:56:18 +0000543 EXPECT_EQ("# define A\\\n b;",
544 format("# define A b;", 11, 2, getLLVMStyleWithColumns(11)));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000545}
546
547TEST_F(FormatTest, MacroDefinitionInsideStatement) {
548 EXPECT_EQ("int x,\n#define A\ny;", format("int x,\n#define A\ny;"));
549}
550
Manuel Klimek6f8424b2013-01-05 21:34:55 +0000551TEST_F(FormatTest, HashInMacroDefinition) {
552 verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11));
553 verifyFormat("#define A \\\n"
554 " { \\\n"
555 " f(#c);\\\n"
556 " }", getLLVMStyleWithColumns(11));
Daniel Jasper765561f2013-01-08 16:17:54 +0000557
558 verifyFormat("#define A(X) \\\n"
559 " void function##X()", getLLVMStyleWithColumns(22));
560
561 verifyFormat("#define A(a, b, c) \\\n"
562 " void a##b##c()", getLLVMStyleWithColumns(22));
563
564 verifyFormat("#define A \\\n"
565 " void # ## #", getLLVMStyleWithColumns(22));
Manuel Klimek6f8424b2013-01-05 21:34:55 +0000566}
567
Manuel Klimekc37b4d62013-01-05 22:14:16 +0000568TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) {
569 EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}"));
570}
571
Manuel Klimekf6fd00b2013-01-05 22:56:06 +0000572TEST_F(FormatTest, FormatHashIfNotAtStartOfLine) {
573 verifyFormat("{\n {\n a #c;\n }\n}");
574}
575
Manuel Klimeka5342db2013-01-06 20:07:31 +0000576TEST_F(FormatTest, FormatUnbalancedStructuralElements) {
577 EXPECT_EQ("#define A \\\n { \\\n {\nint i;",
578 format("#define A { {\nint i;", getLLVMStyleWithColumns(11)));
579 EXPECT_EQ("#define A \\\n } \\\n }\nint i;",
580 format("#define A } }\nint i;", getLLVMStyleWithColumns(11)));
581}
Manuel Klimekd4397b92013-01-04 23:34:14 +0000582
Manuel Klimek95419382013-01-07 07:56:50 +0000583TEST_F(FormatTest, EscapedNewlineAtStartOfTokenInMacroDefinition) {
Daniel Jaspercd162382013-01-07 13:26:07 +0000584 EXPECT_EQ(
585 "#define A \\\n int i; \\\n int j;",
586 format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11)));
Manuel Klimek95419382013-01-07 07:56:50 +0000587}
588
Manuel Klimekd544c572013-01-07 09:24:17 +0000589TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) {
590 verifyFormat("#define A \\\n"
591 " int v( \\\n"
592 " a); \\\n"
593 " int i;", getLLVMStyleWithColumns(11));
594}
595
Manuel Klimeka080a182013-01-02 16:30:12 +0000596TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) {
Manuel Klimekd4397b92013-01-04 23:34:14 +0000597 EXPECT_EQ(
598 "#define ALooooooooooooooooooooooooooooooooooooooongMacro("
599 " \\\n"
600 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n"
601 "\n"
602 "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n"
603 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n",
604 format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro("
605 "\\\n"
606 "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n"
607 " \n"
608 " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n"
609 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n"));
Manuel Klimeka080a182013-01-02 16:30:12 +0000610}
611
Alexander Kornienko15757312012-12-06 18:03:27 +0000612//===----------------------------------------------------------------------===//
613// Line break tests.
614//===----------------------------------------------------------------------===//
615
616TEST_F(FormatTest, FormatsFunctionDefinition) {
617 verifyFormat("void f(int a, int b, int c, int d, int e, int f, int g,"
618 " int h, int j, int f,\n"
619 " int c, int ddddddddddddd) {\n"
620 "}");
621}
622
623TEST_F(FormatTest, FormatsAwesomeMethodCall) {
624 verifyFormat(
Daniel Jaspera4974cf2012-12-24 16:43:00 +0000625 "SomeLongMethodName(SomeReallyLongMethod(\n"
626 " CallOtherReallyLongMethod(parameter, parameter, parameter)),\n"
627 " SecondLongCall(parameter));");
Alexander Kornienko15757312012-12-06 18:03:27 +0000628}
629
Daniel Jasper1321eb52012-12-18 21:05:13 +0000630TEST_F(FormatTest, ConstructorInitializers) {
631 verifyFormat("Constructor() : Initializer(FitsOnTheLine) {\n}");
632
633 verifyFormat(
634 "SomeClass::Constructor()\n"
635 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {\n"
636 "}");
637
638 verifyFormat(
639 "SomeClass::Constructor()\n"
640 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
641 " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {\n"
642 "}");
643
644 verifyFormat("Constructor()\n"
645 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
646 " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
647 " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
648 " aaaaaaaaaaaaaaaaaaaaaaa() {\n"
649 "}");
650
651 // Here a line could be saved by splitting the second initializer onto two
652 // lines, but that is not desireable.
653 verifyFormat("Constructor()\n"
654 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n"
655 " aaaaaaaaaaa(aaaaaaaaaaa),\n"
656 " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
657 "}");
658
659 verifyGoogleFormat("MyClass::MyClass(int var)\n"
660 " : some_var_(var), // 4 space indent\n"
661 " some_other_var_(var + 1) { // lined up\n"
662 "}");
663}
664
Alexander Kornienko15757312012-12-06 18:03:27 +0000665TEST_F(FormatTest, BreaksAsHighAsPossible) {
666 verifyFormat(
667 "if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n"
668 " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n"
669 " f();");
670}
671
Daniel Jasperbac016b2012-12-03 18:12:45 +0000672TEST_F(FormatTest, BreaksDesireably) {
673 verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n"
674 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n"
Manuel Klimekde768542013-01-07 18:10:23 +0000675 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {\n}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000676
677 verifyFormat(
678 "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
679 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}");
680
681 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
682 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
683 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));");
Daniel Jaspera88bb452012-12-04 10:50:12 +0000684
685 verifyFormat(
686 "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
687 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n"
688 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
689 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));");
Daniel Jasper33182dd2012-12-05 14:57:28 +0000690
691 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
692 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
693
Daniel Jasper723f0302013-01-02 14:40:02 +0000694 verifyFormat(
695 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n"
696 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
697
Daniel Jasper33182dd2012-12-05 14:57:28 +0000698 // This test case breaks on an incorrect memoization, i.e. an optimization not
699 // taking into account the StopAt value.
700 verifyFormat(
701 "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
Daniel Jaspercf225b62012-12-24 13:43:52 +0000702 " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
703 " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
704 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jaspera4974cf2012-12-24 16:43:00 +0000705
Daniel Jaspercd162382013-01-07 13:26:07 +0000706 verifyFormat("{\n {\n {\n"
707 " Annotation.SpaceRequiredBefore =\n"
708 " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n"
709 " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n"
710 " }\n }\n}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000711}
712
Daniel Jaspere2c7acf2012-12-24 00:13:23 +0000713TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) {
714 verifyFormat(
715 "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
716 " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {\n}");
Daniel Jaspercd162382013-01-07 13:26:07 +0000717 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n"
718 " ccccccccccccccccccccccccc) {\n}");
719 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n"
720 " ccccccccccccccccccccccccc) {\n}");
Daniel Jaspere2c7acf2012-12-24 00:13:23 +0000721 verifyFormat(
722 "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n"
723 " ccccccccccccccccccccccccc) {\n}");
724}
725
Daniel Jasper9cda8002013-01-07 13:08:40 +0000726TEST_F(FormatTest, PrefersNotToBreakAfterAssignments) {
727 verifyFormat(
728 "unsigned Cost = TTI.getMemoryOpCost(I->getOpcode(), VectorTy,\n"
729 " SI->getAlignment(),\n"
730 " SI->getPointerAddressSpaceee());\n");
731 verifyFormat(
732 "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n"
733 " Line.Tokens.front().Tok.getLocation(),\n"
734 " Line.Tokens.back().Tok.getLocation());");
735}
736
Daniel Jaspercf225b62012-12-24 13:43:52 +0000737TEST_F(FormatTest, AlignsAfterAssignments) {
738 verifyFormat(
739 "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000740 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000741 verifyFormat(
742 "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000743 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000744 verifyFormat(
745 "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000746 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000747 verifyFormat(
748 "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000749 " aaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000750 verifyFormat(
Daniel Jasper9cda8002013-01-07 13:08:40 +0000751 "double LooooooooooooooooooooooooongResult = aaaaaaaaaaaaaaaaaaaaaaaa +\n"
752 " aaaaaaaaaaaaaaaaaaaaaaaa +\n"
753 " aaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000754}
755
756TEST_F(FormatTest, AlignsAfterReturn) {
757 verifyFormat(
758 "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
759 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
760 verifyFormat(
761 "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
762 " aaaaaaaaaaaaaaaaaaaaaaaaa);");
763}
764
Daniel Jasper9c837d02013-01-09 07:06:56 +0000765TEST_F(FormatTest, BreaksConditionalExpressions) {
766 verifyFormat(
767 "aaaa(aaaaaaaaaaaaaaaaaaaa,\n"
768 " aaaaaaaaaaaaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n"
769 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
770 verifyFormat("aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa ?\n"
771 " aaaaaaaaaaaaaaaaaaaaaaa : aaaaaaaaaaaaaaaaaaaaa);");
772}
773
Daniel Jasperbac016b2012-12-03 18:12:45 +0000774TEST_F(FormatTest, AlignsStringLiterals) {
775 verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n"
776 " \"short literal\");");
777 verifyFormat(
778 "looooooooooooooooooooooooongFunction(\n"
779 " \"short literal\"\n"
780 " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");");
781}
782
Alexander Kornienko15757312012-12-06 18:03:27 +0000783TEST_F(FormatTest, AlignsPipes) {
784 verifyFormat(
785 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
786 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
787 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
788 verifyFormat(
789 "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n"
790 " << aaaaaaaaaaaaaaaaaaaa;");
791 verifyFormat(
792 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
793 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
794 verifyFormat(
795 "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n"
796 " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n"
797 " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";");
798 verifyFormat(
799 "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
800 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
801 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
802}
803
Daniel Jasperbac016b2012-12-03 18:12:45 +0000804TEST_F(FormatTest, UnderstandsEquals) {
805 verifyFormat(
806 "aaaaaaaaaaaaaaaaa =\n"
807 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
808 verifyFormat(
809 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
810 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
811 "}");
812 verifyFormat(
813 "if (a) {\n"
814 "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
815 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
816 "}");
817
Daniel Jasper9cda8002013-01-07 13:08:40 +0000818 verifyFormat(
819 "if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = 100000000 +\n"
820 " 10000000) {\n"
821 "}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000822}
823
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000824TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) {
Daniel Jasper1321eb52012-12-18 21:05:13 +0000825 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n"
826 " .looooooooooooooooooooooooooooooooooooooongFunction();");
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000827
Daniel Jasper1321eb52012-12-18 21:05:13 +0000828 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n"
829 " ->looooooooooooooooooooooooooooooooooooooongFunction();");
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000830
831 verifyFormat(
832 "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n"
833 " Parameter2);");
834
835 verifyFormat(
836 "ShortObject->shortFunction(\n"
837 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n"
838 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);");
839
840 verifyFormat("loooooooooooooongFunction(\n"
841 " LoooooooooooooongObject->looooooooooooooooongFunction());");
842
843 verifyFormat(
844 "function(LoooooooooooooooooooooooooooooooooooongObject\n"
845 " ->loooooooooooooooooooooooooooooooooooooooongFunction());");
846
Daniel Jasper46a46a22013-01-07 07:13:20 +0000847 // Here, it is not necessary to wrap at "." or "->".
Daniel Jasper1321eb52012-12-18 21:05:13 +0000848 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n"
849 " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
850 "}");
Daniel Jasper46a46a22013-01-07 07:13:20 +0000851 verifyFormat(
852 "aaaaaaaaaaa->aaaaaaaaa(\n"
853 " aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
854 " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n");
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000855}
856
Daniel Jasper9a64fb52013-01-02 15:08:56 +0000857TEST_F(FormatTest, WrapsTemplateDeclarations) {
858 verifyFormat("template <typename T>\n"
859 "virtual void loooooooooooongFunction(int Param1, int Param2);");
860 verifyFormat(
861 "template <typename T> void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n"
862 " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);");
863 verifyFormat(
864 "template <typename T>\n"
865 "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n"
866 " int Paaaaaaaaaaaaaaaaaaaaram2);");
Daniel Jasper5eda31e2013-01-02 18:30:06 +0000867 verifyFormat(
868 "template <typename T>\n"
869 "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n"
870 " aaaaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaaaaa,\n"
871 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jasperd64f7382013-01-09 09:50:48 +0000872 verifyFormat("template <typename T>\n"
873 "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
874 " int aaaaaaaaaaaaaaaaa);");
Daniel Jasper9a64fb52013-01-02 15:08:56 +0000875
876}
877
Daniel Jasperbac016b2012-12-03 18:12:45 +0000878TEST_F(FormatTest, UnderstandsTemplateParameters) {
879 verifyFormat("A<int> a;");
880 verifyFormat("A<A<A<int> > > a;");
881 verifyFormat("A<A<A<int, 2>, 3>, 4> a;");
882 verifyFormat("bool x = a < 1 || 2 > a;");
883 verifyFormat("bool x = 5 < f<int>();");
884 verifyFormat("bool x = f<int>() > 5;");
885 verifyFormat("bool x = 5 < a<int>::x;");
886 verifyFormat("bool x = a < 4 ? a > 2 : false;");
887 verifyFormat("bool x = f() ? a < 2 : a > 2;");
888
889 verifyGoogleFormat("A<A<int>> a;");
890 verifyGoogleFormat("A<A<A<int>>> a;");
891 verifyGoogleFormat("A<A<A<A<int>>>> a;");
892
893 verifyFormat("test >> a >> b;");
894 verifyFormat("test << a >> b;");
895
896 verifyFormat("f<int>();");
897 verifyFormat("template <typename T> void f() {\n}");
898}
899
Daniel Jasper98e6b4a2012-12-21 09:41:31 +0000900TEST_F(FormatTest, UnderstandsUnaryOperators) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000901 verifyFormat("int a = -2;");
Daniel Jasper8822d3a2012-12-04 13:02:32 +0000902 verifyFormat("f(-1, -2, -3);");
903 verifyFormat("a[-1] = 5;");
904 verifyFormat("int a = 5 + -2;");
Daniel Jasper112fb272012-12-05 07:51:39 +0000905 verifyFormat("if (i == -1) {\n}");
906 verifyFormat("if (i != -1) {\n}");
907 verifyFormat("if (i > -1) {\n}");
908 verifyFormat("if (i < -1) {\n}");
Daniel Jasperd56a7372012-12-06 13:16:39 +0000909 verifyFormat("++(a->f());");
910 verifyFormat("--(a->f());");
911 verifyFormat("if (!(a->f())) {\n}");
Daniel Jasper98e6b4a2012-12-21 09:41:31 +0000912
913 verifyFormat("a-- > b;");
914 verifyFormat("b ? -a : c;");
915 verifyFormat("n * sizeof char16;");
Daniel Jasperba3d3072013-01-02 17:21:36 +0000916 verifyFormat("n * alignof char16;");
Daniel Jasper98e6b4a2012-12-21 09:41:31 +0000917 verifyFormat("sizeof(char);");
Daniel Jasperba3d3072013-01-02 17:21:36 +0000918 verifyFormat("alignof(char);");
Daniel Jasper1f0754b2013-01-02 15:26:16 +0000919
920 verifyFormat("return -1;");
921 verifyFormat("switch (a) {\n"
922 "case -1:\n"
923 " break;\n"
924 "}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000925}
926
927TEST_F(FormatTest, UndestandsOverloadedOperators) {
Daniel Jasperf6aef6a2012-12-24 10:56:04 +0000928 verifyFormat("bool operator<();");
929 verifyFormat("bool operator>();");
930 verifyFormat("bool operator=();");
931 verifyFormat("bool operator==();");
932 verifyFormat("bool operator!=();");
933 verifyFormat("int operator+();");
934 verifyFormat("int operator++();");
935 verifyFormat("bool operator();");
936 verifyFormat("bool operator()();");
937 verifyFormat("bool operator[]();");
938 verifyFormat("operator bool();");
939 verifyFormat("operator SomeType<int>();");
940 verifyFormat("void *operator new(std::size_t size);");
941 verifyFormat("void *operator new[](std::size_t size);");
942 verifyFormat("void operator delete(void *ptr);");
943 verifyFormat("void operator delete[](void *ptr);");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000944}
945
Daniel Jasper5d334402013-01-02 08:57:10 +0000946TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000947 verifyFormat("int *f(int *a) {\n}");
948 verifyFormat("f(a, *a);");
949 verifyFormat("f(*a);");
950 verifyFormat("int a = b * 10;");
951 verifyFormat("int a = 10 * b;");
Daniel Jasper112fb272012-12-05 07:51:39 +0000952 verifyFormat("int a = b * c;");
Daniel Jasper33182dd2012-12-05 14:57:28 +0000953 verifyFormat("int a += b * c;");
954 verifyFormat("int a -= b * c;");
955 verifyFormat("int a *= b * c;");
956 verifyFormat("int a /= b * c;");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000957 verifyFormat("int a = *b;");
Daniel Jasper112fb272012-12-05 07:51:39 +0000958 verifyFormat("int a = *b * c;");
959 verifyFormat("int a = b * *c;");
Daniel Jasperc74e2792012-12-07 09:52:15 +0000960 verifyFormat("int main(int argc, char **argv) {\n}");
Nico Weber00d5a042012-12-23 01:07:46 +0000961 verifyFormat("return 10 * b;");
962 verifyFormat("return *b * *c;");
963 verifyFormat("return a & ~b;");
Daniel Jasper5d334402013-01-02 08:57:10 +0000964 verifyFormat("f(b ? *c : *d);");
965 verifyFormat("int a = b ? *c : *d;");
Daniel Jasperba3d3072013-01-02 17:21:36 +0000966 verifyFormat("*b = a;");
967 verifyFormat("a * ~b;");
968 verifyFormat("a * !b;");
969 verifyFormat("a * +b;");
970 verifyFormat("a * -b;");
971 verifyFormat("a * ++b;");
972 verifyFormat("a * --b;");
Daniel Jasperc74e2792012-12-07 09:52:15 +0000973
Daniel Jasper9bb0d282013-01-04 20:46:38 +0000974 verifyFormat("InvalidRegions[*R] = 0;");
975
Daniel Jasper8b39c662012-12-10 18:59:13 +0000976 verifyFormat("A<int *> a;");
977 verifyFormat("A<int **> a;");
978 verifyFormat("A<int *, int *> a;");
979 verifyFormat("A<int **, int **> a;");
Daniel Jasperef5b9c32013-01-02 15:46:59 +0000980 verifyFormat("Type *A = static_cast<Type *>(P);");
981 verifyFormat("Type *A = (Type *) P;");
982 verifyFormat("Type *A = (vector<Type *, int *>) P;");
Daniel Jasper8b39c662012-12-10 18:59:13 +0000983
Daniel Jasper2db356d2013-01-08 20:03:18 +0000984 verifyFormat(
985 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
986 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
987
Daniel Jasperc74e2792012-12-07 09:52:15 +0000988 verifyGoogleFormat("int main(int argc, char** argv) {\n}");
Daniel Jasper8b39c662012-12-10 18:59:13 +0000989 verifyGoogleFormat("A<int*> a;");
990 verifyGoogleFormat("A<int**> a;");
991 verifyGoogleFormat("A<int*, int*> a;");
992 verifyGoogleFormat("A<int**, int**> a;");
Daniel Jasper5d334402013-01-02 08:57:10 +0000993 verifyGoogleFormat("f(b ? *c : *d);");
994 verifyGoogleFormat("int a = b ? *c : *d;");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000995}
996
Daniel Jasper4dc41de2013-01-02 08:44:14 +0000997TEST_F(FormatTest, DoesNotBreakBeforePointerOrReference) {
Daniel Jaspercd162382013-01-07 13:26:07 +0000998 verifyFormat("int *someFunction(int LoooooooooooooooongParam1,\n"
999 " int LoooooooooooooooongParam2) {\n}");
Daniel Jasper4dc41de2013-01-02 08:44:14 +00001000 verifyFormat(
1001 "TypeSpecDecl *TypeSpecDecl::Create(ASTContext &C, DeclContext *DC,\n"
1002 " SourceLocation L, IdentifierIn *II,\n"
1003 " Type *T) {\n}");
1004}
1005
Daniel Jasper3b5943f2012-12-06 09:56:08 +00001006TEST_F(FormatTest, LineStartsWithSpecialCharacter) {
1007 verifyFormat("(a)->b();");
1008 verifyFormat("--a;");
1009}
1010
Daniel Jasper8822d3a2012-12-04 13:02:32 +00001011TEST_F(FormatTest, HandlesIncludeDirectives) {
1012 EXPECT_EQ("#include <string>\n", format("#include <string>\n"));
Daniel Jaspercd1a32b2012-12-21 17:58:39 +00001013 EXPECT_EQ("#include <a/b/c.h>\n", format("#include <a/b/c.h>\n"));
Daniel Jasper8822d3a2012-12-04 13:02:32 +00001014 EXPECT_EQ("#include \"a/b/string\"\n", format("#include \"a/b/string\"\n"));
1015 EXPECT_EQ("#include \"string.h\"\n", format("#include \"string.h\"\n"));
1016 EXPECT_EQ("#include \"string.h\"\n", format("#include \"string.h\"\n"));
Nico Weberb23ae0c2012-12-21 18:21:56 +00001017
1018 EXPECT_EQ("#import <string>\n", format("#import <string>\n"));
1019 EXPECT_EQ("#import <a/b/c.h>\n", format("#import <a/b/c.h>\n"));
1020 EXPECT_EQ("#import \"a/b/string\"\n", format("#import \"a/b/string\"\n"));
1021 EXPECT_EQ("#import \"string.h\"\n", format("#import \"string.h\"\n"));
1022 EXPECT_EQ("#import \"string.h\"\n", format("#import \"string.h\"\n"));
Daniel Jasper8822d3a2012-12-04 13:02:32 +00001023}
1024
Alexander Kornienko15757312012-12-06 18:03:27 +00001025//===----------------------------------------------------------------------===//
1026// Error recovery tests.
1027//===----------------------------------------------------------------------===//
1028
Daniel Jasperceb99ab2013-01-09 10:16:05 +00001029TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) {
1030 verifyFormat("int aaaaaaaa =\n"
1031 " // Overly long comment\n"
1032 " b;", getLLVMStyleWithColumns(20));
1033 verifyFormat("function(\n"
1034 " ShortArgument,\n"
1035 " LoooooooooooongArgument);\n", getLLVMStyleWithColumns(20));
1036}
1037
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001038TEST_F(FormatTest, IncorrectAccessSpecifier) {
1039 verifyFormat("public:");
1040 verifyFormat("class A {\n"
1041 "public\n"
1042 " void f() {\n"
1043 " }\n"
1044 "};");
1045 verifyFormat("public\n"
1046 "int qwerty;");
1047 verifyFormat("public\n"
1048 "B {\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001049 "}");
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001050 verifyFormat("public\n"
1051 "{\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001052 "}");
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001053 verifyFormat("public\n"
1054 "B {\n"
1055 " int x;\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001056 "}");
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001057}
Daniel Jasperbac016b2012-12-03 18:12:45 +00001058
Alexander Kornienko393b0082012-12-04 15:40:36 +00001059TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) {
1060 verifyFormat("{");
1061}
1062
1063TEST_F(FormatTest, IncorrectCodeDoNoWhile) {
1064 verifyFormat("do {\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001065 "}");
Alexander Kornienko393b0082012-12-04 15:40:36 +00001066 verifyFormat("do {\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001067 "}\n"
Alexander Kornienko393b0082012-12-04 15:40:36 +00001068 "f();");
1069 verifyFormat("do {\n"
1070 "}\n"
1071 "wheeee(fun);");
1072 verifyFormat("do {\n"
1073 " f();\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001074 "}");
Alexander Kornienko393b0082012-12-04 15:40:36 +00001075}
1076
Daniel Jasper1f42f112013-01-04 18:52:56 +00001077TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) {
1078 verifyFormat("namespace {\n"
Manuel Klimekd4397b92013-01-04 23:34:14 +00001079 "class Foo { Foo ( }; } // comment");
Daniel Jasper1f42f112013-01-04 18:52:56 +00001080}
1081
Alexander Kornienkocff563c2012-12-04 17:27:50 +00001082TEST_F(FormatTest, IncorrectCodeErrorDetection) {
1083 EXPECT_EQ("{\n{\n}\n", format("{\n{\n}\n"));
1084 EXPECT_EQ("{\n {\n}\n", format("{\n {\n}\n"));
1085 EXPECT_EQ("{\n {\n }\n", format("{\n {\n }\n"));
Alexander Kornienkoa3a2b3a2012-12-06 17:49:17 +00001086 EXPECT_EQ("{\n {\n }\n }\n}\n", format("{\n {\n }\n }\n}\n"));
Alexander Kornienkocff563c2012-12-04 17:27:50 +00001087
1088 FormatStyle Style = getLLVMStyle();
1089 Style.ColumnLimit = 10;
1090 EXPECT_EQ("{\n"
1091 " {\n"
1092 " breakme(\n"
1093 " qwe);\n"
1094 "}\n", format("{\n"
1095 " {\n"
1096 " breakme(qwe);\n"
1097 "}\n", Style));
1098
1099}
1100
Nico Webercf4a79c2013-01-08 17:56:31 +00001101//===----------------------------------------------------------------------===//
1102// Objective-C tests.
1103//===----------------------------------------------------------------------===//
1104
Fariborz Jahanian154120c2012-12-20 19:54:13 +00001105TEST_F(FormatTest, FormatForObjectiveCMethodDecls) {
1106 verifyFormat("- (void)sendAction:(SEL)aSelector to:(BOOL)anObject;");
1107 EXPECT_EQ("- (NSUInteger)indexOfObject:(id)anObject;",
1108 format("-(NSUInteger)indexOfObject:(id)anObject;"));
Daniel Jaspercd162382013-01-07 13:26:07 +00001109 EXPECT_EQ("- (NSInteger)Mthod1;", format("-(NSInteger)Mthod1;"));
Fariborz Jahanian154120c2012-12-20 19:54:13 +00001110 EXPECT_EQ("+ (id)Mthod2;", format("+(id)Mthod2;"));
1111 EXPECT_EQ("- (NSInteger)Method3:(id)anObject;",
1112 format("-(NSInteger)Method3:(id)anObject;"));
1113 EXPECT_EQ("- (NSInteger)Method4:(id)anObject;",
1114 format("-(NSInteger)Method4:(id)anObject;"));
1115 EXPECT_EQ("- (NSInteger)Method5:(id)anObject:(id)AnotherObject;",
1116 format("-(NSInteger)Method5:(id)anObject:(id)AnotherObject;"));
1117 EXPECT_EQ("- (id)Method6:(id)A:(id)B:(id)C:(id)D;",
1118 format("- (id)Method6:(id)A:(id)B:(id)C:(id)D;"));
Daniel Jaspercd162382013-01-07 13:26:07 +00001119 EXPECT_EQ(
1120 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;",
1121 format("- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;"));
Fariborz Jahanian9b3f02c2012-12-21 22:51:18 +00001122
1123 // Very long objectiveC method declaration.
Daniel Jaspercd162382013-01-07 13:26:07 +00001124 EXPECT_EQ(
1125 "- (NSUInteger)indexOfObject:(id)anObject inRange:(NSRange)range\n "
1126 "outRange:(NSRange)out_range outRange1:(NSRange)out_range1\n "
1127 "outRange2:(NSRange)out_range2 outRange3:(NSRange)out_range3\n "
1128 "outRange4:(NSRange)out_range4 outRange5:(NSRange)out_range5\n "
1129 "outRange6:(NSRange)out_range6 outRange7:(NSRange)out_range7\n "
1130 "outRange8:(NSRange)out_range8 outRange9:(NSRange)out_range9;",
1131 format(
1132 "- (NSUInteger)indexOfObject:(id)anObject inRange:(NSRange)range "
1133 "outRange:(NSRange) out_range outRange1:(NSRange) out_range1 "
1134 "outRange2:(NSRange) out_range2 outRange3:(NSRange) out_range3 "
1135 "outRange4:(NSRange) out_range4 outRange5:(NSRange) out_range5 "
1136 "outRange6:(NSRange) out_range6 outRange7:(NSRange) out_range7 "
1137 "outRange8:(NSRange) out_range8 outRange9:(NSRange) out_range9;"));
Fariborz Jahanian154120c2012-12-20 19:54:13 +00001138}
1139
Daniel Jasper886568d2013-01-09 08:36:49 +00001140TEST_F(FormatTest, FormatObjCBlocks) {
1141 verifyFormat("int (^Block) (int, int);");
1142 verifyFormat("int (^Block1) (int, int) = ^(int i, int j)");
1143}
1144
Nico Weber581f5572013-01-07 15:56:25 +00001145TEST_F(FormatTest, ObjCAt) {
Nico Weber4a293a22013-01-07 16:07:07 +00001146 verifyFormat("@autoreleasepool");
Nico Weberd0af4b42013-01-07 16:14:28 +00001147 verifyFormat("@catch");
1148 verifyFormat("@class");
Nico Weber4a293a22013-01-07 16:07:07 +00001149 verifyFormat("@compatibility_alias");
1150 verifyFormat("@defs");
Nico Weberefcfe732013-01-07 15:17:23 +00001151 verifyFormat("@dynamic");
Nico Weber4a293a22013-01-07 16:07:07 +00001152 verifyFormat("@encode");
1153 verifyFormat("@end");
1154 verifyFormat("@finally");
1155 verifyFormat("@implementation");
1156 verifyFormat("@import");
1157 verifyFormat("@interface");
1158 verifyFormat("@optional");
1159 verifyFormat("@package");
Nico Weberd0af4b42013-01-07 16:14:28 +00001160 verifyFormat("@private");
Nico Weber4a293a22013-01-07 16:07:07 +00001161 verifyFormat("@property");
Nico Weberd0af4b42013-01-07 16:14:28 +00001162 verifyFormat("@protected");
Nico Weber4a293a22013-01-07 16:07:07 +00001163 verifyFormat("@protocol");
Nico Weberd0af4b42013-01-07 16:14:28 +00001164 verifyFormat("@public");
Nico Weber4a293a22013-01-07 16:07:07 +00001165 verifyFormat("@required");
1166 verifyFormat("@selector");
1167 verifyFormat("@synchronized");
1168 verifyFormat("@synthesize");
Nico Weberd0af4b42013-01-07 16:14:28 +00001169 verifyFormat("@throw");
1170 verifyFormat("@try");
Nico Weber4a293a22013-01-07 16:07:07 +00001171
Nico Webercb4d6902013-01-08 19:40:21 +00001172 // FIXME: Make the uncommented lines below pass.
1173 verifyFormat("@\"String\"");
1174 verifyFormat("@1");
1175 //verifyFormat("@+4.8");
1176 //verifyFormat("@-4");
1177 verifyFormat("@1LL");
1178 verifyFormat("@.5");
1179 verifyFormat("@'c'");
1180 verifyFormat("@true");
1181 verifyFormat("NSNumber *smallestInt = @(-INT_MAX - 1);");
1182 verifyFormat("@[");
1183 verifyFormat("@{");
1184
1185
Nico Weber581f5572013-01-07 15:56:25 +00001186 EXPECT_EQ("@interface", format("@ interface"));
1187
1188 // The precise formatting of this doesn't matter, nobody writes code like
1189 // this.
1190 verifyFormat("@ /*foo*/ interface");
Nico Weberefcfe732013-01-07 15:17:23 +00001191}
1192
Nico Weberc31689a2013-01-08 19:15:23 +00001193TEST_F(FormatTest, ObjCSnippets) {
1194 // FIXME: Make the uncommented lines below pass.
1195 verifyFormat("@autoreleasepool {\n"
1196 " foo();\n"
1197 "}");
Nico Webercf4a79c2013-01-08 17:56:31 +00001198 verifyFormat("@class Foo, Bar;");
Nico Weberc31689a2013-01-08 19:15:23 +00001199 verifyFormat("@compatibility_alias AliasName ExistingClass;");
Nico Webercf4a79c2013-01-08 17:56:31 +00001200 verifyFormat("@dynamic textColor;");
Nico Weberc31689a2013-01-08 19:15:23 +00001201 //verifyFormat("char *buf1 = @encode(int **);");
Nico Weber3a2673e2013-01-08 20:16:23 +00001202 verifyFormat("Protocol *proto = @protocol(p1);");
Nico Weberc31689a2013-01-08 19:15:23 +00001203 //verifyFormat("SEL s = @selector(foo:);");
Nico Weber3a2673e2013-01-08 20:16:23 +00001204 verifyFormat("@synchronized(self) {\n"
1205 " f();\n"
1206 "}");
Nico Weberc31689a2013-01-08 19:15:23 +00001207 verifyFormat("@synthesize dropArrowPosition = dropArrowPosition_;");
Nico Webercf4a79c2013-01-08 17:56:31 +00001208
1209 // FIXME: "getter=bar" should not be surround by spaces in @property.
1210 verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;");
1211}
1212
Daniel Jaspercd162382013-01-07 13:26:07 +00001213} // end namespace tooling
1214} // end namespace clang