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

Find constructions of smart (unique or shared) pointers where the pointer is declared with non-array target type and an array (created with a new-expression) is passed to it. More...

#include <SmartPtrArrayMismatchCheck.h>

Inheritance diagram for clang::tidy::bugprone::SmartPtrArrayMismatchCheck:
Inheritance graph
[legend]

Public Member Functions

 SmartPtrArrayMismatchCheck (StringRef Name, ClangTidyContext *Context, StringRef SmartPointerName)
 
bool isLanguageVersionSupported (const LangOptions &LangOpts) const override
 Override this to disable registering matchers and PP callbacks if an invalid language version is being used.
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder.
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 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 SmartPtrClassMatcher = ast_matchers::internal::BindableMatcher< Decl >
 

Protected Member Functions

virtual SmartPtrClassMatcher getSmartPointerClassMatcher () const =0
 Returns matcher that match with different smart pointer classes.
 
- 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 PointerTypeN [] = "pointer_type"
 

Additional Inherited Members

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

Detailed Description

Find constructions of smart (unique or shared) pointers where the pointer is declared with non-array target type and an array (created with a new-expression) is passed to it.

Definition at line 19 of file SmartPtrArrayMismatchCheck.h.

Member Typedef Documentation

◆ SmartPtrClassMatcher

using clang::tidy::bugprone::SmartPtrArrayMismatchCheck::SmartPtrClassMatcher = ast_matchers::internal::BindableMatcher<Decl>
protected

Definition at line 32 of file SmartPtrArrayMismatchCheck.h.

Constructor & Destructor Documentation

◆ SmartPtrArrayMismatchCheck()

clang::tidy::bugprone::SmartPtrArrayMismatchCheck::SmartPtrArrayMismatchCheck ( StringRef  Name,
ClangTidyContext Context,
StringRef  SmartPointerName 
)

Definition at line 50 of file SmartPtrArrayMismatchCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::bugprone::SmartPtrArrayMismatchCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
overridevirtual

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

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 77 of file SmartPtrArrayMismatchCheck.cpp.

References clang::tidy::ClangTidyCheck::diag(), and clang::tidy::utils::rangeCanBeFixed().

◆ getSmartPointerClassMatcher()

virtual SmartPtrClassMatcher clang::tidy::bugprone::SmartPtrArrayMismatchCheck::getSmartPointerClassMatcher ( ) const
protectedpure virtual

Returns matcher that match with different smart pointer classes.

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

Implemented in clang::tidy::bugprone::SharedPtrArrayMismatchCheck, and clang::tidy::bugprone::UniquePtrArrayMismatchCheck.

Referenced by registerMatchers().

◆ isLanguageVersionSupported()

bool clang::tidy::bugprone::SmartPtrArrayMismatchCheck::isLanguageVersionSupported ( const LangOptions &  LangOpts) const
inlineoverridevirtual

Override this to disable registering matchers and PP callbacks if an invalid language version is being used.

For example if a check is examining overloaded functions then this should be overridden to return false when the CPlusPlus flag is not set in LangOpts.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 24 of file SmartPtrArrayMismatchCheck.h.

◆ registerMatchers()

void clang::tidy::bugprone::SmartPtrArrayMismatchCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
overridevirtual

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 57 of file SmartPtrArrayMismatchCheck.cpp.

References getSmartPointerClassMatcher(), and PointerTypeN.

◆ storeOptions()

void clang::tidy::bugprone::SmartPtrArrayMismatchCheck::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 54 of file SmartPtrArrayMismatchCheck.cpp.

Member Data Documentation

◆ PointerTypeN

const char clang::tidy::bugprone::SmartPtrArrayMismatchCheck::PointerTypeN = "pointer_type"
staticprotected

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