clang-tools 8.0.0

RedundantSmartptrGetCheck.h
Go to the documentation of this file.
1 //===--- RedundantSmartptrGetCheck.h - clang-tidy ---------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
12
13 #include "../ClangTidy.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace readability {
18
19 /// Find and remove redundant calls to smart pointer's `.get()` method.
20 ///
21 /// Examples:
22 ///
23 /// \code
24 /// ptr.get()->Foo() ==> ptr->Foo()
25 /// *ptr.get() ==> *ptr
26 /// *ptr->get() ==> **ptr
27 /// \endcode
28 class RedundantSmartptrGetCheck : public ClangTidyCheck {
29 public:
30 RedundantSmartptrGetCheck(StringRef Name, ClangTidyContext *Context)
31 : ClangTidyCheck(Name, Context),
32 IgnoreMacros(Options.getLocalOrGlobal("IgnoreMacros", 1) != 0) {}
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;
36
37 private:
38 const bool IgnoreMacros;
39 };
40
41 } // namespace readability
42 } // namespace tidy
43 } // namespace clang
44
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_REDUNDANTSMARTPTRGETCHECK_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
clang::tidy::readability::RedundantSmartptrGetCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: RedundantSmartptrGetCheck.cpp:99
clang::tidy::readability::RedundantSmartptrGetCheck::RedundantSmartptrGetCheck
RedundantSmartptrGetCheck(StringRef Name, ClangTidyContext *Context)
Definition: RedundantSmartptrGetCheck.h:30
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidy.h:183
clang::tidy::readability::RedundantSmartptrGetCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: RedundantSmartptrGetCheck.cpp:127
clang::tidy::readability::RedundantSmartptrGetCheck
Find and remove redundant calls to smart pointer&#39;s .get() method.
Definition: RedundantSmartptrGetCheck.h:28
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:98
Result
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
Definition: ClangdServer.cpp:60
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ChangeNamespace.cpp:18
clang::tidy::readability::RedundantSmartptrGetCheck::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: RedundantSmartptrGetCheck.cpp:94
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:100