Skip to content

Commit ecde610

Browse files
njames93njames93
committed
Add a modernize-use-ranges check
1 parent f190343 commit ecde610

File tree

11 files changed

+923
-0
lines changed

11 files changed

+923
-0
lines changed

‎clang-tools-extra/clang-tidy/modernize/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ add_clang_library(clangTidyModernizeModule
4040
UseNoexceptCheck.cpp
4141
UseNullptrCheck.cpp
4242
UseOverrideCheck.cpp
43+
UseRangesCheck.cpp
4344
UseStartsEndsWithCheck.cpp
4445
UseStdFormatCheck.cpp
4546
UseStdNumbersCheck.cpp

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
#include "UseNoexceptCheck.h"
4242
#include "UseNullptrCheck.h"
4343
#include "UseOverrideCheck.h"
44+
#include "UseRangesCheck.h"
4445
#include "UseStartsEndsWithCheck.h"
4546
#include "UseStdFormatCheck.h"
4647
#include "UseStdNumbersCheck.h"
@@ -75,6 +76,7 @@ class ModernizeModule : public ClangTidyModule {
7576
CheckFactories.registerCheck<PassByValueCheck>("modernize-pass-by-value");
7677
CheckFactories.registerCheck<UseDesignatedInitializersCheck>(
7778
"modernize-use-designated-initializers");
79+
CheckFactories.registerCheck<UseRangesCheck>("modernize-use-ranges");
7880
CheckFactories.registerCheck<UseStartsEndsWithCheck>(
7981
"modernize-use-starts-ends-with");
8082
CheckFactories.registerCheck<UseStdFormatCheck>("modernize-use-std-format");

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

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
//===--- UseRangesCheck.cpp - clang-tidy ----------------------------------===//
2+
//
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
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#include "UseRangesCheck.h"
10+
#include "clang/AST/Decl.h"
11+
#include "llvm/ADT/ArrayRef.h"
12+
#include "llvm/ADT/IntrusiveRefCntPtr.h"
13+
#include "llvm/ADT/SmallVector.h"
14+
#include "llvm/ADT/StringRef.h"
15+
#include <initializer_list>
16+
17+
// FixItHint - Let the docs script know that this class does provide fixits
18+
19+
namespace clang::tidy::modernize {
20+
21+
static constexpr const char *SingleRangeNames[] = {
22+
"all_of",
23+
"any_of",
24+
"none_of",
25+
"for_each",
26+
"find",
27+
"find_if",
28+
"find_if_not",
29+
"adjacent_find",
30+
"copy",
31+
"copy_if",
32+
"copy_backward",
33+
"move",
34+
"move_backward",
35+
"fill",
36+
"transform",
37+
"replace",
38+
"replace_if",
39+
"generate",
40+
"remove",
41+
"remove_if",
42+
"remove_copy",
43+
"remove_copy_if",
44+
"unique",
45+
"unique_copy",
46+
"sample",
47+
"partition_point",
48+
"lower_bound",
49+
"upper_bound",
50+
"equal_range",
51+
"binary_search",
52+
"push_heap",
53+
"pop_heap",
54+
"make_heap",
55+
"sort_heap",
56+
"next_permutation",
57+
"prev_permutation",
58+
"reverse",
59+
"reverse_copy",
60+
"shift_left",
61+
"shift_right",
62+
"is_partitioned",
63+
"partition",
64+
"partition_copy",
65+
"stable_partition",
66+
"sort",
67+
"stable_sort",
68+
"is_sorted",
69+
"is_sorted_until",
70+
"is_heap",
71+
"is_heap_until",
72+
"max_element",
73+
"min_element",
74+
"minmax_element",
75+
"uninitialized_copy",
76+
"uninitialized_fill",
77+
"uninitialized_move",
78+
"uninitialized_default_construct",
79+
"uninitialized_value_construct",
80+
"destroy",
81+
};
82+
83+
static constexpr const char *TwoRangeNames[] = {
84+
"equal",
85+
"mismatch",
86+
"partial_sort_copy",
87+
"includes",
88+
"set_union",
89+
"set_intersection",
90+
"set_difference",
91+
"set_symmetric_difference",
92+
"merge",
93+
"lexicographical_compare",
94+
"find_end",
95+
"search",
96+
"is_permutation",
97+
};
98+
99+
namespace {
100+
class StdReplacer : public utils::UseRangesCheck::Replacer {
101+
public:
102+
explicit StdReplacer(SmallVector<UseRangesCheck::Signature> Signatures)
103+
: Signatures(std::move(Signatures)) {}
104+
std::optional<std::string>
105+
getReplaceName(const NamedDecl &OriginalName) const override {
106+
return ("std::ranges::" + OriginalName.getName()).str();
107+
}
108+
ArrayRef<UseRangesCheck::Signature>
109+
getReplacementSignatures() const override {
110+
return Signatures;
111+
}
112+
113+
private:
114+
SmallVector<UseRangesCheck::Signature> Signatures;
115+
};
116+
117+
class StdAlgorithmReplacer : public StdReplacer {
118+
using StdReplacer::StdReplacer;
119+
std::optional<std::string>
120+
getHeaderInclusion(const NamedDecl & /*OriginalName*/) const override {
121+
return "<algorithm>";
122+
}
123+
};
124+
125+
class StdNumericReplacer : public StdReplacer {
126+
using StdReplacer::StdReplacer;
127+
std::optional<std::string>
128+
getHeaderInclusion(const NamedDecl & /*OriginalName*/) const override {
129+
return "<numeric>";
130+
}
131+
};
132+
} // namespace
133+
134+
utils::UseRangesCheck::ReplacerMap UseRangesCheck::getReplacerMap() const {
135+
136+
utils::UseRangesCheck::ReplacerMap Result;
137+
138+
// template<typename Iter> Func(Iter first, Iter last,...).
139+
static const Signature SingleRangeArgs = {{0}};
140+
// template<typename Iter1, typename Iter2>
141+
// Func(Iter1 first1, Iter1 last1, Iter2 first2, Iter2 last2,...).
142+
static const Signature TwoRangeArgs = {{0}, {2}};
143+
144+
static const Signature SingleRangeFunc[] = {SingleRangeArgs};
145+
146+
static const Signature TwoRangeFunc[] = {TwoRangeArgs};
147+
148+
static const std::pair<ArrayRef<Signature>, ArrayRef<const char *>>
149+
AlgorithmNames[] = {{SingleRangeFunc, SingleRangeNames},
150+
{TwoRangeFunc, TwoRangeNames}};
151+
SmallString<64> Buff;
152+
for (const auto &[Signatures, Values] : AlgorithmNames) {
153+
auto Replacer = llvm::makeIntrusiveRefCnt<StdAlgorithmReplacer>(
154+
SmallVector<UseRangesCheck::Signature>{Signatures});
155+
for (const auto &Name : Values) {
156+
Buff.assign({"::std::", Name});
157+
Result.try_emplace(Buff, Replacer);
158+
}
159+
}
160+
if (getLangOpts().CPlusPlus23)
161+
Result.try_emplace(
162+
"::std::iota",
163+
llvm::makeIntrusiveRefCnt<StdNumericReplacer>(
164+
SmallVector<UseRangesCheck::Signature>{std::begin(SingleRangeFunc),
165+
std::end(SingleRangeFunc)}));
166+
return Result;
167+
}
168+
169+
bool UseRangesCheck::isLanguageVersionSupported(
170+
const LangOptions &LangOpts) const {
171+
return LangOpts.CPlusPlus20;
172+
}
173+
ArrayRef<std::pair<StringRef, StringRef>>
174+
UseRangesCheck::getFreeBeginEndMethods() const {
175+
static const std::pair<StringRef, StringRef> Refs[] = {
176+
{"::std::begin", "::std::end"}, {"::std::cbegin", "::std::cend"}};
177+
return Refs;
178+
}
179+
std::optional<UseRangesCheck::ReverseIteratorDescriptor>
180+
UseRangesCheck::getReverseDescriptor() const {
181+
static const std::pair<StringRef, StringRef> Refs[] = {
182+
{"::std::rbegin", "::std::rend"}, {"::std::crbegin", "::std::crend"}};
183+
return ReverseIteratorDescriptor{"std::views::reverse", "<ranges>", Refs};
184+
}
185+
} // namespace clang::tidy::modernize

‎clang-tools-extra/clang-tidy/modernize/UseRangesCheck.h

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
//===--- UseRangesCheck.h - clang-tidy --------------------------*- C++ -*-===//
2+
//
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
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USERANGESCHECK_H
10+
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USERANGESCHECK_H
11+
12+
#include "../utils/UseRangesCheck.h"
13+
14+
namespace clang::tidy::modernize {
15+
16+
/// Detects calls to standard library iterator algorithms that could be
17+
/// replaced with a ranges version instead
18+
///
19+
/// For the user-facing documentation see:
20+
/// http://clang.llvm.org/extra/clang-tidy/checks/modernize/use-ranges.html
21+
class UseRangesCheck : public utils::UseRangesCheck {
22+
public:
23+
using utils::UseRangesCheck::UseRangesCheck;
24+
25+
ReplacerMap getReplacerMap() const override;
26+
27+
ArrayRef<std::pair<StringRef, StringRef>>
28+
getFreeBeginEndMethods() const override;
29+
30+
std::optional<ReverseIteratorDescriptor>
31+
getReverseDescriptor() const override;
32+
33+
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
34+
35+
};
36+
37+
} // namespace clang::tidy::modernize
38+
39+
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USERANGESCHECK_H

‎clang-tools-extra/clang-tidy/utils/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ add_clang_library(clangTidyUtils
2525
RenamerClangTidyCheck.cpp
2626
TransformerClangTidyCheck.cpp
2727
TypeTraits.cpp
28+
UseRangesCheck.cpp
2829
UsingInserter.cpp
2930

3031
LINK_LIBS

0 commit comments

Comments
 (0)