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

Checks whether a call to the size() method can be replaced with a call to empty(). More...

#include <ContainerSizeEmptyCheck.h>

Inheritance diagram for clang::tidy::readability::ContainerSizeEmptyCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::readability::ContainerSizeEmptyCheck:
Collaboration graph
[legend]

Public Member Functions

 ContainerSizeEmptyCheck (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 whether a call to the size() method can be replaced with a call to empty().

The emptiness of a container should be checked using the empty() method instead of the size() method. It is not guaranteed that size() is a constant-time function, and it is generally more efficient and also shows clearer intent to use empty(). Furthermore some containers may implement the empty() method but not implement the size() method. Using empty() whenever possible makes it easier to switch to another container in the future.

Definition at line 29 of file ContainerSizeEmptyCheck.h.

Constructor & Destructor Documentation

◆ ContainerSizeEmptyCheck()

clang::tidy::readability::ContainerSizeEmptyCheck::ContainerSizeEmptyCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 25 of file ContainerSizeEmptyCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::readability::ContainerSizeEmptyCheck::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 104 of file ContainerSizeEmptyCheck.cpp.

References clang::tidy::ClangTidyCheck::diag(), clang::tidy::ClangTidyCheck::getLangOpts(), and clang::tidy::utils::IsBinaryOrTernary().

◆ registerMatchers()

void clang::tidy::readability::ContainerSizeEmptyCheck::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 29 of file ContainerSizeEmptyCheck.cpp.


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