clang-tools  12.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]
Collaboration diagram for clang::tidy::cppcoreguidelines::SpecialMemberFunctionsCheck:
Collaboration graph
[legend]

Classes

struct  SpecialMemberFunctionData
 

Public Types

enum  SpecialMemberFunctionKind : uint8_t {
  SpecialMemberFunctionKind::Destructor, SpecialMemberFunctionKind::DefaultDestructor, SpecialMemberFunctionKind::NonDefaultDestructor, SpecialMemberFunctionKind::CopyConstructor,
  SpecialMemberFunctionKind::CopyAssignment, SpecialMemberFunctionKind::MoveConstructor, SpecialMemberFunctionKind::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. More...
 
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. More...
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
void onEndOfTranslationUnit () override
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP)
 Override this to register PPCallbacks in the preprocessor. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit. More...
 
const LangOptions & getLangOpts () const
 Returns the language options from the context. More...
 
- 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 25 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 60 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 24 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 102 of file SpecialMemberFunctionsCheck.cpp.

◆ 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 28 of file SpecialMemberFunctionsCheck.h.

◆ onEndOfTranslationUnit()

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

Definition at line 137 of file SpecialMemberFunctionsCheck.cpp.

◆ 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 40 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 32 of file SpecialMemberFunctionsCheck.cpp.


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