-
Notifications
You must be signed in to change notification settings - Fork 13.7k
[clang-tidy] add check to suggest replacement of nested std::min or std::max with initializer lists #85572
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
PiotrZSL
merged 17 commits into
llvm:main
from
sopyb:modernize-min-max-use-initializer-list
Apr 25, 2024
Merged
[clang-tidy] add check to suggest replacement of nested std::min or std::max with initializer lists #85572
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
17d6ad6
[clang-tidy] add check to suggest replacement of nested std::min or s…
sopyb 1bed756
Summary: Refactor min-max-use-initializer-list.cpp and add tests
sopyb f2e8474
Squash: Apply Clang format fixes and ensure InnerCall uses std::min o…
sopyb bbdf160
Addressing code smell issues and consider nested calls with initializ…
sopyb 4027379
Refactor generateReplacement to return FixItHints to avoid check conf…
sopyb 1bd6550
Update documentation
sopyb 61ceb14
consistency changes
sopyb d506f63
Remove braces from if statement
sopyb 6abf8a2
Adding comments and code cleanup
sopyb 3df9873
Change ArgText to type StringRef
sopyb 2126e62
Check if Nested call has no arguments
sopyb 65079e0
Addressing issues raised in review
sopyb 079f1d9
Addressing 5chmidti final suggestions.
sopyb 892f5db
Add performance options to modernize check
sopyb 98d252e
Addressing the part of Piotr's review
sopyb cdc6591
Fix sanitizer issue
sopyb 57de5cf
Clang-tidy & indenting
sopyb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
271 changes: 271 additions & 0 deletions
271
clang-tools-extra/clang-tidy/modernize/MinMaxUseInitializerListCheck.cpp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,271 @@ | ||
//===--- MinMaxUseInitializerListCheck.cpp - clang-tidy -------------------===// | ||
// | ||
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||
// See https://llvm.org/LICENSE.txt for license information. | ||
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#include "MinMaxUseInitializerListCheck.h" | ||
#include "../utils/ASTUtils.h" | ||
#include "../utils/LexerUtils.h" | ||
#include "clang/ASTMatchers/ASTMatchFinder.h" | ||
#include "clang/Frontend/CompilerInstance.h" | ||
#include "clang/Lex/Lexer.h" | ||
|
||
using namespace clang; | ||
|
||
namespace { | ||
|
||
struct FindArgsResult { | ||
const Expr *First; | ||
const Expr *Last; | ||
const Expr *Compare; | ||
SmallVector<const clang::Expr *, 2> Args; | ||
}; | ||
|
||
} // anonymous namespace | ||
|
||
using namespace clang::ast_matchers; | ||
|
||
namespace clang::tidy::modernize { | ||
|
||
static FindArgsResult findArgs(const CallExpr *Call) { | ||
FindArgsResult Result; | ||
Result.First = nullptr; | ||
Result.Last = nullptr; | ||
Result.Compare = nullptr; | ||
|
||
sopyb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// check if the function has initializer list argument | ||
if (Call->getNumArgs() < 3) { | ||
auto ArgIterator = Call->arguments().begin(); | ||
|
||
const auto *InitListExpr = | ||
dyn_cast<CXXStdInitializerListExpr>(*ArgIterator); | ||
const auto *InitList = | ||
InitListExpr != nullptr | ||
? dyn_cast<clang::InitListExpr>( | ||
InitListExpr->getSubExpr()->IgnoreImplicit()) | ||
: nullptr; | ||
|
||
if (InitList) { | ||
Result.Args.append(InitList->inits().begin(), InitList->inits().end()); | ||
Result.First = *ArgIterator; | ||
Result.Last = *ArgIterator; | ||
|
||
// check if there is a comparison argument | ||
std::advance(ArgIterator, 1); | ||
if (ArgIterator != Call->arguments().end()) | ||
Result.Compare = *ArgIterator; | ||
|
||
return Result; | ||
} | ||
Result.Args = SmallVector<const Expr *>(Call->arguments()); | ||
} else { | ||
// if it has 3 arguments then the last will be the comparison | ||
Result.Compare = *(std::next(Call->arguments().begin(), 2)); | ||
Result.Args = SmallVector<const Expr *>(llvm::drop_end(Call->arguments())); | ||
} | ||
Result.First = Result.Args.front(); | ||
Result.Last = Result.Args.back(); | ||
|
||
return Result; | ||
} | ||
|
||
static SmallVector<FixItHint> | ||
generateReplacements(const MatchFinder::MatchResult &Match, | ||
const CallExpr *TopCall, const FindArgsResult &Result, | ||
const bool IgnoreNonTrivialTypes, | ||
const std::uint64_t IgnoreTrivialTypesOfSizeAbove) { | ||
SmallVector<FixItHint> FixItHints; | ||
const SourceManager &SourceMngr = *Match.SourceManager; | ||
const LangOptions &LanguageOpts = Match.Context->getLangOpts(); | ||
|
||
const QualType ResultType = TopCall->getDirectCallee() | ||
->getReturnType() | ||
.getCanonicalType() | ||
.getNonReferenceType() | ||
.getUnqualifiedType(); | ||
|
||
// check if the type is trivial | ||
const bool IsResultTypeTrivial = ResultType.isTrivialType(*Match.Context); | ||
|
||
if ((!IsResultTypeTrivial && IgnoreNonTrivialTypes)) | ||
return FixItHints; | ||
|
||
if (IsResultTypeTrivial && | ||
static_cast<std::uint64_t>( | ||
Match.Context->getTypeSizeInChars(ResultType).getQuantity()) > | ||
IgnoreTrivialTypesOfSizeAbove) | ||
return FixItHints; | ||
|
||
for (const Expr *Arg : Result.Args) { | ||
const auto *InnerCall = dyn_cast<CallExpr>(Arg->IgnoreParenImpCasts()); | ||
|
||
// If the argument is not a nested call | ||
if (!InnerCall) { | ||
// check if typecast is required | ||
const QualType ArgType = Arg->IgnoreParenImpCasts() | ||
->getType() | ||
.getCanonicalType() | ||
.getUnqualifiedType(); | ||
|
||
if (ArgType == ResultType) | ||
continue; | ||
|
||
const StringRef ArgText = Lexer::getSourceText( | ||
CharSourceRange::getTokenRange(Arg->getSourceRange()), SourceMngr, | ||
LanguageOpts); | ||
|
||
const auto Replacement = Twine("static_cast<") | ||
.concat(ResultType.getAsString(LanguageOpts)) | ||
.concat(">(") | ||
.concat(ArgText) | ||
.concat(")") | ||
.str(); | ||
|
||
FixItHints.push_back( | ||
FixItHint::CreateReplacement(Arg->getSourceRange(), Replacement)); | ||
continue; | ||
} | ||
|
||
const FindArgsResult InnerResult = findArgs(InnerCall); | ||
|
||
// if the nested call doesn't have arguments skip it | ||
if (!InnerResult.First || !InnerResult.Last) | ||
continue; | ||
|
||
// if the nested call is not the same as the top call | ||
if (InnerCall->getDirectCallee()->getQualifiedNameAsString() != | ||
TopCall->getDirectCallee()->getQualifiedNameAsString()) | ||
continue; | ||
|
||
// if the nested call doesn't have the same compare function | ||
if ((Result.Compare || InnerResult.Compare) && | ||
!utils::areStatementsIdentical(Result.Compare, InnerResult.Compare, | ||
*Match.Context)) | ||
continue; | ||
|
||
// remove the function call | ||
FixItHints.push_back( | ||
FixItHint::CreateRemoval(InnerCall->getCallee()->getSourceRange())); | ||
|
||
// remove the parentheses | ||
const auto LParen = utils::lexer::findNextTokenSkippingComments( | ||
InnerCall->getCallee()->getEndLoc(), SourceMngr, LanguageOpts); | ||
if (LParen.has_value() && LParen->is(tok::l_paren)) | ||
FixItHints.push_back( | ||
FixItHint::CreateRemoval(SourceRange(LParen->getLocation()))); | ||
FixItHints.push_back( | ||
FixItHint::CreateRemoval(SourceRange(InnerCall->getRParenLoc()))); | ||
|
||
// if the inner call has an initializer list arg | ||
if (InnerResult.First == InnerResult.Last) { | ||
// remove the initializer list braces | ||
FixItHints.push_back(FixItHint::CreateRemoval( | ||
CharSourceRange::getTokenRange(InnerResult.First->getBeginLoc()))); | ||
FixItHints.push_back(FixItHint::CreateRemoval( | ||
CharSourceRange::getTokenRange(InnerResult.First->getEndLoc()))); | ||
} | ||
|
||
const SmallVector<FixItHint> InnerReplacements = generateReplacements( | ||
Match, InnerCall, InnerResult, IgnoreNonTrivialTypes, | ||
IgnoreTrivialTypesOfSizeAbove); | ||
|
||
FixItHints.append(InnerReplacements); | ||
|
||
if (InnerResult.Compare) { | ||
// find the comma after the value arguments | ||
const auto Comma = utils::lexer::findNextTokenSkippingComments( | ||
InnerResult.Last->getEndLoc(), SourceMngr, LanguageOpts); | ||
|
||
// remove the comma and the comparison | ||
if (Comma.has_value() && Comma->is(tok::comma)) | ||
FixItHints.push_back( | ||
FixItHint::CreateRemoval(SourceRange(Comma->getLocation()))); | ||
|
||
FixItHints.push_back( | ||
FixItHint::CreateRemoval(InnerResult.Compare->getSourceRange())); | ||
} | ||
} | ||
|
||
return FixItHints; | ||
} | ||
|
||
MinMaxUseInitializerListCheck::MinMaxUseInitializerListCheck( | ||
StringRef Name, ClangTidyContext *Context) | ||
: ClangTidyCheck(Name, Context), | ||
IgnoreNonTrivialTypes(Options.get("IgnoreNonTrivialTypes", true)), | ||
IgnoreTrivialTypesOfSizeAbove( | ||
Options.get("IgnoreTrivialTypesOfSizeAbove", 32L)), | ||
Inserter(Options.getLocalOrGlobal("IncludeStyle", | ||
utils::IncludeSorter::IS_LLVM), | ||
areDiagsSelfContained()) {} | ||
PiotrZSL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
void MinMaxUseInitializerListCheck::storeOptions( | ||
ClangTidyOptions::OptionMap &Opts) { | ||
Options.store(Opts, "IgnoreNonTrivialTypes", IgnoreNonTrivialTypes); | ||
Options.store(Opts, "IgnoreTrivialTypesOfSizeAbove", | ||
IgnoreTrivialTypesOfSizeAbove); | ||
Options.store(Opts, "IncludeStyle", Inserter.getStyle()); | ||
} | ||
|
||
void MinMaxUseInitializerListCheck::registerMatchers(MatchFinder *Finder) { | ||
auto CreateMatcher = [](const StringRef FunctionName) { | ||
auto FuncDecl = functionDecl(hasName(FunctionName)); | ||
auto Expression = callExpr(callee(FuncDecl)); | ||
|
||
return callExpr(callee(FuncDecl), | ||
anyOf(hasArgument(0, Expression), | ||
hasArgument(1, Expression), | ||
hasArgument(0, cxxStdInitializerListExpr())), | ||
unless(hasParent(Expression))) | ||
.bind("topCall"); | ||
}; | ||
|
||
Finder->addMatcher(CreateMatcher("::std::max"), this); | ||
Finder->addMatcher(CreateMatcher("::std::min"), this); | ||
} | ||
|
||
void MinMaxUseInitializerListCheck::registerPPCallbacks( | ||
const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) { | ||
Inserter.registerPreprocessor(PP); | ||
} | ||
|
||
void MinMaxUseInitializerListCheck::check( | ||
const MatchFinder::MatchResult &Match) { | ||
|
||
const auto *TopCall = Match.Nodes.getNodeAs<CallExpr>("topCall"); | ||
|
||
const FindArgsResult Result = findArgs(TopCall); | ||
const SmallVector<FixItHint> Replacements = | ||
generateReplacements(Match, TopCall, Result, IgnoreNonTrivialTypes, | ||
IgnoreTrivialTypesOfSizeAbove); | ||
|
||
if (Replacements.empty()) | ||
return; | ||
|
||
const DiagnosticBuilder Diagnostic = | ||
diag(TopCall->getBeginLoc(), | ||
"do not use nested 'std::%0' calls, use an initializer list instead") | ||
<< TopCall->getDirectCallee()->getName() | ||
<< Inserter.createIncludeInsertion( | ||
Match.SourceManager->getFileID(TopCall->getBeginLoc()), | ||
"<algorithm>"); | ||
|
||
// if the top call doesn't have an initializer list argument | ||
if (Result.First != Result.Last) { | ||
// add { and } insertions | ||
Diagnostic << FixItHint::CreateInsertion(Result.First->getBeginLoc(), "{"); | ||
|
||
Diagnostic << FixItHint::CreateInsertion( | ||
Lexer::getLocForEndOfToken(Result.Last->getEndLoc(), 0, | ||
*Match.SourceManager, | ||
Match.Context->getLangOpts()), | ||
"}"); | ||
} | ||
|
||
Diagnostic << Replacements; | ||
} | ||
|
||
} // namespace clang::tidy::modernize |
56 changes: 56 additions & 0 deletions
56
clang-tools-extra/clang-tidy/modernize/MinMaxUseInitializerListCheck.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
//===--- MinMaxUseInitializerListCheck.h - clang-tidy -----------*- C++ -*-===// | ||
// | ||
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||
// See https://llvm.org/LICENSE.txt for license information. | ||
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_MINMAXUSEINITIALIZERLISTCHECK_H | ||
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_MINMAXUSEINITIALIZERLISTCHECK_H | ||
|
||
#include "../ClangTidyCheck.h" | ||
#include "../utils/IncludeInserter.h" | ||
|
||
namespace clang::tidy::modernize { | ||
|
||
/// Replaces nested ``std::min`` and ``std::max`` calls with an initializer list | ||
/// where applicable. | ||
/// | ||
/// For example: | ||
/// | ||
/// \code | ||
/// int a = std::max(std::max(i, j), k); | ||
/// \endcode | ||
/// | ||
/// This code is transformed to: | ||
/// | ||
/// \code | ||
/// int a = std::max({i, j, k}); | ||
/// \endcode | ||
class MinMaxUseInitializerListCheck : public ClangTidyCheck { | ||
public: | ||
MinMaxUseInitializerListCheck(StringRef Name, ClangTidyContext *Context); | ||
|
||
void storeOptions(ClangTidyOptions::OptionMap &Opts) override; | ||
void registerMatchers(ast_matchers::MatchFinder *Finder) override; | ||
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, | ||
Preprocessor *ModuleExpanderPP) override; | ||
void check(const ast_matchers::MatchFinder::MatchResult &Match) override; | ||
|
||
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override { | ||
return LangOpts.CPlusPlus11; | ||
} | ||
std::optional<TraversalKind> getCheckTraversalKind() const override { | ||
return TK_IgnoreUnlessSpelledInSource; | ||
} | ||
|
||
sopyb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
private: | ||
bool IgnoreNonTrivialTypes; | ||
std::uint64_t IgnoreTrivialTypesOfSizeAbove; | ||
utils::IncludeInserter Inserter; | ||
}; | ||
|
||
} // namespace clang::tidy::modernize | ||
|
||
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_MINMAXUSEINITIALIZERLISTCHECK_H |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.