clang-tools  11.0.0git
ProBoundsConstantArrayIndexCheck.h
Go to the documentation of this file.
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
25  const std::string GslHeader;
26  const utils::IncludeSorter::IncludeStyle IncludeStyle;
27  std::unique_ptr<utils::IncludeInserter> Inserter;
28 
29 public:
31  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
32  return LangOpts.CPlusPlus;
33  }
34  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
35  Preprocessor *ModuleExpanderPP) override;
36  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
37  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
38  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
39 };
40 
41 } // namespace cppcoreguidelines
42 } // namespace tidy
43 } // namespace clang
44 
45 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
IncludeStyle
Supported include styles.
Definition: IncludeSorter.h:26
Base class for all clang-tidy checks.
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
static constexpr llvm::StringLiteral Name
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
std::map< std::string, ClangTidyValue > OptionMap
This checks that all array subscriptions on static arrays and std::arrays have a constant index and a...