clang-tools-extra/clang-tidy/cppcoreguidelines/ProBoundsConstantArrayIndexCheck.h

   1 //===--- ProBoundsConstantArrayIndexCheck.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_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include "../utils/IncludeInserter.h"
  14
  15 namespace clang {
  16 namespace tidy {
  17 namespace cppcoreguidelines {
  18
  19 /// This checks that all array subscriptions on static arrays and std::arrays
  20 /// have a constant index and are within bounds
  21 ///
  22 /// For the user-facing documentation see:
  23 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/pro-bounds-constant-array-index.html
  24 class ProBoundsConstantArrayIndexCheck : public ClangTidyCheck {
  25   const StringRef GslHeader;
  26   utils::IncludeInserter Inserter;
  27
  28 public:
  29   ProBoundsConstantArrayIndexCheck(StringRef Name, ClangTidyContext *Context);
  30   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  31     return LangOpts.CPlusPlus;
  32   }
  33   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  34                            Preprocessor *ModuleExpanderPP) override;
  35   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  36   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  37   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  38 };
  39
  40 } // namespace cppcoreguidelines
  41 } // namespace tidy
  42 } // namespace clang
  43
  44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H