[clang-tidy] Ignore overriden methods in `readability-const-return-type`.

Overrides are constrained by the signature of the overridden method, so a
warning on an override is frequently unactionable.

Differential Revision: https://reviews.llvm.org/D137968
This commit is contained in:
Thomas Etter 2022-11-14 18:56:07 +00:00 committed by Yitzhak Mandelbaum
parent e05ce03cfa
commit f3afd16b65
3 changed files with 21 additions and 5 deletions

View File

@ -114,7 +114,9 @@ void ConstReturnTypeCheck::registerMatchers(MatchFinder *Finder) {
Finder->addMatcher(
functionDecl(
returns(allOf(isConstQualified(), unless(NonLocalConstType))),
anyOf(isDefinition(), cxxMethodDecl(isPure())))
anyOf(isDefinition(), cxxMethodDecl(isPure())),
// Overridden functions are not actionable.
unless(cxxMethodDecl(isOverride())))
.bind("func"),
this);
}

View File

@ -171,6 +171,11 @@ Changes in existing checks
:doc:`readability-simplify-boolean-expr <clang-tidy/checks/readability/simplify-boolean-expr>`
when using a C++23 ``if consteval`` statement.
- Change the behavior of :doc:`readability-const-return-type
<clang-tidy/checks/readability/const-return-type>` to not
warn about `const` return types in overridden functions since the derived
class cannot always choose to change the function signature.
- Improved :doc:`misc-redundant-expression <clang-tidy/checks/misc/redundant-expression>`
check.

View File

@ -279,13 +279,22 @@ public:
// CHECK-NOT-FIXES: virtual int getC() = 0;
};
class PVDerive : public PVBase {
class NVDerive : public PVBase {
public:
const int getC() { return 1; }
// CHECK-MESSAGES: [[@LINE-1]]:3: warning: return type 'const int' is 'const'-qualified at the top level, which may reduce code readability without improving const correctness
// CHECK-NOT-FIXES: int getC() { return 1; }
// Don't warn about overridden methods, because it may be impossible to make
// them non-const as the user may not be able to change the base class.
const int getC() override { return 1; }
};
class NVDeriveOutOfLine : public PVBase {
public:
// Don't warn about overridden methods, because it may be impossible to make
// them non-const as one may not be able to change the base class
const int getC();
};
const int NVDeriveOutOfLine::getC() { return 1; }
// Don't warn about const auto types, because it may be impossible to make them non-const
// without a significant semantics change. Since `auto` drops cv-qualifiers,
// tests check `decltype(auto)`.