1 //===--- RedundantSmartptrGetCheck.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_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang::tidy::readability {
15 
16 /// Find and remove redundant calls to smart pointer's `.get()` method.
17 ///
18 /// Examples:
19 ///
20 /// \code
21 ///   ptr.get()->Foo()  ==>  ptr->Foo()
22 ///   *ptr.get()  ==>  *ptr
23 ///   *ptr->get()  ==>  **ptr
24 /// \endcode
25 class RedundantSmartptrGetCheck : public ClangTidyCheck {
26 public:
RedundantSmartptrGetCheck(StringRef Name,ClangTidyContext * Context)27   RedundantSmartptrGetCheck(StringRef Name, ClangTidyContext *Context)
28       : ClangTidyCheck(Name, Context),
29         IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", true)) {}
isLanguageVersionSupported(const LangOptions & LangOpts)30   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
31     return LangOpts.CPlusPlus;
32   }
33   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
34   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
35   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
getCheckTraversalKind()36   std::optional<TraversalKind> getCheckTraversalKind() const override {
37     return TK_IgnoreUnlessSpelledInSource;
38   }
39 
40 private:
41   const bool IgnoreMacros;
42 };
43 
44 } // namespace clang::tidy::readability
45 
46 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
47