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 std::string Result = applyAllReplacements(Code, Replaces); 29 EXPECT_NE("", Result); 30 DEBUG(llvm::errs() << "\n" << Result << "\n\n"); 31 return Result; 32 } 33 34 static std::string format( 35 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 } 71 72 TEST_F(FormatTestJava, Chromium) { 73 verifyFormat("class SomeClass {\n" 74 " void f() {}\n" 75 " int g() {\n" 76 " return 0;\n" 77 " }\n" 78 " void h() {\n" 79 " while (true) f();\n" 80 " for (;;) f();\n" 81 " if (true) f();\n" 82 " }\n" 83 "}", 84 getChromiumStyle(FormatStyle::LK_Java)); 85 } 86 87 TEST_F(FormatTestJava, QualifiedNames) { 88 verifyFormat("public some.package.Type someFunction( // comment\n" 89 " int parameter) {}"); 90 } 91 92 TEST_F(FormatTestJava, ClassKeyword) { 93 verifyFormat("SomeClass.class.getName();"); 94 verifyFormat("Class c = SomeClass.class;"); 95 } 96 97 TEST_F(FormatTestJava, ClassDeclarations) { 98 verifyFormat("public class SomeClass {\n" 99 " private int a;\n" 100 " private int b;\n" 101 "}"); 102 verifyFormat("public class A {\n" 103 " class B {\n" 104 " int i;\n" 105 " }\n" 106 " class C {\n" 107 " int j;\n" 108 " }\n" 109 "}"); 110 verifyFormat("public class A extends B.C {}"); 111 112 verifyFormat("abstract class SomeClass\n" 113 " extends SomeOtherClass implements SomeInterface {}", 114 getStyleWithColumns(60)); 115 verifyFormat("abstract class SomeClass extends SomeOtherClass\n" 116 " implements SomeInterfaceeeeeeeeeeeee {}", 117 getStyleWithColumns(60)); 118 verifyFormat("abstract class SomeClass\n" 119 " extends SomeOtherClass\n" 120 " implements SomeInterface {}", 121 getStyleWithColumns(40)); 122 verifyFormat("abstract class SomeClass\n" 123 " extends SomeOtherClass\n" 124 " implements SomeInterface,\n" 125 " AnotherInterface {}", 126 getStyleWithColumns(40)); 127 verifyFormat("abstract class SomeClass\n" 128 " implements SomeInterface, AnotherInterface {}", 129 getStyleWithColumns(60)); 130 verifyFormat("@SomeAnnotation()\n" 131 "abstract class aaaaaaaaaaaa\n" 132 " extends bbbbbbbbbbbbbbb implements cccccccccccc {}", 133 getStyleWithColumns(76)); 134 verifyFormat("@SomeAnnotation()\n" 135 "abstract class aaaaaaaaa<a>\n" 136 " extends bbbbbbbbbbbb<b> implements cccccccccccc {}", 137 getStyleWithColumns(76)); 138 verifyFormat("interface SomeInterface<A> extends Foo, Bar {\n" 139 " void doStuff(int theStuff);\n" 140 " void doMoreStuff(int moreStuff);\n" 141 "}"); 142 verifyFormat("public interface SomeInterface {\n" 143 " void doStuff(int theStuff);\n" 144 " void doMoreStuff(int moreStuff);\n" 145 "}"); 146 verifyFormat("@interface SomeInterface {\n" 147 " void doStuff(int theStuff);\n" 148 " void doMoreStuff(int moreStuff);\n" 149 "}"); 150 verifyFormat("public @interface SomeInterface {\n" 151 " void doStuff(int theStuff);\n" 152 " void doMoreStuff(int moreStuff);\n" 153 "}"); 154 } 155 156 TEST_F(FormatTestJava, EnumDeclarations) { 157 verifyFormat("enum SomeThing { ABC, CDE }"); 158 verifyFormat("enum SomeThing {\n" 159 " ABC,\n" 160 " CDE,\n" 161 "}"); 162 verifyFormat("public class SomeClass {\n" 163 " enum SomeThing { ABC, CDE }\n" 164 " void f() {}\n" 165 "}"); 166 verifyFormat("public class SomeClass implements SomeInterface {\n" 167 " enum SomeThing { ABC, CDE }\n" 168 " void f() {}\n" 169 "}"); 170 verifyFormat("enum SomeThing {\n" 171 " ABC,\n" 172 " CDE;\n" 173 " void f() {}\n" 174 "}"); 175 verifyFormat("enum SomeThing {\n" 176 " ABC(1, \"ABC\"),\n" 177 " CDE(2, \"CDE\");\n" 178 " Something(int i, String s) {}\n" 179 "}"); 180 verifyFormat("enum SomeThing {\n" 181 " ABC(new int[] {1, 2}),\n" 182 " CDE(new int[] {2, 3});\n" 183 " Something(int[] i) {}\n" 184 "}"); 185 verifyFormat("public enum SomeThing {\n" 186 " ABC {\n" 187 " public String toString() {\n" 188 " return \"ABC\";\n" 189 " }\n" 190 " },\n" 191 " CDE {\n" 192 " @Override\n" 193 " public String toString() {\n" 194 " return \"CDE\";\n" 195 " }\n" 196 " };\n" 197 " public void f() {}\n" 198 "}"); 199 verifyFormat("private enum SomeEnum implements Foo<?, B> {\n" 200 " ABC {\n" 201 " @Override\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 "}"); 213 } 214 215 TEST_F(FormatTestJava, ArrayInitializers) { 216 verifyFormat("new int[] {1, 2, 3, 4};"); 217 verifyFormat("new int[] {\n" 218 " 1, 2, 3, 4,\n" 219 "};"); 220 221 FormatStyle Style = getStyleWithColumns(65); 222 Style.Cpp11BracedListStyle = false; 223 verifyFormat( 224 "expected = new int[] { 10, 10, 10, 10, 10, 10, 10, 10, 10, 10,\n" 225 " 100, 100, 100, 100, 100, 100, 100, 100, 100, 100 };", 226 Style); 227 } 228 229 TEST_F(FormatTestJava, ThrowsDeclarations) { 230 verifyFormat("public void doSooooooooooooooooooooooooooomething()\n" 231 " throws LooooooooooooooooooooooooooooongException {}"); 232 verifyFormat("public void doSooooooooooooooooooooooooooomething()\n" 233 " throws LoooooooooongException, LooooooooooongException {}"); 234 } 235 236 TEST_F(FormatTestJava, Annotations) { 237 verifyFormat("@Override\n" 238 "public String toString() {}"); 239 verifyFormat("@Override\n" 240 "@Nullable\n" 241 "public String getNameIfPresent() {}"); 242 verifyFormat("@Override // comment\n" 243 "@Nullable\n" 244 "public String getNameIfPresent() {}"); 245 verifyFormat("@java.lang.Override // comment\n" 246 "@Nullable\n" 247 "public String getNameIfPresent() {}"); 248 249 verifyFormat("@SuppressWarnings(value = \"unchecked\")\n" 250 "public void doSomething() {}"); 251 verifyFormat("@SuppressWarnings(value = \"unchecked\")\n" 252 "@Author(name = \"abc\")\n" 253 "public void doSomething() {}"); 254 255 verifyFormat("DoSomething(new A() {\n" 256 " @Override\n" 257 " public String toString() {}\n" 258 "});"); 259 260 verifyFormat("void SomeFunction(@Nullable String something) {}"); 261 verifyFormat("void SomeFunction(@org.llvm.Nullable String something) {}"); 262 263 verifyFormat("@Partial @Mock DataLoader loader;"); 264 verifyFormat("@SuppressWarnings(value = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")\n" 265 "public static int iiiiiiiiiiiiiiiiiiiiiiii;"); 266 267 verifyFormat("@SomeAnnotation(\"With some really looooooooooooooong text\")\n" 268 "private static final long something = 0L;"); 269 verifyFormat("@org.llvm.Qualified(\"With some really looooooooooong text\")\n" 270 "private static final long something = 0L;"); 271 verifyFormat("@Mock\n" 272 "DataLoader loooooooooooooooooooooooader =\n" 273 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 274 getStyleWithColumns(60)); 275 verifyFormat("@org.llvm.QualifiedMock\n" 276 "DataLoader loooooooooooooooooooooooader =\n" 277 " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", 278 getStyleWithColumns(60)); 279 verifyFormat("@Test(a)\n" 280 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" 281 " aaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaa);"); 282 verifyFormat("@SomeAnnotation(\n" 283 " aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa)\n" 284 "int i;", 285 getStyleWithColumns(50)); 286 verifyFormat("@Test\n" 287 "ReturnType doSomething(\n" 288 " String aaaaaaaaaaaaa, String bbbbbbbbbbbbbbb) {}", 289 getStyleWithColumns(60)); 290 } 291 292 TEST_F(FormatTestJava, Generics) { 293 verifyFormat("Iterable<?> a;"); 294 verifyFormat("Iterable<?> a;"); 295 verifyFormat("Iterable<? extends SomeObject> a;"); 296 297 verifyFormat("A.<B>doSomething();"); 298 299 verifyFormat("@Override\n" 300 "public Map<String, ?> getAll() {}"); 301 302 verifyFormat("public <R> ArrayList<R> get() {}"); 303 verifyFormat("protected <R> ArrayList<R> get() {}"); 304 verifyFormat("private <R> ArrayList<R> get() {}"); 305 verifyFormat("public static <R> ArrayList<R> get() {}"); 306 verifyFormat("public static native <R> ArrayList<R> get();"); 307 verifyFormat("public final <X> Foo foo() {}"); 308 verifyFormat("public abstract <X> Foo foo();"); 309 verifyFormat("<T extends B> T getInstance(Class<T> type);"); 310 verifyFormat("Function<F, ? extends T> function;"); 311 312 verifyFormat("private Foo<X, Y>[] foos;"); 313 verifyFormat("Foo<X, Y>[] foos = this.foos;"); 314 verifyFormat("return (a instanceof List<?>)\n" 315 " ? aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n" 316 " : aaaaaaaaaaaaaaaaaaaaaaa;", 317 getStyleWithColumns(60)); 318 319 verifyFormat( 320 "SomeLoooooooooooooooooooooongType name =\n" 321 " SomeType.foo(someArgument)\n" 322 " .<X>method()\n" 323 " .aaaaaaaaaaaaaaaaaaa()\n" 324 " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); 325 } 326 327 TEST_F(FormatTestJava, StringConcatenation) { 328 verifyFormat("String someString = \"abc\"\n" 329 " + \"cde\";"); 330 } 331 332 TEST_F(FormatTestJava, TryCatchFinally) { 333 verifyFormat("try {\n" 334 " Something();\n" 335 "} catch (SomeException e) {\n" 336 " HandleException(e);\n" 337 "}"); 338 verifyFormat("try {\n" 339 " Something();\n" 340 "} finally {\n" 341 " AlwaysDoThis();\n" 342 "}"); 343 verifyFormat("try {\n" 344 " Something();\n" 345 "} catch (SomeException e) {\n" 346 " HandleException(e);\n" 347 "} finally {\n" 348 " AlwaysDoThis();\n" 349 "}"); 350 351 verifyFormat("try {\n" 352 " Something();\n" 353 "} catch (SomeException | OtherException e) {\n" 354 " HandleException(e);\n" 355 "}"); 356 } 357 358 TEST_F(FormatTestJava, SynchronizedKeyword) { 359 verifyFormat("synchronized (mData) {\n" 360 " // ...\n" 361 "}"); 362 } 363 364 TEST_F(FormatTestJava, PackageDeclarations) { 365 verifyFormat("package some.really.loooooooooooooooooooooong.package;", 366 getStyleWithColumns(50)); 367 } 368 369 TEST_F(FormatTestJava, ImportDeclarations) { 370 verifyFormat("import some.really.loooooooooooooooooooooong.imported.Class;", 371 getStyleWithColumns(50)); 372 verifyFormat("import static some.really.looooooooooooooooong.imported.Class;", 373 getStyleWithColumns(50)); 374 } 375 376 TEST_F(FormatTestJava, MethodDeclarations) { 377 verifyFormat("void methodName(Object arg1,\n" 378 " Object arg2, Object arg3) {}", 379 getStyleWithColumns(40)); 380 verifyFormat("void methodName(\n" 381 " Object arg1, Object arg2) {}", 382 getStyleWithColumns(40)); 383 } 384 385 TEST_F(FormatTestJava, CppKeywords) { 386 verifyFormat("public void union(Type a, Type b);"); 387 verifyFormat("public void struct(Object o);"); 388 verifyFormat("public void delete(Object o);"); 389 } 390 391 TEST_F(FormatTestJava, NeverAlignAfterReturn) { 392 verifyFormat("return aaaaaaaaaaaaaaaaaaa\n" 393 " && bbbbbbbbbbbbbbbbbbb\n" 394 " && ccccccccccccccccccc;", 395 getStyleWithColumns(40)); 396 verifyFormat("return (result == null)\n" 397 " ? aaaaaaaaaaaaaaaaa\n" 398 " : bbbbbbbbbbbbbbbbb;", 399 getStyleWithColumns(40)); 400 verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n" 401 " .bbbbbbbbbbbbbbbbbbb()\n" 402 " .ccccccccccccccccccc();", 403 getStyleWithColumns(40)); 404 verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n" 405 " .bbbbbbbbbbbbbbbbbbb(\n" 406 " ccccccccccccccc)\n" 407 " .ccccccccccccccccccc();", 408 getStyleWithColumns(40)); 409 } 410 411 TEST_F(FormatTestJava, FormatsInnerBlocks) { 412 verifyFormat("someObject.someFunction(new Runnable() {\n" 413 " @Override\n" 414 " public void run() {\n" 415 " System.out.println(42);\n" 416 " }\n" 417 "}, someOtherParameter);"); 418 verifyFormat("someFunction(new Runnable() {\n" 419 " public void run() {\n" 420 " System.out.println(42);\n" 421 " }\n" 422 "});"); 423 verifyFormat("someObject.someFunction(\n" 424 " new Runnable() {\n" 425 " @Override\n" 426 " public void run() {\n" 427 " System.out.println(42);\n" 428 " }\n" 429 " },\n" 430 " new Runnable() {\n" 431 " @Override\n" 432 " public void run() {\n" 433 " System.out.println(43);\n" 434 " }\n" 435 " },\n" 436 " someOtherParameter);"); 437 } 438 439 TEST_F(FormatTestJava, FormatsLambdas) { 440 verifyFormat("(aaaaaaaaaa, bbbbbbbbbb) -> aaaaaaaaaa + bbbbbbbbbb;"); 441 verifyFormat("(aaaaaaaaaa, bbbbbbbbbb)\n" 442 " -> aaaaaaaaaa + bbbbbbbbbb;", 443 getStyleWithColumns(40)); 444 verifyFormat("Runnable someLambda = () -> DoSomething();"); 445 verifyFormat("Runnable someLambda = () -> {\n" 446 " DoSomething();\n" 447 "}"); 448 449 verifyFormat("Runnable someLambda =\n" 450 " (int aaaaa) -> DoSomething(aaaaa);", 451 getStyleWithColumns(40)); 452 } 453 454 TEST_F(FormatTestJava, BreaksStringLiterals) { 455 // FIXME: String literal breaking is currently disabled for Java and JS, as it 456 // requires strings to be merged using "+" which we don't support. 457 EXPECT_EQ("\"some text other\";", 458 format("\"some text other\";", getStyleWithColumns(14))); 459 } 460 461 TEST_F(FormatTestJava, AlignsBlockComments) { 462 EXPECT_EQ("/*\n" 463 " * Really multi-line\n" 464 " * comment.\n" 465 " */\n" 466 "void f() {}", 467 format(" /*\n" 468 " * Really multi-line\n" 469 " * comment.\n" 470 " */\n" 471 " void f() {}")); 472 } 473 474 } // end namespace tooling 475 } // end namespace clang 476