9bb5685b21
Summary: Bugzilla: https://bugs.llvm.org/show_bug.cgi?id=27702 I wasn't sure how this type of thing is usually tested. So any advice would be appreciated. `check-llvm`, `check-clang` and `check-clang-tools` are clean for me. **C++98** ``` tetsuo@garland-c-16-sgp1-01:~/dev/llvm-project/test$ cat compile_commands.json [ { "directory": "/home/tetsuo/dev/llvm-project/test", "command": "/usr/bin/c++ -std=gnu++98 -o CMakeFiles/test.dir/test.cpp.o -c /home/tetsuo/dev/llvm-project/test/test.cpp", "file": "/home/tetsuo/dev/llvm-project/test/test.cpp" } ] tetsuo@garland-c-16-sgp1-01:~/dev/llvm-project/test$ ../build/bin/clang-tidy --checks=misc-unconventional-assign-operator test.cpp 3053 warnings generated. /home/tetsuo/dev/llvm-project/test/test.cpp:7:3: warning: operator=() should take 'Foo const&' or 'Foo' [misc-unconventional-assign-operator] Foo &operator=(Foo &Other) { ^ Suppressed 3052 warnings (3052 in non-user code). Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well. ``` **C++17** ``` tetsuo@garland-c-16-sgp1-01:~/dev/llvm-project/test$ cat compile_commands.json [ { "directory": "/home/tetsuo/dev/llvm-project/test", "command": "/usr/bin/c++ -std=gnu++17 -o CMakeFiles/test.dir/test.cpp.o -c /home/tetsuo/dev/llvm-project/test/test.cpp", "file": "/home/tetsuo/dev/llvm-project/test/test.cpp" } ] tetsuo@garland-c-16-sgp1-01:~/dev/llvm-project/test$ ../build/bin/clang-tidy --checks=misc-unconventional-assign-operator test.cpp 5377 warnings generated. /home/tetsuo/dev/llvm-project/test/test.cpp:7:3: warning: operator=() should take 'Foo const&', 'Foo&&' or 'Foo' [misc-unconventional-assign-operator] Foo &operator=(Foo &Other) { ^ Suppressed 5376 warnings (5376 in non-user code). Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well. ``` Reviewers: njames93, MaskRay, alexfh, hokein, aaron.ballman Reviewed By: njames93 Subscribers: xazax.hun, cfe-commits Tags: #clang-tools-extra, #clang Differential Revision: https://reviews.llvm.org/D75901
97 lines
3.7 KiB
C++
97 lines
3.7 KiB
C++
//===--- UnconventionalAssignOperatorCheck.cpp - clang-tidy -----*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "UnconventionalAssignOperatorCheck.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "clang/ASTMatchers/ASTMatchers.h"
|
|
|
|
using namespace clang::ast_matchers;
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace misc {
|
|
|
|
void UnconventionalAssignOperatorCheck::registerMatchers(
|
|
ast_matchers::MatchFinder *Finder) {
|
|
const auto HasGoodReturnType = cxxMethodDecl(returns(lValueReferenceType(
|
|
pointee(unless(isConstQualified()),
|
|
anyOf(autoType(), hasDeclaration(equalsBoundNode("class")))))));
|
|
|
|
const auto IsSelf = qualType(
|
|
anyOf(hasDeclaration(equalsBoundNode("class")),
|
|
referenceType(pointee(hasDeclaration(equalsBoundNode("class"))))));
|
|
const auto IsAssign =
|
|
cxxMethodDecl(unless(anyOf(isDeleted(), isPrivate(), isImplicit())),
|
|
hasName("operator="), ofClass(recordDecl().bind("class")))
|
|
.bind("method");
|
|
const auto IsSelfAssign =
|
|
cxxMethodDecl(IsAssign, hasParameter(0, parmVarDecl(hasType(IsSelf))))
|
|
.bind("method");
|
|
|
|
Finder->addMatcher(
|
|
cxxMethodDecl(IsAssign, unless(HasGoodReturnType)).bind("ReturnType"),
|
|
this);
|
|
|
|
const auto BadSelf = referenceType(
|
|
anyOf(lValueReferenceType(pointee(unless(isConstQualified()))),
|
|
rValueReferenceType(pointee(isConstQualified()))));
|
|
|
|
Finder->addMatcher(
|
|
cxxMethodDecl(IsSelfAssign,
|
|
hasParameter(0, parmVarDecl(hasType(BadSelf))))
|
|
.bind("ArgumentType"),
|
|
this);
|
|
|
|
Finder->addMatcher(
|
|
cxxMethodDecl(IsSelfAssign, anyOf(isConst(), isVirtual())).bind("cv"),
|
|
this);
|
|
|
|
const auto IsBadReturnStatement = returnStmt(unless(has(ignoringParenImpCasts(
|
|
anyOf(unaryOperator(hasOperatorName("*"), hasUnaryOperand(cxxThisExpr())),
|
|
cxxOperatorCallExpr(argumentCountIs(1),
|
|
callee(unresolvedLookupExpr()),
|
|
hasArgument(0, cxxThisExpr())),
|
|
cxxOperatorCallExpr(
|
|
hasOverloadedOperatorName("="),
|
|
hasArgument(
|
|
0, unaryOperator(hasOperatorName("*"),
|
|
hasUnaryOperand(cxxThisExpr())))))))));
|
|
const auto IsGoodAssign = cxxMethodDecl(IsAssign, HasGoodReturnType);
|
|
|
|
Finder->addMatcher(returnStmt(IsBadReturnStatement, forFunction(IsGoodAssign))
|
|
.bind("returnStmt"),
|
|
this);
|
|
}
|
|
|
|
void UnconventionalAssignOperatorCheck::check(
|
|
const MatchFinder::MatchResult &Result) {
|
|
if (const auto *RetStmt = Result.Nodes.getNodeAs<ReturnStmt>("returnStmt")) {
|
|
diag(RetStmt->getBeginLoc(), "operator=() should always return '*this'");
|
|
} else {
|
|
static const char *const Messages[][2] = {
|
|
{"ReturnType", "operator=() should return '%0&'"},
|
|
{"ArgumentType",
|
|
getLangOpts().CPlusPlus11
|
|
? "operator=() should take '%0 const&', '%0&&' or '%0'"
|
|
: "operator=() should take '%0 const&' or '%0'"},
|
|
{"cv", "operator=() should not be marked '%1'"}};
|
|
|
|
const auto *Method = Result.Nodes.getNodeAs<CXXMethodDecl>("method");
|
|
for (const auto &Message : Messages) {
|
|
if (Result.Nodes.getNodeAs<Decl>(Message[0]))
|
|
diag(Method->getBeginLoc(), Message[1])
|
|
<< Method->getParent()->getName()
|
|
<< (Method->isConst() ? "const" : "virtual");
|
|
}
|
|
}
|
|
}
|
|
|
|
} // namespace misc
|
|
} // namespace tidy
|
|
} // namespace clang
|