Page MenuHomePhabricator
Differential D72282 Diff 240691 clang-tools-extra/docs/clang-tidy/checks/bugprone-unintended-adl.rst

Changeset View

Standalone View

View Options

clang-tools-extra/docs/clang-tidy/checks/bugprone-unintended-adl.rst

  • This file was added.
.. title:: clang-tidy - bugprone-unintended-adl
bugprone-unintended-adl
=======================
Finds usages of ADL (argument-dependent lookup), or potential ADL in the case
of templates, that are not on the provided whitelist.
Eugene.ZelenkoUnsubmitted
Done
ReplyInline Actions

Please follow 80 character length limit. Same below.

Eugene.Zelenko: Please follow 80 character length limit. Same below.
.. code-block:: c++
namespace aspace {
struct A {};
void func(const A &);
} // namespace aspace
namespace bspace {
void func(int);
void test() {
aspace::A a;
func(5);
func(a); // calls 'aspace::func' through ADL
}
} // namespace bspace
(Example respectfully borrowed from `Abseil TotW #49 <https://abseil.io/tips/49>`_.)
ADL can be surprising, and can lead to `subtle bugs
Eugene.ZelenkoUnsubmitted
Done
ReplyInline Actions

Please use double back-ticks for swap (or std::swap?).

Eugene.Zelenko: Please use double back-ticks for swap (or std::swap?).
<https://bugs.llvm.org/show_bug.cgi?id=44398>`_ without the utmost attention.
However, it very is useful for lookup of overloaded operators, and for
customization points within libraries (e.g. ``swap`` in the C++ standard
library). As such, this check can be configured to ignore calls to overloaded
operators as well as other legitimate uses of ADL specified in a whitelist.
This check does not suggest any fixes.
Options
Eugene.ZelenkoUnsubmitted
Done
ReplyInline Actions

Indentation. Please use double back-ticks for a + b and operator+(a, b).

Eugene.Zelenko: Indentation. Please use double back-ticks for a + b and operator+(a, b).
logan-5AuthorUnsubmitted
Done
ReplyInline Actions

I'm not sure what you would like me to change about the indentation. This follows the same format (three spaces) I've found in the documentation for other checks.

logan-5: I'm not sure what you would like me to change about the indentation. This follows the same…
-------
.. option:: IgnoreOverloadedOperators
Eugene.ZelenkoUnsubmitted
Done
ReplyInline Actions

Indentation. Please use double back-ticks for swap (or std::swap?).

Eugene.Zelenko: Indentation. Please use double back-ticks for swap (or std::swap?).
logan-5AuthorUnsubmitted
Done
ReplyInline Actions

Since the 'swap' here is referring to the default value of the option string, shouldn't it just be single backticks?

logan-5: Since the 'swap' here is referring to the default value of the option string, shouldn't it just…
Eugene.ZelenkoUnsubmitted
Done
ReplyInline Actions

It was about swap above, not about option default value.

Eugene.Zelenko: It was about swap above, not about option default value.
If non-zero, ignores calls to overloaded operators using operator syntax
(e.g. ``a + b``), but not function call syntax (e.g. ``operator+(a, b)``).
Default is `1`.
.. option:: Whitelist
Semicolon-separated list of names that the check ignores. Default is
`swap;make_error_code;make_error_condition;data;begin;end;rbegin;rend;crbegin;crend;size;ssize;empty`.