File: misleading-capture-default-by-value.rst

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (48 lines) | stat: -rw-r--r-- 1,631 bytes parent folder | download | duplicates (12)
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
40
41
42
43
44
45
46
47
48
.. title:: clang-tidy - cppcoreguidelines-misleading-capture-default-by-value

cppcoreguidelines-misleading-capture-default-by-value
=====================================================

Warns when lambda specify a by-value capture default and capture ``this``.

By-value capture defaults in member functions can be misleading about whether
data members are captured by value or reference. This occurs because specifying
the capture default ``[=]`` actually captures the ``this`` pointer by value,
not the data members themselves. As a result, data members are still indirectly
accessed via the captured ``this`` pointer, which essentially means they are
being accessed by reference. Therefore, even when using ``[=]``, data members
are effectively captured by reference, which might not align with the user's
expectations.

Examples:

.. code-block:: c++

      struct AClass {
        int member;
        void misleadingLogic() {
          int local = 0;
          member = 0;
          auto f = [=]() mutable {
            local += 1;
            member += 1;
          };
          f();
          // Here, local is 0 but member is 1
        }

        void clearLogic() {
          int local = 0;
          member = 0;
          auto f = [this, local]() mutable {
            local += 1;
            member += 1;
          };
          f();
          // Here, local is 0 but member is 1
        }
      };

This check implements `F.54
<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#f54-when-writing-a-lambda-that-captures-this-or-any-class-data-member-dont-use--default-capture>`_
from the C++ Core Guidelines.