File: avoid-do-while.rst

package info (click to toggle)
llvm-toolchain-19 1%3A19.1.7-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,998,520 kB
  • sloc: cpp: 6,951,680; ansic: 1,486,157; asm: 913,598; python: 232,024; f90: 80,126; objc: 75,281; lisp: 37,276; pascal: 16,990; sh: 10,009; ml: 5,058; perl: 4,724; awk: 3,523; makefile: 3,167; javascript: 2,504; xml: 892; fortran: 664; cs: 573
file content (39 lines) | stat: -rw-r--r-- 860 bytes parent folder | download | duplicates (14) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
.. title:: clang-tidy - cppcoreguidelines-avoid-do-while

cppcoreguidelines-avoid-do-while
================================

Warns when using ``do-while`` loops. They are less readable than plain ``while``
loops, since the termination condition is at the end and the condition is not
checked prior to the first iteration. This can lead to subtle bugs.

This check implements `ES.75
<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Res-do>`_
from the C++ Core Guidelines.

Examples:

.. code-block:: c++

  int x;
  do {
      std::cin >> x;
      // ...
  } while (x < 0);

Options
-------

.. option:: IgnoreMacros

  Ignore the check when analyzing macros. This is useful for safely defining function-like macros:

  .. code-block:: c++

    #define FOO_BAR(x) \
    do { \
      foo(x); \
      bar(x); \
    } while(0)

  Defaults to `false`.