1 //===- unittest/Format/FormatTestJava.cpp - Formatting tests for Java -----===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "FormatTestUtils.h" 10 #include "clang/Format/Format.h" 11 #include "llvm/Support/Debug.h" 12 #include "gtest/gtest.h" 13 14 #define DEBUG_TYPE "format-test" 15 16 namespace clang { 17 namespace format { 18 19 class FormatTestJava : public ::testing::Test { 20 protected: 21 static std::string format(llvm::StringRef Code, unsigned Offset, 22 unsigned Length, const FormatStyle &Style) { 23 LLVM_DEBUG(llvm::errs() << "---\n"); 24 LLVM_DEBUG(llvm::errs() << Code << "\n\n"); 25 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length)); 26 tooling::Replacements Replaces = reformat(Style, Code, Ranges); 27 auto Result = applyAllReplacements(Code, Replaces); 28 EXPECT_TRUE(static_cast<bool>(Result)); 29 LLVM_DEBUG(llvm::errs() << "\n" << *Result << "\n\n"); 30 return *Result; 31 } 32 33 static std::string 34 format(llvm::StringRef Code, 35 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_Java)) { 36 return format(Code, 0, Code.size(), Style); 37 } 38 39 static FormatStyle getStyleWithColumns(unsigned ColumnLimit) { 40 FormatStyle Style = getGoogleStyle(FormatStyle::LK_Java); 41 Style.ColumnLimit = ColumnLimit; 42 return Style; 43 } 44 45 static void verifyFormat( 46 llvm::StringRef Code, 47 const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_Java)) { 48 EXPECT_EQ(Code.str(), format(Code, Style)) << "Expected code is not stable"; 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 " default void doStuffWithDefault() {}\n" 148 "}"); 149 verifyFormat("@interface SomeInterface {\n" 150 " void doStuff(int theStuff);\n" 151 " void doMoreStuff(int moreStuff);\n" 152 "}"); 153 verifyFormat("public @interface SomeInterface {\n" 154 " void doStuff(int theStuff);\n" 155 " void doMoreStuff(int moreStuff);\n" 156 "}"); 157 verifyFormat("class A {\n" 158 " public @interface SomeInterface {\n" 159 " int stuff;\n" 160 " void doMoreStuff(int moreStuff);\n" 161 " }\n" 162 "}"); 163 verifyFormat("class A {\n" 164 " public @interface SomeInterface {}\n" 165 "}"); 166 } 167 168 TEST_F(FormatTestJava, AnonymousClasses) { 169 verifyFormat("return new A() {\n" 170 " public String toString() {\n" 171 " return \"NotReallyA\";\n" 172 " }\n" 173 "};"); 174 verifyFormat("A a = new A() {\n" 175 " public String toString() {\n" 176 " return \"NotReallyA\";\n" 177 " }\n" 178 "};"); 179 } 180 181 TEST_F(FormatTestJava, EnumDeclarations) { 182 verifyFormat("enum SomeThing { ABC, CDE }"); 183 verifyFormat("enum SomeThing {\n" 184 " ABC,\n" 185 " CDE,\n" 186 "}"); 187 verifyFormat("public class SomeClass {\n" 188 " enum SomeThing { ABC, CDE }\n" 189 " void f() {}\n" 190 "}"); 191 verifyFormat("public class SomeClass implements SomeInterface {\n" 192 " enum SomeThing { ABC, CDE }\n" 193 " void f() {}\n" 194 "}"); 195 verifyFormat("enum SomeThing {\n" 196 " ABC,\n" 197 " CDE;\n" 198 " void f() {}\n" 199 "}"); 200 verifyFormat("enum SomeThing {\n" 201 " ABC(1, \"ABC\"),\n" 202 " CDE(2, \"CDE\");\n" 203 " Something(int i, String s) {}\n" 204 "}"); 205 verifyFormat("enum SomeThing {\n" 206 " ABC(new int[] {1, 2}),\n" 207 " CDE(new int[] {2, 3});\n" 208 " Something(int[] i) {}\n" 209 "}"); 210 verifyFormat("public enum SomeThing {\n" 211 " ABC {\n" 212 " public String toString() {\n" 213 " return \"ABC\";\n" 214 " }\n" 215 " },\n" 216 " CDE {\n" 217 " @Override\n" 218 " public String toString() {\n" 219 " return \"CDE\";\n" 220 " }\n" 221 " };\n" 222 " public void f() {}\n" 223 "}"); 224 verifyFormat("private enum SomeEnum implements Foo<?, B> {\n" 225 " ABC {\n" 226 " @Override\n" 227 " public String toString() {\n" 228 " return \"ABC\";\n" 229 " }\n" 230 " },\n" 231 " CDE {\n" 232 " @Override\n" 233 " public String toString() {\n" 234 " return \"CDE\";\n" 235 " }\n" 236 " };\n" 237 "}"); 238 verifyFormat("public enum VeryLongEnum {\n" 239 " ENUM_WITH_MANY_PARAMETERS(\n" 240 " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"bbbbbbbbbbbbbbbb\", " 241 "\"cccccccccccccccccccccccc\"),\n" 242 " SECOND_ENUM(\"a\", \"b\", \"c\");\n" 243 " private VeryLongEnum(String a, String b, String c) {}\n" 244 "}\n"); 245 } 246 247 TEST_F(FormatTestJava, ArrayInitializers) { 248 verifyFormat("new int[] {1, 2, 3, 4};"); 249 verifyFormat("new int[] {\n" 250 " 1,\n" 251 " 2,\n" 252 " 3,\n" 253 " 4,\n" 254 "};"); 255 256 FormatStyle Style = getStyleWithColumns(65); 257 Style.Cpp11BracedListStyle = false; 258 verifyFormat( 259 "expected = new int[] { 10, 10, 10, 10, 10, 10, 10, 10, 10, 10,\n" 260 " 100, 100, 100, 100, 100, 100, 100, 100, 100, 100 };", 261 Style); 262 } 263 264 TEST_F(FormatTestJava, ThrowsDeclarations) { 265 verifyFormat("public void doSooooooooooooooooooooooooooomething()\n" 266 " throws LooooooooooooooooooooooooooooongException {}"); 267 verifyFormat("public void doSooooooooooooooooooooooooooomething()\n" 268 " throws LoooooooooongException, LooooooooooongException {}"); 269 } 270 271 TEST_F(FormatTestJava, Annotations) { 272 verifyFormat("@Override\n" 273 "public String toString() {}"); 274 verifyFormat("@Override\n" 275 "@Nullable\n" 276 "public String getNameIfPresent() {}"); 277 verifyFormat("@Override // comment\n" 278 "@Nullable\n" 279 "public String getNameIfPresent() {}"); 280 verifyFormat("@java.lang.Override // comment\n" 281 "@Nullable\n" 282 "public String getNameIfPresent() {}"); 283 284 verifyFormat("@SuppressWarnings(value = \"unchecked\")\n" 285 "public void doSomething() {}"); 286 verifyFormat("@SuppressWarnings(value = \"unchecked\")\n" 287 "@Author(name = \"abc\")\n" 288 "public void doSomething() {}"); 289 290 verifyFormat("DoSomething(new A() {\n" 291 " @Override\n" 292 " public String toString() {}\n" 293 "});"); 294 295 verifyFormat("void SomeFunction(@Nullable String something) {}"); 296 verifyFormat("void SomeFunction(@org.llvm.Nullable String something) {}"); 297 298 verifyFormat("@Partial @Mock DataLoader loader;"); 299 verifyFormat("@Partial\n" 300 "@Mock\n" 301 "DataLoader loader;", 302 getChromiumStyle(FormatStyle::LK_Java)); 303 verifyFormat("@SuppressWarnings(value = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")\n" 304 "public static int iiiiiiiiiiiiiiiiiiiiiiii;"); 305 306 verifyFormat("@SomeAnnotation(\"With some really looooooooooooooong text\")\n" 307 "private static final long something = 0L;"); 308 verifyFormat("@org.llvm.Qualified(\"With some really looooooooooong text\")\n" 309 "private static final long something = 0L;"); 310 verifyFormat("@Mock\n" 311 "DataLoader loooooooooooooooooooooooader =\n" 312 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 313 getStyleWithColumns(60)); 314 verifyFormat("@org.llvm.QualifiedMock\n" 315 "DataLoader loooooooooooooooooooooooader =\n" 316 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 317 getStyleWithColumns(60)); 318 verifyFormat("@Test(a)\n" 319 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 320 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaa);"); 321 verifyFormat("@SomeAnnotation(\n" 322 " aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa)\n" 323 "int i;", 324 getStyleWithColumns(50)); 325 verifyFormat("@Test\n" 326 "ReturnType doSomething(\n" 327 " String aaaaaaaaaaaaa, String bbbbbbbbbbbbbbb) {}", 328 getStyleWithColumns(60)); 329 verifyFormat("{\n" 330 " boolean someFunction(\n" 331 " @Param(aaaaaaaaaaaaaaaa) String aaaaa,\n" 332 " String bbbbbbbbbbbbbbb) {}\n" 333 "}", 334 getStyleWithColumns(60)); 335 verifyFormat("@Annotation(\"Some\"\n" 336 " + \" text\")\n" 337 "List<Integer> list;"); 338 339 verifyFormat( 340 "@Test\n" 341 "@Feature({\"Android-TabSwitcher\"})\n" 342 "@CommandLineFlags.Add({ChromeSwitches.DISABLE_FIRST_RUN_EXPERIENCE})\n" 343 "@Features.EnableFeatures({FEATURE})\n" 344 "public void test(@Foo.bar(\"baz\") @Quux.Qoob int theFirstParaaaaam,\n" 345 " @Foo.bar(\"baz\") @Quux.Qoob int theSecondParaaaaaaaaaaaaaaaam) {}"); 346 } 347 348 TEST_F(FormatTestJava, Generics) { 349 verifyFormat("Iterable<?> a;"); 350 verifyFormat("Iterable<?> a;"); 351 verifyFormat("Iterable<? extends SomeObject> a;"); 352 353 verifyFormat("A.<B>doSomething();"); 354 verifyFormat("A.<B<C>>doSomething();"); 355 verifyFormat("A.<B<C<D>>>doSomething();"); 356 verifyFormat("A.<B<C<D<E>>>>doSomething();"); 357 358 verifyFormat("OrderedPair<String, List<Box<Integer>>> p = null;"); 359 360 verifyFormat("@Override\n" 361 "public Map<String, ?> getAll() {}"); 362 363 verifyFormat("public <R> ArrayList<R> get() {}"); 364 verifyFormat("protected <R> ArrayList<R> get() {}"); 365 verifyFormat("private <R> ArrayList<R> get() {}"); 366 verifyFormat("public static <R> ArrayList<R> get() {}"); 367 verifyFormat("public static native <R> ArrayList<R> get();"); 368 verifyFormat("public final <X> Foo foo() {}"); 369 verifyFormat("public abstract <X> Foo foo();"); 370 verifyFormat("<T extends B> T getInstance(Class<T> type);"); 371 verifyFormat("Function<F, ? extends T> function;"); 372 373 verifyFormat("private Foo<X, Y>[] foos;"); 374 verifyFormat("Foo<X, Y>[] foos = this.foos;"); 375 verifyFormat("return (a instanceof List<?>)\n" 376 " ? aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 377 " : aaaaaaaaaaaaaaaaaaaaaaa;", 378 getStyleWithColumns(60)); 379 380 verifyFormat( 381 "SomeLoooooooooooooooooooooongType name =\n" 382 " SomeType.foo(someArgument)\n" 383 " .<X>method()\n" 384 " .aaaaaaaaaaaaaaaaaaa()\n" 385 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 386 } 387 388 TEST_F(FormatTestJava, StringConcatenation) { 389 verifyFormat("String someString = \"abc\"\n" 390 " + \"cde\";"); 391 } 392 393 TEST_F(FormatTestJava, TryCatchFinally) { 394 verifyFormat("try {\n" 395 " Something();\n" 396 "} catch (SomeException e) {\n" 397 " HandleException(e);\n" 398 "}"); 399 verifyFormat("try {\n" 400 " Something();\n" 401 "} finally {\n" 402 " AlwaysDoThis();\n" 403 "}"); 404 verifyFormat("try {\n" 405 " Something();\n" 406 "} catch (SomeException e) {\n" 407 " HandleException(e);\n" 408 "} finally {\n" 409 " AlwaysDoThis();\n" 410 "}"); 411 412 verifyFormat("try {\n" 413 " Something();\n" 414 "} catch (SomeException | OtherException e) {\n" 415 " HandleException(e);\n" 416 "}"); 417 } 418 419 TEST_F(FormatTestJava, TryWithResources) { 420 verifyFormat("try (SomeResource rs = someFunction()) {\n" 421 " Something();\n" 422 "}"); 423 verifyFormat("try (SomeResource rs = someFunction()) {\n" 424 " Something();\n" 425 "} catch (SomeException e) {\n" 426 " HandleException(e);\n" 427 "}"); 428 } 429 430 TEST_F(FormatTestJava, SynchronizedKeyword) { 431 verifyFormat("synchronized (mData) {\n" 432 " // ...\n" 433 "}"); 434 } 435 436 TEST_F(FormatTestJava, AssertKeyword) { 437 verifyFormat("assert a && b;"); 438 verifyFormat("assert (a && b);"); 439 } 440 441 TEST_F(FormatTestJava, PackageDeclarations) { 442 verifyFormat("package some.really.loooooooooooooooooooooong.package;", 443 getStyleWithColumns(50)); 444 } 445 446 TEST_F(FormatTestJava, ImportDeclarations) { 447 verifyFormat("import some.really.loooooooooooooooooooooong.imported.Class;", 448 getStyleWithColumns(50)); 449 verifyFormat("import static some.really.looooooooooooooooong.imported.Class;", 450 getStyleWithColumns(50)); 451 } 452 453 TEST_F(FormatTestJava, MethodDeclarations) { 454 verifyFormat("void methodName(Object arg1,\n" 455 " Object arg2, Object arg3) {}", 456 getStyleWithColumns(40)); 457 verifyFormat("void methodName(\n" 458 " Object arg1, Object arg2) {}", 459 getStyleWithColumns(40)); 460 } 461 462 TEST_F(FormatTestJava, MethodReference) { 463 EXPECT_EQ("private void foo() {\n" 464 " f(this::methodReference);\n" 465 " f(C.super::methodReference);\n" 466 " Consumer<String> c = System.out::println;\n" 467 " Iface<Integer> mRef = Ty::<Integer>meth;\n" 468 "}", 469 format("private void foo() {\n" 470 " f(this ::methodReference);\n" 471 " f(C.super ::methodReference);\n" 472 " Consumer<String> c = System.out ::println;\n" 473 " Iface<Integer> mRef = Ty :: <Integer> meth;\n" 474 "}")); 475 } 476 477 TEST_F(FormatTestJava, CppKeywords) { 478 verifyFormat("public void union(Type a, Type b);"); 479 verifyFormat("public void struct(Object o);"); 480 verifyFormat("public void delete(Object o);"); 481 verifyFormat("return operator && (aa);"); 482 } 483 484 TEST_F(FormatTestJava, NeverAlignAfterReturn) { 485 verifyFormat("return aaaaaaaaaaaaaaaaaaa\n" 486 " && bbbbbbbbbbbbbbbbbbb\n" 487 " && ccccccccccccccccccc;", 488 getStyleWithColumns(40)); 489 verifyFormat("return (result == null)\n" 490 " ? aaaaaaaaaaaaaaaaa\n" 491 " : bbbbbbbbbbbbbbbbb;", 492 getStyleWithColumns(40)); 493 verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n" 494 " .bbbbbbbbbbbbbbbbbbb()\n" 495 " .ccccccccccccccccccc();", 496 getStyleWithColumns(40)); 497 verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n" 498 " .bbbbbbbbbbbbbbbbbbb(\n" 499 " ccccccccccccccc)\n" 500 " .ccccccccccccccccccc();", 501 getStyleWithColumns(40)); 502 } 503 504 TEST_F(FormatTestJava, FormatsInnerBlocks) { 505 verifyFormat("someObject.someFunction(new Runnable() {\n" 506 " @Override\n" 507 " public void run() {\n" 508 " System.out.println(42);\n" 509 " }\n" 510 "}, someOtherParameter);"); 511 verifyFormat("someFunction(new Runnable() {\n" 512 " public void run() {\n" 513 " System.out.println(42);\n" 514 " }\n" 515 "});"); 516 verifyFormat("someObject.someFunction(\n" 517 " new Runnable() {\n" 518 " @Override\n" 519 " public void run() {\n" 520 " System.out.println(42);\n" 521 " }\n" 522 " },\n" 523 " new Runnable() {\n" 524 " @Override\n" 525 " public void run() {\n" 526 " System.out.println(43);\n" 527 " }\n" 528 " },\n" 529 " someOtherParameter);"); 530 } 531 532 TEST_F(FormatTestJava, FormatsLambdas) { 533 verifyFormat("(aaaaaaaaaa, bbbbbbbbbb) -> aaaaaaaaaa + bbbbbbbbbb;"); 534 verifyFormat("(aaaaaaaaaa, bbbbbbbbbb)\n" 535 " -> aaaaaaaaaa + bbbbbbbbbb;", 536 getStyleWithColumns(40)); 537 verifyFormat("Runnable someLambda = () -> DoSomething();"); 538 verifyFormat("Runnable someLambda = () -> {\n" 539 " DoSomething();\n" 540 "}"); 541 542 verifyFormat("Runnable someLambda =\n" 543 " (int aaaaa) -> DoSomething(aaaaa);", 544 getStyleWithColumns(40)); 545 } 546 547 TEST_F(FormatTestJava, BreaksStringLiterals) { 548 // FIXME: String literal breaking is currently disabled for Java and JS, as it 549 // requires strings to be merged using "+" which we don't support. 550 EXPECT_EQ("\"some text other\";", 551 format("\"some text other\";", getStyleWithColumns(14))); 552 } 553 554 TEST_F(FormatTestJava, AlignsBlockComments) { 555 EXPECT_EQ("/*\n" 556 " * Really multi-line\n" 557 " * comment.\n" 558 " */\n" 559 "void f() {}", 560 format(" /*\n" 561 " * Really multi-line\n" 562 " * comment.\n" 563 " */\n" 564 " void f() {}")); 565 } 566 567 TEST_F(FormatTestJava, KeepsDelimitersOnOwnLineInJavaDocComments) { 568 EXPECT_EQ("/**\n" 569 " * javadoc line 1\n" 570 " * javadoc line 2\n" 571 " */", 572 format("/** javadoc line 1\n" 573 " * javadoc line 2 */")); 574 } 575 576 TEST_F(FormatTestJava, RetainsLogicalShifts) { 577 verifyFormat("void f() {\n" 578 " int a = 1;\n" 579 " a >>>= 1;\n" 580 "}"); 581 verifyFormat("void f() {\n" 582 " int a = 1;\n" 583 " a = a >>> 1;\n" 584 "}"); 585 } 586 587 } // namespace format 588 } // end namespace clang 589