mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-19 19:45:40 -04:00

The check warns when (a member of) the copied object is assigned to in a copy constructor or copy assignment operator. Based on https://wiki.sei.cmu.edu/confluence/display/cplusplus/OOP58-CPP.+Copy+operations+must+not+mutate+the+source+object Differential Revision: https://reviews.llvm.org/D70052
84 lines
3.1 KiB
C++
84 lines
3.1 KiB
C++
//===--- MutatingCopyCheck.cpp - clang-tidy -------------------------------===//
|
|
//
|
|
// 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 "MutatingCopyCheck.h"
|
|
#include "clang/AST/ASTContext.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
|
|
using namespace clang::ast_matchers;
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace cert {
|
|
|
|
static constexpr llvm::StringLiteral SourceDeclName = "ChangedPVD";
|
|
static constexpr llvm::StringLiteral MutatingOperatorName = "MutatingOp";
|
|
static constexpr llvm::StringLiteral MutatingCallName = "MutatingCall";
|
|
|
|
void MutatingCopyCheck::registerMatchers(MatchFinder *Finder) {
|
|
if (!getLangOpts().CPlusPlus)
|
|
return;
|
|
|
|
const auto MemberExprOrSourceObject = anyOf(
|
|
memberExpr(), declRefExpr(to(decl(equalsBoundNode(SourceDeclName)))));
|
|
|
|
const auto IsPartOfSource =
|
|
allOf(unless(hasDescendant(expr(unless(MemberExprOrSourceObject)))),
|
|
MemberExprOrSourceObject);
|
|
|
|
const auto IsSourceMutatingAssignment =
|
|
expr(anyOf(binaryOperator(isAssignmentOperator(), hasLHS(IsPartOfSource))
|
|
.bind(MutatingOperatorName),
|
|
cxxOperatorCallExpr(isAssignmentOperator(),
|
|
hasArgument(0, IsPartOfSource))
|
|
.bind(MutatingOperatorName)));
|
|
|
|
const auto MemberExprOrSelf = anyOf(memberExpr(), cxxThisExpr());
|
|
|
|
const auto IsPartOfSelf = allOf(
|
|
unless(hasDescendant(expr(unless(MemberExprOrSelf)))), MemberExprOrSelf);
|
|
|
|
const auto IsSelfMutatingAssignment =
|
|
expr(anyOf(binaryOperator(isAssignmentOperator(), hasLHS(IsPartOfSelf)),
|
|
cxxOperatorCallExpr(isAssignmentOperator(),
|
|
hasArgument(0, IsPartOfSelf))));
|
|
|
|
const auto IsSelfMutatingMemberFunction =
|
|
functionDecl(hasBody(hasDescendant(IsSelfMutatingAssignment)));
|
|
|
|
const auto IsSourceMutatingMemberCall =
|
|
cxxMemberCallExpr(on(IsPartOfSource),
|
|
callee(IsSelfMutatingMemberFunction))
|
|
.bind(MutatingCallName);
|
|
|
|
const auto MutatesSource = allOf(
|
|
hasParameter(
|
|
0, parmVarDecl(hasType(lValueReferenceType())).bind(SourceDeclName)),
|
|
anyOf(forEachDescendant(IsSourceMutatingAssignment),
|
|
forEachDescendant(IsSourceMutatingMemberCall)));
|
|
|
|
Finder->addMatcher(cxxConstructorDecl(isCopyConstructor(), MutatesSource),
|
|
this);
|
|
|
|
Finder->addMatcher(cxxMethodDecl(isCopyAssignmentOperator(), MutatesSource),
|
|
this);
|
|
}
|
|
|
|
void MutatingCopyCheck::check(const MatchFinder::MatchResult &Result) {
|
|
if (const auto *MemberCall =
|
|
Result.Nodes.getNodeAs<CXXMemberCallExpr>(MutatingCallName))
|
|
diag(MemberCall->getBeginLoc(), "call mutates copied object");
|
|
else if (const auto *Assignment =
|
|
Result.Nodes.getNodeAs<Expr>(MutatingOperatorName))
|
|
diag(Assignment->getBeginLoc(), "mutating copied object");
|
|
}
|
|
|
|
} // namespace cert
|
|
} // namespace tidy
|
|
} // namespace clang
|