clang-tools-extra/clang-tidy/misc/UniqueptrResetReleaseCheck.h

   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::tidy::misc {
  16
  17 /// Find and replace `unique_ptr::reset(release())` with `std::move()`.
  18 ///
  19 /// Example:
  20 ///
  21 /// \code
  22 ///   std::unique_ptr<Foo> x, y;
  23 ///   x.reset(y.release()); -> x = std::move(y);
  24 /// \endcode
  25 ///
  26 /// If `y` is already rvalue, `std::move()` is not added.  `x` and `y` can also
  27 /// be `std::unique_ptr<Foo>*`.
  28 class UniqueptrResetReleaseCheck : public ClangTidyCheck {
  29 public:
  30   UniqueptrResetReleaseCheck(StringRef Name, ClangTidyContext *Context);
  31
  32   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  33     // Only register the matchers for C++11; the functionality currently does
  34     // not
  35     // provide any benefit to other languages, despite being benign.
  36     return LangOpts.CPlusPlus11;
  37   }
  38   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  39                            Preprocessor *ModuleExpanderPP) override;
  40   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  41   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  42   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  43
  44 private:
  45   utils::IncludeInserter Inserter;
  46 };
  47
  48 } // namespace clang::tidy::misc
  49
  50 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_UNIQUEPTRRESETRELEASECHECK_H