clang-tidy/bugprone/TooSmallLoopVariableCheck.h

0001 //===--- TooSmallLoopVariableCheck.h - clang-tidy ---------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::bugprone {
0015
0016 /// This check gives a warning if a loop variable has a too small type which
0017 /// might not be able to represent all values which are part of the whole range
0018 /// in which the loop iterates.
0019 /// If the loop variable's type is too small we might end up in an infinite
0020 /// loop. Example:
0021 /// \code
0022 ///   long size = 294967296l;
0023 ///   for (short i = 0; i < size; ++i) {} { ... }
0024 /// \endcode
0025 ///
0026 /// For the user-facing documentation see:
0027 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/too-small-loop-variable.html
0028 class TooSmallLoopVariableCheck : public ClangTidyCheck {
0029 public:
0030   TooSmallLoopVariableCheck(StringRef Name, ClangTidyContext *Context);
0031
0032   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0033   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0034   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0035
0036 private:
0037   const unsigned MagnitudeBitsUpperLimit;
0038 };
0039
0040 } // namespace clang::tidy::bugprone
0041
0042 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H