clang-tools  14.0.0git
Public Member Functions | List of all members
clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck Class Reference

This checks that all array subscriptions on static arrays and std::arrays have a constant index and are within bounds. More...

#include <ProBoundsConstantArrayIndexCheck.h>

Inheritance diagram for clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck:
Collaboration graph
[legend]

Public Member Functions

 ProBoundsConstantArrayIndexCheck (StringRef Name, ClangTidyContext *Context)
 
bool isLanguageVersionSupported (const LangOptions &LangOpts) const override
 Override this to disable registering matchers and PP callbacks if an invalid language version is being used. More...
 
void registerPPCallbacks (const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
 Override this to register PPCallbacks in the preprocessor. More...
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void storeOptions (ClangTidyOptions::OptionMap &Opts) override
 Should store all options supported by this check with their current values or default values for options that haven't been overridden. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 
DiagnosticBuilder configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const
 Adds a diagnostic to report errors in the check's configuration. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit. More...
 
const LangOptions & getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

This checks that all array subscriptions on static arrays and std::arrays have a constant index and are within bounds.

For the user-facing documentation see: http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.html

Definition at line 24 of file ProBoundsConstantArrayIndexCheck.h.

Constructor & Destructor Documentation

◆ ProBoundsConstantArrayIndexCheck()

clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::ProBoundsConstantArrayIndexCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 21 of file ProBoundsConstantArrayIndexCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
overridevirtual

ClangTidyChecks that register ASTMatchers should do the actual work in here.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 58 of file ProBoundsConstantArrayIndexCheck.cpp.

◆ isLanguageVersionSupported()

bool clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::isLanguageVersionSupported ( const LangOptions &  LangOpts) const
inlineoverridevirtual

Override this to disable registering matchers and PP callbacks if an invalid language version is being used.

For example if a check is examining overloaded functions then this should be overridden to return false when the CPlusPlus flag is not set in LangOpts.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 30 of file ProBoundsConstantArrayIndexCheck.h.

◆ registerMatchers()

void clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::registerMatchers ( ast_matchers::MatchFinder *  Finder)
overridevirtual

Override this to register AST matchers with Finder.

This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.

You can register as many matchers as necessary with Finder. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.

This will only be executed if the function isLanguageVersionSupported returns true.

If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 38 of file ProBoundsConstantArrayIndexCheck.cpp.

◆ registerPPCallbacks()

void clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::registerPPCallbacks ( const SourceManager &  SM,
Preprocessor *  PP,
Preprocessor *  ModuleExpanderPP 
)
overridevirtual

Override this to register PPCallbacks in the preprocessor.

This should be used for clang-tidy checks that analyze preprocessor- dependent properties, e.g. include directives and macro definitions.

This will only be executed if the function isLanguageVersionSupported returns true.

There are two Preprocessors to choose from that differ in how they handle modular #includes:

  • PP is the real Preprocessor. It doesn't walk into modular #includes and thus doesn't generate PPCallbacks for their contents.
  • ModuleExpanderPP preprocesses the whole translation unit in the non-modular mode, which allows it to generate PPCallbacks not only for the main file and textual headers, but also for all transitively included modular headers when the analysis runs with modules enabled. When modules are not enabled ModuleExpanderPP just points to the real preprocessor.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 33 of file ProBoundsConstantArrayIndexCheck.cpp.

References clang::tidy::bugprone::PP, and clang::tidy::utils::IncludeInserter::registerPreprocessor().

◆ storeOptions()

void clang::tidy::cppcoreguidelines::ProBoundsConstantArrayIndexCheck::storeOptions ( ClangTidyOptions::OptionMap Options)
overridevirtual

Should store all options supported by this check with their current values or default values for options that haven't been overridden.

The check should use Options.store() to store each option it supports whether it has the default value or it has been overridden.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 27 of file ProBoundsConstantArrayIndexCheck.cpp.


The documentation for this class was generated from the following files: