File: cert-oop57-cpp.rst

package info (click to toggle)
llvm-toolchain-11 1%3A11.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 995,808 kB
  • sloc: cpp: 4,767,656; ansic: 760,916; asm: 477,436; python: 170,940; objc: 69,804; lisp: 29,914; sh: 23,855; f90: 18,173; pascal: 7,551; perl: 7,471; ml: 5,603; awk: 3,489; makefile: 2,573; xml: 915; cs: 573; fortran: 503; javascript: 452
file content (40 lines) | stat: -rw-r--r-- 1,429 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
.. title:: clang-tidy - cert-oop57-cpp

cert-oop57-cpp
==============

  Flags use of the `C` standard library functions ``memset``, ``memcpy`` and
  ``memcmp`` and similar derivatives on non-trivial types.

Options
-------

.. option:: MemSetNames

   Specify extra functions to flag that act similarily to ``memset``.
   Specify names in a semicolon delimited list.
   Default is an empty string.
   The check will detect the following functions:
   `memset`, `std::memset`.

.. option:: MemCpyNames

   Specify extra functions to flag that act similarily to ``memcpy``.
   Specify names in a semicolon delimited list.
   Default is an empty string.
   The check will detect the following functions:
   `std::memcpy`, `memcpy`, `std::memmove`, `memmove`, `std::strcpy`,
   `strcpy`, `memccpy`, `stpncpy`, `strncpy`.

.. option:: MemCmpNames

   Specify extra functions to flag that act similarily to ``memcmp``.
   Specify names in a semicolon delimited list.
   Default is an empty string.
   The check will detect the following functions:
   `std::memcmp`, `memcmp`, `std::strcmp`, `strcmp`, `strncmp`.

This check corresponds to the CERT C++ Coding Standard rule
`OOP57-CPP. Prefer special member functions and overloaded operators to C 
Standard Library functions
<https://wiki.sei.cmu.edu/confluence/display/cplusplus/OOP57-CPP.+Prefer+special+member+functions+and+overloaded+operators+to+C+Standard+Library+functions>`_.