clang-tools  6.0.0svn
Public Member Functions | List of all members
clang::tidy::misc::ForwardingReferenceOverloadCheck Class Reference

The checker looks for constructors that can act as copy or move constructors through their forwarding reference parameters. More...

#include <ForwardingReferenceOverloadCheck.h>

Inheritance diagram for clang::tidy::misc::ForwardingReferenceOverloadCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::misc::ForwardingReferenceOverloadCheck:
Collaboration graph
[legend]

Public Member Functions

 ForwardingReferenceOverloadCheck (StringRef Name, ClangTidyContext *Context)
 
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...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual void registerPPCallbacks (CompilerInstance &Compiler)
 Override this to register PPCallbacks with Compiler. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
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. 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...
 
LangOptions getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

The checker looks for constructors that can act as copy or move constructors through their forwarding reference parameters.

If a non const lvalue reference is passed to the constructor, the forwarding reference parameter can be a perfect match while the const reference parameter of the copy constructor can't. The forwarding reference constructor will be called, which can lead to confusion. For detailed description of this problem see: Scott Meyers, Effective Modern C++ Design, item 26.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/misc-forwarding-reference-overload.html

Definition at line 30 of file ForwardingReferenceOverloadCheck.h.

Constructor & Destructor Documentation

◆ ForwardingReferenceOverloadCheck()

clang::tidy::misc::ForwardingReferenceOverloadCheck::ForwardingReferenceOverloadCheck ( StringRef  Name,
ClangTidyContext Context 
)
inline

Definition at line 32 of file ForwardingReferenceOverloadCheck.h.

References registerMatchers().

Member Function Documentation

◆ check()

void clang::tidy::misc::ForwardingReferenceOverloadCheck::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 89 of file ForwardingReferenceOverloadCheck.cpp.

◆ registerMatchers()

void clang::tidy::misc::ForwardingReferenceOverloadCheck::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.

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 63 of file ForwardingReferenceOverloadCheck.cpp.

Referenced by ForwardingReferenceOverloadCheck().


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