clang::tidy::boost::UseRangesCheck Class Reference

Detects calls to standard library iterator algorithms that could be replaced with a boost ranges version instead. More...

#include <UseRangesCheck.h>

Inheritance diagram for clang::tidy::boost::UseRangesCheck:

Public Member Functions
	UseRangesCheck (StringRef Name, ClangTidyContext *Context)
void	storeOptions (ClangTidyOptions::OptionMap &Opts) override
ReplacerMap	getReplacerMap () const override
	Gets a map of function to replace and methods to create the replacements.
DiagnosticBuilder	createDiag (const CallExpr &Call) override
	Create a diagnostic for the CallExpr Override this to support custom diagnostic messages.
ArrayRef< std::pair< StringRef, StringRef > >	getFreeBeginEndMethods () const override
	Gets the fully qualified names of begin and end functions.
std::optional< ReverseIteratorDescriptor >	getReverseDescriptor () const override
Public Member Functions inherited from clang::tidy::utils::UseRangesCheck
	UseRangesCheck (StringRef Name, ClangTidyContext *Context)
void	registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) final
void	registerMatchers (ast_matchers::MatchFinder *Finder) final
void	check (const ast_matchers::MatchFinder::MatchResult &Result) final
bool	isLanguageVersionSupported (const LangOptions &LangOpts) const override
void	storeOptions (ClangTidyOptions::OptionMap &Opts) override
std::optional< TraversalKind >	getCheckTraversalKind () const override

Additional Inherited Members
Public Types inherited from clang::tidy::utils::UseRangesCheck
using	Signature = SmallVector<Indexes, 2>
using	ReplacerMap = llvm::StringMap<llvm::IntrusiveRefCntPtr<Replacer>>

Detailed Description

Detects calls to standard library iterator algorithms that could be replaced with a boost ranges version instead.

For the user-facing documentation see: https://clang.llvm.org/extra/clang-tidy/checks/boost/use-ranges.html

Definition at line 21 of file boost/UseRangesCheck.h.

Constructor & Destructor Documentation

UseRangesCheck()

clang::tidy::boost::UseRangesCheck::UseRangesCheck	(	StringRef	Name,
		ClangTidyContext *	Context )

Definition at line 332 of file boost/UseRangesCheck.cpp.

References UseRangesCheck().

Referenced by UseRangesCheck().

Member Function Documentation

createDiag()

DiagnosticBuilder clang::tidy::boost::UseRangesCheck::createDiag ( const CallExpr & Call )

overridevirtual

Create a diagnostic for the CallExpr Override this to support custom diagnostic messages.

Reimplemented from clang::tidy::utils::UseRangesCheck.

Definition at line 343 of file boost/UseRangesCheck.cpp.

getFreeBeginEndMethods()

ArrayRef< std::pair< StringRef, StringRef > > clang::tidy::boost::UseRangesCheck::getFreeBeginEndMethods ( ) const

overridevirtual

Gets the fully qualified names of begin and end functions.

The functions must take the container as their one and only argument ::std::begin and ::std::end are a common example

Reimplemented from clang::tidy::utils::UseRangesCheck.

Definition at line 350 of file boost/UseRangesCheck.cpp.

getReplacerMap()

utils::UseRangesCheck::ReplacerMap clang::tidy::boost::UseRangesCheck::getReplacerMap ( ) const

overridevirtual

Gets a map of function to replace and methods to create the replacements.

Implements clang::tidy::utils::UseRangesCheck.

Definition at line 202 of file boost/UseRangesCheck.cpp.

getReverseDescriptor()

std::optional< UseRangesCheck::ReverseIteratorDescriptor > clang::tidy::boost::UseRangesCheck::getReverseDescriptor ( ) const

overridevirtual

Reimplemented from clang::tidy::utils::UseRangesCheck.

Definition at line 361 of file boost/UseRangesCheck.cpp.

storeOptions()

void clang::tidy::boost::UseRangesCheck::storeOptions ( ClangTidyOptions::OptionMap & Opts )

override

Definition at line 337 of file boost/UseRangesCheck.cpp.

References clang::tidy::utils::UseRangesCheck::storeOptions().

---

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

• boost/UseRangesCheck.h
• boost/UseRangesCheck.cpp