clang-tools  14.0.0git
Classes | Public Types | Public Member Functions | List of all members
clang::tidy::bugprone::LambdaFunctionNameCheck Class Reference

Detect when func or FUNCTION is being used from within a lambda. More...

#include <LambdaFunctionNameCheck.h>

Inheritance diagram for clang::tidy::bugprone::LambdaFunctionNameCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::bugprone::LambdaFunctionNameCheck:
Collaboration graph
[legend]

Classes

struct  SourceRangeLessThan
 

Public Types

using SourceRangeSet = std::set< SourceRange, SourceRangeLessThan >
 

Public Member Functions

 LambdaFunctionNameCheck (StringRef Name, ClangTidyContext *Context)
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor. 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 bool isLanguageVersionSupported (const LangOptions &LangOpts) const
 Override this to disable registering matchers and PP callbacks if an invalid language version is being used. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const
 Adds a diagnostic to report errors in the check's configuration. 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...
 
const LangOptions & getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Detect when func or FUNCTION is being used from within a lambda.

In that context, those expressions expand to the name of the call operator (i.e., operator()).

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/bugprone-lambda-function-name.html

Definition at line 24 of file LambdaFunctionNameCheck.h.

Member Typedef Documentation

◆ SourceRangeSet

Definition at line 34 of file LambdaFunctionNameCheck.h.

Constructor & Destructor Documentation

◆ LambdaFunctionNameCheck()

clang::tidy::bugprone::LambdaFunctionNameCheck::LambdaFunctionNameCheck ( StringRef  Name,
ClangTidyContext Context 
)
inline

Definition at line 36 of file LambdaFunctionNameCheck.h.

Member Function Documentation

◆ check()

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

◆ registerMatchers()

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

◆ registerPPCallbacks()

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


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