xref: /llvm-project/clang/unittests/Format/FormatTestJava.cpp (revision 5f2764d88687910b6eb013b6e1c1e9744fc1ce93)
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, ClassDeclarations) {
54   verifyFormat("public class SomeClass {\n"
55                "  private int a;\n"
56                "  private int b;\n"
57                "}");
58   verifyFormat("public class A {\n"
59                "  class B {\n"
60                "    int i;\n"
61                "  }\n"
62                "  class C {\n"
63                "    int j;\n"
64                "  }\n"
65                "}");
66   verifyFormat("public class A extends B.C {}");
67 
68   verifyFormat("abstract class SomeClass extends SomeOtherClass\n"
69                "    implements SomeInterface {}",
70                getStyleWithColumns(60));
71   verifyFormat("abstract class SomeClass\n"
72                "    extends SomeOtherClass\n"
73                "    implements SomeInterface {}",
74                getStyleWithColumns(40));
75   verifyFormat("abstract class SomeClass\n"
76                "    extends SomeOtherClass\n"
77                "    implements SomeInterface,\n"
78                "               AnotherInterface {}",
79                getStyleWithColumns(40));
80   verifyFormat("@SomeAnnotation()\n"
81                "abstract class aaaaaaaaaaaa extends bbbbbbbbbbbbbbb\n"
82                "    implements cccccccccccc {\n"
83                "}",
84                getStyleWithColumns(76));
85 }
86 
87 TEST_F(FormatTestJava, EnumDeclarations) {
88   verifyFormat("enum SomeThing { ABC, CDE }");
89   verifyFormat("enum SomeThing { ABC, CDE };");
90   verifyFormat("enum SomeThing {\n"
91                "  ABC,\n"
92                "  CDE,\n"
93                "}");
94   verifyFormat("public class SomeClass {\n"
95                "  enum SomeThing { ABC, CDE }\n"
96                "  void f() {\n"
97                "  }\n"
98                "}");
99 }
100 
101 TEST_F(FormatTestJava, ThrowsDeclarations) {
102   verifyFormat("public void doSooooooooooooooooooooooooooomething()\n"
103                "    throws LooooooooooooooooooooooooooooongException {\n}");
104 }
105 
106 TEST_F(FormatTestJava, Annotations) {
107   verifyFormat("@Override\n"
108                "public String toString() {\n}");
109   verifyFormat("@Override\n"
110                "@Nullable\n"
111                "public String getNameIfPresent() {\n}");
112 
113   verifyFormat("@SuppressWarnings(value = \"unchecked\")\n"
114                "public void doSomething() {\n}");
115   verifyFormat("@SuppressWarnings(value = \"unchecked\")\n"
116                "@Author(name = \"abc\")\n"
117                "public void doSomething() {\n}");
118 
119   verifyFormat("DoSomething(new A() {\n"
120                "  @Override\n"
121                "  public String toString() {\n"
122                "  }\n"
123                "});");
124 
125   verifyFormat("void SomeFunction(@Nullable String something) {\n"
126                "}");
127 
128   verifyFormat("@Partial @Mock DataLoader loader;");
129   verifyFormat("@SuppressWarnings(value = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")\n"
130                "public static int iiiiiiiiiiiiiiiiiiiiiiii;");
131 
132   verifyFormat("@SomeAnnotation(\"With some really looooooooooooooong text\")\n"
133                "private static final long something = 0L;");
134 }
135 
136 TEST_F(FormatTestJava, Generics) {
137   verifyFormat("Iterable<?> a;");
138   verifyFormat("Iterable<?> a;");
139   verifyFormat("Iterable<? extends SomeObject> a;");
140 
141   verifyFormat("A.<B>doSomething();");
142 
143   verifyFormat("@Override\n"
144                "public Map<String, ?> getAll() {\n}");
145 
146   verifyFormat("public static <R> ArrayList<R> get() {\n}");
147   verifyFormat("<T extends B> T getInstance(Class<T> type);");
148 }
149 
150 TEST_F(FormatTestJava, StringConcatenation) {
151   verifyFormat("String someString = \"abc\"\n"
152                "                    + \"cde\";");
153 }
154 
155 TEST_F(FormatTestJava, TryCatchFinally) {
156   verifyFormat("try {\n"
157                "  Something();\n"
158                "} catch (SomeException e) {\n"
159                "  HandleException(e);\n"
160                "}");
161   verifyFormat("try {\n"
162                "  Something();\n"
163                "} finally {\n"
164                "  AlwaysDoThis();\n"
165                "}");
166   verifyFormat("try {\n"
167                "  Something();\n"
168                "} catch (SomeException e) {\n"
169                "  HandleException(e);\n"
170                "} finally {\n"
171                "  AlwaysDoThis();\n"
172                "}");
173 
174   verifyFormat("try {\n"
175                "  Something();\n"
176                "} catch (SomeException | OtherException e) {\n"
177                "  HandleException(e);\n"
178                "}");
179 }
180 
181 TEST_F(FormatTestJava, SynchronizedKeyword) {
182   verifyFormat("synchronized (mData) {\n"
183                "  // ...\n"
184                "}");
185 }
186 
187 TEST_F(FormatTestJava, ImportDeclarations) {
188   verifyFormat("import some.really.loooooooooooooooooooooong.imported.Class;",
189                getStyleWithColumns(50));
190 }
191 
192 } // end namespace tooling
193 } // end namespace clang
194