clang-tidy/cppcoreguidelines/ProBoundsConstantArrayIndexCheck.h

0001 //===--- ProBoundsConstantArrayIndexCheck.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_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "../utils/IncludeInserter.h"
0014
0015 namespace clang::tidy::cppcoreguidelines {
0016
0017 /// This checks that all array subscriptions on static arrays and std::arrays
0018 /// have a constant index and are within bounds
0019 ///
0020 /// For the user-facing documentation see:
0021 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/pro-bounds-constant-array-index.html
0022 class ProBoundsConstantArrayIndexCheck : public ClangTidyCheck {
0023   const StringRef GslHeader;
0024   utils::IncludeInserter Inserter;
0025
0026 public:
0027   ProBoundsConstantArrayIndexCheck(StringRef Name, ClangTidyContext *Context);
0028   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0029     return LangOpts.CPlusPlus;
0030   }
0031   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
0032                            Preprocessor *ModuleExpanderPP) override;
0033   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0034   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0035   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0036 };
0037
0038 } // namespace clang::tidy::cppcoreguidelines
0039
0040 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H