summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst
blob: 979f8af4fb1f25c9a713200b02811e5ae684c02f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
.. title:: clang-tidy - cppcoreguidelines-pro-bounds-constant-array-index

cppcoreguidelines-pro-bounds-constant-array-index
=================================================

This check flags all array subscript expressions on static arrays and
std::arrays that either do not have a constant integer expression index or
are out of bounds (for std::array). For out-of-bounds checking of static
arrays, see the clang-diagnostic-array-bounds check.

The check can generate fixes after the option
cppcoreguidelines-pro-bounds-constant-array-index.GslHeader has been
set to the name of the include file that contains gsl::at(), e.g. "gsl/gsl.h".

This rule is part of the "Bounds safety" profile of the C++ Core Guidelines, see
https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#-bounds2-only-index-into-arrays-using-constant-expressions.
OpenPOWER on IntegriCloud