clang::tidy::bugprone::TooSmallLoopVariableCheck Class Reference

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:

Public Member Functions
	TooSmallLoopVariableCheck (StringRef Name, ClangTidyContext *Context)
void	storeOptions (ClangTidyOptions::OptionMap &Opts) override
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

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: https://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 )

override

Definition at line 185 of file TooSmallLoopVariableCheck.cpp.

References clang::tidy::bugprone::calcMagnitudeBits(), clang::tidy::bugprone::calcUpperBoundMagnitudeBits(), 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 )

override

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)

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.

storeOptions()

void clang::tidy::bugprone::TooSmallLoopVariableCheck::storeOptions ( ClangTidyOptions::OptionMap & Opts )

override

Definition at line 51 of file TooSmallLoopVariableCheck.cpp.

---

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

• TooSmallLoopVariableCheck.h
• TooSmallLoopVariableCheck.cpp