clang-tools  14.0.0git
Public Member Functions | List of all members
clang::tidy::abseil::StringFindStrContainsCheck Class Reference

Finds s.find(...) == string::npos comparisons (for various string-like types) and suggests replacing with absl::StrContains. More...

#include <StringFindStrContainsCheck.h>

Inheritance diagram for clang::tidy::abseil::StringFindStrContainsCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::abseil::StringFindStrContainsCheck:
Collaboration graph
[legend]

Public Member Functions

 StringFindStrContainsCheck (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...
 
- Public Member Functions inherited from clang::tidy::utils::TransformerClangTidyCheck
 TransformerClangTidyCheck (StringRef Name, ClangTidyContext *Context)
 
 TransformerClangTidyCheck (std::function< Optional< transformer::RewriteRule >(const LangOptions &, const OptionsView &)> MakeRule, StringRef Name, ClangTidyContext *Context)
 DEPRECATED: prefer the two argument constructor in conjunction with setRule. More...
 
 TransformerClangTidyCheck (transformer::RewriteRule R, StringRef Name, ClangTidyContext *Context)
 Convenience overload of the constructor when the rule doesn't have any dependies. More...
 
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor. More...
 
void registerMatchers (ast_matchers::MatchFinder *Finder) final
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) final
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
void storeOptions (ClangTidyOptions::OptionMap &Opts) override
 Derived classes that override this function should call this method from the overridden method. More...
 
void setRule (transformer::RewriteRule R)
 Set the rule that this check implements. More...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. 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...
 

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

Finds s.find(...) == string::npos comparisons (for various string-like types) and suggests replacing with absl::StrContains.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/abseil-string-find-str-contains.html

Definition at line 24 of file StringFindStrContainsCheck.h.

Constructor & Destructor Documentation

◆ StringFindStrContainsCheck()

clang::tidy::abseil::StringFindStrContainsCheck::StringFindStrContainsCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 86 of file StringFindStrContainsCheck.cpp.

Member Function Documentation

◆ isLanguageVersionSupported()

bool clang::tidy::abseil::StringFindStrContainsCheck::isLanguageVersionSupported ( const LangOptions &  LangOpts) const
overridevirtual

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 97 of file StringFindStrContainsCheck.cpp.

◆ storeOptions()

void clang::tidy::abseil::StringFindStrContainsCheck::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 102 of file StringFindStrContainsCheck.cpp.


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