Index: clang-tidy/modernize/CMakeLists.txt =================================================================== --- clang-tidy/modernize/CMakeLists.txt +++ clang-tidy/modernize/CMakeLists.txt @@ -21,6 +21,7 @@ UseEqualsDeleteCheck.cpp UseNullptrCheck.cpp UseOverrideCheck.cpp + UseTransparentFunctorsCheck.cpp UseUsingCheck.cpp LINK_LIBS Index: clang-tidy/modernize/ModernizeTidyModule.cpp =================================================================== --- clang-tidy/modernize/ModernizeTidyModule.cpp +++ clang-tidy/modernize/ModernizeTidyModule.cpp @@ -27,6 +27,7 @@ #include "UseEqualsDeleteCheck.h" #include "UseNullptrCheck.h" #include "UseOverrideCheck.h" +#include "UseTransparentFunctorsCheck.h" #include "UseUsingCheck.h" using namespace clang::ast_matchers; @@ -61,6 +62,8 @@ "modernize-use-equals-delete"); CheckFactories.registerCheck("modernize-use-nullptr"); CheckFactories.registerCheck("modernize-use-override"); + CheckFactories.registerCheck( + "modernize-use-transparent-functors"); CheckFactories.registerCheck("modernize-use-using"); } Index: clang-tidy/modernize/UseTransparentFunctorsCheck.h =================================================================== --- /dev/null +++ clang-tidy/modernize/UseTransparentFunctorsCheck.h @@ -0,0 +1,37 @@ +//===--- UseTransparentFunctorsCheck.h - clang-tidy--------------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_TRANSPARENT_FUNCTORS_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_TRANSPARENT_FUNCTORS_H + +#include "../ClangTidy.h" + +namespace clang { +namespace tidy { +namespace modernize { + +/// Prefer using transparent functors to non-transparent ones. +/// +/// For the user-facing documentation see: +/// http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-transparent-functors.html +class UseTransparentFunctorsCheck : public ClangTidyCheck { +public: + UseTransparentFunctorsCheck(StringRef Name, ClangTidyContext *Context); + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; + void storeOptions(ClangTidyOptions::OptionMap &Opts) override; +private: + const bool SafeMode; +}; + +} // namespace modernize +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_USE_TRANSPARENT_FUNCTORS_H Index: clang-tidy/modernize/UseTransparentFunctorsCheck.cpp =================================================================== --- /dev/null +++ clang-tidy/modernize/UseTransparentFunctorsCheck.cpp @@ -0,0 +1,131 @@ +//===--- UseTransparentFunctorsCheck.cpp - clang-tidy----------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "UseTransparentFunctorsCheck.h" +#include "clang/AST/ASTContext.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace tidy { +namespace modernize { + +UseTransparentFunctorsCheck::UseTransparentFunctorsCheck( + StringRef Name, ClangTidyContext *Context) + : ClangTidyCheck(Name, Context), SafeMode(Options.get("SafeMode", 0)) {} + +void UseTransparentFunctorsCheck::storeOptions( + ClangTidyOptions::OptionMap &Opts) { + Options.store(Opts, "SafeMode", SafeMode ? 1 : 0); +} + +void UseTransparentFunctorsCheck::registerMatchers(MatchFinder *Finder) { + if (!getLangOpts().CPlusPlus14) + return; + + const auto TransparentFunctors = + classTemplateSpecializationDecl( + unless(hasAnyTemplateArgument(refersToType(voidType()))), + hasAnyName("::std::plus", "::std::minus", "::std::multiplies", + "::std::divides", "::std::modulus", "::std::negate", + "::std::equal_to", "::std::not_equal_to", "::std::greater", + "::std::less", "::std::greater_equal", "::std::less_equal", + "::std::logical_and", "::std::logical_or", + "::std::logical_not", "::std::bit_and", "::std::bit_or", + "::std::bit_xor", "::std::bit_not")) + .bind("FunctorClass"); + + // Non-transparent functor mentioned as a template parameter. FIXIT. + Finder->addMatcher( + loc(qualType( + unless(elaboratedType()), + hasDeclaration(classTemplateSpecializationDecl( + unless(hasAnyTemplateArgument(templateArgument(refersToType( + qualType(pointsTo(qualType(isAnyCharacter()))))))), + hasAnyTemplateArgument( + templateArgument(refersToType(qualType(hasDeclaration( + TransparentFunctors)))) + .bind("Functor")))))) + .bind("FunctorParentLoc"), + this); + + if (SafeMode) + return; + + // Non-transparent functor constructed. No FIXIT. There is no easy way + // to rule out the problematic char* vs string case. + Finder->addMatcher(cxxConstructExpr(hasDeclaration(cxxMethodDecl( + ofClass(TransparentFunctors))), + unless(isInTemplateInstantiation())) + .bind("FuncInst"), + this); +} + +static const StringRef Message = "prefer transparent functors '%0'"; + +template static T getInnerTypeLocAs(TypeLoc Loc) { + T Result; + while (Result.isNull() && !Loc.isNull()) { + Result = Loc.getAs(); + Loc = Loc.getNextTypeLoc(); + } + return Result; +} + +void UseTransparentFunctorsCheck::check( + const MatchFinder::MatchResult &Result) { + const auto *FuncClass = + Result.Nodes.getNodeAs("FunctorClass"); + if (const auto *FuncInst = + Result.Nodes.getNodeAs("FuncInst")) { + diag(FuncInst->getLocStart(), Message) + << (FuncClass->getName() + "<>").str(); + return; + } + + const auto *Functor = Result.Nodes.getNodeAs("Functor"); + const auto FunctorParentLoc = + Result.Nodes.getNodeAs("FunctorParentLoc") + ->getAs(); + + if (!FunctorParentLoc) + return; + + unsigned ArgNum = 0; + const auto *FunctorParentType = + FunctorParentLoc.getType()->castAs(); + for (; ArgNum < FunctorParentType->getNumArgs(); ++ArgNum) { + const TemplateArgument &Arg = FunctorParentType->getArg(ArgNum); + if (Arg.getKind() != TemplateArgument::Type) + continue; + QualType ParentArgType = Arg.getAsType(); + if (ParentArgType->isRecordType() && + ParentArgType->getAsCXXRecordDecl() == + Functor->getAsType()->getAsCXXRecordDecl()) + break; + } + // Functor is a default template argument. + if (ArgNum == FunctorParentType->getNumArgs()) + return; + TemplateArgumentLoc FunctorLoc = FunctorParentLoc.getArgLoc(ArgNum); + auto FunctorTypeLoc = getInnerTypeLocAs( + FunctorLoc.getTypeSourceInfo()->getTypeLoc()); + if (FunctorTypeLoc.isNull()) + return; + + SourceLocation ReportLoc = FunctorLoc.getLocation(); + diag(ReportLoc, Message) << (FuncClass->getName() + "<>").str() + << FixItHint::CreateRemoval( + FunctorTypeLoc.getArgLoc(0).getSourceRange()); +} + +} // namespace modernize +} // namespace tidy +} // namespace clang Index: docs/ReleaseNotes.rst =================================================================== --- docs/ReleaseNotes.rst +++ docs/ReleaseNotes.rst @@ -96,6 +96,11 @@ Adds ``= delete`` to unimplemented private special member functions. +- New `modernize-use-transparent-functors + `_ check + + Replaces uses of non-transparent functors with transparent ones where applicable. + - New `mpi-buffer-deref `_ check Index: docs/clang-tidy/checks/list.rst =================================================================== --- docs/clang-tidy/checks/list.rst +++ docs/clang-tidy/checks/list.rst @@ -114,6 +114,7 @@ modernize-use-equals-delete modernize-use-nullptr modernize-use-override + modernize-use-transparent-functors modernize-use-using mpi-buffer-deref mpi-type-mismatch Index: docs/clang-tidy/checks/modernize-use-transparent-functors.rst =================================================================== --- /dev/null +++ docs/clang-tidy/checks/modernize-use-transparent-functors.rst @@ -0,0 +1,39 @@ +.. title:: clang-tidy - modernize-use-transparent-functors + +modernize-use-transparent-functors +================================== + +Prefer transparent functors to non-transparent ones. When using transparent +functors, the type does not need to be repeated. The code is easier to read, +maintain and less prone to errors. It not possible to introduce unwanted +conversions. + + .. code-block:: c++ + + // Non-transparent functor + std::map> s; + + // Transparent functor. + std::map> s; + + // Non-transparent functor + using MyFunctor = std::less; + +It is not always a safe transformation though. The following case will be +untouched to preserve the semantics. + + .. code-block:: c++ + + // Non-transparent functor + std::map> s; + +Options +------- + +.. option:: SafeMode + + If the option is set to non-zero (default is `0`), the check will not + warn on these cases as shown above, where automatic FIXIT is not safe to + apply. + +This check requires using C++14 or higher to run. Index: test/clang-tidy/modernize-use-transparent-functors.cpp =================================================================== --- /dev/null +++ test/clang-tidy/modernize-use-transparent-functors.cpp @@ -0,0 +1,107 @@ +// RUN: %check_clang_tidy %s modernize-use-transparent-functors %t -- -- -std=c++14 + +namespace std { +template +struct remove_reference; + +template +constexpr T &&forward(typename std::remove_reference::type &t); + +template +constexpr T &&forward(typename std::remove_reference::type &&t); + +template +struct plus { + constexpr T operator()(const T &Lhs, const T &Rhs) const; +}; + +template <> +struct plus { + template + constexpr auto operator()(T &&Lhs, U &&Rhs) const -> + decltype(forward(Lhs) + forward(Rhs)); +}; + +template +struct less { + constexpr bool operator()(const T &Lhs, const T &Rhs) const; +}; + +template <> +struct less { + template + constexpr bool operator()(T &&Lhs, U &&Rhs) const; +}; + +template +struct logical_not { + constexpr bool operator()(const T &Arg) const; +}; + +template <> +struct logical_not { + template + constexpr bool operator()(T &&Arg) const; +}; + +template +class allocator; + +template < + class Key, + class Compare = std::less<>, + class Allocator = std::allocator> +class set {}; + +template < + class Key, + class Compare = std::less, + class Allocator = std::allocator> +class set2 {}; + +template +InputIt find_if(InputIt first, InputIt last, + UnaryPredicate p); + +template +void sort(RandomIt first, RandomIt last, Compare comp); + +class iterator {}; +class string {}; +} + +int main() { + using std::set; + using std::less; + std::set> s; + // CHECK-MESSAGES: :[[@LINE-1]]:17: warning: prefer transparent functors 'less<>' [modernize-use-transparent-functors] + // CHECK-FIXES: {{^}} std::set> s;{{$}} + set> s2; + // CHECK-MESSAGES: :[[@LINE-1]]:12: warning: prefer transparent functors + // CHECK-FIXES: {{^}} set> s2;{{$}} + set> s3; + // CHECK-MESSAGES: :[[@LINE-1]]:12: warning: prefer transparent functors + // CHECK-FIXES: {{^}} set> s3;{{$}} + std::set> s4; + std::set> s5; + std::set>, std::less<>> s6; + // CHECK-MESSAGES: :[[@LINE-1]]:21: warning: prefer transparent functors + // CHECK-FIXES: {{^}} std::set>, std::less<>> s6;{{$}} + std::iterator begin, end; + sort(begin, end, std::less()); + // CHECK-MESSAGES: :[[@LINE-1]]:20: warning: prefer transparent functors + std::sort(begin, end, std::less<>()); + find_if(begin, end, std::logical_not()); + // CHECK-MESSAGES: :[[@LINE-1]]:23: warning: prefer transparent functors + std::find_if(begin, end, std::logical_not<>()); + using my_set = std::set>; + // CHECK-MESSAGES: :[[@LINE-1]]:32: warning: prefer transparent functors + // CHECK-FIXES: {{^}} using my_set = std::set>;{{$}} + using my_set2 = std::set>; + using my_less = std::less; + find_if(begin, end, my_less()); + // CHECK-MESSAGES: :[[@LINE-1]]:23: warning: prefer transparent functors + std::set2 control; +} + +