clang-tools  14.0.0git
TooSmallLoopVariableCheck.h
Go to the documentation of this file.
1 //===--- TooSmallLoopVariableCheck.h - clang-tidy ---------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace bugprone {
17 
18 /// This check gives a warning if a loop variable has a too small type which
19 /// might not be able to represent all values which are part of the whole range
20 /// in which the loop iterates.
21 /// If the loop variable's type is too small we might end up in an infinite
22 /// loop. Example:
23 /// \code
24 /// long size = 294967296l;
25 /// for (short i = 0; i < size; ++i) {} { ... }
26 /// \endcode
27 ///
28 /// For the user-facing documentation see:
29 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-too-small-loop-variable.html
31 public:
32  TooSmallLoopVariableCheck(StringRef Name, ClangTidyContext *Context);
33 
34  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
35  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
36  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
37 
38 private:
39  const unsigned MagnitudeBitsUpperLimit;
40 };
41 
42 } // namespace bugprone
43 } // namespace tidy
44 } // namespace clang
45 
46 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H
clang::tidy::bugprone::TooSmallLoopVariableCheck
This check gives a warning if a loop variable has a too small type which might not be able to represe...
Definition: TooSmallLoopVariableCheck.h:30
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::bugprone::TooSmallLoopVariableCheck::TooSmallLoopVariableCheck
TooSmallLoopVariableCheck(StringRef Name, ClangTidyContext *Context)
Definition: TooSmallLoopVariableCheck.cpp:30
clang::tidy::bugprone::TooSmallLoopVariableCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
The matcher for loops with suspicious integer loop variable.
Definition: TooSmallLoopVariableCheck.cpp:53
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::bugprone::TooSmallLoopVariableCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: TooSmallLoopVariableCheck.cpp:35
clang::tidy::bugprone::TooSmallLoopVariableCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: TooSmallLoopVariableCheck.cpp:146
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27