clang-tools
15.0.0git
llvm-project
clang-tools-extra
clang-tidy
cppcoreguidelines
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
24
class
ProBoundsConstantArrayIndexCheck
:
public
ClangTidyCheck
{
25
const
StringRef GslHeader;
26
utils::IncludeInserter
Inserter;
27
28
public
:
29
ProBoundsConstantArrayIndexCheck
(StringRef
Name
,
ClangTidyContext
*Context);
30
bool
isLanguageVersionSupported
(
const
LangOptions &
LangOpts
)
const override
{
31
return
LangOpts
.CPlusPlus;
32
}
33
void
registerPPCallbacks
(
const
SourceManager &SM, Preprocessor *
PP
,
34
Preprocessor *ModuleExpanderPP)
override
;
35
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
36
void
storeOptions
(
ClangTidyOptions::OptionMap
&Opts)
override
;
37
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
38
};
39
40
}
// namespace cppcoreguidelines
41
}
// namespace tidy
42
}
// namespace clang
43
44
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_PRO_BOUNDS_CONSTANT_ARRAY_INDEX_H
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition:
ClangTidyOptions.h:115
clang::tidy::utils::IncludeInserter
Produces fixes to insert specified includes to source files, if not yet present.
Definition:
IncludeInserter.h:55
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
ProBoundsConstantArrayIndexCheck.cpp:39
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:53
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::ProBoundsConstantArrayIndexCheck
ProBoundsConstantArrayIndexCheck(StringRef Name, ClangTidyContext *Context)
Definition:
ProBoundsConstantArrayIndexCheck.cpp:21
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition:
ProBoundsConstantArrayIndexCheck.h:30
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:66
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
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition:
ProBoundsConstantArrayIndexCheck.cpp:34
Name
Token Name
Definition:
MacroToEnumCheck.cpp:89
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition:
BadSignalToKillThreadCheck.cpp:29
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
LangOpts
const LangOptions * LangOpts
Definition:
ExtractFunction.cpp:366
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:59
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:24
Generated on Thu May 19 2022 20:15:05 for clang-tools by
1.8.17