clang-tools 20.0.0git
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Attributes | List of all members
clang::tidy::modernize::MakeSmartPtrCheck Class Referenceabstract

Base class for MakeSharedCheck and MakeUniqueCheck. More...

#include <MakeSmartPtrCheck.h>

Inheritance diagram for clang::tidy::modernize::MakeSmartPtrCheck:
Inheritance graph
[legend]

Public Member Functions

 MakeSmartPtrCheck (StringRef Name, ClangTidyContext *Context, StringRef MakeSmartPtrFunctionName)
 
void registerMatchers (ast_matchers::MatchFinder *Finder) final
 Override this to register AST matchers with Finder.
 
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor.
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) final
 ClangTidyChecks that register ASTMatchers should do the actual work in here.
 
void storeOptions (ClangTidyOptions::OptionMap &Opts) override
 Should store all options supported by this check with their current values or default values for options that haven't been overridden.
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context.
 
virtual bool isLanguageVersionSupported (const LangOptions &LangOpts) const
 Override this to disable registering matchers and PP callbacks if an invalid language version is being used.
 
virtual void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP)
 Override this to register PPCallbacks in the preprocessor.
 
virtual void registerMatchers (ast_matchers::MatchFinder *Finder)
 Override this to register AST matchers with Finder.
 
virtual void check (const ast_matchers::MatchFinder::MatchResult &Result)
 ClangTidyChecks that register ASTMatchers should do the actual work in here.
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name.
 
DiagnosticBuilder diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name.
 
DiagnosticBuilder configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const
 Adds a diagnostic to report errors in the check's configuration.
 
virtual void storeOptions (ClangTidyOptions::OptionMap &Options)
 Should store all options supported by this check with their current values or default values for options that haven't been overridden.
 

Protected Types

using SmartPtrTypeMatcher = ast_matchers::internal::BindableMatcher< QualType >
 

Protected Member Functions

virtual SmartPtrTypeMatcher getSmartPointerTypeMatcher () const =0
 Returns matcher that match with different smart pointer types.
 
bool isLanguageVersionSupported (const LangOptions &LangOpts) const override
 Returns whether the C++ version is compatible with current check.
 
- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit.
 
const LangOptions & getLangOpts () const
 Returns the language options from the context.
 
bool areDiagsSelfContained () const
 Returns true when the check is run in a use case when only 1 fix will be applied at a time.
 
StringRef getID () const override
 

Static Protected Attributes

static const char PointerType [] = "pointerType"
 

Additional Inherited Members

- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Base class for MakeSharedCheck and MakeUniqueCheck.

Definition at line 22 of file MakeSmartPtrCheck.h.

Member Typedef Documentation

◆ SmartPtrTypeMatcher

using clang::tidy::modernize::MakeSmartPtrCheck::SmartPtrTypeMatcher = ast_matchers::internal::BindableMatcher<QualType>
protected

Definition at line 33 of file MakeSmartPtrCheck.h.

Constructor & Destructor Documentation

◆ MakeSmartPtrCheck()

clang::tidy::modernize::MakeSmartPtrCheck::MakeSmartPtrCheck ( StringRef  Name,
ClangTidyContext Context,
StringRef  MakeSmartPtrFunctionName 
)

Definition at line 41 of file MakeSmartPtrCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::modernize::MakeSmartPtrCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
finalvirtual

ClangTidyChecks that register ASTMatchers should do the actual work in here.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 114 of file MakeSmartPtrCheck.cpp.

References clang::tidy::utils::type_traits::isTriviallyDefaultConstructible(), PointerType, and Type.

◆ getSmartPointerTypeMatcher()

virtual SmartPtrTypeMatcher clang::tidy::modernize::MakeSmartPtrCheck::getSmartPointerTypeMatcher ( ) const
protectedpure virtual

Returns matcher that match with different smart pointer types.

Requires to bind pointer type (qualType) with PointerType string declared in this class.

Implemented in clang::tidy::modernize::MakeSharedCheck, and clang::tidy::modernize::MakeUniqueCheck.

Referenced by registerMatchers().

◆ isLanguageVersionSupported()

bool clang::tidy::modernize::MakeSmartPtrCheck::isLanguageVersionSupported ( const LangOptions &  LangOpts) const
overrideprotectedvirtual

Returns whether the C++ version is compatible with current check.

Reimplemented from clang::tidy::ClangTidyCheck.

Reimplemented in clang::tidy::modernize::MakeUniqueCheck.

Definition at line 64 of file MakeSmartPtrCheck.cpp.

◆ registerMatchers()

void clang::tidy::modernize::MakeSmartPtrCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
finalvirtual

Override this to register AST matchers with Finder.

This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.

You can register as many matchers as necessary with Finder. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.

This will only be executed if the function isLanguageVersionSupported returns true.

If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 75 of file MakeSmartPtrCheck.cpp.

References getSmartPointerTypeMatcher(), and PointerType.

◆ registerPPCallbacks()

void clang::tidy::modernize::MakeSmartPtrCheck::registerPPCallbacks ( const SourceManager &  SM,
Preprocessor *  PP,
Preprocessor *  ModuleExpanderPP 
)
overridevirtual

Override this to register PPCallbacks in the preprocessor.

This should be used for clang-tidy checks that analyze preprocessor- dependent properties, e.g. include directives and macro definitions.

This will only be executed if the function isLanguageVersionSupported returns true.

There are two Preprocessors to choose from that differ in how they handle modular #includes:

  • PP is the real Preprocessor. It doesn't walk into modular #includes and thus doesn't generate PPCallbacks for their contents.
  • ModuleExpanderPP preprocesses the whole translation unit in the non-modular mode, which allows it to generate PPCallbacks not only for the main file and textual headers, but also for all transitively included modular headers when the analysis runs with modules enabled. When modules are not enabled ModuleExpanderPP just points to the real preprocessor.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 69 of file MakeSmartPtrCheck.cpp.

References clang::tidy::utils::IncludeInserter::registerPreprocessor().

◆ storeOptions()

void clang::tidy::modernize::MakeSmartPtrCheck::storeOptions ( ClangTidyOptions::OptionMap Options)
overridevirtual

Should store all options supported by this check with their current values or default values for options that haven't been overridden.

The check should use Options.store() to store each option it supports whether it has the default value or it has been overridden.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 55 of file MakeSmartPtrCheck.cpp.

References clang::tidy::utils::IncludeInserter::getStyle(), clang::tidy::ClangTidyCheck::Options, and clang::tidy::ClangTidyCheck::OptionsView::store().

Member Data Documentation

◆ PointerType

const char clang::tidy::modernize::MakeSmartPtrCheck::PointerType = "pointerType"
staticprotected

The documentation for this class was generated from the following files: