12 #include "clang/AST/ASTContext.h"
13 #include "clang/ASTMatchers/ASTMatchFinder.h"
14 #include "llvm/ADT/DenseMapInfo.h"
15 #include "llvm/ADT/StringExtras.h"
17 #define DEBUG_TYPE "clang-tidy"
19 using namespace clang::ast_matchers;
23 namespace cppcoreguidelines {
25 void SpecialMemberFunctionsCheck::registerMatchers(MatchFinder *
Finder) {
26 if (!getLangOpts().CPlusPlus)
31 has(cxxDestructorDecl(unless(isImplicit())).bind(
"dtor")),
32 has(cxxConstructorDecl(isCopyConstructor(), unless(isImplicit()))
34 has(cxxMethodDecl(isCopyAssignmentOperator(),
36 .bind(
"copy-assign")),
37 has(cxxConstructorDecl(isMoveConstructor(), unless(isImplicit()))
39 has(cxxMethodDecl(isMoveAssignmentOperator(),
41 .bind(
"move-assign"))))
46 static llvm::StringRef
49 case SpecialMemberFunctionsCheck::SpecialMemberFunctionKind::Destructor:
50 return "a destructor";
51 case SpecialMemberFunctionsCheck::SpecialMemberFunctionKind::CopyConstructor:
52 return "a copy constructor";
53 case SpecialMemberFunctionsCheck::SpecialMemberFunctionKind::CopyAssignment:
54 return "a copy assignment operator";
55 case SpecialMemberFunctionsCheck::SpecialMemberFunctionKind::MoveConstructor:
56 return "a move constructor";
57 case SpecialMemberFunctionsCheck::SpecialMemberFunctionKind::MoveAssignment:
58 return "a move assignment operator";
60 llvm_unreachable(
"Unhandled SpecialMemberFunctionKind");
64 join(ArrayRef<SpecialMemberFunctionsCheck::SpecialMemberFunctionKind> SMFS,
65 llvm::StringRef AndOr) {
67 assert(!SMFS.empty() &&
68 "List of defined or undefined members should never be empty.");
70 llvm::raw_string_ostream Stream(Buffer);
73 size_t LastIndex = SMFS.size() - 1;
74 for (
size_t i = 1; i < LastIndex; ++i) {
78 Stream << AndOr <<
toString(SMFS[LastIndex]);
83 void SpecialMemberFunctionsCheck::check(
84 const MatchFinder::MatchResult &
Result) {
85 const auto *MatchedDecl = Result.Nodes.getNodeAs<CXXRecordDecl>(
"class-def");
89 ClassDefId ID(MatchedDecl->getLocation(), MatchedDecl->getName());
91 std::initializer_list<std::pair<std::string, SpecialMemberFunctionKind>>
92 Matchers = {{
"dtor", SpecialMemberFunctionKind::Destructor},
93 {
"copy-ctor", SpecialMemberFunctionKind::CopyConstructor},
94 {
"copy-assign", SpecialMemberFunctionKind::CopyAssignment},
95 {
"move-ctor", SpecialMemberFunctionKind::MoveConstructor},
96 {
"move-assign", SpecialMemberFunctionKind::MoveAssignment}};
98 for (
const auto &KV : Matchers)
99 if (Result.Nodes.getNodeAs<CXXMethodDecl>(KV.first)) {
101 llvm::SmallVectorImpl<SpecialMemberFunctionKind> &Members =
102 ClassWithSpecialMembers[ID];
103 if (find(Members, Kind) == Members.end())
104 Members.push_back(Kind);
108 void SpecialMemberFunctionsCheck::onEndOfTranslationUnit() {
109 llvm::SmallVector<SpecialMemberFunctionKind, 5> AllSpecialMembers = {
110 SpecialMemberFunctionKind::Destructor,
111 SpecialMemberFunctionKind::CopyConstructor,
112 SpecialMemberFunctionKind::CopyAssignment};
114 if (getLangOpts().CPlusPlus11) {
115 AllSpecialMembers.push_back(SpecialMemberFunctionKind::MoveConstructor);
116 AllSpecialMembers.push_back(SpecialMemberFunctionKind::MoveAssignment);
119 for (
const auto &C : ClassWithSpecialMembers) {
120 const auto &DefinedSpecialMembers = C.second;
122 if (DefinedSpecialMembers.size() == AllSpecialMembers.size())
125 llvm::SmallVector<SpecialMemberFunctionKind, 5> UndefinedSpecialMembers;
126 std::set_difference(AllSpecialMembers.begin(), AllSpecialMembers.end(),
127 DefinedSpecialMembers.begin(),
128 DefinedSpecialMembers.end(),
129 std::back_inserter(UndefinedSpecialMembers));
131 diag(C.first.first,
"class '%0' defines %1 but does not define %2")
132 << C.first.second <<
join(DefinedSpecialMembers,
" and ")
133 <<
join(UndefinedSpecialMembers,
" or ");
SpecialMemberFunctionKind
std::unique_ptr< ast_matchers::MatchFinder > Finder
static llvm::StringRef toString(SpecialMemberFunctionsCheck::SpecialMemberFunctionKind K)
static std::string join(ArrayRef< SpecialMemberFunctionsCheck::SpecialMemberFunctionKind > SMFS, llvm::StringRef AndOr)
std::pair< SourceLocation, std::string > ClassDefId