blob: 47e6bdd114f4ff1848f93e7a0a5344a26128f90f [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)));
Daniel Jasper46ef8522013-01-10 13:08:12 +000029 Lexer Lex(ID, Context.Sources.getBuffer(ID), Context.Sources,
30 getFormattingLangOpts());
Daniel Jaspercd162382013-01-07 13:26:07 +000031 tooling::Replacements Replace = reformat(Style, Lex, Context.Sources,
32 Ranges);
Daniel Jasperbac016b2012-12-03 18:12:45 +000033 EXPECT_TRUE(applyAllReplacements(Replace, Context.Rewrite));
34 return Context.getRewrittenText(ID);
35 }
36
37 std::string format(llvm::StringRef Code,
38 const FormatStyle &Style = getLLVMStyle()) {
39 return format(Code, 0, Code.size(), Style);
40 }
41
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000042 std::string messUp(llvm::StringRef Code) {
43 std::string MessedUp(Code.str());
44 bool InComment = false;
Manuel Klimek526ed112013-01-09 15:25:02 +000045 bool InPreprocessorDirective = false;
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000046 bool JustReplacedNewline = false;
47 for (unsigned i = 0, e = MessedUp.size() - 1; i != e; ++i) {
48 if (MessedUp[i] == '/' && MessedUp[i + 1] == '/') {
49 if (JustReplacedNewline)
50 MessedUp[i - 1] = '\n';
51 InComment = true;
Manuel Klimek526ed112013-01-09 15:25:02 +000052 } else if (MessedUp[i] == '#' && JustReplacedNewline) {
53 MessedUp[i - 1] = '\n';
54 InPreprocessorDirective = true;
Manuel Klimekd4397b92013-01-04 23:34:14 +000055 } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') {
56 MessedUp[i] = ' ';
Manuel Klimek526ed112013-01-09 15:25:02 +000057 MessedUp[i + 1] = ' ';
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000058 } else if (MessedUp[i] == '\n') {
59 if (InComment) {
60 InComment = false;
Manuel Klimek526ed112013-01-09 15:25:02 +000061 } else if (InPreprocessorDirective) {
62 InPreprocessorDirective = false;
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000063 } else {
64 JustReplacedNewline = true;
65 MessedUp[i] = ' ';
66 }
Manuel Klimekd4397b92013-01-04 23:34:14 +000067 } else if (MessedUp[i] != ' ') {
68 JustReplacedNewline = false;
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000069 }
Daniel Jasperbac016b2012-12-03 18:12:45 +000070 }
Daniel Jaspere35ec2b2012-12-18 19:56:56 +000071 return MessedUp;
72 }
73
Manuel Klimek060143e2013-01-02 18:33:23 +000074 FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) {
75 FormatStyle Style = getLLVMStyle();
76 Style.ColumnLimit = ColumnLimit;
77 return Style;
78 }
79
80 void verifyFormat(llvm::StringRef Code,
81 const FormatStyle &Style = getLLVMStyle()) {
82 EXPECT_EQ(Code.str(), format(messUp(Code), Style));
Daniel Jasperbac016b2012-12-03 18:12:45 +000083 }
84
85 void verifyGoogleFormat(llvm::StringRef Code) {
Manuel Klimek060143e2013-01-02 18:33:23 +000086 verifyFormat(Code, getGoogleStyle());
Daniel Jasperbac016b2012-12-03 18:12:45 +000087 }
88};
89
Manuel Klimek526ed112013-01-09 15:25:02 +000090TEST_F(FormatTest, MessUp) {
91 EXPECT_EQ("1 2 3", messUp("1 2 3"));
92 EXPECT_EQ("1 2 3\n", messUp("1\n2\n3\n"));
93 EXPECT_EQ("a\n//b\nc", messUp("a\n//b\nc"));
94 EXPECT_EQ("a\n#b\nc", messUp("a\n#b\nc"));
95 EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne"));
96}
97
Alexander Kornienko15757312012-12-06 18:03:27 +000098//===----------------------------------------------------------------------===//
99// Basic function tests.
100//===----------------------------------------------------------------------===//
101
Daniel Jasperbac016b2012-12-03 18:12:45 +0000102TEST_F(FormatTest, DoesNotChangeCorrectlyFormatedCode) {
103 EXPECT_EQ(";", format(";"));
104}
105
106TEST_F(FormatTest, FormatsGlobalStatementsAt0) {
107 EXPECT_EQ("int i;", format(" int i;"));
108 EXPECT_EQ("\nint i;", format(" \n\t \r int i;"));
109 EXPECT_EQ("int i;\nint j;", format(" int i; int j;"));
110 EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;"));
111}
112
113TEST_F(FormatTest, FormatsUnwrappedLinesAtFirstFormat) {
114 EXPECT_EQ("int i;", format("int\ni;"));
115}
116
117TEST_F(FormatTest, FormatsNestedBlockStatements) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000118 EXPECT_EQ("{\n {\n {}\n }\n}", format("{{{}}}"));
Daniel Jasperbac016b2012-12-03 18:12:45 +0000119}
120
Alexander Kornienko15757312012-12-06 18:03:27 +0000121TEST_F(FormatTest, FormatsNestedCall) {
122 verifyFormat("Method(f1, f2(f3));");
123 verifyFormat("Method(f1(f2, f3()));");
124}
125
Alexander Kornienko15757312012-12-06 18:03:27 +0000126//===----------------------------------------------------------------------===//
127// Tests for control statements.
128//===----------------------------------------------------------------------===//
129
130TEST_F(FormatTest, FormatIfWithoutCompountStatement) {
131 verifyFormat("if (true)\n f();\ng();");
132 verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();");
133 verifyFormat("if (a)\n if (b) {\n f();\n }\ng();");
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000134 verifyFormat("if (a)\n"
135 " // comment\n"
136 " f();");
Alexander Kornienko15757312012-12-06 18:03:27 +0000137}
138
139TEST_F(FormatTest, ParseIfElse) {
140 verifyFormat("if (true)\n"
141 " if (true)\n"
142 " if (true)\n"
143 " f();\n"
144 " else\n"
145 " g();\n"
146 " else\n"
147 " h();\n"
148 "else\n"
149 " i();");
150 verifyFormat("if (true)\n"
151 " if (true)\n"
152 " if (true) {\n"
153 " if (true)\n"
154 " f();\n"
155 " } else {\n"
156 " g();\n"
157 " }\n"
158 " else\n"
159 " h();\n"
160 "else {\n"
161 " i();\n"
162 "}");
163}
164
165TEST_F(FormatTest, ElseIf) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000166 verifyFormat("if (a) {} else if (b) {}");
Alexander Kornienko15757312012-12-06 18:03:27 +0000167 verifyFormat("if (a)\n"
168 " f();\n"
169 "else if (b)\n"
170 " g();\n"
171 "else\n"
172 " h();");
173}
174
Daniel Jasperbac016b2012-12-03 18:12:45 +0000175TEST_F(FormatTest, FormatsForLoop) {
176 verifyFormat(
177 "for (int VeryVeryLongLoopVariable = 0; VeryVeryLongLoopVariable < 10;\n"
Alexander Kornienko2e97cfc2012-12-05 15:06:06 +0000178 " ++VeryVeryLongLoopVariable)\n"
179 " ;");
180 verifyFormat("for (;;)\n"
181 " f();");
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000182 verifyFormat("for (;;) {}");
Alexander Kornienko2e97cfc2012-12-05 15:06:06 +0000183 verifyFormat("for (;;) {\n"
184 " f();\n"
185 "}");
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000186
187 verifyFormat(
188 "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n"
189 " E = UnwrappedLines.end();\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000190 " I != E; ++I) {}");
Daniel Jaspera324a0e2012-12-21 14:37:20 +0000191
192 verifyFormat(
193 "for (MachineFun::iterator IIII = PrevIt, EEEE = F.end(); IIII != EEEE;\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000194 " ++IIIII) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000195}
196
197TEST_F(FormatTest, FormatsWhileLoop) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000198 verifyFormat("while (true) {}");
Alexander Kornienko2e97cfc2012-12-05 15:06:06 +0000199 verifyFormat("while (true)\n"
200 " f();");
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000201 verifyFormat("while () {}");
Alexander Kornienko2e97cfc2012-12-05 15:06:06 +0000202 verifyFormat("while () {\n"
203 " f();\n"
204 "}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000205}
206
Alexander Kornienko15757312012-12-06 18:03:27 +0000207TEST_F(FormatTest, FormatsDoWhile) {
208 verifyFormat("do {\n"
209 " do_something();\n"
210 "} while (something());");
211 verifyFormat("do\n"
212 " do_something();\n"
213 "while (something());");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000214}
215
Alexander Kornienko15757312012-12-06 18:03:27 +0000216TEST_F(FormatTest, FormatsSwitchStatement) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000217 verifyFormat("switch (x) {\n"
218 "case 1:\n"
219 " f();\n"
220 " break;\n"
221 "case kFoo:\n"
222 "case ns::kBar:\n"
223 "case kBaz:\n"
224 " break;\n"
225 "default:\n"
226 " g();\n"
227 " break;\n"
228 "}");
229 verifyFormat("switch (x) {\n"
230 "case 1: {\n"
231 " f();\n"
232 " break;\n"
233 "}\n"
234 "}");
235 verifyFormat("switch (test)\n"
236 " ;");
Alexander Kornienko15757312012-12-06 18:03:27 +0000237 verifyGoogleFormat("switch (x) {\n"
238 " case 1:\n"
239 " f();\n"
240 " break;\n"
241 " case kFoo:\n"
242 " case ns::kBar:\n"
243 " case kBaz:\n"
244 " break;\n"
245 " default:\n"
246 " g();\n"
247 " break;\n"
248 "}");
249 verifyGoogleFormat("switch (x) {\n"
250 " case 1: {\n"
251 " f();\n"
252 " break;\n"
253 " }\n"
254 "}");
255 verifyGoogleFormat("switch (test)\n"
256 " ;");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000257}
258
Alexander Kornienko15757312012-12-06 18:03:27 +0000259TEST_F(FormatTest, FormatsLabels) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000260 verifyFormat("void f() {\n"
261 " some_code();\n"
262 "test_label:\n"
263 " some_other_code();\n"
264 " {\n"
265 " some_more_code();\n"
266 " another_label:\n"
267 " some_more_code();\n"
268 " }\n"
269 "}");
270 verifyFormat("some_code();\n"
271 "test_label:\n"
272 "some_other_code();");
273}
274
Alexander Kornienko15757312012-12-06 18:03:27 +0000275//===----------------------------------------------------------------------===//
276// Tests for comments.
277//===----------------------------------------------------------------------===//
278
279TEST_F(FormatTest, UnderstandsSingleLineComments) {
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000280 verifyFormat("// line 1\n"
281 "// line 2\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000282 "void f() {}\n");
Alexander Kornienko15757312012-12-06 18:03:27 +0000283
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000284 verifyFormat("void f() {\n"
285 " // Doesn't do anything\n"
286 "}");
Alexander Kornienko15757312012-12-06 18:03:27 +0000287
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000288 verifyFormat("int i // This is a fancy variable\n"
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000289 " = 5;");
Alexander Kornienko15757312012-12-06 18:03:27 +0000290
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000291 verifyFormat("enum E {\n"
292 " // comment\n"
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000293 " VAL_A, // comment\n"
Daniel Jaspere35ec2b2012-12-18 19:56:56 +0000294 " VAL_B\n"
295 "};");
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000296
297 verifyFormat(
298 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000299 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // Trailing comment");
Daniel Jasper043835a2013-01-09 09:33:39 +0000300 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
301 " // Comment inside a statement.\n"
302 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;");
Manuel Klimek6cf58142013-01-07 08:54:53 +0000303
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000304 EXPECT_EQ("int i; // single line trailing comment",
Manuel Klimek6cf58142013-01-07 08:54:53 +0000305 format("int i;\\\n// single line trailing comment"));
Daniel Jasper7ad4eff2013-01-07 11:09:06 +0000306
307 verifyGoogleFormat("int a; // Trailing comment.");
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000308}
309
310TEST_F(FormatTest, UnderstandsMultiLineComments) {
Alexander Kornienko15757312012-12-06 18:03:27 +0000311 verifyFormat("f(/*test=*/ true);");
312}
313
Alexander Kornienko15757312012-12-06 18:03:27 +0000314//===----------------------------------------------------------------------===//
315// Tests for classes, namespaces, etc.
316//===----------------------------------------------------------------------===//
317
318TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000319 verifyFormat("class A {};");
Alexander Kornienko15757312012-12-06 18:03:27 +0000320}
321
322TEST_F(FormatTest, UnderstandsAccessSpecifiers) {
323 verifyFormat("class A {\n"
324 "public:\n"
325 "protected:\n"
326 "private:\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000327 " void f() {}\n"
Alexander Kornienko15757312012-12-06 18:03:27 +0000328 "};");
329 verifyGoogleFormat("class A {\n"
330 " public:\n"
331 " protected:\n"
332 " private:\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000333 " void f() {}\n"
Alexander Kornienko15757312012-12-06 18:03:27 +0000334 "};");
335}
336
337TEST_F(FormatTest, FormatsDerivedClass) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000338 verifyFormat("class A : public B {};");
339 verifyFormat("class A : public ::B {};");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000340}
341
Manuel Klimekde768542013-01-07 18:10:23 +0000342TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000343 verifyFormat("class A {} a, b;");
344 verifyFormat("struct A {} a, b;");
Manuel Klimekde768542013-01-07 18:10:23 +0000345}
346
Alexander Kornienko15757312012-12-06 18:03:27 +0000347TEST_F(FormatTest, FormatsEnum) {
Alexander Kornienkoa166e732012-12-04 14:46:19 +0000348 verifyFormat("enum {\n"
349 " Zero,\n"
350 " One = 1,\n"
351 " Two = One + 1,\n"
352 " Three = (One + Two),\n"
353 " Four = (Zero && (One ^ Two)) | (One << Two),\n"
354 " Five = (One, Two, Three, Four, 5)\n"
355 "};");
356 verifyFormat("enum Enum {\n"
357 "};");
358 verifyFormat("enum {\n"
359 "};");
360}
361
Alexander Kornienko15757312012-12-06 18:03:27 +0000362TEST_F(FormatTest, FormatsNamespaces) {
363 verifyFormat("namespace some_namespace {\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000364 "class A {};\n"
Alexander Kornienko15757312012-12-06 18:03:27 +0000365 "void f() {\n"
366 " f();\n"
367 "}\n"
368 "}");
369 verifyFormat("namespace {\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000370 "class A {};\n"
Alexander Kornienko15757312012-12-06 18:03:27 +0000371 "void f() {\n"
372 " f();\n"
373 "}\n"
374 "}");
Dmitri Gribenko1f94f2b2012-12-30 21:27:25 +0000375 verifyFormat("inline namespace X {\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000376 "class A {};\n"
Dmitri Gribenko1f94f2b2012-12-30 21:27:25 +0000377 "void f() {\n"
378 " f();\n"
379 "}\n"
380 "}");
Alexander Kornienko15757312012-12-06 18:03:27 +0000381 verifyFormat("using namespace some_namespace;\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000382 "class A {};\n"
Alexander Kornienko15757312012-12-06 18:03:27 +0000383 "void f() {\n"
384 " f();\n"
385 "}");
386}
387
Nico Webera9ccdd12013-01-07 16:36:17 +0000388TEST_F(FormatTest, FormatTryCatch) {
389 verifyFormat("try {\n"
390 " throw a * b;\n"
391 "}\n"
392 "catch (int a) {\n"
393 " // Do nothing.\n"
394 "}\n"
395 "catch (...) {\n"
396 " exit(42);\n"
397 "}");
398
399 // Function-level try statements.
400 verifyFormat("int f() try {\n"
401 " return 4;\n"
402 "}\n"
403 "catch (...) {\n"
404 " return 5;\n"
405 "}");
406 verifyFormat("class A {\n"
407 " int a;\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000408 " A() try : a(0) {}\n"
Nico Webera9ccdd12013-01-07 16:36:17 +0000409 " catch (...) {\n"
410 " throw;\n"
411 " }\n"
412 "};\n");
413}
414
415TEST_F(FormatTest, FormatObjCTryCatch) {
416 verifyFormat("@try {\n"
417 " f();\n"
418 "}\n"
419 "@catch (NSException e) {\n"
420 " @throw;\n"
421 "}\n"
422 "@finally {\n"
423 " exit(42);\n"
424 "}");
425}
426
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000427TEST_F(FormatTest, StaticInitializers) {
428 verifyFormat("static SomeClass SC = { 1, 'a' };");
429
430 // FIXME: Format like enums if the static initializer does not fit on a line.
431 verifyFormat(
Daniel Jasper9cda8002013-01-07 13:08:40 +0000432 "static SomeClass WithALoooooooooooooooooooongName = {\n"
Manuel Klimekc8c8a472013-01-10 15:58:26 +0000433 " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n"
434 "};");
435
436 verifyFormat(
437 "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n"
438 " looooooooooooooooooooooooooooooooooongname,\n"
439 " looooooooooooooooooooooooooooooong };");
Daniel Jasper05b1ac82012-12-17 11:29:41 +0000440}
441
Manuel Klimeka080a182013-01-02 16:30:12 +0000442TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) {
443 verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro("
444 " \\\n"
445 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)");
446}
447
Daniel Jasper71607512013-01-07 10:48:50 +0000448TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) {
Daniel Jaspercd162382013-01-07 13:26:07 +0000449 verifyFormat("virtual void write(ELFWriter *writerrr,\n"
450 " OwningPtr<FileOutputBuffer> &buffer) = 0;");
Daniel Jasper71607512013-01-07 10:48:50 +0000451}
452
Manuel Klimeka080a182013-01-02 16:30:12 +0000453TEST_F(FormatTest, BreaksOnHashWhenDirectiveIsInvalid) {
454 EXPECT_EQ("#\n;", format("#;"));
Manuel Klimekdd5b1012013-01-07 10:03:37 +0000455 verifyFormat("#\n;\n;\n;");
Manuel Klimeka080a182013-01-02 16:30:12 +0000456}
457
458TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) {
459 EXPECT_EQ("#line 42 \"test\"\n",
460 format("# \\\n line \\\n 42 \\\n \"test\"\n"));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000461 EXPECT_EQ("#define A \\\n B\n",
462 format("# \\\n define \\\n A \\\n B\n",
463 getLLVMStyleWithColumns(12)));
Manuel Klimeka080a182013-01-02 16:30:12 +0000464}
465
466TEST_F(FormatTest, EndOfFileEndsPPDirective) {
467 EXPECT_EQ("#line 42 \"test\"",
468 format("# \\\n line \\\n 42 \\\n \"test\""));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000469 EXPECT_EQ("#define A \\\n B",
470 format("# \\\n define \\\n A \\\n B",
471 getLLVMStyleWithColumns(12)));
Manuel Klimeka080a182013-01-02 16:30:12 +0000472}
473
Manuel Klimek060143e2013-01-02 18:33:23 +0000474TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) {
Manuel Klimekd544c572013-01-07 09:24:17 +0000475 // If the macro fits in one line, we still do not get the full
476 // line, as only the next line decides whether we need an escaped newline and
477 // thus use the last column.
478 verifyFormat("#define A(B)", getLLVMStyleWithColumns(13));
Manuel Klimek060143e2013-01-02 18:33:23 +0000479
Manuel Klimekd544c572013-01-07 09:24:17 +0000480 verifyFormat("#define A( \\\n B)", getLLVMStyleWithColumns(12));
481 verifyFormat("#define AA(\\\n B)", getLLVMStyleWithColumns(12));
Manuel Klimek060143e2013-01-02 18:33:23 +0000482 verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12));
483}
484
485TEST_F(FormatTest, HandlePreprocessorDirectiveContext) {
Manuel Klimekd4397b92013-01-04 23:34:14 +0000486 EXPECT_EQ("// some comment\n"
487 "#include \"a.h\"\n"
488 "#define A(A,\\\n"
489 " B)\n"
490 "#include \"b.h\"\n"
491 "// some comment\n",
492 format(" // some comment\n"
493 " #include \"a.h\"\n"
494 "#define A(A,\\\n"
495 " B)\n"
496 " #include \"b.h\"\n"
497 " // some comment\n", getLLVMStyleWithColumns(13)));
Manuel Klimek060143e2013-01-02 18:33:23 +0000498}
499
Manuel Klimekd4397b92013-01-04 23:34:14 +0000500TEST_F(FormatTest, LayoutSingleHash) {
501 EXPECT_EQ("#\na;", format("#\na;"));
502}
503
504TEST_F(FormatTest, LayoutCodeInMacroDefinitions) {
505 EXPECT_EQ("#define A \\\n"
506 " c; \\\n"
507 " e;\n"
508 "f;", format("#define A c; e;\n"
509 "f;", getLLVMStyleWithColumns(14)));
510}
511
512TEST_F(FormatTest, LayoutRemainingTokens) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000513 EXPECT_EQ("{}", format("{}"));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000514}
515
516TEST_F(FormatTest, LayoutSingleUnwrappedLineInMacro) {
Daniel Jasper26f7e782013-01-08 14:56:18 +0000517 EXPECT_EQ("# define A\\\n b;",
518 format("# define A b;", 11, 2, getLLVMStyleWithColumns(11)));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000519}
520
521TEST_F(FormatTest, MacroDefinitionInsideStatement) {
Manuel Klimek526ed112013-01-09 15:25:02 +0000522 EXPECT_EQ("int x,\n"
523 "#define A\n"
524 " y;", format("int x,\n#define A\ny;"));
Manuel Klimekd4397b92013-01-04 23:34:14 +0000525}
526
Manuel Klimek6f8424b2013-01-05 21:34:55 +0000527TEST_F(FormatTest, HashInMacroDefinition) {
528 verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11));
529 verifyFormat("#define A \\\n"
530 " { \\\n"
531 " f(#c);\\\n"
532 " }", getLLVMStyleWithColumns(11));
Daniel Jasper765561f2013-01-08 16:17:54 +0000533
534 verifyFormat("#define A(X) \\\n"
535 " void function##X()", getLLVMStyleWithColumns(22));
536
537 verifyFormat("#define A(a, b, c) \\\n"
538 " void a##b##c()", getLLVMStyleWithColumns(22));
539
540 verifyFormat("#define A \\\n"
541 " void # ## #", getLLVMStyleWithColumns(22));
Manuel Klimek6f8424b2013-01-05 21:34:55 +0000542}
543
Manuel Klimekc37b4d62013-01-05 22:14:16 +0000544TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) {
545 EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}"));
546}
547
Manuel Klimekf6fd00b2013-01-05 22:56:06 +0000548TEST_F(FormatTest, FormatHashIfNotAtStartOfLine) {
549 verifyFormat("{\n {\n a #c;\n }\n}");
550}
551
Manuel Klimeka5342db2013-01-06 20:07:31 +0000552TEST_F(FormatTest, FormatUnbalancedStructuralElements) {
553 EXPECT_EQ("#define A \\\n { \\\n {\nint i;",
554 format("#define A { {\nint i;", getLLVMStyleWithColumns(11)));
555 EXPECT_EQ("#define A \\\n } \\\n }\nint i;",
556 format("#define A } }\nint i;", getLLVMStyleWithColumns(11)));
557}
Manuel Klimekd4397b92013-01-04 23:34:14 +0000558
Manuel Klimek95419382013-01-07 07:56:50 +0000559TEST_F(FormatTest, EscapedNewlineAtStartOfTokenInMacroDefinition) {
Daniel Jaspercd162382013-01-07 13:26:07 +0000560 EXPECT_EQ(
561 "#define A \\\n int i; \\\n int j;",
562 format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11)));
Manuel Klimek95419382013-01-07 07:56:50 +0000563}
564
Manuel Klimekd544c572013-01-07 09:24:17 +0000565TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) {
566 verifyFormat("#define A \\\n"
567 " int v( \\\n"
568 " a); \\\n"
569 " int i;", getLLVMStyleWithColumns(11));
570}
571
Manuel Klimeka080a182013-01-02 16:30:12 +0000572TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) {
Manuel Klimekd4397b92013-01-04 23:34:14 +0000573 EXPECT_EQ(
574 "#define ALooooooooooooooooooooooooooooooooooooooongMacro("
575 " \\\n"
576 " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n"
577 "\n"
578 "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n"
579 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n",
580 format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro("
581 "\\\n"
582 "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n"
583 " \n"
584 " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n"
585 " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n"));
Manuel Klimeka080a182013-01-02 16:30:12 +0000586}
587
Manuel Klimek526ed112013-01-09 15:25:02 +0000588TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) {
589 EXPECT_EQ("int\n"
590 "#define A\n"
591 " a;",
592 format("int\n#define A\na;"));
593 verifyFormat(
594 "functionCallTo(someOtherFunction(\n"
595 " withSomeParameters, whichInSequence,\n"
596 " areLongerThanALine(andAnotherCall,\n"
597 "#define A \\\n"
598 " B\n"
599 " withMoreParamters,\n"
600 " whichStronglyInfluenceTheLayout),\n"
601 " andMoreParameters),\n"
602 " trailing);", getLLVMStyleWithColumns(69));
603}
604
Manuel Klimekbb42bf12013-01-10 11:52:21 +0000605TEST_F(FormatTest, LayoutBlockInsideParens) {
606 EXPECT_EQ("functionCall({\n"
607 " int i;\n"
608 "});", format(" functionCall ( {int i;} );"));
609}
610
611TEST_F(FormatTest, LayoutBlockInsideStatement) {
612 EXPECT_EQ("SOME_MACRO {\n"
613 " int i;\n"
614 "}\n"
615 "int i;", format(" SOME_MACRO {int i;} int i;"));
616}
617
618TEST_F(FormatTest, LayoutNestedBlocks) {
619 verifyFormat("void AddOsStrings(unsigned bitmask) {\n"
620 " struct s {\n"
621 " int i;\n"
622 " };\n"
623 " s kBitsToOs[] = { { 10 } };\n"
624 " for (int i = 0; i < 10; ++i)\n"
625 " return;\n"
626 "}");
627}
628
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000629TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) {
630 EXPECT_EQ("{}", format("{}"));
631}
632
Alexander Kornienko15757312012-12-06 18:03:27 +0000633//===----------------------------------------------------------------------===//
634// Line break tests.
635//===----------------------------------------------------------------------===//
636
637TEST_F(FormatTest, FormatsFunctionDefinition) {
638 verifyFormat("void f(int a, int b, int c, int d, int e, int f, int g,"
639 " int h, int j, int f,\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000640 " int c, int ddddddddddddd) {}");
Alexander Kornienko15757312012-12-06 18:03:27 +0000641}
642
643TEST_F(FormatTest, FormatsAwesomeMethodCall) {
644 verifyFormat(
Daniel Jaspera4974cf2012-12-24 16:43:00 +0000645 "SomeLongMethodName(SomeReallyLongMethod(\n"
646 " CallOtherReallyLongMethod(parameter, parameter, parameter)),\n"
647 " SecondLongCall(parameter));");
Alexander Kornienko15757312012-12-06 18:03:27 +0000648}
649
Daniel Jasper1321eb52012-12-18 21:05:13 +0000650TEST_F(FormatTest, ConstructorInitializers) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000651 verifyFormat("Constructor() : Initializer(FitsOnTheLine) {}");
Daniel Jasper7e9bf8c2013-01-11 11:37:55 +0000652 verifyFormat("Constructor() : Inttializer(FitsOnTheLine) {}",
653 getLLVMStyleWithColumns(45));
654 verifyFormat("Constructor()\n"
655 " : Inttializer(FitsOnTheLine) {}",
656 getLLVMStyleWithColumns(44));
Daniel Jasper1321eb52012-12-18 21:05:13 +0000657
658 verifyFormat(
659 "SomeClass::Constructor()\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000660 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}");
Daniel Jasper1321eb52012-12-18 21:05:13 +0000661
662 verifyFormat(
663 "SomeClass::Constructor()\n"
Daniel Jasper7e9bf8c2013-01-11 11:37:55 +0000664 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
665 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}");
666 verifyGoogleFormat(
667 "SomeClass::Constructor()\n"
668 " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
669 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
670 " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}");
671
672 verifyFormat(
673 "SomeClass::Constructor()\n"
Daniel Jasper1321eb52012-12-18 21:05:13 +0000674 " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000675 " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}");
Daniel Jasper1321eb52012-12-18 21:05:13 +0000676
677 verifyFormat("Constructor()\n"
678 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
679 " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
680 " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000681 " aaaaaaaaaaaaaaaaaaaaaaa() {}");
Daniel Jasper1321eb52012-12-18 21:05:13 +0000682
683 // Here a line could be saved by splitting the second initializer onto two
684 // lines, but that is not desireable.
685 verifyFormat("Constructor()\n"
686 " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n"
687 " aaaaaaaaaaa(aaaaaaaaaaa),\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000688 " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
Daniel Jasper1321eb52012-12-18 21:05:13 +0000689
690 verifyGoogleFormat("MyClass::MyClass(int var)\n"
691 " : some_var_(var), // 4 space indent\n"
692 " some_other_var_(var + 1) { // lined up\n"
693 "}");
694}
695
Alexander Kornienko15757312012-12-06 18:03:27 +0000696TEST_F(FormatTest, BreaksAsHighAsPossible) {
697 verifyFormat(
698 "if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n"
699 " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n"
700 " f();");
701}
702
Daniel Jasperbac016b2012-12-03 18:12:45 +0000703TEST_F(FormatTest, BreaksDesireably) {
704 verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n"
705 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000706 " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000707
708 verifyFormat(
709 "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000710 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000711
712 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
713 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
714 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));");
Daniel Jaspera88bb452012-12-04 10:50:12 +0000715
716 verifyFormat(
717 "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
718 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n"
719 " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
720 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));");
Daniel Jasper33182dd2012-12-05 14:57:28 +0000721
722 verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
723 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
724
Daniel Jasper723f0302013-01-02 14:40:02 +0000725 verifyFormat(
726 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n"
727 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
728
Daniel Jasper33182dd2012-12-05 14:57:28 +0000729 // This test case breaks on an incorrect memoization, i.e. an optimization not
730 // taking into account the StopAt value.
731 verifyFormat(
732 "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
Daniel Jaspercf225b62012-12-24 13:43:52 +0000733 " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
734 " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
735 " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jaspera4974cf2012-12-24 16:43:00 +0000736
Daniel Jaspercd162382013-01-07 13:26:07 +0000737 verifyFormat("{\n {\n {\n"
738 " Annotation.SpaceRequiredBefore =\n"
739 " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n"
740 " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n"
741 " }\n }\n}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000742}
743
Daniel Jasper7d19bc22013-01-11 14:23:32 +0000744TEST_F(FormatTest, DoesNotBreakTrailingAnnotation) {
745 verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
746 " GUARDED_BY(aaaaaaaaaaaaa);");
747}
748
Daniel Jaspere2c7acf2012-12-24 00:13:23 +0000749TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) {
750 verifyFormat(
751 "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000752 " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {}");
Daniel Jaspercd162382013-01-07 13:26:07 +0000753 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000754 " ccccccccccccccccccccccccc) {}");
Daniel Jaspercd162382013-01-07 13:26:07 +0000755 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000756 " ccccccccccccccccccccccccc) {}");
Daniel Jaspere2c7acf2012-12-24 00:13:23 +0000757 verifyFormat(
758 "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000759 " ccccccccccccccccccccccccc) {}");
Daniel Jaspere2c7acf2012-12-24 00:13:23 +0000760}
761
Daniel Jasper9cda8002013-01-07 13:08:40 +0000762TEST_F(FormatTest, PrefersNotToBreakAfterAssignments) {
763 verifyFormat(
764 "unsigned Cost = TTI.getMemoryOpCost(I->getOpcode(), VectorTy,\n"
765 " SI->getAlignment(),\n"
766 " SI->getPointerAddressSpaceee());\n");
767 verifyFormat(
768 "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n"
769 " Line.Tokens.front().Tok.getLocation(),\n"
770 " Line.Tokens.back().Tok.getLocation());");
771}
772
Daniel Jaspercf225b62012-12-24 13:43:52 +0000773TEST_F(FormatTest, AlignsAfterAssignments) {
774 verifyFormat(
775 "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000776 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000777 verifyFormat(
778 "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000779 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000780 verifyFormat(
781 "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000782 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000783 verifyFormat(
784 "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
Daniel Jasper9cda8002013-01-07 13:08:40 +0000785 " aaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000786 verifyFormat(
Daniel Jasper9cda8002013-01-07 13:08:40 +0000787 "double LooooooooooooooooooooooooongResult = aaaaaaaaaaaaaaaaaaaaaaaa +\n"
788 " aaaaaaaaaaaaaaaaaaaaaaaa +\n"
789 " aaaaaaaaaaaaaaaaaaaaaaaa;");
Daniel Jaspercf225b62012-12-24 13:43:52 +0000790}
791
792TEST_F(FormatTest, AlignsAfterReturn) {
793 verifyFormat(
794 "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
795 " aaaaaaaaaaaaaaaaaaaaaaaaa;");
796 verifyFormat(
797 "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
798 " aaaaaaaaaaaaaaaaaaaaaaaaa);");
799}
800
Daniel Jasper9c837d02013-01-09 07:06:56 +0000801TEST_F(FormatTest, BreaksConditionalExpressions) {
802 verifyFormat(
803 "aaaa(aaaaaaaaaaaaaaaaaaaa,\n"
804 " aaaaaaaaaaaaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n"
805 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
806 verifyFormat("aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa ?\n"
807 " aaaaaaaaaaaaaaaaaaaaaaa : aaaaaaaaaaaaaaaaaaaaa);");
808}
809
Daniel Jasperbac016b2012-12-03 18:12:45 +0000810TEST_F(FormatTest, AlignsStringLiterals) {
811 verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n"
812 " \"short literal\");");
813 verifyFormat(
814 "looooooooooooooooooooooooongFunction(\n"
815 " \"short literal\"\n"
816 " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");");
817}
818
Alexander Kornienko15757312012-12-06 18:03:27 +0000819TEST_F(FormatTest, AlignsPipes) {
820 verifyFormat(
821 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
822 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
823 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
824 verifyFormat(
825 "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n"
826 " << aaaaaaaaaaaaaaaaaaaa;");
827 verifyFormat(
828 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
829 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
830 verifyFormat(
831 "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n"
832 " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n"
833 " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";");
834 verifyFormat(
835 "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
836 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
837 " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
838}
839
Daniel Jasperbac016b2012-12-03 18:12:45 +0000840TEST_F(FormatTest, UnderstandsEquals) {
841 verifyFormat(
842 "aaaaaaaaaaaaaaaaa =\n"
843 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
844 verifyFormat(
845 "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000846 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000847 verifyFormat(
848 "if (a) {\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000849 " f();\n"
Daniel Jasperbac016b2012-12-03 18:12:45 +0000850 "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000851 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000852
Daniel Jasper9cda8002013-01-07 13:08:40 +0000853 verifyFormat(
Daniel Jasper3fc0bb72013-01-09 10:40:23 +0000854 // FIXME: Does an expression like this ever make sense? If yes, fix.
Daniel Jasper9cda8002013-01-07 13:08:40 +0000855 "if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = 100000000 +\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000856 " 10000000) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000857}
858
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000859TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) {
Daniel Jasper1321eb52012-12-18 21:05:13 +0000860 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n"
861 " .looooooooooooooooooooooooooooooooooooooongFunction();");
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000862
Daniel Jasper1321eb52012-12-18 21:05:13 +0000863 verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n"
864 " ->looooooooooooooooooooooooooooooooooooooongFunction();");
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000865
866 verifyFormat(
867 "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n"
868 " Parameter2);");
869
870 verifyFormat(
871 "ShortObject->shortFunction(\n"
872 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n"
873 " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);");
874
875 verifyFormat("loooooooooooooongFunction(\n"
876 " LoooooooooooooongObject->looooooooooooooooongFunction());");
877
878 verifyFormat(
879 "function(LoooooooooooooooooooooooooooooooooooongObject\n"
880 " ->loooooooooooooooooooooooooooooooooooooooongFunction());");
881
Daniel Jasper46a46a22013-01-07 07:13:20 +0000882 // Here, it is not necessary to wrap at "." or "->".
Daniel Jasper1321eb52012-12-18 21:05:13 +0000883 verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000884 " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
Daniel Jasper46a46a22013-01-07 07:13:20 +0000885 verifyFormat(
886 "aaaaaaaaaaa->aaaaaaaaa(\n"
887 " aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
888 " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n");
Daniel Jasper9a0b4942012-12-17 14:34:14 +0000889}
890
Daniel Jasper9a64fb52013-01-02 15:08:56 +0000891TEST_F(FormatTest, WrapsTemplateDeclarations) {
892 verifyFormat("template <typename T>\n"
893 "virtual void loooooooooooongFunction(int Param1, int Param2);");
894 verifyFormat(
895 "template <typename T> void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n"
896 " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);");
897 verifyFormat(
898 "template <typename T>\n"
899 "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n"
900 " int Paaaaaaaaaaaaaaaaaaaaram2);");
Daniel Jasper5eda31e2013-01-02 18:30:06 +0000901 verifyFormat(
902 "template <typename T>\n"
903 "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n"
904 " aaaaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaaaaa,\n"
905 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
Daniel Jasperd64f7382013-01-09 09:50:48 +0000906 verifyFormat("template <typename T>\n"
907 "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
908 " int aaaaaaaaaaaaaaaaa);");
Daniel Jasper3fc0bb72013-01-09 10:40:23 +0000909 verifyFormat(
910 "template <typename T1, typename T2 = char, typename T3 = char,\n"
911 " typename T4 = char>\n"
912 "void f();");
Daniel Jasper9a64fb52013-01-02 15:08:56 +0000913}
914
Daniel Jasperbac016b2012-12-03 18:12:45 +0000915TEST_F(FormatTest, UnderstandsTemplateParameters) {
916 verifyFormat("A<int> a;");
917 verifyFormat("A<A<A<int> > > a;");
918 verifyFormat("A<A<A<int, 2>, 3>, 4> a;");
919 verifyFormat("bool x = a < 1 || 2 > a;");
920 verifyFormat("bool x = 5 < f<int>();");
921 verifyFormat("bool x = f<int>() > 5;");
922 verifyFormat("bool x = 5 < a<int>::x;");
923 verifyFormat("bool x = a < 4 ? a > 2 : false;");
924 verifyFormat("bool x = f() ? a < 2 : a > 2;");
925
926 verifyGoogleFormat("A<A<int>> a;");
927 verifyGoogleFormat("A<A<A<int>>> a;");
928 verifyGoogleFormat("A<A<A<A<int>>>> a;");
929
930 verifyFormat("test >> a >> b;");
931 verifyFormat("test << a >> b;");
932
933 verifyFormat("f<int>();");
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000934 verifyFormat("template <typename T> void f() {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000935}
936
Daniel Jasper98e6b4a2012-12-21 09:41:31 +0000937TEST_F(FormatTest, UnderstandsUnaryOperators) {
Daniel Jasperbac016b2012-12-03 18:12:45 +0000938 verifyFormat("int a = -2;");
Daniel Jasper8822d3a2012-12-04 13:02:32 +0000939 verifyFormat("f(-1, -2, -3);");
940 verifyFormat("a[-1] = 5;");
941 verifyFormat("int a = 5 + -2;");
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000942 verifyFormat("if (i == -1) {}");
943 verifyFormat("if (i != -1) {}");
944 verifyFormat("if (i > -1) {}");
945 verifyFormat("if (i < -1) {}");
Daniel Jasperd56a7372012-12-06 13:16:39 +0000946 verifyFormat("++(a->f());");
947 verifyFormat("--(a->f());");
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000948 verifyFormat("if (!(a->f())) {}");
Daniel Jasper98e6b4a2012-12-21 09:41:31 +0000949
950 verifyFormat("a-- > b;");
951 verifyFormat("b ? -a : c;");
952 verifyFormat("n * sizeof char16;");
Daniel Jasperba3d3072013-01-02 17:21:36 +0000953 verifyFormat("n * alignof char16;");
Daniel Jasper98e6b4a2012-12-21 09:41:31 +0000954 verifyFormat("sizeof(char);");
Daniel Jasperba3d3072013-01-02 17:21:36 +0000955 verifyFormat("alignof(char);");
Daniel Jasper1f0754b2013-01-02 15:26:16 +0000956
957 verifyFormat("return -1;");
958 verifyFormat("switch (a) {\n"
959 "case -1:\n"
960 " break;\n"
961 "}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000962}
963
964TEST_F(FormatTest, UndestandsOverloadedOperators) {
Daniel Jasperf6aef6a2012-12-24 10:56:04 +0000965 verifyFormat("bool operator<();");
966 verifyFormat("bool operator>();");
967 verifyFormat("bool operator=();");
968 verifyFormat("bool operator==();");
969 verifyFormat("bool operator!=();");
970 verifyFormat("int operator+();");
971 verifyFormat("int operator++();");
972 verifyFormat("bool operator();");
973 verifyFormat("bool operator()();");
974 verifyFormat("bool operator[]();");
975 verifyFormat("operator bool();");
976 verifyFormat("operator SomeType<int>();");
977 verifyFormat("void *operator new(std::size_t size);");
978 verifyFormat("void *operator new[](std::size_t size);");
979 verifyFormat("void operator delete(void *ptr);");
980 verifyFormat("void operator delete[](void *ptr);");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000981}
982
Daniel Jasper5d334402013-01-02 08:57:10 +0000983TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000984 verifyFormat("int *f(int *a) {}");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000985 verifyFormat("f(a, *a);");
986 verifyFormat("f(*a);");
987 verifyFormat("int a = b * 10;");
988 verifyFormat("int a = 10 * b;");
Daniel Jasper112fb272012-12-05 07:51:39 +0000989 verifyFormat("int a = b * c;");
Daniel Jasper33182dd2012-12-05 14:57:28 +0000990 verifyFormat("int a += b * c;");
991 verifyFormat("int a -= b * c;");
992 verifyFormat("int a *= b * c;");
993 verifyFormat("int a /= b * c;");
Daniel Jasperbac016b2012-12-03 18:12:45 +0000994 verifyFormat("int a = *b;");
Daniel Jasper112fb272012-12-05 07:51:39 +0000995 verifyFormat("int a = *b * c;");
996 verifyFormat("int a = b * *c;");
Manuel Klimek36fab8d2013-01-10 13:24:24 +0000997 verifyFormat("int main(int argc, char **argv) {}");
Nico Weber00d5a042012-12-23 01:07:46 +0000998 verifyFormat("return 10 * b;");
999 verifyFormat("return *b * *c;");
1000 verifyFormat("return a & ~b;");
Daniel Jasper5d334402013-01-02 08:57:10 +00001001 verifyFormat("f(b ? *c : *d);");
1002 verifyFormat("int a = b ? *c : *d;");
Daniel Jasperba3d3072013-01-02 17:21:36 +00001003 verifyFormat("*b = a;");
1004 verifyFormat("a * ~b;");
1005 verifyFormat("a * !b;");
1006 verifyFormat("a * +b;");
1007 verifyFormat("a * -b;");
1008 verifyFormat("a * ++b;");
1009 verifyFormat("a * --b;");
Daniel Jasper5cf7cf32013-01-10 11:14:08 +00001010 verifyFormat("int *pa = (int *)&a;");
Daniel Jasperc74e2792012-12-07 09:52:15 +00001011
Daniel Jasper9bb0d282013-01-04 20:46:38 +00001012 verifyFormat("InvalidRegions[*R] = 0;");
1013
Daniel Jasper8b39c662012-12-10 18:59:13 +00001014 verifyFormat("A<int *> a;");
1015 verifyFormat("A<int **> a;");
1016 verifyFormat("A<int *, int *> a;");
1017 verifyFormat("A<int **, int **> a;");
Daniel Jasperef5b9c32013-01-02 15:46:59 +00001018 verifyFormat("Type *A = static_cast<Type *>(P);");
Daniel Jasper5cf7cf32013-01-10 11:14:08 +00001019 verifyFormat("Type *A = (Type *)P;");
1020 verifyFormat("Type *A = (vector<Type *, int *>)P;");
Daniel Jasper8b39c662012-12-10 18:59:13 +00001021
Daniel Jasper2db356d2013-01-08 20:03:18 +00001022 verifyFormat(
1023 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
1024 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
1025
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001026 verifyGoogleFormat("int main(int argc, char** argv) {}");
Daniel Jasper8b39c662012-12-10 18:59:13 +00001027 verifyGoogleFormat("A<int*> a;");
1028 verifyGoogleFormat("A<int**> a;");
1029 verifyGoogleFormat("A<int*, int*> a;");
1030 verifyGoogleFormat("A<int**, int**> a;");
Daniel Jasper5d334402013-01-02 08:57:10 +00001031 verifyGoogleFormat("f(b ? *c : *d);");
1032 verifyGoogleFormat("int a = b ? *c : *d;");
Daniel Jasperbac016b2012-12-03 18:12:45 +00001033}
1034
Daniel Jasper46ef8522013-01-10 13:08:12 +00001035TEST_F(FormatTest, FormatsFunctionTypes) {
1036 // FIXME: Determine the cases that need a space after the return type and fix.
1037 verifyFormat("A<bool()> a;");
1038 verifyFormat("A<SomeType()> a;");
1039 verifyFormat("A<void(*)(int, std::string)> a;");
1040
1041 verifyFormat("int(*func)(void *);");
1042}
1043
Daniel Jasper4dc41de2013-01-02 08:44:14 +00001044TEST_F(FormatTest, DoesNotBreakBeforePointerOrReference) {
Daniel Jaspercd162382013-01-07 13:26:07 +00001045 verifyFormat("int *someFunction(int LoooooooooooooooongParam1,\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001046 " int LoooooooooooooooongParam2) {}");
Daniel Jasper4dc41de2013-01-02 08:44:14 +00001047 verifyFormat(
1048 "TypeSpecDecl *TypeSpecDecl::Create(ASTContext &C, DeclContext *DC,\n"
1049 " SourceLocation L, IdentifierIn *II,\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001050 " Type *T) {}");
Daniel Jasper4dc41de2013-01-02 08:44:14 +00001051}
1052
Daniel Jasper3b5943f2012-12-06 09:56:08 +00001053TEST_F(FormatTest, LineStartsWithSpecialCharacter) {
1054 verifyFormat("(a)->b();");
1055 verifyFormat("--a;");
1056}
1057
Daniel Jasper8822d3a2012-12-04 13:02:32 +00001058TEST_F(FormatTest, HandlesIncludeDirectives) {
1059 EXPECT_EQ("#include <string>\n", format("#include <string>\n"));
Daniel Jaspercd1a32b2012-12-21 17:58:39 +00001060 EXPECT_EQ("#include <a/b/c.h>\n", format("#include <a/b/c.h>\n"));
Daniel Jasper8822d3a2012-12-04 13:02:32 +00001061 EXPECT_EQ("#include \"a/b/string\"\n", format("#include \"a/b/string\"\n"));
1062 EXPECT_EQ("#include \"string.h\"\n", format("#include \"string.h\"\n"));
1063 EXPECT_EQ("#include \"string.h\"\n", format("#include \"string.h\"\n"));
Nico Weberb23ae0c2012-12-21 18:21:56 +00001064
1065 EXPECT_EQ("#import <string>\n", format("#import <string>\n"));
1066 EXPECT_EQ("#import <a/b/c.h>\n", format("#import <a/b/c.h>\n"));
1067 EXPECT_EQ("#import \"a/b/string\"\n", format("#import \"a/b/string\"\n"));
1068 EXPECT_EQ("#import \"string.h\"\n", format("#import \"string.h\"\n"));
1069 EXPECT_EQ("#import \"string.h\"\n", format("#import \"string.h\"\n"));
Daniel Jasper8822d3a2012-12-04 13:02:32 +00001070}
1071
Alexander Kornienko15757312012-12-06 18:03:27 +00001072//===----------------------------------------------------------------------===//
1073// Error recovery tests.
1074//===----------------------------------------------------------------------===//
1075
Daniel Jasper700e7102013-01-10 09:26:47 +00001076TEST_F(FormatTest, IncorrectCodeTrailingStuff) {
1077 verifyFormat("void f() { return } 42");
1078}
1079
Daniel Jasperceb99ab2013-01-09 10:16:05 +00001080TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) {
1081 verifyFormat("int aaaaaaaa =\n"
1082 " // Overly long comment\n"
1083 " b;", getLLVMStyleWithColumns(20));
1084 verifyFormat("function(\n"
1085 " ShortArgument,\n"
1086 " LoooooooooooongArgument);\n", getLLVMStyleWithColumns(20));
1087}
1088
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001089TEST_F(FormatTest, IncorrectAccessSpecifier) {
1090 verifyFormat("public:");
1091 verifyFormat("class A {\n"
1092 "public\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001093 " void f() {}\n"
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001094 "};");
1095 verifyFormat("public\n"
1096 "int qwerty;");
1097 verifyFormat("public\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001098 "B {}");
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001099 verifyFormat("public\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001100 "{}");
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001101 verifyFormat("public\n"
1102 "B {\n"
1103 " int x;\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001104 "}");
Alexander Kornienko56e49c52012-12-10 16:34:48 +00001105}
Daniel Jasperbac016b2012-12-03 18:12:45 +00001106
Alexander Kornienko393b0082012-12-04 15:40:36 +00001107TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) {
1108 verifyFormat("{");
1109}
1110
1111TEST_F(FormatTest, IncorrectCodeDoNoWhile) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001112 verifyFormat("do {}");
1113 verifyFormat("do {}\n"
Alexander Kornienko393b0082012-12-04 15:40:36 +00001114 "f();");
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001115 verifyFormat("do {}\n"
Alexander Kornienko393b0082012-12-04 15:40:36 +00001116 "wheeee(fun);");
1117 verifyFormat("do {\n"
1118 " f();\n"
Manuel Klimekde768542013-01-07 18:10:23 +00001119 "}");
Alexander Kornienko393b0082012-12-04 15:40:36 +00001120}
1121
Daniel Jasper1f42f112013-01-04 18:52:56 +00001122TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) {
1123 verifyFormat("namespace {\n"
Manuel Klimekd4397b92013-01-04 23:34:14 +00001124 "class Foo { Foo ( }; } // comment");
Daniel Jasper1f42f112013-01-04 18:52:56 +00001125}
1126
Alexander Kornienkocff563c2012-12-04 17:27:50 +00001127TEST_F(FormatTest, IncorrectCodeErrorDetection) {
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001128 EXPECT_EQ("{\n{}\n", format("{\n{\n}\n"));
1129 EXPECT_EQ("{\n {}\n", format("{\n {\n}\n"));
1130 EXPECT_EQ("{\n {}\n", format("{\n {\n }\n"));
1131 EXPECT_EQ("{\n {}\n }\n}\n", format("{\n {\n }\n }\n}\n"));
Alexander Kornienkocff563c2012-12-04 17:27:50 +00001132
1133 FormatStyle Style = getLLVMStyle();
1134 Style.ColumnLimit = 10;
1135 EXPECT_EQ("{\n"
1136 " {\n"
1137 " breakme(\n"
1138 " qwe);\n"
1139 "}\n", format("{\n"
1140 " {\n"
1141 " breakme(qwe);\n"
1142 "}\n", Style));
1143
1144}
1145
Manuel Klimek2851c162013-01-10 14:36:46 +00001146TEST_F(FormatTest, LayoutCallsInsideBraceInitializers) {
1147 verifyFormat(
1148 "int x = {\n"
1149 " avariable,\n"
Manuel Klimekc8c8a472013-01-10 15:58:26 +00001150 " b(alongervariable)\n"
1151 "};", getLLVMStyleWithColumns(25));
Manuel Klimek2851c162013-01-10 14:36:46 +00001152}
1153
1154TEST_F(FormatTest, LayoutTokensFollowingBlockInParentheses) {
1155 verifyFormat(
1156 "Aaa({\n"
1157 " int i;\n"
1158 "}, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
1159 " ccccccccccccccccc));");
1160}
1161
Nico Webercf4a79c2013-01-08 17:56:31 +00001162//===----------------------------------------------------------------------===//
1163// Objective-C tests.
1164//===----------------------------------------------------------------------===//
1165
Fariborz Jahanian154120c2012-12-20 19:54:13 +00001166TEST_F(FormatTest, FormatForObjectiveCMethodDecls) {
1167 verifyFormat("- (void)sendAction:(SEL)aSelector to:(BOOL)anObject;");
1168 EXPECT_EQ("- (NSUInteger)indexOfObject:(id)anObject;",
1169 format("-(NSUInteger)indexOfObject:(id)anObject;"));
Daniel Jaspercd162382013-01-07 13:26:07 +00001170 EXPECT_EQ("- (NSInteger)Mthod1;", format("-(NSInteger)Mthod1;"));
Fariborz Jahanian154120c2012-12-20 19:54:13 +00001171 EXPECT_EQ("+ (id)Mthod2;", format("+(id)Mthod2;"));
1172 EXPECT_EQ("- (NSInteger)Method3:(id)anObject;",
1173 format("-(NSInteger)Method3:(id)anObject;"));
1174 EXPECT_EQ("- (NSInteger)Method4:(id)anObject;",
1175 format("-(NSInteger)Method4:(id)anObject;"));
1176 EXPECT_EQ("- (NSInteger)Method5:(id)anObject:(id)AnotherObject;",
1177 format("-(NSInteger)Method5:(id)anObject:(id)AnotherObject;"));
1178 EXPECT_EQ("- (id)Method6:(id)A:(id)B:(id)C:(id)D;",
1179 format("- (id)Method6:(id)A:(id)B:(id)C:(id)D;"));
Daniel Jaspercd162382013-01-07 13:26:07 +00001180 EXPECT_EQ(
1181 "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;",
1182 format("- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;"));
Fariborz Jahanian9b3f02c2012-12-21 22:51:18 +00001183
1184 // Very long objectiveC method declaration.
Daniel Jaspercd162382013-01-07 13:26:07 +00001185 EXPECT_EQ(
1186 "- (NSUInteger)indexOfObject:(id)anObject inRange:(NSRange)range\n "
1187 "outRange:(NSRange)out_range outRange1:(NSRange)out_range1\n "
1188 "outRange2:(NSRange)out_range2 outRange3:(NSRange)out_range3\n "
1189 "outRange4:(NSRange)out_range4 outRange5:(NSRange)out_range5\n "
1190 "outRange6:(NSRange)out_range6 outRange7:(NSRange)out_range7\n "
1191 "outRange8:(NSRange)out_range8 outRange9:(NSRange)out_range9;",
1192 format(
1193 "- (NSUInteger)indexOfObject:(id)anObject inRange:(NSRange)range "
1194 "outRange:(NSRange) out_range outRange1:(NSRange) out_range1 "
1195 "outRange2:(NSRange) out_range2 outRange3:(NSRange) out_range3 "
1196 "outRange4:(NSRange) out_range4 outRange5:(NSRange) out_range5 "
1197 "outRange6:(NSRange) out_range6 outRange7:(NSRange) out_range7 "
1198 "outRange8:(NSRange) out_range8 outRange9:(NSRange) out_range9;"));
Nico Webere0fd4292013-01-10 20:18:33 +00001199
1200 verifyFormat("- (int)sum:(vector<int>)numbers;");
Nico Webercd52bda2013-01-10 23:11:41 +00001201 verifyGoogleFormat("-(void) setDelegate:(id<Protocol>)delegate;");
Nico Webere0fd4292013-01-10 20:18:33 +00001202 // FIXME: In LLVM style, there should be a space in front of a '<' for ObjC
1203 // protocol lists (but not for template classes):
1204 //verifyFormat("- (void)setDelegate:(id <Protocol>)delegate;");
Nico Webercd52bda2013-01-10 23:11:41 +00001205
1206 verifyFormat("- (int(*)())foo:(int(*)())f;");
1207 verifyGoogleFormat("-(int(*)()) foo:(int(*)())foo;");
1208
1209 // If there's no return type (very rare in practice!), LLVM and Google style
1210 // agree.
1211 verifyFormat("- foo:(int)f;");
1212 verifyGoogleFormat("- foo:(int)foo;");
Fariborz Jahanian154120c2012-12-20 19:54:13 +00001213}
1214
Daniel Jasper886568d2013-01-09 08:36:49 +00001215TEST_F(FormatTest, FormatObjCBlocks) {
Daniel Jasper46ef8522013-01-10 13:08:12 +00001216 verifyFormat("int (^Block)(int, int);");
1217 verifyFormat("int (^Block1)(int, int) = ^(int i, int j)");
Daniel Jasper886568d2013-01-09 08:36:49 +00001218}
1219
Nico Weber27d13672013-01-09 20:25:35 +00001220TEST_F(FormatTest, FormatObjCInterface) {
1221 // FIXME: Handle comments like in "@interface /* wait for it */ Foo", PR14875
Nico Weber5f500df2013-01-10 20:12:55 +00001222 verifyFormat("@interface Foo : NSObject <NSSomeDelegate> {\n"
Nico Weber27d13672013-01-09 20:25:35 +00001223 "@public\n"
1224 " int field1;\n"
1225 "@protected\n"
1226 " int field2;\n"
1227 "@private\n"
1228 " int field3;\n"
1229 "@package\n"
1230 " int field4;\n"
1231 "}\n"
1232 "+ (id)init;\n"
1233 "@end");
1234
Nico Weber27d13672013-01-09 20:25:35 +00001235 verifyGoogleFormat("@interface Foo : NSObject<NSSomeDelegate> {\n"
1236 " @public\n"
1237 " int field1;\n"
1238 " @protected\n"
1239 " int field2;\n"
1240 " @private\n"
1241 " int field3;\n"
1242 " @package\n"
1243 " int field4;\n"
1244 "}\n"
Nico Webercd52bda2013-01-10 23:11:41 +00001245 "+(id) init;\n"
Nico Weber27d13672013-01-09 20:25:35 +00001246 "@end");
1247
1248 verifyFormat("@interface Foo\n"
1249 "+ (id)init;\n"
1250 "// Look, a comment!\n"
1251 "- (int)answerWith:(int)i;\n"
1252 "@end");
1253
1254 verifyFormat("@interface Foo\n"
Nico Weber049c4472013-01-09 21:42:32 +00001255 "@end\n"
1256 "@interface Bar\n"
Nico Weber27d13672013-01-09 20:25:35 +00001257 "@end");
1258
1259 verifyFormat("@interface Foo : Bar\n"
1260 "+ (id)init;\n"
1261 "@end");
1262
Nico Weber5f500df2013-01-10 20:12:55 +00001263 verifyFormat("@interface Foo : Bar <Baz, Quux>\n"
Nico Weber27d13672013-01-09 20:25:35 +00001264 "+ (id)init;\n"
1265 "@end");
1266
Nico Weber5f500df2013-01-10 20:12:55 +00001267 verifyGoogleFormat("@interface Foo : Bar<Baz, Quux>\n"
Nico Webercd52bda2013-01-10 23:11:41 +00001268 "+(id) init;\n"
Nico Weber5f500df2013-01-10 20:12:55 +00001269 "@end");
1270
Nico Webered91bba2013-01-10 19:19:14 +00001271 verifyFormat("@interface Foo (HackStuff)\n"
Nico Weber27d13672013-01-09 20:25:35 +00001272 "+ (id)init;\n"
1273 "@end");
1274
Nico Webered91bba2013-01-10 19:19:14 +00001275 verifyFormat("@interface Foo ()\n"
Nico Weber27d13672013-01-09 20:25:35 +00001276 "+ (id)init;\n"
1277 "@end");
1278
Nico Weber5f500df2013-01-10 20:12:55 +00001279 verifyFormat("@interface Foo (HackStuff) <MyProtocol>\n"
Nico Weber27d13672013-01-09 20:25:35 +00001280 "+ (id)init;\n"
1281 "@end");
1282
Nico Weber5f500df2013-01-10 20:12:55 +00001283 verifyGoogleFormat("@interface Foo (HackStuff)<MyProtocol>\n"
Nico Webercd52bda2013-01-10 23:11:41 +00001284 "+(id) init;\n"
Nico Weber5f500df2013-01-10 20:12:55 +00001285 "@end");
1286
Nico Weber27d13672013-01-09 20:25:35 +00001287 verifyFormat("@interface Foo {\n"
1288 " int _i;\n"
1289 "}\n"
1290 "+ (id)init;\n"
1291 "@end");
1292
1293 verifyFormat("@interface Foo : Bar {\n"
1294 " int _i;\n"
1295 "}\n"
1296 "+ (id)init;\n"
1297 "@end");
1298
Nico Weber5f500df2013-01-10 20:12:55 +00001299 verifyFormat("@interface Foo : Bar <Baz, Quux> {\n"
Nico Weber27d13672013-01-09 20:25:35 +00001300 " int _i;\n"
1301 "}\n"
1302 "+ (id)init;\n"
1303 "@end");
1304
Nico Webered91bba2013-01-10 19:19:14 +00001305 verifyFormat("@interface Foo (HackStuff) {\n"
Nico Weber27d13672013-01-09 20:25:35 +00001306 " int _i;\n"
1307 "}\n"
1308 "+ (id)init;\n"
1309 "@end");
1310
Nico Webered91bba2013-01-10 19:19:14 +00001311 verifyFormat("@interface Foo () {\n"
Nico Weber27d13672013-01-09 20:25:35 +00001312 " int _i;\n"
1313 "}\n"
1314 "+ (id)init;\n"
1315 "@end");
1316
Nico Weber5f500df2013-01-10 20:12:55 +00001317 verifyFormat("@interface Foo (HackStuff) <MyProtocol> {\n"
Nico Weber27d13672013-01-09 20:25:35 +00001318 " int _i;\n"
1319 "}\n"
1320 "+ (id)init;\n"
1321 "@end");
1322}
1323
Nico Weber50767d82013-01-09 23:25:37 +00001324TEST_F(FormatTest, FormatObjCImplementation) {
1325 verifyFormat("@implementation Foo : NSObject {\n"
1326 "@public\n"
1327 " int field1;\n"
1328 "@protected\n"
1329 " int field2;\n"
1330 "@private\n"
1331 " int field3;\n"
1332 "@package\n"
1333 " int field4;\n"
1334 "}\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001335 "+ (id)init {}\n"
Nico Weber50767d82013-01-09 23:25:37 +00001336 "@end");
1337
1338 verifyGoogleFormat("@implementation Foo : NSObject {\n"
1339 " @public\n"
1340 " int field1;\n"
1341 " @protected\n"
1342 " int field2;\n"
1343 " @private\n"
1344 " int field3;\n"
1345 " @package\n"
1346 " int field4;\n"
1347 "}\n"
Nico Webercd52bda2013-01-10 23:11:41 +00001348 "+(id) init {}\n"
Nico Weber50767d82013-01-09 23:25:37 +00001349 "@end");
1350
1351 verifyFormat("@implementation Foo\n"
1352 "+ (id)init {\n"
1353 " if (true)\n"
1354 " return nil;\n"
1355 "}\n"
1356 "// Look, a comment!\n"
1357 "- (int)answerWith:(int)i {\n"
1358 " return i;\n"
1359 "}\n"
1360 "@end");
1361
1362 verifyFormat("@implementation Foo\n"
1363 "@end\n"
1364 "@implementation Bar\n"
1365 "@end");
1366
1367 verifyFormat("@implementation Foo : Bar\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001368 "+ (id)init {}\n"
Nico Weber50767d82013-01-09 23:25:37 +00001369 "@end");
1370
1371 verifyFormat("@implementation Foo {\n"
1372 " int _i;\n"
1373 "}\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001374 "+ (id)init {}\n"
Nico Weber50767d82013-01-09 23:25:37 +00001375 "@end");
1376
1377 verifyFormat("@implementation Foo : Bar {\n"
1378 " int _i;\n"
1379 "}\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001380 "+ (id)init {}\n"
Nico Weber50767d82013-01-09 23:25:37 +00001381 "@end");
1382
Nico Webered91bba2013-01-10 19:19:14 +00001383 verifyFormat("@implementation Foo (HackStuff)\n"
Manuel Klimek36fab8d2013-01-10 13:24:24 +00001384 "+ (id)init {}\n"
Nico Weber50767d82013-01-09 23:25:37 +00001385 "@end");
1386}
1387
Nico Weber1abe6ea2013-01-09 21:15:03 +00001388TEST_F(FormatTest, FormatObjCProtocol) {
1389 verifyFormat("@protocol Foo\n"
1390 "@property(weak) id delegate;\n"
1391 "- (NSUInteger)numberOfThings;\n"
1392 "@end");
1393
Nico Weber5f500df2013-01-10 20:12:55 +00001394 verifyFormat("@protocol MyProtocol <NSObject>\n"
Nico Weber1abe6ea2013-01-09 21:15:03 +00001395 "- (NSUInteger)numberOfThings;\n"
1396 "@end");
1397
Nico Weber5f500df2013-01-10 20:12:55 +00001398 verifyGoogleFormat("@protocol MyProtocol<NSObject>\n"
Nico Webercd52bda2013-01-10 23:11:41 +00001399 "-(NSUInteger) numberOfThings;\n"
Nico Weber5f500df2013-01-10 20:12:55 +00001400 "@end");
1401
Nico Weber1abe6ea2013-01-09 21:15:03 +00001402 verifyFormat("@protocol Foo;\n"
1403 "@protocol Bar;\n");
Nico Weber049c4472013-01-09 21:42:32 +00001404
1405 verifyFormat("@protocol Foo\n"
1406 "@end\n"
1407 "@protocol Bar\n"
1408 "@end");
Nico Weberb530fa32013-01-10 00:25:19 +00001409
1410 verifyFormat("@protocol myProtocol\n"
1411 "- (void)mandatoryWithInt:(int)i;\n"
1412 "@optional\n"
1413 "- (void)optional;\n"
1414 "@required\n"
1415 "- (void)required;\n"
Nico Weber880e5382013-01-10 00:42:07 +00001416 "@optional\n"
1417 "@property(assign) int madProp;\n"
Nico Weberb530fa32013-01-10 00:25:19 +00001418 "@end\n");
Nico Weber1abe6ea2013-01-09 21:15:03 +00001419}
1420
Nico Weber581f5572013-01-07 15:56:25 +00001421TEST_F(FormatTest, ObjCAt) {
Nico Weber4a293a22013-01-07 16:07:07 +00001422 verifyFormat("@autoreleasepool");
Nico Weberd0af4b42013-01-07 16:14:28 +00001423 verifyFormat("@catch");
1424 verifyFormat("@class");
Nico Weber4a293a22013-01-07 16:07:07 +00001425 verifyFormat("@compatibility_alias");
1426 verifyFormat("@defs");
Nico Weberefcfe732013-01-07 15:17:23 +00001427 verifyFormat("@dynamic");
Nico Weber4a293a22013-01-07 16:07:07 +00001428 verifyFormat("@encode");
1429 verifyFormat("@end");
1430 verifyFormat("@finally");
1431 verifyFormat("@implementation");
1432 verifyFormat("@import");
1433 verifyFormat("@interface");
1434 verifyFormat("@optional");
1435 verifyFormat("@package");
Nico Weberd0af4b42013-01-07 16:14:28 +00001436 verifyFormat("@private");
Nico Weber4a293a22013-01-07 16:07:07 +00001437 verifyFormat("@property");
Nico Weberd0af4b42013-01-07 16:14:28 +00001438 verifyFormat("@protected");
Nico Weber4a293a22013-01-07 16:07:07 +00001439 verifyFormat("@protocol");
Nico Weberd0af4b42013-01-07 16:14:28 +00001440 verifyFormat("@public");
Nico Weber4a293a22013-01-07 16:07:07 +00001441 verifyFormat("@required");
1442 verifyFormat("@selector");
1443 verifyFormat("@synchronized");
1444 verifyFormat("@synthesize");
Nico Weberd0af4b42013-01-07 16:14:28 +00001445 verifyFormat("@throw");
1446 verifyFormat("@try");
Nico Weber4a293a22013-01-07 16:07:07 +00001447
Nico Webercb4d6902013-01-08 19:40:21 +00001448 verifyFormat("@\"String\"");
1449 verifyFormat("@1");
Nico Weber81ed2f12013-01-10 19:36:35 +00001450 verifyFormat("@+4.8");
1451 verifyFormat("@-4");
Nico Webercb4d6902013-01-08 19:40:21 +00001452 verifyFormat("@1LL");
1453 verifyFormat("@.5");
1454 verifyFormat("@'c'");
1455 verifyFormat("@true");
1456 verifyFormat("NSNumber *smallestInt = @(-INT_MAX - 1);");
1457 verifyFormat("@[");
1458 verifyFormat("@{");
1459
Nico Weber581f5572013-01-07 15:56:25 +00001460 EXPECT_EQ("@interface", format("@ interface"));
1461
1462 // The precise formatting of this doesn't matter, nobody writes code like
1463 // this.
1464 verifyFormat("@ /*foo*/ interface");
Nico Weberefcfe732013-01-07 15:17:23 +00001465}
1466
Nico Weberc31689a2013-01-08 19:15:23 +00001467TEST_F(FormatTest, ObjCSnippets) {
1468 // FIXME: Make the uncommented lines below pass.
1469 verifyFormat("@autoreleasepool {\n"
1470 " foo();\n"
1471 "}");
Nico Webercf4a79c2013-01-08 17:56:31 +00001472 verifyFormat("@class Foo, Bar;");
Nico Weberc31689a2013-01-08 19:15:23 +00001473 verifyFormat("@compatibility_alias AliasName ExistingClass;");
Nico Webercf4a79c2013-01-08 17:56:31 +00001474 verifyFormat("@dynamic textColor;");
Nico Weberc31689a2013-01-08 19:15:23 +00001475 //verifyFormat("char *buf1 = @encode(int **);");
Nico Weber3a2673e2013-01-08 20:16:23 +00001476 verifyFormat("Protocol *proto = @protocol(p1);");
Nico Weberc31689a2013-01-08 19:15:23 +00001477 //verifyFormat("SEL s = @selector(foo:);");
Nico Weber3a2673e2013-01-08 20:16:23 +00001478 verifyFormat("@synchronized(self) {\n"
1479 " f();\n"
1480 "}");
Nico Webercf4a79c2013-01-08 17:56:31 +00001481
Nico Weber70848232013-01-10 21:30:42 +00001482 verifyFormat("@synthesize dropArrowPosition = dropArrowPosition_;");
1483 verifyGoogleFormat("@synthesize dropArrowPosition = dropArrowPosition_;");
1484
Nico Webercf4a79c2013-01-08 17:56:31 +00001485 verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;");
Nico Weber70848232013-01-10 21:30:42 +00001486 verifyFormat("@property(assign, getter=isEditable) BOOL editable;");
1487 verifyGoogleFormat("@property(assign, getter=isEditable) BOOL editable;");
Nico Webercf4a79c2013-01-08 17:56:31 +00001488}
1489
Daniel Jaspercd162382013-01-07 13:26:07 +00001490} // end namespace tooling
1491} // end namespace clang