This check gives a warning if a loop variable has a too small type which might not be able to represent all values which are part of the whole range in which the loop iterates. More...

#include <TooSmallLoopVariableCheck.h>

Inheritance diagram for clang::tidy::bugprone::TooSmallLoopVariableCheck:

[legend]

Public Member Functions
	TooSmallLoopVariableCheck (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
	The matcher for loops with suspicious integer loop variable.

void	check (const ast_matchers::MatchFinder::MatchResult &Result) override
	`ClangTidyChecks` that register ASTMatchers should do the actual work in here.

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::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::ClangTidyCheck
OptionsView	Options

Detailed Description

This check gives a warning if a loop variable has a too small type which might not be able to represent all values which are part of the whole range in which the loop iterates.

If the loop variable's type is too small we might end up in an infinite loop. Example:

long size = 294967296l;

for (short i = 0; i < size; ++i) {} { ... }

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/bugprone/too-small-loop-variable.html

Definition at line 28 of file TooSmallLoopVariableCheck.h.

Constructor & Destructor Documentation

◆ TooSmallLoopVariableCheck()

clang::tidy::bugprone::TooSmallLoopVariableCheck::TooSmallLoopVariableCheck	(	StringRef	Name,
		ClangTidyContext *	Context
	)

Definition at line 46 of file TooSmallLoopVariableCheck.cpp.

Member Function Documentation

◆ check()

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

References clang::tidy::bugprone::calcMagnitudeBits(), clang::tidy::bugprone::calcUpperBoundMagnitudeBits(), clang::tidy::ClangTidyCheck::diag(), clang::tidy::bugprone::formatIntegralType(), clang::tidy::bugprone::LoopIncrementName, clang::tidy::bugprone::LoopUpperBoundName, and clang::tidy::bugprone::LoopVarName.

◆ registerMatchers()

void clang::tidy::bugprone::TooSmallLoopVariableCheck::registerMatchers ( ast_matchers::MatchFinder * Finder )

overridevirtual

The matcher for loops with suspicious integer loop variable.

In this general example, assuming 'j' and 'k' are of integral type:

for (...; j < 3 + 2; ++k) { ... }

The following string identifiers are bound to these parts of the AST: LoopVarName: 'j' (as a VarDecl) LoopVarCastName: 'j' (after implicit conversion) LoopUpperBoundName: '3 + 2' (as an Expr) LoopIncrementName: 'k' (as an Expr) LoopName: The entire for loop (as a ForStmt)

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 69 of file TooSmallLoopVariableCheck.cpp.

References clang::tidy::bugprone::LoopIncrementName, clang::tidy::bugprone::LoopName, clang::tidy::bugprone::LoopUpperBoundName, clang::tidy::bugprone::LoopVarCastName, and clang::tidy::bugprone::LoopVarName.