llvm-project/clang-tools-extra/docs/clang-tidy/checks/bugprone-string-constructor...

45 lines
1.1 KiB
ReStructuredText

.. title:: clang-tidy - bugprone-string-constructor
bugprone-string-constructor
===========================
Finds string constructors that are suspicious and probably errors.
A common mistake is to swap parameters to the 'fill' string-constructor.
Examples:
.. code-block:: c++
std::string str('x', 50); // should be str(50, 'x')
Calling the string-literal constructor with a length bigger than the literal is
suspicious and adds extra random characters to the string.
Examples:
.. code-block:: c++
std::string("test", 200); // Will include random characters after "test".
Creating an empty string from constructors with parameters is considered
suspicious. The programmer should use the empty constructor instead.
Examples:
.. code-block:: c++
std::string("test", 0); // Creation of an empty string.
Options
-------
.. option:: WarnOnLargeLength
When non-zero, the check will warn on a string with a length greater than
`LargeLengthThreshold`. Default is `1`.
.. option:: LargeLengthThreshold
An integer specifying the large length threshold. Default is `0x800000`.