1 //===- unittest/Format/CleanupTest.cpp - Code cleanup unit tests ----------===//
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
7 //===----------------------------------------------------------------------===//
9 #include "clang/Format/Format.h"
11 #include "../Tooling/ReplacementTest.h"
12 #include "clang/Tooling/Core/Replacement.h"
14 #include "gtest/gtest.h"
16 using clang::tooling::ReplacementTest
;
17 using clang::tooling::toReplacements
;
23 class CleanupTest
: public testing::Test
{
25 std::string
cleanup(StringRef Code
, const std::vector
<tooling::Range
> &Ranges
,
26 const FormatStyle
&Style
= getLLVMStyle()) {
27 tooling::Replacements Replaces
= format::cleanup(Style
, Code
, Ranges
);
29 auto Result
= applyAllReplacements(Code
, Replaces
);
30 EXPECT_TRUE(static_cast<bool>(Result
));
34 // Returns code after cleanup around \p Offsets.
35 std::string
cleanupAroundOffsets(ArrayRef
<unsigned> Offsets
, StringRef Code
,
36 const FormatStyle
&Style
= getLLVMStyle()) {
37 std::vector
<tooling::Range
> Ranges
;
38 for (auto Offset
: Offsets
)
39 Ranges
.push_back(tooling::Range(Offset
, 0));
40 return cleanup(Code
, Ranges
, Style
);
44 TEST_F(CleanupTest
, DeleteEmptyNamespaces
) {
45 std::string Code
= "namespace A {\n"
48 "} // namespace A\n\n"
50 "namespace D { int i; }\n"
51 "inline namespace E { namespace { } }\n"
53 std::string Expected
= "\n\n\n\n\nnamespace C {\n"
54 "namespace D { int i; }\n \n"
56 EXPECT_EQ(Expected
, cleanupAroundOffsets({28, 91, 132}, Code
));
59 TEST_F(CleanupTest
, NamespaceWithSyntaxError
) {
60 std::string Code
= "namespace A {\n"
61 "namespace B {\n" // missing r_brace
62 "} // namespace A\n\n"
64 "namespace D int i; }\n"
65 "inline namespace E { namespace { } }\n"
67 std::string Expected
= "namespace A {\n"
68 "\n\n\nnamespace C {\n"
69 "namespace D int i; }\n \n"
71 std::vector
<tooling::Range
> Ranges(1, tooling::Range(0, Code
.size()));
72 EXPECT_EQ(Expected
, cleanup(Code
, Ranges
));
75 TEST_F(CleanupTest
, EmptyNamespaceNotAffected
) {
76 std::string Code
= "namespace A {\n\n"
78 // Even though the namespaces are empty, but the inner most empty namespace
79 // block is not affected by the changed ranges.
80 std::string Expected
= "namespace A {\n\n"
82 // Set the changed range to be the second "\n".
83 EXPECT_EQ(Expected
, cleanupAroundOffsets({14}, Code
));
86 TEST_F(CleanupTest
, EmptyNamespaceWithCommentsNoBreakBeforeBrace
) {
87 std::string Code
= "namespace A {\n"
92 "namespace C { // Yo\n"
94 std::string Expected
= "\n\n\n\n\n\n";
95 std::vector
<tooling::Range
> Ranges(1, tooling::Range(0, Code
.size()));
96 std::string Result
= cleanup(Code
, Ranges
);
97 EXPECT_EQ(Expected
, Result
);
100 TEST_F(CleanupTest
, EmptyNamespaceWithCommentsBreakBeforeBrace
) {
101 std::string Code
= "namespace A\n"
111 std::string Expected
= "\n\n\n\n\n\n\n\n\n\n";
112 std::vector
<tooling::Range
> Ranges(1, tooling::Range(0, Code
.size()));
113 FormatStyle Style
= getLLVMStyle();
114 Style
.BraceWrapping
.AfterNamespace
= true;
115 std::string Result
= cleanup(Code
, Ranges
, Style
);
116 EXPECT_EQ(Expected
, Result
);
119 TEST_F(CleanupTest
, EmptyNamespaceAroundConditionalCompilation
) {
120 std::string Code
= "#ifdef A\n"
126 std::string Expected
= "#ifdef A\n"
131 std::vector
<tooling::Range
> Ranges(1, tooling::Range(0, Code
.size()));
132 FormatStyle Style
= getLLVMStyle();
133 std::string Result
= cleanup(Code
, Ranges
, Style
);
134 EXPECT_EQ(Expected
, Result
);
137 TEST_F(CleanupTest
, CtorInitializationSimpleRedundantComma
) {
138 std::string Code
= "class A {\nA() : , {} };";
139 std::string Expected
= "class A {\nA() {} };";
140 EXPECT_EQ(Expected
, cleanupAroundOffsets({17, 19}, Code
));
142 Code
= "class A {\nA() : x(1), {} };";
143 Expected
= "class A {\nA() : x(1) {} };";
144 EXPECT_EQ(Expected
, cleanupAroundOffsets({23}, Code
));
146 Code
= "class A {\nA() :,,,,{} };";
147 Expected
= "class A {\nA() {} };";
148 EXPECT_EQ(Expected
, cleanupAroundOffsets({15}, Code
));
151 // regression test for bug 39310
152 TEST_F(CleanupTest
, CtorInitializationSimpleRedundantCommaInFunctionTryBlock
) {
153 std::string Code
= "class A {\nA() try : , {} };";
154 std::string Expected
= "class A {\nA() try {} };";
155 EXPECT_EQ(Expected
, cleanupAroundOffsets({21, 23}, Code
));
157 Code
= "class A {\nA() try : x(1), {} };";
158 Expected
= "class A {\nA() try : x(1) {} };";
159 EXPECT_EQ(Expected
, cleanupAroundOffsets({27}, Code
));
161 Code
= "class A {\nA() try :,,,,{} };";
162 Expected
= "class A {\nA() try {} };";
163 EXPECT_EQ(Expected
, cleanupAroundOffsets({19}, Code
));
165 Code
= "class A {\nA() try : x(1),,, {} };";
166 Expected
= "class A {\nA() try : x(1) {} };";
167 EXPECT_EQ(Expected
, cleanupAroundOffsets({27}, Code
));
169 // Do not remove every comma following a colon as it simply doesn't make
170 // sense in some situations.
172 Expected
= "try : , {}";
173 EXPECT_EQ(Expected
, cleanupAroundOffsets({8}, Code
));
176 TEST_F(CleanupTest
, CtorInitializationSimpleRedundantColon
) {
177 std::string Code
= "class A {\nA() : =default; };";
178 std::string Expected
= "class A {\nA() =default; };";
179 EXPECT_EQ(Expected
, cleanupAroundOffsets({15}, Code
));
181 Code
= "class A {\nA() : , =default; };";
182 Expected
= "class A {\nA() =default; };";
183 EXPECT_EQ(Expected
, cleanupAroundOffsets({15}, Code
));
186 TEST_F(CleanupTest
, ListRedundantComma
) {
187 std::string Code
= "void f() { std::vector<int> v = {1,2,,,3,{4,5}}; }";
188 std::string Expected
= "void f() { std::vector<int> v = {1,2,3,{4,5}}; }";
189 EXPECT_EQ(Expected
, cleanupAroundOffsets({40}, Code
));
191 Code
= "int main() { f(1,,2,3,,4);}";
192 Expected
= "int main() { f(1,2,3,4);}";
193 EXPECT_EQ(Expected
, cleanupAroundOffsets({17, 22}, Code
));
196 TEST_F(CleanupTest
, NoCleanupsForJavaScript
) {
197 std::string Code
= "function f() { var x = [a, b, , c]; }";
198 std::string Expected
= "function f() { var x = [a, b, , c]; }";
199 const FormatStyle
&Style
= getGoogleStyle(FormatStyle::LK_JavaScript
);
201 EXPECT_EQ(Expected
, cleanupAroundOffsets({30}, Code
, Style
));
204 TEST_F(CleanupTest
, TrailingCommaInParens
) {
205 std::string Code
= "int main() { f(,1,,2,3,f(1,2,),4,,);}";
206 std::string Expected
= "int main() { f(1,2,3,f(1,2),4);}";
207 EXPECT_EQ(Expected
, cleanupAroundOffsets({15, 18, 29, 33}, Code
));
209 // Lambda contents are also checked for trailing commas.
210 Code
= "int main() { [](){f(,1,,2,3,f(1,2,),4,,);}();}";
211 Expected
= "int main() { [](){f(1,2,3,f(1,2),4);}();}";
212 EXPECT_EQ(Expected
, cleanupAroundOffsets({20, 23, 34, 38}, Code
));
215 TEST_F(CleanupTest
, TrailingCommaInBraces
) {
216 // Trailing comma is allowed in brace list.
217 // If there was trailing comma in the original code, then trailing comma is
218 // preserved. In this example, element between the last two commas is deleted
219 // causing the second-last comma to be redundant.
220 std::string Code
= "void f() { std::vector<int> v = {1,2,3,,}; }";
221 std::string Expected
= "void f() { std::vector<int> v = {1,2,3,}; }";
222 EXPECT_EQ(Expected
, cleanupAroundOffsets({39}, Code
));
224 // If there was no trailing comma in the original code, then trailing comma
225 // introduced by replacements should be cleaned up. In this example, the
226 // element after the last comma is deleted causing the last comma to be
228 Code
= "void f() { std::vector<int> v = {1,2,3,}; }";
229 // FIXME: redundant trailing comma should be removed.
230 Expected
= "void f() { std::vector<int> v = {1,2,3,}; }";
231 EXPECT_EQ(Expected
, cleanupAroundOffsets({39}, Code
));
233 // Still no trailing comma in the original code, but two elements are deleted,
234 // which makes it seems like there was trailing comma.
235 Code
= "void f() { std::vector<int> v = {1, 2, 3, , }; }";
236 // FIXME: redundant trailing comma should also be removed.
237 Expected
= "void f() { std::vector<int> v = {1, 2, 3, }; }";
238 EXPECT_EQ(Expected
, cleanupAroundOffsets({42, 44}, Code
));
241 TEST_F(CleanupTest
, CtorInitializationBracesInParens
) {
242 std::string Code
= "class A {\nA() : x({1}),, {} };";
243 std::string Expected
= "class A {\nA() : x({1}) {} };";
244 EXPECT_EQ(Expected
, cleanupAroundOffsets({24, 26}, Code
));
247 TEST_F(CleanupTest
, RedundantCommaNotInAffectedRanges
) {
249 "class A {\nA() : x({1}), /* comment */, { int x = 0; } };";
250 std::string Expected
=
251 "class A {\nA() : x({1}), /* comment */, { int x = 0; } };";
252 // Set the affected range to be "int x = 0", which does not intercept the
253 // constructor initialization list.
254 std::vector
<tooling::Range
> Ranges(1, tooling::Range(42, 9));
255 std::string Result
= cleanup(Code
, Ranges
);
256 EXPECT_EQ(Expected
, Result
);
258 Code
= "class A {\nA() : x(1), {} };";
259 Expected
= "class A {\nA() : x(1), {} };";
260 // No range. Fixer should do nothing.
262 Result
= cleanup(Code
, Ranges
);
263 EXPECT_EQ(Expected
, Result
);
266 TEST_F(CleanupTest
, RemoveCommentsAroundDeleteCode
) {
268 "class A {\nA() : x({1}), /* comment */, /* comment */ {} };";
269 std::string Expected
= "class A {\nA() : x({1}) {} };";
270 EXPECT_EQ(Expected
, cleanupAroundOffsets({25, 40}, Code
));
272 Code
= "class A {\nA() : x({1}), // comment\n {} };";
273 Expected
= "class A {\nA() : x({1})\n {} };";
274 EXPECT_EQ(Expected
, cleanupAroundOffsets({25}, Code
));
276 Code
= "class A {\nA() : x({1}), // comment\n , y(1),{} };";
277 Expected
= "class A {\nA() : x({1}), y(1){} };";
278 EXPECT_EQ(Expected
, cleanupAroundOffsets({38}, Code
));
280 Code
= "class A {\nA() : x({1}), \n/* comment */, y(1),{} };";
281 Expected
= "class A {\nA() : x({1}), \n y(1){} };";
282 EXPECT_EQ(Expected
, cleanupAroundOffsets({40}, Code
));
284 Code
= "class A {\nA() : , // comment\n y(1),{} };";
285 Expected
= "class A {\nA() : // comment\n y(1){} };";
286 EXPECT_EQ(Expected
, cleanupAroundOffsets({17}, Code
));
288 Code
= "class A {\nA() // comment\n : ,,{} };";
289 Expected
= "class A {\nA() // comment\n {} };";
290 EXPECT_EQ(Expected
, cleanupAroundOffsets({30}, Code
));
292 Code
= "class A {\nA() // comment\n : ,,=default; };";
293 Expected
= "class A {\nA() // comment\n =default; };";
294 EXPECT_EQ(Expected
, cleanupAroundOffsets({30}, Code
));
297 TEST_F(CleanupTest
, CtorInitializerInNamespace
) {
298 std::string Code
= "namespace A {\n"
299 "namespace B {\n" // missing r_brace
300 "} // namespace A\n\n"
302 "class A { A() : x(0),, {} };\n"
303 "inline namespace E { namespace { } }\n"
305 std::string Expected
= "namespace A {\n"
306 "\n\n\nnamespace C {\n"
307 "class A { A() : x(0) {} };\n \n"
309 std::vector
<tooling::Range
> Ranges(1, tooling::Range(0, Code
.size()));
310 std::string Result
= cleanup(Code
, Ranges
);
311 EXPECT_EQ(Expected
, Result
);
314 class CleanUpReplacementsTest
: public ReplacementTest
{
316 tooling::Replacement
createReplacement(unsigned Offset
, unsigned Length
,
318 return tooling::Replacement(FileName
, Offset
, Length
, Text
);
321 tooling::Replacement
createInsertion(StringRef IncludeDirective
) {
322 return createReplacement(UINT_MAX
, 0, IncludeDirective
);
325 tooling::Replacement
createDeletion(StringRef HeaderName
) {
326 return createReplacement(UINT_MAX
, 1, HeaderName
);
329 inline std::string
apply(StringRef Code
,
330 const tooling::Replacements
&Replaces
) {
331 auto CleanReplaces
= cleanupAroundReplacements(Code
, Replaces
, Style
);
332 EXPECT_TRUE(static_cast<bool>(CleanReplaces
))
333 << toString(CleanReplaces
.takeError()) << "\n";
334 auto Result
= applyAllReplacements(Code
, *CleanReplaces
);
335 EXPECT_TRUE(static_cast<bool>(Result
));
339 inline std::string
formatAndApply(StringRef Code
,
340 const tooling::Replacements
&Replaces
) {
341 auto CleanReplaces
= cleanupAroundReplacements(Code
, Replaces
, Style
);
342 EXPECT_TRUE(static_cast<bool>(CleanReplaces
))
343 << toString(CleanReplaces
.takeError()) << "\n";
344 auto FormattedReplaces
= formatReplacements(Code
, *CleanReplaces
, Style
);
345 EXPECT_TRUE(static_cast<bool>(FormattedReplaces
))
346 << toString(FormattedReplaces
.takeError()) << "\n";
347 auto Result
= applyAllReplacements(Code
, *FormattedReplaces
);
348 EXPECT_TRUE(static_cast<bool>(Result
));
352 int getOffset(StringRef Code
, int Line
, int Column
) {
353 RewriterTestContext Context
;
354 FileID ID
= Context
.createInMemoryFile(FileName
, Code
);
355 auto DecomposedLocation
=
356 Context
.Sources
.getDecomposedLoc(Context
.getLocation(ID
, Line
, Column
));
357 return DecomposedLocation
.second
;
360 const std::string FileName
= "fix.cpp";
361 FormatStyle Style
= getLLVMStyle();
364 TEST_F(CleanUpReplacementsTest
, FixOnlyAffectedCodeAfterReplacements
) {
365 std::string Code
= "namespace A {\n"
372 "namespace D { int i; }\n"
373 "inline namespace E { namespace { int y; } }\n"
376 std::string Expected
= "\n\nnamespace C {\n"
377 "namespace D { int i; }\n\n"
380 tooling::Replacements Replaces
=
381 toReplacements({createReplacement(getOffset(Code
, 3, 3), 6, ""),
382 createReplacement(getOffset(Code
, 9, 34), 6, "")});
384 EXPECT_EQ(Expected
, formatAndApply(Code
, Replaces
));
387 TEST_F(CleanUpReplacementsTest
, InsertMultipleIncludesLLVMStyle
) {
388 std::string Code
= "#include \"x/fix.h\"\n"
392 "#include \"clang/Format/Format.h\"\n"
393 "#include <memory>\n";
394 std::string Expected
= "#include \"x/fix.h\"\n"
397 "#include \"new/new.h\"\n"
399 "#include \"clang/Format/Format.h\"\n"
401 "#include <memory>\n";
402 tooling::Replacements Replaces
=
403 toReplacements({createInsertion("#include <list>"),
404 createInsertion("#include \"new/new.h\"")});
405 EXPECT_EQ(Expected
, apply(Code
, Replaces
));
408 TEST_F(CleanUpReplacementsTest
, InsertMultipleIncludesGoogleStyle
) {
409 std::string Code
= "#include \"x/fix.h\"\n"
411 "#include <vector>\n"
413 "#include \"y/a.h\"\n"
414 "#include \"z/b.h\"\n";
415 std::string Expected
= "#include \"x/fix.h\"\n"
418 "#include <vector>\n"
420 "#include \"x/x.h\"\n"
421 "#include \"y/a.h\"\n"
422 "#include \"z/b.h\"\n";
423 tooling::Replacements Replaces
=
424 toReplacements({createInsertion("#include <list>"),
425 createInsertion("#include \"x/x.h\"")});
426 Style
= format::getGoogleStyle(format::FormatStyle::LanguageKind::LK_Cpp
);
427 EXPECT_EQ(Expected
, apply(Code
, Replaces
));
430 TEST_F(CleanUpReplacementsTest
, InsertMultipleNewHeadersAndSortLLVM
) {
431 std::string Code
= "\nint x;";
432 std::string Expected
= "\n#include \"fix.h\"\n"
437 "#include <vector>\n"
439 tooling::Replacements Replaces
= toReplacements(
440 {createInsertion("#include \"a.h\""), createInsertion("#include \"c.h\""),
441 createInsertion("#include \"b.h\""),
442 createInsertion("#include <vector>"), createInsertion("#include <list>"),
443 createInsertion("#include \"fix.h\"")});
444 EXPECT_EQ(Expected
, formatAndApply(Code
, Replaces
));
447 TEST_F(CleanUpReplacementsTest
, InsertMultipleNewHeadersAndSortGoogle
) {
448 std::string Code
= "\nint x;";
449 std::string Expected
= "\n#include \"fix.h\"\n"
452 "#include <vector>\n"
458 tooling::Replacements Replaces
= toReplacements(
459 {createInsertion("#include \"a.h\""), createInsertion("#include \"c.h\""),
460 createInsertion("#include \"b.h\""),
461 createInsertion("#include <vector>"), createInsertion("#include <list>"),
462 createInsertion("#include \"fix.h\"")});
463 Style
= format::getGoogleStyle(format::FormatStyle::LanguageKind::LK_Cpp
);
464 EXPECT_EQ(Expected
, formatAndApply(Code
, Replaces
));
467 TEST_F(CleanUpReplacementsTest
, NoNewLineAtTheEndOfCodeMultipleInsertions
) {
468 std::string Code
= "#include <map>";
469 // FIXME: a better behavior is to only append on newline to Code, but this
470 // case should be rare in practice.
471 std::string Expected
=
472 "#include <map>\n#include <string>\n\n#include <vector>\n";
473 tooling::Replacements Replaces
=
474 toReplacements({createInsertion("#include <string>"),
475 createInsertion("#include <vector>")});
476 EXPECT_EQ(Expected
, apply(Code
, Replaces
));
479 TEST_F(CleanUpReplacementsTest
, FormatCorrectLineWhenHeadersAreInserted
) {
480 std::string Code
= "\n"
486 std::string Expected
= "\n#include \"x.h\"\n"
488 "#include \"clang/x/x.h\"\n"
490 "#include <vector>\n"
495 tooling::Replacements Replaces
= toReplacements(
496 {createReplacement(getOffset(Code
, 4, 8), 1, "b"),
497 createInsertion("#include <vector>"), createInsertion("#include <list>"),
498 createInsertion("#include \"clang/x/x.h\""),
499 createInsertion("#include \"y.h\""),
500 createInsertion("#include \"x.h\"")});
501 EXPECT_EQ(Expected
, formatAndApply(Code
, Replaces
));
504 TEST_F(CleanUpReplacementsTest
, SimpleDeleteIncludes
) {
505 std::string Code
= "#include \"abc.h\"\n"
506 "#include \"xyz.h\" // comment\n"
509 std::string Expected
= "#include \"xyz\"\n"
511 tooling::Replacements Replaces
=
512 toReplacements({createDeletion("abc.h"), createDeletion("xyz.h")});
513 EXPECT_EQ(Expected
, apply(Code
, Replaces
));
516 TEST_F(CleanUpReplacementsTest
, InsertionAndDeleteHeader
) {
517 std::string Code
= "#include \"a.h\"\n"
519 "#include <vector>\n";
520 std::string Expected
= "#include \"a.h\"\n"
523 tooling::Replacements Replaces
= toReplacements(
524 {createDeletion("<vector>"), createInsertion("#include <map>")});
525 EXPECT_EQ(Expected
, apply(Code
, Replaces
));
529 } // end namespace format
530 } // end namespace clang