clang-tidy/readability/RedundantSmartptrGetCheck.h

0001 //===--- RedundantSmartptrGetCheck.h - clang-tidy ---------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::readability {
0015
0016 /// Find and remove redundant calls to smart pointer's `.get()` method.
0017 ///
0018 /// Examples:
0019 ///
0020 /// \code
0021 ///   ptr.get()->Foo()  ==>  ptr->Foo()
0022 ///   *ptr.get()  ==>  *ptr
0023 ///   *ptr->get()  ==>  **ptr
0024 /// \endcode
0025 class RedundantSmartptrGetCheck : public ClangTidyCheck {
0026 public:
0027   RedundantSmartptrGetCheck(StringRef Name, ClangTidyContext *Context)
0028       : ClangTidyCheck(Name, Context),
0029         IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", true)) {}
0030   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0031     return LangOpts.CPlusPlus;
0032   }
0033   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0034   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0035   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0036   std::optional<TraversalKind> getCheckTraversalKind() const override {
0037     return TK_IgnoreUnlessSpelledInSource;
0038   }
0039
0040 private:
0041   const bool IgnoreMacros;
0042 };
0043
0044 } // namespace clang::tidy::readability
0045
0046 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H