intel/llvm
1
0
Fork 0
mirror of https://github.com/intel/llvm.git synced 2026-01-18 16:50:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

[clang-format] Don't break block comments when sorting includes.

Browse Source 
Fixes https://github.com/llvm/llvm-project/issues/34626.

Before, the include sorter would break the code:
```
#include <stdio.h>
#include <stdint.h> /* long
                       comment */
```
and change it into:
```
#include <stdint.h> /* long
#include <stdio.h>
                       comment */
```

This commit handles only the most basic case of a single block comment on an include line, but does not try to handle all the possible edge cases with multiple comments.

Reviewed By: HazardyKnusperkeks

Differential Revision: https://reviews.llvm.org/D118627
This commit is contained in:
Marek Kurdej
2022-01-31 18:39:00 +01:00
parent a265cf22af
commit 95bf0a9ebd
2 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
clang/lib/Format/Format.cpp
View File

@@ -2678,6 +2678,15 @@ tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
if (!FormattingOff && !MergeWithNextLine) {
if (IncludeRegex.match(Line, &Matches)) {
StringRef IncludeName = Matches[2];
if (Line.contains("/*") && !Line.contains("*/")) {
// #include with a start of a block comment, but without the end.
// Need to keep all the lines until the end of the comment together.
// FIXME: This is somehow simplified check that probably does not work
// correctly if there are multiple comments on a line.
Pos = Code.find("*/", SearchFrom);
Line = Code.substr(
Prev, (Pos != StringRef::npos ? Pos + 2 : Code.size()) - Prev);
}
int Category = Categories.getIncludePriority(
IncludeName,
/*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);

15
clang/unittests/Format/SortIncludesTest.cpp
View File

@@ -70,6 +70,21 @@ TEST_F(SortIncludesTest, BasicSorting) {
{tooling::Range(25, 1)}));
}
TEST_F(SortIncludesTest, TrailingComments) {
EXPECT_EQ("#include \"a.h\"\n"
"#include \"b.h\" /* long\n"
" * long\n"
" * comment*/\n"
"#include \"c.h\"\n"
"#include \"d.h\"\n",
sort("#include \"a.h\"\n"
"#include \"c.h\"\n"
"#include \"b.h\" /* long\n"
" * long\n"
" * comment*/\n"
"#include \"d.h\"\n"));
}
TEST_F(SortIncludesTest, SortedIncludesUsingSortPriorityAttribute) {
FmtStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Regroup;
FmtStyle.IncludeStyle.IncludeCategories = {