clang-tools 19.0.0git
Public Member Functions | List of all members
clang::tidy::hicpp::IgnoredRemoveResultCheck Class Reference

Ensure that the result of std::remove, std::remove_if and std::unique are not ignored according to rule 17.5.1. More...

#include <IgnoredRemoveResultCheck.h>

Inheritance diagram for clang::tidy::hicpp::IgnoredRemoveResultCheck:
Inheritance graph
[legend]

Public Member Functions

 IgnoredRemoveResultCheck (StringRef Name, ClangTidyContext *Context)
 
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.
 
- Public Member Functions inherited from clang::tidy::bugprone::UnusedReturnValueCheck
 UnusedReturnValueCheck (StringRef Name, ClangTidyContext *Context)
 
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.
 
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::bugprone::UnusedReturnValueCheck
 UnusedReturnValueCheck (StringRef Name, ClangTidyContext *Context, std::string CheckedFunctions)
 
 UnusedReturnValueCheck (StringRef Name, ClangTidyContext *Context, std::string CheckedFunctions, std::vector< StringRef > CheckedReturnTypes, bool AllowCastToVoid)
 
- 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::bugprone::UnusedReturnValueCheck
bool AllowCastToVoid
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Ensure that the result of std::remove, std::remove_if and std::unique are not ignored according to rule 17.5.1.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/hicpp/ignored-remove-result.html

Definition at line 21 of file IgnoredRemoveResultCheck.h.

Constructor & Destructor Documentation

◆ IgnoredRemoveResultCheck()

clang::tidy::hicpp::IgnoredRemoveResultCheck::IgnoredRemoveResultCheck ( StringRef  Name,
ClangTidyContext Context 
)

Member Function Documentation

◆ storeOptions()

void clang::tidy::hicpp::IgnoredRemoveResultCheck::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::bugprone::UnusedReturnValueCheck.

Definition at line 24 of file IgnoredRemoveResultCheck.cpp.

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


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