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