clang-tools 19.0.0git
Classes | Public Types | Public Member Functions | List of all members
clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck Class Reference

Checks for classes where some, but not all, of the special member functions are defined. More...

#include <SpecialMemberFunctionsCheck.h>

Inheritance diagram for clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck:
Inheritance graph
[legend]

Classes

struct  SpecialMemberFunctionData
 

Public Types

enum class  SpecialMemberFunctionKind : uint8_t {
  Destructor , DefaultDestructor , NonDefaultDestructor , CopyConstructor ,
  CopyAssignment , MoveConstructor , MoveAssignment
}
 
using ClassDefId = std::pair< SourceLocation, std::string >
 
using ClassDefiningSpecialMembersMap = llvm::DenseMap< ClassDefId, llvm::SmallVector< SpecialMemberFunctionData, 5 > >
 

Public Member Functions

 SpecialMemberFunctionsCheck (StringRef Name, ClangTidyContext *Context)
 
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 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.
 
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 onEndOfTranslationUnit () override
 
std::optional< TraversalKind > getCheckTraversalKind () const override
 
- 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.
 

Additional Inherited Members

- 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
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Checks for classes where some, but not all, of the special member functions are defined.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/special-member-functions.html

Definition at line 23 of file SpecialMemberFunctionsCheck.h.

Member Typedef Documentation

◆ ClassDefId

using clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::ClassDefId = std::pair<SourceLocation, std::string>

Definition at line 56 of file SpecialMemberFunctionsCheck.h.

◆ ClassDefiningSpecialMembersMap

Definition at line 58 of file SpecialMemberFunctionsCheck.h.

Member Enumeration Documentation

◆ SpecialMemberFunctionKind

Enumerator
Destructor 
DefaultDestructor 
NonDefaultDestructor 
CopyConstructor 
CopyAssignment 
MoveConstructor 
MoveAssignment 

Definition at line 36 of file SpecialMemberFunctionsCheck.h.

Constructor & Destructor Documentation

◆ SpecialMemberFunctionsCheck()

clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::SpecialMemberFunctionsCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 22 of file SpecialMemberFunctionsCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::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 95 of file SpecialMemberFunctionsCheck.cpp.

References CopyAssignment, CopyConstructor, DefaultDestructor, Destructor, ID, MoveAssignment, MoveConstructor, and NonDefaultDestructor.

◆ getCheckTraversalKind()

std::optional< TraversalKind > clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::getCheckTraversalKind ( ) const
inlineoverride

Definition at line 33 of file SpecialMemberFunctionsCheck.h.

◆ isLanguageVersionSupported()

bool clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::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 26 of file SpecialMemberFunctionsCheck.h.

◆ onEndOfTranslationUnit()

void clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::onEndOfTranslationUnit ( )
override

Definition at line 134 of file SpecialMemberFunctionsCheck.cpp.

References C.

◆ registerMatchers()

void clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::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 38 of file SpecialMemberFunctionsCheck.cpp.

◆ storeOptions()

void clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck::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 30 of file SpecialMemberFunctionsCheck.cpp.

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


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