xref: /llvm-project/clang/unittests/Format/FormatTestJava.cpp (revision a644d7f39c22e918c1368169e508048b7860e32e)
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   verifyFormat("@SomeAnnotation()\n"
86                "abstract class aaaaaaaaa<a> extends bbbbbbbbbbbb<b>\n"
87                "    implements cccccccccccc {\n"
88                "}",
89                getStyleWithColumns(76));
90   verifyFormat("interface SomeInterface<A> extends Foo, Bar {\n"
91                "  void doStuff(int theStuff);\n"
92                "  void doMoreStuff(int moreStuff);\n"
93                "}");
94   verifyFormat("public interface SomeInterface {\n"
95                "  void doStuff(int theStuff);\n"
96                "  void doMoreStuff(int moreStuff);\n"
97                "}");
98   verifyFormat("@interface SomeInterface {\n"
99                "  void doStuff(int theStuff);\n"
100                "  void doMoreStuff(int moreStuff);\n"
101                "}");
102   verifyFormat("public @interface SomeInterface {\n"
103                "  void doStuff(int theStuff);\n"
104                "  void doMoreStuff(int moreStuff);\n"
105                "}");
106 }
107 
108 TEST_F(FormatTestJava, EnumDeclarations) {
109   verifyFormat("enum SomeThing { ABC, CDE }");
110   verifyFormat("enum SomeThing {\n"
111                "  ABC,\n"
112                "  CDE,\n"
113                "}");
114   verifyFormat("public class SomeClass {\n"
115                "  enum SomeThing { ABC, CDE }\n"
116                "  void f() {\n"
117                "  }\n"
118                "}");
119 }
120 
121 TEST_F(FormatTestJava, ThrowsDeclarations) {
122   verifyFormat("public void doSooooooooooooooooooooooooooomething()\n"
123                "    throws LooooooooooooooooooooooooooooongException {\n}");
124 }
125 
126 TEST_F(FormatTestJava, Annotations) {
127   verifyFormat("@Override\n"
128                "public String toString() {\n}");
129   verifyFormat("@Override\n"
130                "@Nullable\n"
131                "public String getNameIfPresent() {\n}");
132 
133   verifyFormat("@SuppressWarnings(value = \"unchecked\")\n"
134                "public void doSomething() {\n}");
135   verifyFormat("@SuppressWarnings(value = \"unchecked\")\n"
136                "@Author(name = \"abc\")\n"
137                "public void doSomething() {\n}");
138 
139   verifyFormat("DoSomething(new A() {\n"
140                "  @Override\n"
141                "  public String toString() {\n"
142                "  }\n"
143                "});");
144 
145   verifyFormat("void SomeFunction(@Nullable String something) {\n"
146                "}");
147 
148   verifyFormat("@Partial @Mock DataLoader loader;");
149   verifyFormat("@SuppressWarnings(value = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")\n"
150                "public static int iiiiiiiiiiiiiiiiiiiiiiii;");
151 
152   verifyFormat("@SomeAnnotation(\"With some really looooooooooooooong text\")\n"
153                "private static final long something = 0L;");
154 }
155 
156 TEST_F(FormatTestJava, Generics) {
157   verifyFormat("Iterable<?> a;");
158   verifyFormat("Iterable<?> a;");
159   verifyFormat("Iterable<? extends SomeObject> a;");
160 
161   verifyFormat("A.<B>doSomething();");
162 
163   verifyFormat("@Override\n"
164                "public Map<String, ?> getAll() {\n}");
165 
166   verifyFormat("public static <R> ArrayList<R> get() {\n}");
167   verifyFormat("<T extends B> T getInstance(Class<T> type);");
168 }
169 
170 TEST_F(FormatTestJava, StringConcatenation) {
171   verifyFormat("String someString = \"abc\"\n"
172                "                    + \"cde\";");
173 }
174 
175 TEST_F(FormatTestJava, TryCatchFinally) {
176   verifyFormat("try {\n"
177                "  Something();\n"
178                "} catch (SomeException e) {\n"
179                "  HandleException(e);\n"
180                "}");
181   verifyFormat("try {\n"
182                "  Something();\n"
183                "} finally {\n"
184                "  AlwaysDoThis();\n"
185                "}");
186   verifyFormat("try {\n"
187                "  Something();\n"
188                "} catch (SomeException e) {\n"
189                "  HandleException(e);\n"
190                "} finally {\n"
191                "  AlwaysDoThis();\n"
192                "}");
193 
194   verifyFormat("try {\n"
195                "  Something();\n"
196                "} catch (SomeException | OtherException e) {\n"
197                "  HandleException(e);\n"
198                "}");
199 }
200 
201 TEST_F(FormatTestJava, SynchronizedKeyword) {
202   verifyFormat("synchronized (mData) {\n"
203                "  // ...\n"
204                "}");
205 }
206 
207 TEST_F(FormatTestJava, ImportDeclarations) {
208   verifyFormat("import some.really.loooooooooooooooooooooong.imported.Class;",
209                getStyleWithColumns(50));
210 }
211 
212 } // end namespace tooling
213 } // end namespace clang
214