1 //===--- UniqueptrDeleteReleaseCheck.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 "UniqueptrDeleteReleaseCheck.h"
10 #include "clang/AST/ASTContext.h"
11 #include "clang/ASTMatchers/ASTMatchFinder.h"
12 #include "clang/Basic/Diagnostic.h"
13 #include "clang/Basic/SourceLocation.h"
14 #include "clang/Lex/Lexer.h"
15 
16 using namespace clang::ast_matchers;
17 
18 namespace clang {
19 namespace tidy {
20 namespace readability {
21 
storeOptions(ClangTidyOptions::OptionMap & Opts)22 void UniqueptrDeleteReleaseCheck::storeOptions(
23     ClangTidyOptions::OptionMap &Opts) {
24   Options.store(Opts, "PreferResetCall", PreferResetCall);
25 }
26 
UniqueptrDeleteReleaseCheck(StringRef Name,ClangTidyContext * Context)27 UniqueptrDeleteReleaseCheck::UniqueptrDeleteReleaseCheck(
28     StringRef Name, ClangTidyContext *Context)
29     : ClangTidyCheck(Name, Context),
30       PreferResetCall(Options.get("PreferResetCall", false)) {}
31 
registerMatchers(MatchFinder * Finder)32 void UniqueptrDeleteReleaseCheck::registerMatchers(MatchFinder *Finder) {
33 
34   auto UniquePtrWithDefaultDelete = classTemplateSpecializationDecl(
35       hasName("::std::unique_ptr"),
36       hasTemplateArgument(1, refersToType(hasDeclaration(cxxRecordDecl(
37                                  hasName("::std::default_delete"))))));
38 
39   Finder->addMatcher(
40       cxxDeleteExpr(
41           unless(isInTemplateInstantiation()),
42           has(cxxMemberCallExpr(
43                   callee(memberExpr(hasObjectExpression(anyOf(
44                                         hasType(UniquePtrWithDefaultDelete),
45                                         hasType(pointsTo(
46                                             UniquePtrWithDefaultDelete)))),
47                                     member(cxxMethodDecl(hasName("release"))))
48                              .bind("release_expr")))
49                   .bind("release_call")))
50           .bind("delete"),
51       this);
52 }
53 
check(const MatchFinder::MatchResult & Result)54 void UniqueptrDeleteReleaseCheck::check(
55     const MatchFinder::MatchResult &Result) {
56   const auto *DeleteExpr = Result.Nodes.getNodeAs<CXXDeleteExpr>("delete");
57   const auto *ReleaseExpr = Result.Nodes.getNodeAs<MemberExpr>("release_expr");
58   const auto *ReleaseCallExpr =
59       Result.Nodes.getNodeAs<CXXMemberCallExpr>("release_call");
60 
61   if (ReleaseExpr->getBeginLoc().isMacroID())
62     return;
63 
64   auto D =
65       diag(DeleteExpr->getBeginLoc(), "prefer '%select{= nullptr|reset()}0' "
66                                       "to reset 'unique_ptr<>' objects");
67   D << PreferResetCall << DeleteExpr->getSourceRange()
68     << FixItHint::CreateRemoval(CharSourceRange::getCharRange(
69            DeleteExpr->getBeginLoc(),
70            DeleteExpr->getArgument()->getBeginLoc()));
71   if (PreferResetCall) {
72     D << FixItHint::CreateReplacement(ReleaseExpr->getMemberLoc(), "reset");
73   } else {
74     if (ReleaseExpr->isArrow())
75       D << FixItHint::CreateInsertion(ReleaseExpr->getBase()->getBeginLoc(),
76                                       "*");
77     D << FixItHint::CreateReplacement(
78         CharSourceRange::getTokenRange(ReleaseExpr->getOperatorLoc(),
79                                        ReleaseCallExpr->getEndLoc()),
80         " = nullptr");
81   }
82 }
83 
84 } // namespace readability
85 } // namespace tidy
86 } // namespace clang
87