File: virtual-class-destructor.rst

package info (click to toggle)
llvm-toolchain-15 1%3A15.0.6-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,554,644 kB
  • sloc: cpp: 5,922,452; ansic: 1,012,136; asm: 674,362; python: 191,568; objc: 73,855; f90: 42,327; lisp: 31,913; pascal: 11,973; javascript: 10,144; sh: 9,421; perl: 7,447; ml: 5,527; awk: 3,523; makefile: 2,520; xml: 885; cs: 573; fortran: 567
file content (57 lines) | stat: -rw-r--r-- 1,641 bytes parent folder | download | duplicates (5)
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
49
50
51
52
53
54
55
56
57
.. title:: clang-tidy - cppcoreguidelines-virtual-class-destructor

cppcoreguidelines-virtual-class-destructor
===============================================

Finds virtual classes whose destructor is neither public and virtual
nor protected and non-virtual. A virtual class's destructor should be specified
in one of these ways to prevent undefined behavior.

This check implements
`C.35 <http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rc-dtor-virtual>`_
from the CppCoreGuidelines.

Note that this check will diagnose a class with a virtual method regardless of
whether the class is used as a base class or not.

Fixes are available for user-declared and implicit destructors that are either
public and non-virtual or protected and virtual. No fixes are offered for
private destructors. There, the decision whether to make them private and
virtual or protected and non-virtual depends on the use case and is thus left
to the user.

Example
-------

For example, the following classes/structs get flagged by the check since they
violate guideline **C.35**:

.. code-block:: c++

  struct Foo {        // NOK, protected destructor should not be virtual
    virtual void f();
  protected:
    virtual ~Foo(){}
  };

  class Bar {         // NOK, public destructor should be virtual
    virtual void f();
  public:
    ~Bar(){}
  };

This would be rewritten to look like this:

.. code-block:: c++

  struct Foo {        // OK, destructor is not virtual anymore
    virtual void f();
  protected:
    ~Foo(){}
  };

  class Bar {         // OK, destructor is now virtual
    virtual void f();
  public:
    virtual ~Bar(){}
  };