clang-tools
5.0.0
Main Page
Namespaces
Classes
Files
File List
File Members
llvm.src
tools
clang
tools
extra
clang-tidy
cppcoreguidelines
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
25
class
ProBoundsConstantArrayIndexCheck
:
public
ClangTidyCheck
{
26
const
std::string GslHeader;
27
const
utils::IncludeSorter::IncludeStyle
IncludeStyle;
28
std::unique_ptr<utils::IncludeInserter> Inserter;
29
30
public
:
31
ProBoundsConstantArrayIndexCheck
(StringRef
Name
,
ClangTidyContext
*
Context
);
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
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition:
ProBoundsConstantArrayIndexCheck.cpp:28
Name
StringHandle Name
Definition:
PreprocessorTracker.cpp:525
Finder
std::unique_ptr< ast_matchers::MatchFinder > Finder
Definition:
ClangTidy.cpp:275
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
ProBoundsConstantArrayIndexCheck.cpp:67
clang::tidy::utils::IncludeSorter::IncludeStyle
IncludeStyle
Supported include styles.
Definition:
IncludeSorter.h:27
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidy.h:127
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::ProBoundsConstantArrayIndexCheck
ProBoundsConstantArrayIndexCheck(StringRef Name, ClangTidyContext *Context)
Definition:
ProBoundsConstantArrayIndexCheck.cpp:22
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition:
ClangTidyOptions.h:99
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::registerPPCallbacks
void registerPPCallbacks(CompilerInstance &Compiler) override
Override this to register PPCallbacks with Compiler.
Definition:
ProBoundsConstantArrayIndexCheck.cpp:34
Context
ClangTidyContext & Context
Definition:
ClangTidy.cpp:87
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:104
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
ProBoundsConstantArrayIndexCheck.cpp:44
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck
This checks that all array subscriptions on static arrays and std::arrays have a constant index and a...
Definition:
ProBoundsConstantArrayIndexCheck.h:25
Generated on Tue Sep 5 2017 11:44:54 for clang-tools by
1.8.6