clang-tools  5.0.0
ProBoundsConstantArrayIndexCheck.h
Go to the documentation of this file.
1 //===--- ProBoundsConstantArrayIndexCheck.h - clang-tidy---------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
12 
13 #include "../ClangTidy.h"
14 #include "../utils/IncludeInserter.h"
15 
16 namespace clang {
17 namespace tidy {
18 namespace cppcoreguidelines {
19 
20 /// This checks that all array subscriptions on static arrays and std::arrays
21 /// have a constant index and are within bounds
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.html
26  const std::string GslHeader;
27  const utils::IncludeSorter::IncludeStyle IncludeStyle;
28  std::unique_ptr<utils::IncludeInserter> Inserter;
29 
30 public:
32  void registerPPCallbacks(CompilerInstance &Compiler) 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 cppcoreguidelines
39 } // namespace tidy
40 } // namespace clang
41 
42 #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...
StringHandle Name
std::unique_ptr< ast_matchers::MatchFinder > Finder
Definition: ClangTidy.cpp:275
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:27
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
std::map< std::string, std::string > OptionMap
void registerPPCallbacks(CompilerInstance &Compiler) override
Override this to register PPCallbacks with Compiler.
ClangTidyContext & Context
Definition: ClangTidy.cpp:87
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.
This checks that all array subscriptions on static arrays and std::arrays have a constant index and a...