1 //===- unittest/Format/FormatTestJava.cpp - Formatting tests for Java -----===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "FormatTestUtils.h" 11 #include "clang/Format/Format.h" 12 #include "llvm/Support/Debug.h" 13 #include "gtest/gtest.h" 14 15 #define DEBUG_TYPE "format-test" 16 17 namespace clang { 18 namespace format { 19 20 class FormatTestJava : public ::testing::Test { 21 protected: 22 static std::string format(llvm::StringRef Code, unsigned Offset, 23 unsigned Length, const FormatStyle &Style) { 24 DEBUG(llvm::errs() << "---\n"); 25 DEBUG(llvm::errs() << Code << "\n\n"); 26 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length)); 27 tooling::Replacements Replaces = reformat(Style, Code, Ranges); 28 auto Result = applyAllReplacements(Code, Replaces); 29 EXPECT_TRUE(static_cast<bool>(Result)); 30 DEBUG(llvm::errs() << "\n" << *Result << "\n\n"); 31 return *Result; 32 } 33 34 static std::string 35 format(llvm::StringRef Code, 36 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_Java)) { 37 return format(Code, 0, Code.size(), Style); 38 } 39 40 static FormatStyle getStyleWithColumns(unsigned ColumnLimit) { 41 FormatStyle Style = getGoogleStyle(FormatStyle::LK_Java); 42 Style.ColumnLimit = ColumnLimit; 43 return Style; 44 } 45 46 static void verifyFormat( 47 llvm::StringRef Code, 48 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_Java)) { 49 EXPECT_EQ(Code.str(), format(test::messUp(Code), Style)); 50 } 51 }; 52 53 TEST_F(FormatTestJava, NoAlternativeOperatorNames) { 54 verifyFormat("someObject.and();"); 55 } 56 57 TEST_F(FormatTestJava, UnderstandsCasts) { 58 verifyFormat("a[b >> 1] = (byte) (c() << 4);"); 59 } 60 61 TEST_F(FormatTestJava, FormatsInstanceOfLikeOperators) { 62 FormatStyle Style = getStyleWithColumns(50); 63 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" 64 " instanceof bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;", 65 Style); 66 Style.BreakBeforeBinaryOperators = FormatStyle::BOS_None; 67 verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaa instanceof\n" 68 " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;", 69 Style); 70 verifyFormat("return aaaaaaaaaaaaaaaaaaa instanceof bbbbbbbbbbbbbbbbbbbbbbb\n" 71 " && ccccccccccccccccccc instanceof dddddddddddddddddddddd;"); 72 } 73 74 TEST_F(FormatTestJava, Chromium) { 75 verifyFormat("class SomeClass {\n" 76 " void f() {}\n" 77 " int g() {\n" 78 " return 0;\n" 79 " }\n" 80 " void h() {\n" 81 " while (true) f();\n" 82 " for (;;) f();\n" 83 " if (true) f();\n" 84 " }\n" 85 "}", 86 getChromiumStyle(FormatStyle::LK_Java)); 87 } 88 89 TEST_F(FormatTestJava, QualifiedNames) { 90 verifyFormat("public some.package.Type someFunction( // comment\n" 91 " int parameter) {}"); 92 } 93 94 TEST_F(FormatTestJava, ClassKeyword) { 95 verifyFormat("SomeClass.class.getName();"); 96 verifyFormat("Class c = SomeClass.class;"); 97 } 98 99 TEST_F(FormatTestJava, ClassDeclarations) { 100 verifyFormat("public class SomeClass {\n" 101 " private int a;\n" 102 " private int b;\n" 103 "}"); 104 verifyFormat("public class A {\n" 105 " class B {\n" 106 " int i;\n" 107 " }\n" 108 " class C {\n" 109 " int j;\n" 110 " }\n" 111 "}"); 112 verifyFormat("public class A extends B.C {}"); 113 114 verifyFormat("abstract class SomeClass\n" 115 " extends SomeOtherClass implements SomeInterface {}", 116 getStyleWithColumns(60)); 117 verifyFormat("abstract class SomeClass extends SomeOtherClass\n" 118 " implements SomeInterfaceeeeeeeeeeeee {}", 119 getStyleWithColumns(60)); 120 verifyFormat("abstract class SomeClass\n" 121 " extends SomeOtherClass\n" 122 " implements SomeInterface {}", 123 getStyleWithColumns(40)); 124 verifyFormat("abstract class SomeClass\n" 125 " extends SomeOtherClass\n" 126 " implements SomeInterface,\n" 127 " AnotherInterface {}", 128 getStyleWithColumns(40)); 129 verifyFormat("abstract class SomeClass\n" 130 " implements SomeInterface, AnotherInterface {}", 131 getStyleWithColumns(60)); 132 verifyFormat("@SomeAnnotation()\n" 133 "abstract class aaaaaaaaaaaa\n" 134 " extends bbbbbbbbbbbbbbb implements cccccccccccc {}", 135 getStyleWithColumns(76)); 136 verifyFormat("@SomeAnnotation()\n" 137 "abstract class aaaaaaaaa<a>\n" 138 " extends bbbbbbbbbbbb<b> implements cccccccccccc {}", 139 getStyleWithColumns(76)); 140 verifyFormat("interface SomeInterface<A> extends Foo, Bar {\n" 141 " void doStuff(int theStuff);\n" 142 " void doMoreStuff(int moreStuff);\n" 143 "}"); 144 verifyFormat("public interface SomeInterface {\n" 145 " void doStuff(int theStuff);\n" 146 " void doMoreStuff(int moreStuff);\n" 147 "}"); 148 verifyFormat("@interface SomeInterface {\n" 149 " void doStuff(int theStuff);\n" 150 " void doMoreStuff(int moreStuff);\n" 151 "}"); 152 verifyFormat("public @interface SomeInterface {\n" 153 " void doStuff(int theStuff);\n" 154 " void doMoreStuff(int moreStuff);\n" 155 "}"); 156 } 157 158 TEST_F(FormatTestJava, AnonymousClasses) { 159 verifyFormat("return new A() {\n" 160 " public String toString() {\n" 161 " return \"NotReallyA\";\n" 162 " }\n" 163 "};"); 164 verifyFormat("A a = new A() {\n" 165 " public String toString() {\n" 166 " return \"NotReallyA\";\n" 167 " }\n" 168 "};"); 169 } 170 171 TEST_F(FormatTestJava, EnumDeclarations) { 172 verifyFormat("enum SomeThing { ABC, CDE }"); 173 verifyFormat("enum SomeThing {\n" 174 " ABC,\n" 175 " CDE,\n" 176 "}"); 177 verifyFormat("public class SomeClass {\n" 178 " enum SomeThing { ABC, CDE }\n" 179 " void f() {}\n" 180 "}"); 181 verifyFormat("public class SomeClass implements SomeInterface {\n" 182 " enum SomeThing { ABC, CDE }\n" 183 " void f() {}\n" 184 "}"); 185 verifyFormat("enum SomeThing {\n" 186 " ABC,\n" 187 " CDE;\n" 188 " void f() {}\n" 189 "}"); 190 verifyFormat("enum SomeThing {\n" 191 " ABC(1, \"ABC\"),\n" 192 " CDE(2, \"CDE\");\n" 193 " Something(int i, String s) {}\n" 194 "}"); 195 verifyFormat("enum SomeThing {\n" 196 " ABC(new int[] {1, 2}),\n" 197 " CDE(new int[] {2, 3});\n" 198 " Something(int[] i) {}\n" 199 "}"); 200 verifyFormat("public enum SomeThing {\n" 201 " ABC {\n" 202 " public String toString() {\n" 203 " return \"ABC\";\n" 204 " }\n" 205 " },\n" 206 " CDE {\n" 207 " @Override\n" 208 " public String toString() {\n" 209 " return \"CDE\";\n" 210 " }\n" 211 " };\n" 212 " public void f() {}\n" 213 "}"); 214 verifyFormat("private enum SomeEnum implements Foo<?, B> {\n" 215 " ABC {\n" 216 " @Override\n" 217 " public String toString() {\n" 218 " return \"ABC\";\n" 219 " }\n" 220 " },\n" 221 " CDE {\n" 222 " @Override\n" 223 " public String toString() {\n" 224 " return \"CDE\";\n" 225 " }\n" 226 " };\n" 227 "}"); 228 verifyFormat("public enum VeryLongEnum {\n" 229 " ENUM_WITH_MANY_PARAMETERS(\n" 230 " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"bbbbbbbbbbbbbbbb\", " 231 "\"cccccccccccccccccccccccc\"),\n" 232 " SECOND_ENUM(\"a\", \"b\", \"c\");\n" 233 " private VeryLongEnum(String a, String b, String c) {}\n" 234 "}\n"); 235 } 236 237 TEST_F(FormatTestJava, ArrayInitializers) { 238 verifyFormat("new int[] {1, 2, 3, 4};"); 239 verifyFormat("new int[] {\n" 240 " 1,\n" 241 " 2,\n" 242 " 3,\n" 243 " 4,\n" 244 "};"); 245 246 FormatStyle Style = getStyleWithColumns(65); 247 Style.Cpp11BracedListStyle = false; 248 verifyFormat( 249 "expected = new int[] { 10, 10, 10, 10, 10, 10, 10, 10, 10, 10,\n" 250 " 100, 100, 100, 100, 100, 100, 100, 100, 100, 100 };", 251 Style); 252 } 253 254 TEST_F(FormatTestJava, ThrowsDeclarations) { 255 verifyFormat("public void doSooooooooooooooooooooooooooomething()\n" 256 " throws LooooooooooooooooooooooooooooongException {}"); 257 verifyFormat("public void doSooooooooooooooooooooooooooomething()\n" 258 " throws LoooooooooongException, LooooooooooongException {}"); 259 } 260 261 TEST_F(FormatTestJava, Annotations) { 262 verifyFormat("@Override\n" 263 "public String toString() {}"); 264 verifyFormat("@Override\n" 265 "@Nullable\n" 266 "public String getNameIfPresent() {}"); 267 verifyFormat("@Override // comment\n" 268 "@Nullable\n" 269 "public String getNameIfPresent() {}"); 270 verifyFormat("@java.lang.Override // comment\n" 271 "@Nullable\n" 272 "public String getNameIfPresent() {}"); 273 274 verifyFormat("@SuppressWarnings(value = \"unchecked\")\n" 275 "public void doSomething() {}"); 276 verifyFormat("@SuppressWarnings(value = \"unchecked\")\n" 277 "@Author(name = \"abc\")\n" 278 "public void doSomething() {}"); 279 280 verifyFormat("DoSomething(new A() {\n" 281 " @Override\n" 282 " public String toString() {}\n" 283 "});"); 284 285 verifyFormat("void SomeFunction(@Nullable String something) {}"); 286 verifyFormat("void SomeFunction(@org.llvm.Nullable String something) {}"); 287 288 verifyFormat("@Partial @Mock DataLoader loader;"); 289 verifyFormat("@Partial\n" 290 "@Mock\n" 291 "DataLoader loader;", 292 getChromiumStyle(FormatStyle::LK_Java)); 293 verifyFormat("@SuppressWarnings(value = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")\n" 294 "public static int iiiiiiiiiiiiiiiiiiiiiiii;"); 295 296 verifyFormat("@SomeAnnotation(\"With some really looooooooooooooong text\")\n" 297 "private static final long something = 0L;"); 298 verifyFormat("@org.llvm.Qualified(\"With some really looooooooooong text\")\n" 299 "private static final long something = 0L;"); 300 verifyFormat("@Mock\n" 301 "DataLoader loooooooooooooooooooooooader =\n" 302 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 303 getStyleWithColumns(60)); 304 verifyFormat("@org.llvm.QualifiedMock\n" 305 "DataLoader loooooooooooooooooooooooader =\n" 306 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 307 getStyleWithColumns(60)); 308 verifyFormat("@Test(a)\n" 309 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 310 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaa);"); 311 verifyFormat("@SomeAnnotation(\n" 312 " aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa)\n" 313 "int i;", 314 getStyleWithColumns(50)); 315 verifyFormat("@Test\n" 316 "ReturnType doSomething(\n" 317 " String aaaaaaaaaaaaa, String bbbbbbbbbbbbbbb) {}", 318 getStyleWithColumns(60)); 319 verifyFormat("{\n" 320 " boolean someFunction(\n" 321 " @Param(aaaaaaaaaaaaaaaa) String aaaaa,\n" 322 " String bbbbbbbbbbbbbbb) {}\n" 323 "}", 324 getStyleWithColumns(60)); 325 verifyFormat("@Annotation(\"Some\"\n" 326 " + \" text\")\n" 327 "List<Integer> list;"); 328 } 329 330 TEST_F(FormatTestJava, Generics) { 331 verifyFormat("Iterable<?> a;"); 332 verifyFormat("Iterable<?> a;"); 333 verifyFormat("Iterable<? extends SomeObject> a;"); 334 335 verifyFormat("A.<B>doSomething();"); 336 337 verifyFormat("@Override\n" 338 "public Map<String, ?> getAll() {}"); 339 340 verifyFormat("public <R> ArrayList<R> get() {}"); 341 verifyFormat("protected <R> ArrayList<R> get() {}"); 342 verifyFormat("private <R> ArrayList<R> get() {}"); 343 verifyFormat("public static <R> ArrayList<R> get() {}"); 344 verifyFormat("public static native <R> ArrayList<R> get();"); 345 verifyFormat("public final <X> Foo foo() {}"); 346 verifyFormat("public abstract <X> Foo foo();"); 347 verifyFormat("<T extends B> T getInstance(Class<T> type);"); 348 verifyFormat("Function<F, ? extends T> function;"); 349 350 verifyFormat("private Foo<X, Y>[] foos;"); 351 verifyFormat("Foo<X, Y>[] foos = this.foos;"); 352 verifyFormat("return (a instanceof List<?>)\n" 353 " ? aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 354 " : aaaaaaaaaaaaaaaaaaaaaaa;", 355 getStyleWithColumns(60)); 356 357 verifyFormat( 358 "SomeLoooooooooooooooooooooongType name =\n" 359 " SomeType.foo(someArgument)\n" 360 " .<X>method()\n" 361 " .aaaaaaaaaaaaaaaaaaa()\n" 362 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 363 } 364 365 TEST_F(FormatTestJava, StringConcatenation) { 366 verifyFormat("String someString = \"abc\"\n" 367 " + \"cde\";"); 368 } 369 370 TEST_F(FormatTestJava, TryCatchFinally) { 371 verifyFormat("try {\n" 372 " Something();\n" 373 "} catch (SomeException e) {\n" 374 " HandleException(e);\n" 375 "}"); 376 verifyFormat("try {\n" 377 " Something();\n" 378 "} finally {\n" 379 " AlwaysDoThis();\n" 380 "}"); 381 verifyFormat("try {\n" 382 " Something();\n" 383 "} catch (SomeException e) {\n" 384 " HandleException(e);\n" 385 "} finally {\n" 386 " AlwaysDoThis();\n" 387 "}"); 388 389 verifyFormat("try {\n" 390 " Something();\n" 391 "} catch (SomeException | OtherException e) {\n" 392 " HandleException(e);\n" 393 "}"); 394 } 395 396 TEST_F(FormatTestJava, TryWithResources) { 397 verifyFormat("try (SomeResource rs = someFunction()) {\n" 398 " Something();\n" 399 "}"); 400 verifyFormat("try (SomeResource rs = someFunction()) {\n" 401 " Something();\n" 402 "} catch (SomeException e) {\n" 403 " HandleException(e);\n" 404 "}"); 405 } 406 407 TEST_F(FormatTestJava, SynchronizedKeyword) { 408 verifyFormat("synchronized (mData) {\n" 409 " // ...\n" 410 "}"); 411 } 412 413 TEST_F(FormatTestJava, AssertKeyword) { 414 verifyFormat("assert a && b;"); 415 verifyFormat("assert (a && b);"); 416 } 417 418 TEST_F(FormatTestJava, PackageDeclarations) { 419 verifyFormat("package some.really.loooooooooooooooooooooong.package;", 420 getStyleWithColumns(50)); 421 } 422 423 TEST_F(FormatTestJava, ImportDeclarations) { 424 verifyFormat("import some.really.loooooooooooooooooooooong.imported.Class;", 425 getStyleWithColumns(50)); 426 verifyFormat("import static some.really.looooooooooooooooong.imported.Class;", 427 getStyleWithColumns(50)); 428 } 429 430 TEST_F(FormatTestJava, MethodDeclarations) { 431 verifyFormat("void methodName(Object arg1,\n" 432 " Object arg2, Object arg3) {}", 433 getStyleWithColumns(40)); 434 verifyFormat("void methodName(\n" 435 " Object arg1, Object arg2) {}", 436 getStyleWithColumns(40)); 437 } 438 439 TEST_F(FormatTestJava, CppKeywords) { 440 verifyFormat("public void union(Type a, Type b);"); 441 verifyFormat("public void struct(Object o);"); 442 verifyFormat("public void delete(Object o);"); 443 verifyFormat("return operator && (aa);"); 444 } 445 446 TEST_F(FormatTestJava, NeverAlignAfterReturn) { 447 verifyFormat("return aaaaaaaaaaaaaaaaaaa\n" 448 " && bbbbbbbbbbbbbbbbbbb\n" 449 " && ccccccccccccccccccc;", 450 getStyleWithColumns(40)); 451 verifyFormat("return (result == null)\n" 452 " ? aaaaaaaaaaaaaaaaa\n" 453 " : bbbbbbbbbbbbbbbbb;", 454 getStyleWithColumns(40)); 455 verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n" 456 " .bbbbbbbbbbbbbbbbbbb()\n" 457 " .ccccccccccccccccccc();", 458 getStyleWithColumns(40)); 459 verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n" 460 " .bbbbbbbbbbbbbbbbbbb(\n" 461 " ccccccccccccccc)\n" 462 " .ccccccccccccccccccc();", 463 getStyleWithColumns(40)); 464 } 465 466 TEST_F(FormatTestJava, FormatsInnerBlocks) { 467 verifyFormat("someObject.someFunction(new Runnable() {\n" 468 " @Override\n" 469 " public void run() {\n" 470 " System.out.println(42);\n" 471 " }\n" 472 "}, someOtherParameter);"); 473 verifyFormat("someFunction(new Runnable() {\n" 474 " public void run() {\n" 475 " System.out.println(42);\n" 476 " }\n" 477 "});"); 478 verifyFormat("someObject.someFunction(\n" 479 " new Runnable() {\n" 480 " @Override\n" 481 " public void run() {\n" 482 " System.out.println(42);\n" 483 " }\n" 484 " },\n" 485 " new Runnable() {\n" 486 " @Override\n" 487 " public void run() {\n" 488 " System.out.println(43);\n" 489 " }\n" 490 " },\n" 491 " someOtherParameter);"); 492 } 493 494 TEST_F(FormatTestJava, FormatsLambdas) { 495 verifyFormat("(aaaaaaaaaa, bbbbbbbbbb) -> aaaaaaaaaa + bbbbbbbbbb;"); 496 verifyFormat("(aaaaaaaaaa, bbbbbbbbbb)\n" 497 " -> aaaaaaaaaa + bbbbbbbbbb;", 498 getStyleWithColumns(40)); 499 verifyFormat("Runnable someLambda = () -> DoSomething();"); 500 verifyFormat("Runnable someLambda = () -> {\n" 501 " DoSomething();\n" 502 "}"); 503 504 verifyFormat("Runnable someLambda =\n" 505 " (int aaaaa) -> DoSomething(aaaaa);", 506 getStyleWithColumns(40)); 507 } 508 509 TEST_F(FormatTestJava, BreaksStringLiterals) { 510 // FIXME: String literal breaking is currently disabled for Java and JS, as it 511 // requires strings to be merged using "+" which we don't support. 512 EXPECT_EQ("\"some text other\";", 513 format("\"some text other\";", getStyleWithColumns(14))); 514 } 515 516 TEST_F(FormatTestJava, AlignsBlockComments) { 517 EXPECT_EQ("/*\n" 518 " * Really multi-line\n" 519 " * comment.\n" 520 " */\n" 521 "void f() {}", 522 format(" /*\n" 523 " * Really multi-line\n" 524 " * comment.\n" 525 " */\n" 526 " void f() {}")); 527 } 528 529 TEST_F(FormatTestJava, KeepsDelimitersOnOwnLineInJavaDocComments) { 530 EXPECT_EQ("/**\n" 531 " * javadoc line 1\n" 532 " * javadoc line 2\n" 533 " */", 534 format("/** javadoc line 1\n" 535 " * javadoc line 2 */")); 536 } 537 538 TEST_F(FormatTestJava, RetainsLogicalShifts) { 539 verifyFormat("void f() {\n" 540 " int a = 1;\n" 541 " a >>>= 1;\n" 542 "}"); 543 verifyFormat("void f() {\n" 544 " int a = 1;\n" 545 " a = a >>> 1;\n" 546 "}"); 547 } 548 549 550 } // end namespace tooling 551 } // end namespace clang 552