clang-tools  14.0.0git
UniqueptrResetReleaseCheck.h
Go to the documentation of this file.
1 //===--- UniqueptrResetReleaseCheck.h - clang-tidy --------------*- C++ -*-===//
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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNIQUEPTRRESETRELEASECHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNIQUEPTRRESETRELEASECHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "../utils/IncludeInserter.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace misc {
18 
19 /// Find and replace `unique_ptr::reset(release())` with `std::move()`.
20 ///
21 /// Example:
22 ///
23 /// \code
24 /// std::unique_ptr<Foo> x, y;
25 /// x.reset(y.release()); -> x = std::move(y);
26 /// \endcode
27 ///
28 /// If `y` is already rvalue, `std::move()` is not added. `x` and `y` can also
29 /// be `std::unique_ptr<Foo>*`.
31 public:
33 
34  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
35  // Only register the matchers for C++11; the functionality currently does
36  // not
37  // provide any benefit to other languages, despite being benign.
38  return LangOpts.CPlusPlus11;
39  }
40  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
41  Preprocessor *ModuleExpanderPP) override;
42  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
43  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
44  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
45 
46 private:
47  utils::IncludeInserter Inserter;
48 };
49 
50 } // namespace misc
51 } // namespace tidy
52 } // namespace clang
53 
54 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNIQUEPTRRESETRELEASECHECK_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::utils::IncludeInserter
Produces fixes to insert specified includes to source files, if not yet present.
Definition: IncludeInserter.h:55
clang::tidy::misc::UniqueptrResetReleaseCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: UniqueptrResetReleaseCheck.cpp:25
clang::tidy::misc::UniqueptrResetReleaseCheck
Find and replace unique_ptr::reset(release()) with std::move().
Definition: UniqueptrResetReleaseCheck.h:30
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::misc::UniqueptrResetReleaseCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: UniqueptrResetReleaseCheck.cpp:109
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::misc::UniqueptrResetReleaseCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: UniqueptrResetReleaseCheck.cpp:30
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:29
clang::tidy::misc::UniqueptrResetReleaseCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: UniqueptrResetReleaseCheck.cpp:35
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::misc::UniqueptrResetReleaseCheck::UniqueptrResetReleaseCheck
UniqueptrResetReleaseCheck(StringRef Name, ClangTidyContext *Context)
Definition: UniqueptrResetReleaseCheck.cpp:19
clang::tidy::misc::UniqueptrResetReleaseCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: UniqueptrResetReleaseCheck.h:34