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

Checks for inaccurate use of the erase() method. More...

#include <InaccurateEraseCheck.h>

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

Public Member Functions

 InaccurateEraseCheck (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

Checks for inaccurate use of the erase() method.

Algorithms like remove() do not actually remove any element from the container but return an iterator to the first redundant element at the end of the container. These redundant elements must be removed using the erase() method. This check warns when not all of the elements will be removed due to using an inappropriate overload.

Definition at line 26 of file InaccurateEraseCheck.h.

Constructor & Destructor Documentation

◆ InaccurateEraseCheck()

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

Definition at line 28 of file InaccurateEraseCheck.h.

References registerMatchers().

Member Function Documentation

◆ check()

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

References Loc.

◆ registerMatchers()

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

Referenced by InaccurateEraseCheck().


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