clang-tools-extra/clang-tidy/bugprone/TooSmallLoopVariableCheck.h

   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::tidy::bugprone {
  15
  16 /// This check gives a warning if a loop variable has a too small type which
  17 /// might not be able to represent all values which are part of the whole range
  18 /// in which the loop iterates.
  19 /// If the loop variable's type is too small we might end up in an infinite
  20 /// loop. Example:
  21 /// \code
  22 ///   long size = 294967296l;
  23 ///   for (short i = 0; i < size; ++i) {} { ... }
  24 /// \endcode
  25 ///
  26 /// For the user-facing documentation see:
  27 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/too-small-loop-variable.html
  28 class TooSmallLoopVariableCheck : public ClangTidyCheck {
  29 public:
  30   TooSmallLoopVariableCheck(StringRef Name, ClangTidyContext *Context);
  31
  32   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  33   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  34   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  35
  36 private:
  37   const unsigned MagnitudeBitsUpperLimit;
  38 };
  39
  40 } // namespace clang::tidy::bugprone
  41
  42 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_TOOSMALLLOOPVARIABLECHECK_H