//===- unittest/Format/FormatTestJava.cpp - Formatting tests for Java -----===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "FormatTestUtils.h"
#include "clang/Format/Format.h"
#include "llvm/Support/Debug.h"
#include "gtest/gtest.h"
#define DEBUG_TYPE "format-test"
namespace clang {
namespace format {
class FormatTestJava : public ::testing::Test {
protected:
static std::string format(llvm::StringRef Code, unsigned Offset,
unsigned Length, const FormatStyle &Style) {
DEBUG(llvm::errs() << "---\n");
DEBUG(llvm::errs() << Code << "\n\n");
std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
tooling::Replacements Replaces = reformat(Style, Code, Ranges);
std::string Result = applyAllReplacements(Code, Replaces);
EXPECT_NE("", Result);
DEBUG(llvm::errs() << "\n" << Result << "\n\n");
return Result;
}
static std::string format(
llvm::StringRef Code,
const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_Java)) {
return format(Code, 0, Code.size(), Style);
}
static FormatStyle getStyleWithColumns(unsigned ColumnLimit) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_Java);
Style.ColumnLimit = ColumnLimit;
return Style;
}
static void verifyFormat(
llvm::StringRef Code,
const FormatStyle &Style = getGoogleStyle(FormatStyle::LK_Java)) {
EXPECT_EQ(Code.str(), format(test::messUp(Code), Style));
}
};
TEST_F(FormatTestJava, NoAlternativeOperatorNames) {
verifyFormat("someObject.and();");
}
TEST_F(FormatTestJava, UnderstandsCasts) {
verifyFormat("a[b >> 1] = (byte) (c() << 4);");
}
TEST_F(FormatTestJava, FormatsInstanceOfLikeOperators) {
FormatStyle Style = getStyleWithColumns(50);
verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
" instanceof bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;",
Style);
Style.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaa instanceof\n"
" bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;",
Style);
}
TEST_F(FormatTestJava, Chromium) {
verifyFormat("class SomeClass {\n"
" void f() {}\n"
" int g() {\n"
" return 0;\n"
" }\n"
" void h() {\n"
" while (true) f();\n"
" for (;;) f();\n"
" if (true) f();\n"
" }\n"
"}",
getChromiumStyle(FormatStyle::LK_Java));
}
TEST_F(FormatTestJava, QualifiedNames) {
verifyFormat("public some.package.Type someFunction( // comment\n"
" int parameter) {}");
}
TEST_F(FormatTestJava, ClassKeyword) {
verifyFormat("SomeClass.class.getName();");
verifyFormat("Class c = SomeClass.class;");
}
TEST_F(FormatTestJava, ClassDeclarations) {
verifyFormat("public class SomeClass {\n"
" private int a;\n"
" private int b;\n"
"}");
verifyFormat("public class A {\n"
" class B {\n"
" int i;\n"
" }\n"
" class C {\n"
" int j;\n"
" }\n"
"}");
verifyFormat("public class A extends B.C {}");
verifyFormat("abstract class SomeClass\n"
" extends SomeOtherClass implements SomeInterface {}",
getStyleWithColumns(60));
verifyFormat("abstract class SomeClass extends SomeOtherClass\n"
" implements SomeInterfaceeeeeeeeeeeee {}",
getStyleWithColumns(60));
verifyFormat("abstract class SomeClass\n"
" extends SomeOtherClass\n"
" implements SomeInterface {}",
getStyleWithColumns(40));
verifyFormat("abstract class SomeClass\n"
" extends SomeOtherClass\n"
" implements SomeInterface,\n"
" AnotherInterface {}",
getStyleWithColumns(40));
verifyFormat("abstract class SomeClass\n"
" implements SomeInterface, AnotherInterface {}",
getStyleWithColumns(60));
verifyFormat("@SomeAnnotation()\n"
"abstract class aaaaaaaaaaaa\n"
" extends bbbbbbbbbbbbbbb implements cccccccccccc {}",
getStyleWithColumns(76));
verifyFormat("@SomeAnnotation()\n"
"abstract class aaaaaaaaa<a>\n"
" extends bbbbbbbbbbbb<b> implements cccccccccccc {}",
getStyleWithColumns(76));
verifyFormat("interface SomeInterface<A> extends Foo, Bar {\n"
" void doStuff(int theStuff);\n"
" void doMoreStuff(int moreStuff);\n"
"}");
verifyFormat("public interface SomeInterface {\n"
" void doStuff(int theStuff);\n"
" void doMoreStuff(int moreStuff);\n"
"}");
verifyFormat("@interface SomeInterface {\n"
" void doStuff(int theStuff);\n"
" void doMoreStuff(int moreStuff);\n"
"}");
verifyFormat("public @interface SomeInterface {\n"
" void doStuff(int theStuff);\n"
" void doMoreStuff(int moreStuff);\n"
"}");
}
TEST_F(FormatTestJava, AnonymousClasses) {
verifyFormat("return new A() {\n"
" public String toString() {\n"
" return \"NotReallyA\";\n"
" }\n"
"};");
verifyFormat("A a = new A() {\n"
" public String toString() {\n"
" return \"NotReallyA\";\n"
" }\n"
"};");
}
TEST_F(FormatTestJava, EnumDeclarations) {
verifyFormat("enum SomeThing { ABC, CDE }");
verifyFormat("enum SomeThing {\n"
" ABC,\n"
" CDE,\n"
"}");
verifyFormat("public class SomeClass {\n"
" enum SomeThing { ABC, CDE }\n"
" void f() {}\n"
"}");
verifyFormat("public class SomeClass implements SomeInterface {\n"
" enum SomeThing { ABC, CDE }\n"
" void f() {}\n"
"}");
verifyFormat("enum SomeThing {\n"
" ABC,\n"
" CDE;\n"
" void f() {}\n"
"}");
verifyFormat("enum SomeThing {\n"
" ABC(1, \"ABC\"),\n"
" CDE(2, \"CDE\");\n"
" Something(int i, String s) {}\n"
"}");
verifyFormat("enum SomeThing {\n"
" ABC(new int[] {1, 2}),\n"
" CDE(new int[] {2, 3});\n"
" Something(int[] i) {}\n"
"}");
verifyFormat("public enum SomeThing {\n"
" ABC {\n"
" public String toString() {\n"
" return \"ABC\";\n"
" }\n"
" },\n"
" CDE {\n"
" @Override\n"
" public String toString() {\n"
" return \"CDE\";\n"
" }\n"
" };\n"
" public void f() {}\n"
"}");
verifyFormat("private enum SomeEnum implements Foo<?, B> {\n"
" ABC {\n"
" @Override\n"
" public String toString() {\n"
" return \"ABC\";\n"
" }\n"
" },\n"
" CDE {\n"
" @Override\n"
" public String toString() {\n"
" return \"CDE\";\n"
" }\n"
" };\n"
"}");
}
TEST_F(FormatTestJava, ArrayInitializers) {
verifyFormat("new int[] {1, 2, 3, 4};");
verifyFormat("new int[] {\n"
" 1, 2, 3, 4,\n"
"};");
FormatStyle Style = getStyleWithColumns(65);
Style.Cpp11BracedListStyle = false;
verifyFormat(
"expected = new int[] { 10, 10, 10, 10, 10, 10, 10, 10, 10, 10,\n"
" 100, 100, 100, 100, 100, 100, 100, 100, 100, 100 };",
Style);
}
TEST_F(FormatTestJava, ThrowsDeclarations) {
verifyFormat("public void doSooooooooooooooooooooooooooomething()\n"
" throws LooooooooooooooooooooooooooooongException {}");
verifyFormat("public void doSooooooooooooooooooooooooooomething()\n"
" throws LoooooooooongException, LooooooooooongException {}");
}
TEST_F(FormatTestJava, Annotations) {
verifyFormat("@Override\n"
"public String toString() {}");
verifyFormat("@Override\n"
"@Nullable\n"
"public String getNameIfPresent() {}");
verifyFormat("@Override // comment\n"
"@Nullable\n"
"public String getNameIfPresent() {}");
verifyFormat("@java.lang.Override // comment\n"
"@Nullable\n"
"public String getNameIfPresent() {}");
verifyFormat("@SuppressWarnings(value = \"unchecked\")\n"
"public void doSomething() {}");
verifyFormat("@SuppressWarnings(value = \"unchecked\")\n"
"@Author(name = \"abc\")\n"
"public void doSomething() {}");
verifyFormat("DoSomething(new A() {\n"
" @Override\n"
" public String toString() {}\n"
"});");
verifyFormat("void SomeFunction(@Nullable String something) {}");
verifyFormat("void SomeFunction(@org.llvm.Nullable String something) {}");
verifyFormat("@Partial @Mock DataLoader loader;");
verifyFormat("@SuppressWarnings(value = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")\n"
"public static int iiiiiiiiiiiiiiiiiiiiiiii;");
verifyFormat("@SomeAnnotation(\"With some really looooooooooooooong text\")\n"
"private static final long something = 0L;");
verifyFormat("@org.llvm.Qualified(\"With some really looooooooooong text\")\n"
"private static final long something = 0L;");
verifyFormat("@Mock\n"
"DataLoader loooooooooooooooooooooooader =\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
getStyleWithColumns(60));
verifyFormat("@org.llvm.QualifiedMock\n"
"DataLoader loooooooooooooooooooooooader =\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
getStyleWithColumns(60));
verifyFormat("@Test(a)\n"
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaa);");
verifyFormat("@SomeAnnotation(\n"
" aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaa)\n"
"int i;",
getStyleWithColumns(50));
verifyFormat("@Test\n"
"ReturnType doSomething(\n"
" String aaaaaaaaaaaaa, String bbbbbbbbbbbbbbb) {}",
getStyleWithColumns(60));
verifyFormat("{\n"
" boolean someFunction(\n"
" @Param(aaaaaaaaaaaaaaaa) String aaaaa,\n"
" String bbbbbbbbbbbbbbb) {}\n"
"}",
getStyleWithColumns(60));
}
TEST_F(FormatTestJava, Generics) {
verifyFormat("Iterable<?> a;");
verifyFormat("Iterable<?> a;");
verifyFormat("Iterable<? extends SomeObject> a;");
verifyFormat("A.<B>doSomething();");
verifyFormat("@Override\n"
"public Map<String, ?> getAll() {}");
verifyFormat("public <R> ArrayList<R> get() {}");
verifyFormat("protected <R> ArrayList<R> get() {}");
verifyFormat("private <R> ArrayList<R> get() {}");
verifyFormat("public static <R> ArrayList<R> get() {}");
verifyFormat("public static native <R> ArrayList<R> get();");
verifyFormat("public final <X> Foo foo() {}");
verifyFormat("public abstract <X> Foo foo();");
verifyFormat("<T extends B> T getInstance(Class<T> type);");
verifyFormat("Function<F, ? extends T> function;");
verifyFormat("private Foo<X, Y>[] foos;");
verifyFormat("Foo<X, Y>[] foos = this.foos;");
verifyFormat("return (a instanceof List<?>)\n"
" ? aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n"
" : aaaaaaaaaaaaaaaaaaaaaaa;",
getStyleWithColumns(60));
verifyFormat(
"SomeLoooooooooooooooooooooongType name =\n"
" SomeType.foo(someArgument)\n"
" .<X>method()\n"
" .aaaaaaaaaaaaaaaaaaa()\n"
" .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();");
}
TEST_F(FormatTestJava, StringConcatenation) {
verifyFormat("String someString = \"abc\"\n"
" + \"cde\";");
}
TEST_F(FormatTestJava, TryCatchFinally) {
verifyFormat("try {\n"
" Something();\n"
"} catch (SomeException e) {\n"
" HandleException(e);\n"
"}");
verifyFormat("try {\n"
" Something();\n"
"} finally {\n"
" AlwaysDoThis();\n"
"}");
verifyFormat("try {\n"
" Something();\n"
"} catch (SomeException e) {\n"
" HandleException(e);\n"
"} finally {\n"
" AlwaysDoThis();\n"
"}");
verifyFormat("try {\n"
" Something();\n"
"} catch (SomeException | OtherException e) {\n"
" HandleException(e);\n"
"}");
}
TEST_F(FormatTestJava, TryWithResources) {
verifyFormat("try (SomeResource rs = someFunction()) {\n"
" Something();\n"
"}");
verifyFormat("try (SomeResource rs = someFunction()) {\n"
" Something();\n"
"} catch (SomeException e) {\n"
" HandleException(e);\n"
"}");
}
TEST_F(FormatTestJava, SynchronizedKeyword) {
verifyFormat("synchronized (mData) {\n"
" // ...\n"
"}");
}
TEST_F(FormatTestJava, PackageDeclarations) {
verifyFormat("package some.really.loooooooooooooooooooooong.package;",
getStyleWithColumns(50));
}
TEST_F(FormatTestJava, ImportDeclarations) {
verifyFormat("import some.really.loooooooooooooooooooooong.imported.Class;",
getStyleWithColumns(50));
verifyFormat("import static some.really.looooooooooooooooong.imported.Class;",
getStyleWithColumns(50));
}
TEST_F(FormatTestJava, MethodDeclarations) {
verifyFormat("void methodName(Object arg1,\n"
" Object arg2, Object arg3) {}",
getStyleWithColumns(40));
verifyFormat("void methodName(\n"
" Object arg1, Object arg2) {}",
getStyleWithColumns(40));
}
TEST_F(FormatTestJava, CppKeywords) {
verifyFormat("public void union(Type a, Type b);");
verifyFormat("public void struct(Object o);");
verifyFormat("public void delete(Object o);");
}
TEST_F(FormatTestJava, NeverAlignAfterReturn) {
verifyFormat("return aaaaaaaaaaaaaaaaaaa\n"
" && bbbbbbbbbbbbbbbbbbb\n"
" && ccccccccccccccccccc;",
getStyleWithColumns(40));
verifyFormat("return (result == null)\n"
" ? aaaaaaaaaaaaaaaaa\n"
" : bbbbbbbbbbbbbbbbb;",
getStyleWithColumns(40));
verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n"
" .bbbbbbbbbbbbbbbbbbb()\n"
" .ccccccccccccccccccc();",
getStyleWithColumns(40));
verifyFormat("return aaaaaaaaaaaaaaaaaaa()\n"
" .bbbbbbbbbbbbbbbbbbb(\n"
" ccccccccccccccc)\n"
" .ccccccccccccccccccc();",
getStyleWithColumns(40));
}
TEST_F(FormatTestJava, FormatsInnerBlocks) {
verifyFormat("someObject.someFunction(new Runnable() {\n"
" @Override\n"
" public void run() {\n"
" System.out.println(42);\n"
" }\n"
"}, someOtherParameter);");
verifyFormat("someFunction(new Runnable() {\n"
" public void run() {\n"
" System.out.println(42);\n"
" }\n"
"});");
verifyFormat("someObject.someFunction(\n"
" new Runnable() {\n"
" @Override\n"
" public void run() {\n"
" System.out.println(42);\n"
" }\n"
" },\n"
" new Runnable() {\n"
" @Override\n"
" public void run() {\n"
" System.out.println(43);\n"
" }\n"
" },\n"
" someOtherParameter);");
}
TEST_F(FormatTestJava, FormatsLambdas) {
verifyFormat("(aaaaaaaaaa, bbbbbbbbbb) -> aaaaaaaaaa + bbbbbbbbbb;");
verifyFormat("(aaaaaaaaaa, bbbbbbbbbb)\n"
" -> aaaaaaaaaa + bbbbbbbbbb;",
getStyleWithColumns(40));
verifyFormat("Runnable someLambda = () -> DoSomething();");
verifyFormat("Runnable someLambda = () -> {\n"
" DoSomething();\n"
"}");
verifyFormat("Runnable someLambda =\n"
" (int aaaaa) -> DoSomething(aaaaa);",
getStyleWithColumns(40));
}
TEST_F(FormatTestJava, BreaksStringLiterals) {
// FIXME: String literal breaking is currently disabled for Java and JS, as it
// requires strings to be merged using "+" which we don't support.
EXPECT_EQ("\"some text other\";",
format("\"some text other\";", getStyleWithColumns(14)));
}
TEST_F(FormatTestJava, AlignsBlockComments) {
EXPECT_EQ("/*\n"
" * Really multi-line\n"
" * comment.\n"
" */\n"
"void f() {}",
format(" /*\n"
" * Really multi-line\n"
" * comment.\n"
" */\n"
" void f() {}"));
}
} // end namespace tooling
} // end namespace clang