clang-tools 18.0.0git
UseEqualsDeleteCheck.cpp
Go to the documentation of this file.
1//===--- UseEqualsDeleteCheck.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
10#include "clang/AST/ASTContext.h"
11#include "clang/ASTMatchers/ASTMatchFinder.h"
12#include "clang/Lex/Lexer.h"
13
14using namespace clang::ast_matchers;
15
16namespace clang::tidy::modernize {
17
18namespace {
19AST_MATCHER(FunctionDecl, hasAnyDefinition) {
20 if (Node.hasBody() || Node.isPure() || Node.isDefaulted() || Node.isDeleted())
21 return true;
22
23 if (const FunctionDecl *Definition = Node.getDefinition())
24 if (Definition->hasBody() || Definition->isPure() ||
25 Definition->isDefaulted() || Definition->isDeleted())
26 return true;
27
28 return false;
29}
30
31AST_MATCHER(Decl, isUsed) { return Node.isUsed(); }
32
33AST_MATCHER(CXXMethodDecl, isSpecialFunction) {
34 if (const auto *Constructor = dyn_cast<CXXConstructorDecl>(&Node))
35 return Constructor->isDefaultConstructor() ||
36 Constructor->isCopyOrMoveConstructor();
37
38 return isa<CXXDestructorDecl>(Node) || Node.isCopyAssignmentOperator() ||
39 Node.isMoveAssignmentOperator();
40}
41} // namespace
42
43static const char SpecialFunction[] = "SpecialFunction";
44static const char DeletedNotPublic[] = "DeletedNotPublic";
45
47 ClangTidyContext *Context)
48 : ClangTidyCheck(Name, Context),
49 IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", true)) {}
50
52 Options.store(Opts, "IgnoreMacros", IgnoreMacros);
53}
54
55void UseEqualsDeleteCheck::registerMatchers(MatchFinder *Finder) {
56 auto PrivateSpecialFn = cxxMethodDecl(isPrivate(), isSpecialFunction());
57
58 Finder->addMatcher(
59 cxxMethodDecl(
60 PrivateSpecialFn, unless(hasAnyDefinition()), unless(isUsed()),
61 // Ensure that all methods except private special member functions are
62 // defined.
63 unless(ofClass(hasMethod(cxxMethodDecl(unless(PrivateSpecialFn),
64 unless(hasAnyDefinition()))))))
65 .bind(SpecialFunction),
66 this);
67
68 Finder->addMatcher(
69 cxxMethodDecl(isDeleted(), unless(isPublic())).bind(DeletedNotPublic),
70 this);
71}
72
73void UseEqualsDeleteCheck::check(const MatchFinder::MatchResult &Result) {
74 if (const auto *Func =
75 Result.Nodes.getNodeAs<CXXMethodDecl>(SpecialFunction)) {
76 SourceLocation EndLoc = Lexer::getLocForEndOfToken(
77 Func->getEndLoc(), 0, *Result.SourceManager, getLangOpts());
78
79 if (IgnoreMacros && Func->getLocation().isMacroID())
80 return;
81 // FIXME: Improve FixItHint to make the method public.
82 diag(Func->getLocation(),
83 "use '= delete' to prohibit calling of a special member function")
84 << FixItHint::CreateInsertion(EndLoc, " = delete");
85 } else if (const auto *Func =
86 Result.Nodes.getNodeAs<CXXMethodDecl>(DeletedNotPublic)) {
87 // Ignore this warning in macros, since it's extremely noisy in code using
88 // DISALLOW_COPY_AND_ASSIGN-style macros and there's no easy way to
89 // automatically fix the warning when macros are in play.
90 if (IgnoreMacros && Func->getLocation().isMacroID())
91 return;
92 // FIXME: Add FixItHint to make the method public.
93 diag(Func->getLocation(), "deleted member function should be public");
94 }
95}
96
97} // namespace clang::tidy::modernize
const FunctionDecl * Decl
llvm::StringRef Name
::clang::DynTypedNode Node
void store(ClangTidyOptions::OptionMap &Options, StringRef LocalName, StringRef Value) const
Stores an option with the check-local name LocalName with string value Value to Options.
Base class for all clang-tidy checks.
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check's name.
const LangOptions & getLangOpts() const
Returns the language options from the context.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
UseEqualsDeleteCheck(StringRef Name, ClangTidyContext *Context)
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
AST_MATCHER(Decl, declHasNoReturnAttr)
matches a Decl if it has a "no return" attribute of any kind
static const char DeletedNotPublic[]
static const char SpecialFunction[]
llvm::StringMap< ClangTidyValue > OptionMap