| 1 |
.. title:: clang-tidy - bugprone-too-small-loop-variable |
| 2 |
|
| 3 |
bugprone-too-small-loop-variable |
| 4 |
================================ |
| 5 |
|
| 6 |
Detects those ``for`` loops that have a loop variable with a "too small" type |
| 7 |
which means this type can't represent all values which are part of the |
| 8 |
iteration range. |
| 9 |
|
| 10 |
.. code-block:: c++ |
| 11 |
|
| 12 |
int main() { |
| 13 |
long size = 294967296l; |
| 14 |
for (short i = 0; i < size; ++i) {} |
| 15 |
} |
| 16 |
|
| 17 |
This ``for`` loop is an infinite loop because the ``short`` type can't represent |
| 18 |
all values in the ``[0..size]`` interval. |
| 19 |
|
| 20 |
In a real use case size means a container's size which depends on the user input. |
| 21 |
|
| 22 |
.. code-block:: c++ |
| 23 |
|
| 24 |
int doSomething(const std::vector& items) { |
| 25 |
for (short i = 0; i < items.size(); ++i) {} |
| 26 |
} |
| 27 |
|
| 28 |
This algorithm works for a small amount of objects, but will lead to freeze for |
| 29 |
a larger user input. |
| 30 |
|
| 31 |
.. option:: MagnitudeBitsUpperLimit |
| 32 |
|
| 33 |
Upper limit for the magnitude bits of the loop variable. If it's set the check |
| 34 |
filters out those catches in which the loop variable's type has more magnitude |
| 35 |
bits as the specified upper limit. The default value is 16. |
| 36 |
For example, if the user sets this option to 31 (bits), then a 32-bit ``unsigned int`` |
| 37 |
is ignored by the check, however a 32-bit ``int`` is not (A 32-bit ``signed int`` |
| 38 |
has 31 magnitude bits). |
| 39 |
|
| 40 |
.. code-block:: c++ |
| 41 |
|
| 42 |
int main() { |
| 43 |
long size = 294967296l; |
| 44 |
for (unsigned i = 0; i < size; ++i) {} // no warning with MagnitudeBitsUpperLimit = 31 on a system where unsigned is 32-bit |
| 45 |
for (int i = 0; i < size; ++i) {} // warning with MagnitudeBitsUpperLimit = 31 on a system where int is 32-bit |
| 46 |
} |