Skip to content

Commit 5fa742e

Browse files
HerrCai0907HerrCai0907
authored
[clang-tidy][NFC] add qutation mark for C++ classes in warning message (llvm#109068)
As discussion in llvm#108555 (comment), split quotation mark change in a new NFC PR. It is more readable to use `'std::array'` than `std::array<>`
1 parent c4744e4 commit 5fa742e

File tree

10 files changed

+52
-52
lines changed

10 files changed

+52
-52
lines changed

‎clang-tools-extra/clang-tidy/modernize/AvoidCArraysCheck.cpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,18 @@ void AvoidCArraysCheck::check(const MatchFinder::MatchResult &Result) {
8080
enum class RecommendType { Array, Vector, Span };
8181
llvm::SmallVector<const char *> RecommendTypes{};
8282
if (IsVLA) {
83-
RecommendTypes.push_back("std::vector<>");
83+
RecommendTypes.push_back("'std::vector'");
8484
} else if (ArrayType->getTypePtr()->isIncompleteArrayType() && IsInParam) {
8585
// in function parameter, we also don't know the size of
8686
// IncompleteArrayType.
8787
if (Result.Context->getLangOpts().CPlusPlus20)
88-
RecommendTypes.push_back("std::span<>");
88+
RecommendTypes.push_back("'std::span'");
8989
else {
90-
RecommendTypes.push_back("std::array<>");
91-
RecommendTypes.push_back("std::vector<>");
90+
RecommendTypes.push_back("'std::array'");
91+
RecommendTypes.push_back("'std::vector'");
9292
}
9393
} else {
94-
RecommendTypes.push_back("std::array<>");
94+
RecommendTypes.push_back("'std::array'");
9595
}
9696
diag(ArrayType->getBeginLoc(),
9797
"do not declare %select{C-style|C VLA}0 arrays, use %1 instead")

‎clang-tools-extra/docs/clang-tidy/checks/modernize/avoid-c-arrays.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,32 @@ modernize-avoid-c-arrays
1010
Finds C-style array types and recommend to use ``std::array<>`` /
1111
``std::vector<>``. All types of C arrays are diagnosed.
1212

13-
For incomplete C-style array types appeared in parameters, It would be better to
13+
For parameters of incomplete C-style array type, it would be better to
1414
use ``std::span`` / ``gsl::span`` as replacement.
1515

1616
However, fix-it are potentially dangerous in header files and are therefore not
1717
emitted right now.
1818

1919
.. code:: c++
2020

21-
int a[] = {1, 2}; // warning: do not declare C-style arrays, use std::array<> instead
21+
int a[] = {1, 2}; // warning: do not declare C-style arrays, use 'std::array' instead
2222

23-
int b[1]; // warning: do not declare C-style arrays, use std::array<> instead
23+
int b[1]; // warning: do not declare C-style arrays, use 'std::array' instead
2424

2525
void foo() {
26-
int c[b[0]]; // warning: do not declare C VLA arrays, use std::vector<> instead
26+
int c[b[0]]; // warning: do not declare C VLA arrays, use 'std::vector' instead
2727
}
2828

2929
template <typename T, int Size>
3030
class array {
31-
T d[Size]; // warning: do not declare C-style arrays, use std::array<> instead
31+
T d[Size]; // warning: do not declare C-style arrays, use 'std::array' instead
3232

33-
int e[1]; // warning: do not declare C-style arrays, use std::array<> instead
33+
int e[1]; // warning: do not declare C-style arrays, use 'std::array' instead
3434
};
3535

36-
array<int[4], 2> d; // warning: do not declare C-style arrays, use std::array<> instead
36+
array<int[4], 2> d; // warning: do not declare C-style arrays, use 'std::array' instead
3737

38-
using k = int[4]; // warning: do not declare C-style arrays, use std::array<> instead
38+
using k = int[4]; // warning: do not declare C-style arrays, use 'std::array' instead
3939

4040

4141
However, the ``extern "C"`` code is ignored, since it is common to share

‎clang-tools-extra/test/clang-tidy/checkers/modernize/avoid-c-arrays-c++20.cpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// RUN: %check_clang_tidy -std=c++20 %s modernize-avoid-c-arrays %t
22

33
int f1(int data[], int size) {
4-
// CHECK-MESSAGES: :[[@LINE-1]]:8: warning: do not declare C-style arrays, use std::span<> instead
4+
// CHECK-MESSAGES: :[[@LINE-1]]:8: warning: do not declare C-style arrays, use 'std::span' instead
55
int f4[] = {1, 2};
6-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
6+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
77
}
88

99
int f2(int data[100]) {
10-
// CHECK-MESSAGES: :[[@LINE-1]]:8: warning: do not declare C-style arrays, use std::array<> instead
10+
// CHECK-MESSAGES: :[[@LINE-1]]:8: warning: do not declare C-style arrays, use 'std::array' instead
1111
}

‎clang-tools-extra/test/clang-tidy/checkers/modernize/avoid-c-arrays-ignores-main.cpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// RUN: %check_clang_tidy -std=c++17 %s modernize-avoid-c-arrays %t
22

33
int not_main(int argc, char *argv[]) {
4-
// CHECK-MESSAGES: :[[@LINE-1]]:24: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead
4+
// CHECK-MESSAGES: :[[@LINE-1]]:24: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead
55
int f4[] = {1, 2};
6-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
6+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
77
}
88

99
int main(int argc, char *argv[]) {
1010
int f5[] = {1, 2};
11-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
11+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
1212

1313
auto not_main = [](int argc, char *argv[]) {
14-
// CHECK-MESSAGES: :[[@LINE-1]]:32: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead
14+
// CHECK-MESSAGES: :[[@LINE-1]]:32: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead
1515
int f6[] = {1, 2};
16-
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: do not declare C-style arrays, use std::array<> instead
16+
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: do not declare C-style arrays, use 'std::array' instead
1717
};
1818
}

‎clang-tools-extra/test/clang-tidy/checkers/modernize/avoid-c-arrays-ignores-strings.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
const char name[] = "name";
55
const char array[] = {'n', 'a', 'm', 'e', '\0'};
6-
// CHECK-MESSAGES: :[[@LINE-1]]:7: warning: do not declare C-style arrays, use std::array<> instead [modernize-avoid-c-arrays]
6+
// CHECK-MESSAGES: :[[@LINE-1]]:7: warning: do not declare C-style arrays, use 'std::array' instead [modernize-avoid-c-arrays]
77

88
void takeCharArray(const char name[]);
9-
// CHECK-MESSAGES: :[[@LINE-1]]:26: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead [modernize-avoid-c-arrays]
9+
// CHECK-MESSAGES: :[[@LINE-1]]:26: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead [modernize-avoid-c-arrays]

‎clang-tools-extra/test/clang-tidy/checkers/modernize/avoid-c-arrays-ignores-three-arg-main.cpp

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
// RUN: %check_clang_tidy -std=c++17 %s modernize-avoid-c-arrays %t
22

33
int not_main(int argc, char *argv[], char *argw[]) {
4-
// CHECK-MESSAGES: :[[@LINE-1]]:24: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead
5-
// CHECK-MESSAGES: :[[@LINE-2]]:38: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead
4+
// CHECK-MESSAGES: :[[@LINE-1]]:24: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead
5+
// CHECK-MESSAGES: :[[@LINE-2]]:38: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead
66
int f4[] = {1, 2};
7-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
7+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
88
}
99

1010
int main(int argc, char *argv[], char *argw[]) {
1111
int f5[] = {1, 2};
12-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
12+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
1313

1414
auto not_main = [](int argc, char *argv[], char *argw[]) {
15-
// CHECK-MESSAGES: :[[@LINE-1]]:32: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead
16-
// CHECK-MESSAGES: :[[@LINE-2]]:46: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead
15+
// CHECK-MESSAGES: :[[@LINE-1]]:32: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead
16+
// CHECK-MESSAGES: :[[@LINE-2]]:46: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead
1717
int f6[] = {1, 2};
18-
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: do not declare C-style arrays, use std::array<> instead
18+
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: do not declare C-style arrays, use 'std::array' instead
1919
};
2020
}

‎clang-tools-extra/test/clang-tidy/checkers/modernize/avoid-c-arrays.cpp

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
// RUN: %check_clang_tidy -std=c++17 %s modernize-avoid-c-arrays %t
22

33
int a[] = {1, 2};
4-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead
4+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead
55

66
int b[1];
7-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead
7+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead
88

99
void foo() {
1010
int c[b[0]];
11-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C VLA arrays, use std::vector<> instead
11+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C VLA arrays, use 'std::vector' instead
1212

1313
using d = decltype(c);
1414
d e;
@@ -20,17 +20,17 @@ void foo() {
2020
template <typename T, int Size>
2121
class array {
2222
T d[Size];
23-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
23+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
2424

2525
int e[1];
26-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
26+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
2727
};
2828

2929
array<int[4], 2> d;
30-
// CHECK-MESSAGES: :[[@LINE-1]]:7: warning: do not declare C-style arrays, use std::array<> instead
30+
// CHECK-MESSAGES: :[[@LINE-1]]:7: warning: do not declare C-style arrays, use 'std::array' instead
3131

3232
using k = int[4];
33-
// CHECK-MESSAGES: :[[@LINE-1]]:11: warning: do not declare C-style arrays, use std::array<> instead
33+
// CHECK-MESSAGES: :[[@LINE-1]]:11: warning: do not declare C-style arrays, use 'std::array' instead
3434

3535
array<k, 2> dk;
3636

@@ -39,14 +39,14 @@ class unique_ptr {
3939
T *d;
4040

4141
int e[1];
42-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
42+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
4343
};
4444

4545
unique_ptr<int[]> d2;
46-
// CHECK-MESSAGES: :[[@LINE-1]]:12: warning: do not declare C-style arrays, use std::array<> instead
46+
// CHECK-MESSAGES: :[[@LINE-1]]:12: warning: do not declare C-style arrays, use 'std::array' instead
4747

4848
using k2 = int[];
49-
// CHECK-MESSAGES: :[[@LINE-1]]:12: warning: do not declare C-style arrays, use std::array<> instead
49+
// CHECK-MESSAGES: :[[@LINE-1]]:12: warning: do not declare C-style arrays, use 'std::array' instead
5050

5151
unique_ptr<k2> dk2;
5252

@@ -65,17 +65,17 @@ inline void bar() {
6565

6666
extern "C++" {
6767
int f3[] = {1, 2};
68-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead
68+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead
6969

7070
int j3[1];
71-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead
71+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead
7272

7373
struct Foo {
7474
int f3[3] = {1, 2};
75-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
75+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
7676

7777
int j3[1];
78-
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use std::array<> instead
78+
// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: do not declare C-style arrays, use 'std::array' instead
7979
};
8080
}
8181

@@ -88,7 +88,7 @@ struct Bar {
8888
}
8989

9090
const char name[] = "Some string";
91-
// CHECK-MESSAGES: :[[@LINE-1]]:7: warning: do not declare C-style arrays, use std::array<> instead [modernize-avoid-c-arrays]
91+
// CHECK-MESSAGES: :[[@LINE-1]]:7: warning: do not declare C-style arrays, use 'std::array' instead [modernize-avoid-c-arrays]
9292

9393
void takeCharArray(const char name[]);
94-
// CHECK-MESSAGES: :[[@LINE-1]]:26: warning: do not declare C-style arrays, use std::array<> or std::vector<> instead [modernize-avoid-c-arrays]
94+
// CHECK-MESSAGES: :[[@LINE-1]]:26: warning: do not declare C-style arrays, use 'std::array' or 'std::vector' instead [modernize-avoid-c-arrays]

‎clang-tools-extra/test/clang-tidy/infrastructure/nolint.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,10 @@ class D5 { D5(int x); }; // NOLINT(google*,-google*)
125125
class D6 { D6(int x); }; // NOLINT(*,-google*)
126126

127127
int array1[10];
128-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead [cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays]
128+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead [cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays]
129129

130130
int array2[10]; // NOLINT(cppcoreguidelines-avoid-c-arrays)
131-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead [modernize-avoid-c-arrays]
131+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead [modernize-avoid-c-arrays]
132132

133133
int array3[10]; // NOLINT(cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays)
134134
int array4[10]; // NOLINT(*-avoid-c-arrays)

‎clang-tools-extra/test/clang-tidy/infrastructure/nolintbeginend.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,11 @@ class C16 { C16(int x); };
133133
// NOLINTEND(*,-google*)
134134

135135
int array1[10];
136-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead [cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays]
136+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead [cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays]
137137

138138
// NOLINTBEGIN(cppcoreguidelines-avoid-c-arrays)
139139
int array2[10];
140-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead [modernize-avoid-c-arrays]
140+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead [modernize-avoid-c-arrays]
141141
// NOLINTEND(cppcoreguidelines-avoid-c-arrays)
142142

143143
// NOLINTBEGIN(cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays)

‎clang-tools-extra/test/clang-tidy/infrastructure/nolintnextline.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ class I5 { I5(int x); };
7070
class I6 { I6(int x); };
7171

7272
int array1[10];
73-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead [cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays]
73+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead [cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays]
7474

7575
// NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays)
7676
int array2[10];
77-
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use std::array<> instead [modernize-avoid-c-arrays]
77+
// CHECK-MESSAGES: :[[@LINE-1]]:1: warning: do not declare C-style arrays, use 'std::array' instead [modernize-avoid-c-arrays]
7878

7979
// NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays)
8080
int array3[10];

0 commit comments

Comments
 (0)