forked from OSchip/llvm-project
[clang-tidy][NFC] Reimplement SimplifyBooleanExpr with RecursiveASTVisitors
Reimplement the matching logic using Visitors instead of matchers. Benchmarks from running the check over SemaCodeComplete.cpp Before 0.20s, After 0.04s Reviewed By: aaron.ballman Differential Revision: https://reviews.llvm.org/D125026
This commit is contained in:
Nathan James
parent
ff3f4988ed
commit
6f87261919
|
|
@ -7,7 +7,6 @@
|
|||
//===----------------------------------------------------------------------===//
|
||||
|
||||
#include "SimplifyBooleanExprCheck.h"
|
||||
#include "SimplifyBooleanExprMatchers.h"
|
||||
#include "clang/AST/RecursiveASTVisitor.h"
|
||||
#include "clang/Lex/Lexer.h"
|
||||
|
||||
|
|
@ -22,46 +21,18 @@ namespace readability {
|
|||
|
||||
namespace {
|
||||
|
||||
StringRef getText(const MatchFinder::MatchResult &Result, SourceRange Range) {
|
||||
StringRef getText(const ASTContext &Context, SourceRange Range) {
|
||||
return Lexer::getSourceText(CharSourceRange::getTokenRange(Range),
|
||||
*Result.SourceManager,
|
||||
Result.Context->getLangOpts());
|
||||
Context.getSourceManager(),
|
||||
Context.getLangOpts());
|
||||
}
|
||||
|
||||
template <typename T>
|
||||
StringRef getText(const MatchFinder::MatchResult &Result, T &Node) {
|
||||
return getText(Result, Node.getSourceRange());
|
||||
template <typename T> StringRef getText(const ASTContext &Context, T &Node) {
|
||||
return getText(Context, Node.getSourceRange());
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
static constexpr char ConditionThenStmtId[] = "if-bool-yields-then";
|
||||
static constexpr char ConditionElseStmtId[] = "if-bool-yields-else";
|
||||
static constexpr char TernaryId[] = "ternary-bool-yields-condition";
|
||||
static constexpr char TernaryNegatedId[] = "ternary-bool-yields-not-condition";
|
||||
static constexpr char IfReturnsBoolId[] = "if-return";
|
||||
static constexpr char IfReturnsNotBoolId[] = "if-not-return";
|
||||
static constexpr char ThenLiteralId[] = "then-literal";
|
||||
static constexpr char IfAssignVariableId[] = "if-assign-lvalue";
|
||||
static constexpr char IfAssignLocId[] = "if-assign-loc";
|
||||
static constexpr char IfAssignBoolId[] = "if-assign";
|
||||
static constexpr char IfAssignNotBoolId[] = "if-assign-not";
|
||||
static constexpr char IfAssignVarId[] = "if-assign-var";
|
||||
static constexpr char CompoundReturnId[] = "compound-return";
|
||||
static constexpr char CompoundIfId[] = "compound-if";
|
||||
static constexpr char CompoundBoolId[] = "compound-bool";
|
||||
static constexpr char CompoundNotBoolId[] = "compound-bool-not";
|
||||
static constexpr char CaseId[] = "case";
|
||||
static constexpr char CaseCompoundBoolId[] = "case-compound-bool";
|
||||
static constexpr char CaseCompoundNotBoolId[] = "case-compound-bool-not";
|
||||
static constexpr char DefaultId[] = "default";
|
||||
static constexpr char DefaultCompoundBoolId[] = "default-compound-bool";
|
||||
static constexpr char DefaultCompoundNotBoolId[] = "default-compound-bool-not";
|
||||
static constexpr char LabelId[] = "label";
|
||||
static constexpr char LabelCompoundBoolId[] = "label-compound-bool";
|
||||
static constexpr char LabelCompoundNotBoolId[] = "label-compound-bool-not";
|
||||
static constexpr char IfStmtId[] = "if";
|
||||
|
||||
static constexpr char SimplifyOperatorDiagnostic[] =
|
||||
"redundant boolean literal supplied to boolean operator";
|
||||
static constexpr char SimplifyConditionDiagnostic[] =
|
||||
|
|
@ -69,33 +40,6 @@ static constexpr char SimplifyConditionDiagnostic[] =
|
|||
static constexpr char SimplifyConditionalReturnDiagnostic[] =
|
||||
"redundant boolean literal in conditional return statement";
|
||||
|
||||
static const Expr *getBoolLiteral(const MatchFinder::MatchResult &Result,
|
||||
StringRef Id) {
|
||||
if (const Expr *Literal = Result.Nodes.getNodeAs<CXXBoolLiteralExpr>(Id))
|
||||
return Literal->getBeginLoc().isMacroID() ? nullptr : Literal;
|
||||
if (const auto *Negated = Result.Nodes.getNodeAs<UnaryOperator>(Id)) {
|
||||
if (Negated->getOpcode() == UO_LNot &&
|
||||
isa<CXXBoolLiteralExpr>(Negated->getSubExpr()))
|
||||
return Negated->getBeginLoc().isMacroID() ? nullptr : Negated;
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
static internal::BindableMatcher<Stmt> literalOrNegatedBool(bool Value) {
|
||||
return expr(
|
||||
anyOf(cxxBoolLiteral(equals(Value)),
|
||||
unaryOperator(hasUnaryOperand(cxxBoolLiteral(equals(!Value))),
|
||||
hasOperatorName("!"))));
|
||||
}
|
||||
|
||||
static internal::Matcher<Stmt> returnsBool(bool Value,
|
||||
StringRef Id = "ignored") {
|
||||
auto SimpleReturnsBool = returnStmt(has(literalOrNegatedBool(Value).bind(Id)))
|
||||
.bind("returns-bool");
|
||||
return anyOf(SimpleReturnsBool,
|
||||
compoundStmt(statementCountIs(1), has(SimpleReturnsBool)));
|
||||
}
|
||||
|
||||
static bool needsParensAfterUnaryNegation(const Expr *E) {
|
||||
E = E->IgnoreImpCasts();
|
||||
if (isa<BinaryOperator>(E) || isa<ConditionalOperator>(E))
|
||||
|
|
@ -192,32 +136,29 @@ static bool needsStaticCast(const Expr *E) {
|
|||
return !E->getType()->isBooleanType();
|
||||
}
|
||||
|
||||
static std::string
|
||||
compareExpressionToConstant(const MatchFinder::MatchResult &Result,
|
||||
const Expr *E, bool Negated, const char *Constant) {
|
||||
static std::string compareExpressionToConstant(const ASTContext &Context,
|
||||
const Expr *E, bool Negated,
|
||||
const char *Constant) {
|
||||
E = E->IgnoreImpCasts();
|
||||
const std::string ExprText =
|
||||
(isa<BinaryOperator>(E) ? ("(" + getText(Result, *E) + ")")
|
||||
: getText(Result, *E))
|
||||
(isa<BinaryOperator>(E) ? ("(" + getText(Context, *E) + ")")
|
||||
: getText(Context, *E))
|
||||
.str();
|
||||
return ExprText + " " + (Negated ? "!=" : "==") + " " + Constant;
|
||||
}
|
||||
|
||||
static std::string
|
||||
compareExpressionToNullPtr(const MatchFinder::MatchResult &Result,
|
||||
const Expr *E, bool Negated) {
|
||||
const char *NullPtr =
|
||||
Result.Context->getLangOpts().CPlusPlus11 ? "nullptr" : "NULL";
|
||||
return compareExpressionToConstant(Result, E, Negated, NullPtr);
|
||||
static std::string compareExpressionToNullPtr(const ASTContext &Context,
|
||||
const Expr *E, bool Negated) {
|
||||
const char *NullPtr = Context.getLangOpts().CPlusPlus11 ? "nullptr" : "NULL";
|
||||
return compareExpressionToConstant(Context, E, Negated, NullPtr);
|
||||
}
|
||||
|
||||
static std::string
|
||||
compareExpressionToZero(const MatchFinder::MatchResult &Result, const Expr *E,
|
||||
bool Negated) {
|
||||
return compareExpressionToConstant(Result, E, Negated, "0");
|
||||
static std::string compareExpressionToZero(const ASTContext &Context,
|
||||
const Expr *E, bool Negated) {
|
||||
return compareExpressionToConstant(Context, E, Negated, "0");
|
||||
}
|
||||
|
||||
static std::string replacementExpression(const MatchFinder::MatchResult &Result,
|
||||
static std::string replacementExpression(const ASTContext &Context,
|
||||
bool Negated, const Expr *E) {
|
||||
E = E->IgnoreParenBaseCasts();
|
||||
if (const auto *EC = dyn_cast<ExprWithCleanups>(E))
|
||||
|
|
@ -228,20 +169,20 @@ static std::string replacementExpression(const MatchFinder::MatchResult &Result,
|
|||
if (const auto *UnOp = dyn_cast<UnaryOperator>(E)) {
|
||||
if (UnOp->getOpcode() == UO_LNot) {
|
||||
if (needsNullPtrComparison(UnOp->getSubExpr()))
|
||||
return compareExpressionToNullPtr(Result, UnOp->getSubExpr(), true);
|
||||
return compareExpressionToNullPtr(Context, UnOp->getSubExpr(), true);
|
||||
|
||||
if (needsZeroComparison(UnOp->getSubExpr()))
|
||||
return compareExpressionToZero(Result, UnOp->getSubExpr(), true);
|
||||
return compareExpressionToZero(Context, UnOp->getSubExpr(), true);
|
||||
|
||||
return replacementExpression(Result, false, UnOp->getSubExpr());
|
||||
return replacementExpression(Context, false, UnOp->getSubExpr());
|
||||
}
|
||||
}
|
||||
|
||||
if (needsNullPtrComparison(E))
|
||||
return compareExpressionToNullPtr(Result, E, false);
|
||||
return compareExpressionToNullPtr(Context, E, false);
|
||||
|
||||
if (needsZeroComparison(E))
|
||||
return compareExpressionToZero(Result, E, false);
|
||||
return compareExpressionToZero(Context, E, false);
|
||||
|
||||
StringRef NegatedOperator;
|
||||
const Expr *LHS = nullptr;
|
||||
|
|
@ -258,20 +199,20 @@ static std::string replacementExpression(const MatchFinder::MatchResult &Result,
|
|||
}
|
||||
}
|
||||
if (!NegatedOperator.empty() && LHS && RHS)
|
||||
return (asBool((getText(Result, *LHS) + " " + NegatedOperator + " " +
|
||||
getText(Result, *RHS))
|
||||
return (asBool((getText(Context, *LHS) + " " + NegatedOperator + " " +
|
||||
getText(Context, *RHS))
|
||||
.str(),
|
||||
NeedsStaticCast));
|
||||
|
||||
StringRef Text = getText(Result, *E);
|
||||
StringRef Text = getText(Context, *E);
|
||||
if (!NeedsStaticCast && needsParensAfterUnaryNegation(E))
|
||||
return ("!(" + Text + ")").str();
|
||||
|
||||
if (needsNullPtrComparison(E))
|
||||
return compareExpressionToNullPtr(Result, E, false);
|
||||
return compareExpressionToNullPtr(Context, E, false);
|
||||
|
||||
if (needsZeroComparison(E))
|
||||
return compareExpressionToZero(Result, E, false);
|
||||
return compareExpressionToZero(Context, E, false);
|
||||
|
||||
return ("!" + asBool(Text, NeedsStaticCast));
|
||||
}
|
||||
|
|
@ -279,20 +220,20 @@ static std::string replacementExpression(const MatchFinder::MatchResult &Result,
|
|||
if (const auto *UnOp = dyn_cast<UnaryOperator>(E)) {
|
||||
if (UnOp->getOpcode() == UO_LNot) {
|
||||
if (needsNullPtrComparison(UnOp->getSubExpr()))
|
||||
return compareExpressionToNullPtr(Result, UnOp->getSubExpr(), false);
|
||||
return compareExpressionToNullPtr(Context, UnOp->getSubExpr(), false);
|
||||
|
||||
if (needsZeroComparison(UnOp->getSubExpr()))
|
||||
return compareExpressionToZero(Result, UnOp->getSubExpr(), false);
|
||||
return compareExpressionToZero(Context, UnOp->getSubExpr(), false);
|
||||
}
|
||||
}
|
||||
|
||||
if (needsNullPtrComparison(E))
|
||||
return compareExpressionToNullPtr(Result, E, true);
|
||||
return compareExpressionToNullPtr(Context, E, true);
|
||||
|
||||
if (needsZeroComparison(E))
|
||||
return compareExpressionToZero(Result, E, true);
|
||||
return compareExpressionToZero(Context, E, true);
|
||||
|
||||
return asBool(getText(Result, *E), NeedsStaticCast);
|
||||
return asBool(getText(Context, *E), NeedsStaticCast);
|
||||
}
|
||||
|
||||
static const Expr *stmtReturnsBool(const ReturnStmt *Ret, bool Negated) {
|
||||
|
|
@ -330,14 +271,14 @@ static const Expr *stmtReturnsBool(const IfStmt *IfRet, bool Negated) {
|
|||
return nullptr;
|
||||
}
|
||||
|
||||
static bool containsDiscardedTokens(const MatchFinder::MatchResult &Result,
|
||||
static bool containsDiscardedTokens(const ASTContext &Context,
|
||||
CharSourceRange CharRange) {
|
||||
std::string ReplacementText =
|
||||
Lexer::getSourceText(CharRange, *Result.SourceManager,
|
||||
Result.Context->getLangOpts())
|
||||
Lexer::getSourceText(CharRange, Context.getSourceManager(),
|
||||
Context.getLangOpts())
|
||||
.str();
|
||||
Lexer Lex(CharRange.getBegin(), Result.Context->getLangOpts(),
|
||||
ReplacementText.data(), ReplacementText.data(),
|
||||
Lexer Lex(CharRange.getBegin(), Context.getLangOpts(), ReplacementText.data(),
|
||||
ReplacementText.data(),
|
||||
ReplacementText.data() + ReplacementText.size());
|
||||
Lex.SetCommentRetentionState(true);
|
||||
|
||||
|
|
@ -352,18 +293,248 @@ static bool containsDiscardedTokens(const MatchFinder::MatchResult &Result,
|
|||
|
||||
class SimplifyBooleanExprCheck::Visitor : public RecursiveASTVisitor<Visitor> {
|
||||
public:
|
||||
Visitor(SimplifyBooleanExprCheck *Check,
|
||||
const MatchFinder::MatchResult &Result)
|
||||
: Check(Check), Result(Result) {}
|
||||
Visitor(SimplifyBooleanExprCheck *Check, ASTContext &Context)
|
||||
: Check(Check), Context(Context) {}
|
||||
|
||||
bool traverse() { return TraverseAST(Context); }
|
||||
|
||||
static bool shouldIgnore(Stmt *S) {
|
||||
switch (S->getStmtClass()) {
|
||||
case Stmt::ImplicitCastExprClass:
|
||||
case Stmt::MaterializeTemporaryExprClass:
|
||||
case Stmt::CXXBindTemporaryExprClass:
|
||||
return true;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
bool dataTraverseStmtPre(Stmt *S) {
|
||||
if (S && !shouldIgnore(S))
|
||||
StmtStack.push_back(S);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool dataTraverseStmtPost(Stmt *S) {
|
||||
if (S && !shouldIgnore(S)) {
|
||||
assert(StmtStack.back() == S);
|
||||
StmtStack.pop_back();
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool VisitBinaryOperator(const BinaryOperator *Op) const {
|
||||
Check->reportBinOp(Result, Op);
|
||||
Check->reportBinOp(Context, Op);
|
||||
return true;
|
||||
}
|
||||
|
||||
// Extracts a bool if an expression is (true|false|!true|!false);
|
||||
static Optional<bool> getAsBoolLiteral(const Expr *E, bool FilterMacro) {
|
||||
if (const auto *Bool = dyn_cast<CXXBoolLiteralExpr>(E)) {
|
||||
if (FilterMacro && Bool->getBeginLoc().isMacroID())
|
||||
return llvm::None;
|
||||
return Bool->getValue();
|
||||
}
|
||||
if (const auto *UnaryOp = dyn_cast<UnaryOperator>(E)) {
|
||||
if (FilterMacro && UnaryOp->getBeginLoc().isMacroID())
|
||||
return None;
|
||||
if (UnaryOp->getOpcode() == UO_LNot)
|
||||
if (Optional<bool> Res = getAsBoolLiteral(
|
||||
UnaryOp->getSubExpr()->IgnoreImplicit(), FilterMacro))
|
||||
return !*Res;
|
||||
}
|
||||
return llvm::None;
|
||||
}
|
||||
|
||||
template <typename Node> struct NodeAndBool {
|
||||
const Node *Item = nullptr;
|
||||
bool Bool = false;
|
||||
|
||||
operator bool() const { return Item != nullptr; }
|
||||
};
|
||||
|
||||
using ExprAndBool = NodeAndBool<Expr>;
|
||||
using DeclAndBool = NodeAndBool<Decl>;
|
||||
|
||||
/// Detect's return (true|false|!true|!false);
|
||||
static ExprAndBool parseReturnLiteralBool(const Stmt *S) {
|
||||
const auto *RS = dyn_cast<ReturnStmt>(S);
|
||||
if (!RS || !RS->getRetValue())
|
||||
return {};
|
||||
if (Optional<bool> Ret =
|
||||
getAsBoolLiteral(RS->getRetValue()->IgnoreImplicit(), false)) {
|
||||
return {RS->getRetValue(), *Ret};
|
||||
}
|
||||
return {};
|
||||
}
|
||||
|
||||
/// If \p S is not a \c CompoundStmt, applies F on \p S, otherwise if there is
|
||||
/// only 1 statement in the \c CompoundStmt, applies F on that single
|
||||
/// statement.
|
||||
template <typename Functor>
|
||||
static auto checkSingleStatement(Stmt *S, Functor F) -> decltype(F(S)) {
|
||||
if (auto *CS = dyn_cast<CompoundStmt>(S)) {
|
||||
if (CS->size() == 1)
|
||||
return F(CS->body_front());
|
||||
return {};
|
||||
}
|
||||
return F(S);
|
||||
}
|
||||
|
||||
Stmt *parent() const {
|
||||
return StmtStack.size() < 2 ? nullptr : StmtStack[StmtStack.size() - 2];
|
||||
}
|
||||
|
||||
bool VisitIfStmt(IfStmt *If) {
|
||||
/*
|
||||
* if (true) ThenStmt(); -> ThenStmt();
|
||||
* if (false) ThenStmt(); -> <Empty>;
|
||||
* if (false) ThenStmt(); else ElseStmt() -> ElseStmt();
|
||||
*/
|
||||
Expr *Cond = If->getCond()->IgnoreImplicit();
|
||||
if (Optional<bool> Bool = getAsBoolLiteral(Cond, true)) {
|
||||
if (*Bool)
|
||||
Check->replaceWithThenStatement(Context, If, Cond);
|
||||
else
|
||||
Check->replaceWithElseStatement(Context, If, Cond);
|
||||
}
|
||||
|
||||
if (If->getElse()) {
|
||||
/*
|
||||
* if (Cond) return true; else return false; -> return Cond;
|
||||
* if (Cond) return false; else return true; -> return !Cond;
|
||||
*/
|
||||
if (ExprAndBool ThenReturnBool =
|
||||
checkSingleStatement(If->getThen(), parseReturnLiteralBool)) {
|
||||
ExprAndBool ElseReturnBool =
|
||||
checkSingleStatement(If->getElse(), parseReturnLiteralBool);
|
||||
if (ElseReturnBool && ThenReturnBool.Bool != ElseReturnBool.Bool) {
|
||||
if (Check->ChainedConditionalReturn ||
|
||||
!isa_and_nonnull<IfStmt>(parent())) {
|
||||
Check->replaceWithReturnCondition(Context, If, ThenReturnBool.Item,
|
||||
ElseReturnBool.Bool);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
/*
|
||||
* if (Cond) A = true; else A = false; -> A = Cond;
|
||||
* if (Cond) A = false; else A = true; -> A = !Cond;
|
||||
*/
|
||||
Expr *Var = nullptr;
|
||||
SourceLocation Loc;
|
||||
auto VarBoolAssignmentMatcher = [&Var,
|
||||
&Loc](const Stmt *S) -> DeclAndBool {
|
||||
const auto *BO = dyn_cast<BinaryOperator>(S);
|
||||
if (!BO || BO->getOpcode() != BO_Assign)
|
||||
return {};
|
||||
Optional<bool> RightasBool =
|
||||
getAsBoolLiteral(BO->getRHS()->IgnoreImplicit(), false);
|
||||
if (!RightasBool)
|
||||
return {};
|
||||
Expr *IgnImp = BO->getLHS()->IgnoreImplicit();
|
||||
if (!Var) {
|
||||
// We only need to track these for the Then branch.
|
||||
Loc = BO->getRHS()->getBeginLoc();
|
||||
Var = IgnImp;
|
||||
}
|
||||
if (auto *DRE = dyn_cast<DeclRefExpr>(IgnImp))
|
||||
return {DRE->getDecl(), *RightasBool};
|
||||
if (auto *ME = dyn_cast<MemberExpr>(IgnImp))
|
||||
return {ME->getMemberDecl(), *RightasBool};
|
||||
return {};
|
||||
};
|
||||
if (DeclAndBool ThenAssignment =
|
||||
checkSingleStatement(If->getThen(), VarBoolAssignmentMatcher)) {
|
||||
DeclAndBool ElseAssignment =
|
||||
checkSingleStatement(If->getElse(), VarBoolAssignmentMatcher);
|
||||
if (ElseAssignment.Item == ThenAssignment.Item &&
|
||||
ElseAssignment.Bool != ThenAssignment.Bool) {
|
||||
if (Check->ChainedConditionalAssignment ||
|
||||
!isa_and_nonnull<IfStmt>(parent())) {
|
||||
Check->replaceWithAssignment(Context, If, Var, Loc,
|
||||
ElseAssignment.Bool);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool VisitConditionalOperator(ConditionalOperator *Cond) {
|
||||
/*
|
||||
* Condition ? true : false; -> Condition
|
||||
* Condition ? false : true; -> !Condition;
|
||||
*/
|
||||
if (Optional<bool> Then =
|
||||
getAsBoolLiteral(Cond->getTrueExpr()->IgnoreImplicit(), false)) {
|
||||
if (Optional<bool> Else =
|
||||
getAsBoolLiteral(Cond->getFalseExpr()->IgnoreImplicit(), false)) {
|
||||
if (*Then != *Else)
|
||||
Check->replaceWithCondition(Context, Cond, *Else);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool VisitCompoundStmt(CompoundStmt *CS) {
|
||||
if (CS->size() < 2)
|
||||
return true;
|
||||
bool CurIf = false, PrevIf = false;
|
||||
for (auto First = CS->body_begin(), Second = std::next(First),
|
||||
End = CS->body_end();
|
||||
Second != End; ++Second, ++First) {
|
||||
PrevIf = CurIf;
|
||||
CurIf = isa<IfStmt>(*First);
|
||||
ExprAndBool TrailingReturnBool = parseReturnLiteralBool(*Second);
|
||||
if (!TrailingReturnBool)
|
||||
continue;
|
||||
|
||||
if (CurIf) {
|
||||
/*
|
||||
* if (Cond) return true; return false; -> return Cond;
|
||||
* if (Cond) return false; return true; -> return !Cond;
|
||||
*/
|
||||
auto *If = cast<IfStmt>(*First);
|
||||
ExprAndBool ThenReturnBool =
|
||||
checkSingleStatement(If->getThen(), parseReturnLiteralBool);
|
||||
if (ThenReturnBool && ThenReturnBool.Bool != TrailingReturnBool.Bool) {
|
||||
if (Check->ChainedConditionalReturn ||
|
||||
(!PrevIf && If->getElse() == nullptr)) {
|
||||
Check->replaceCompoundReturnWithCondition(
|
||||
Context, cast<ReturnStmt>(*Second), TrailingReturnBool.Bool,
|
||||
If);
|
||||
}
|
||||
}
|
||||
} else if (isa<LabelStmt, CaseStmt, DefaultStmt>(*First)) {
|
||||
/*
|
||||
* (case X|label_X|default): if (Cond) return BoolLiteral;
|
||||
* return !BoolLiteral
|
||||
*/
|
||||
Stmt *SubStmt =
|
||||
isa<LabelStmt>(*First) ? cast<LabelStmt>(*First)->getSubStmt()
|
||||
: isa<CaseStmt>(*First) ? cast<CaseStmt>(*First)->getSubStmt()
|
||||
: cast<DefaultStmt>(*First)->getSubStmt();
|
||||
auto *SubIf = dyn_cast<IfStmt>(SubStmt);
|
||||
if (SubIf && !SubIf->getElse()) {
|
||||
ExprAndBool ThenReturnBool =
|
||||
checkSingleStatement(SubIf->getThen(), parseReturnLiteralBool);
|
||||
if (ThenReturnBool &&
|
||||
ThenReturnBool.Bool != TrailingReturnBool.Bool) {
|
||||
Check->replaceCompoundReturnWithCondition(
|
||||
Context, cast<ReturnStmt>(*Second), TrailingReturnBool.Bool,
|
||||
SubIf);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
private:
|
||||
SimplifyBooleanExprCheck *Check;
|
||||
const MatchFinder::MatchResult &Result;
|
||||
SmallVector<Stmt *, 32> StmtStack;
|
||||
ASTContext &Context;
|
||||
};
|
||||
|
||||
SimplifyBooleanExprCheck::SimplifyBooleanExprCheck(StringRef Name,
|
||||
|
|
@ -387,8 +558,8 @@ static bool containsBoolLiteral(const Expr *E) {
|
|||
return false;
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::reportBinOp(
|
||||
const MatchFinder::MatchResult &Result, const BinaryOperator *Op) {
|
||||
void SimplifyBooleanExprCheck::reportBinOp(const ASTContext &Context,
|
||||
const BinaryOperator *Op) {
|
||||
const auto *LHS = Op->getLHS()->IgnoreParenImpCasts();
|
||||
const auto *RHS = Op->getRHS()->IgnoreParenImpCasts();
|
||||
|
||||
|
|
@ -410,12 +581,12 @@ void SimplifyBooleanExprCheck::reportBinOp(
|
|||
|
||||
bool BoolValue = Bool->getValue();
|
||||
|
||||
auto ReplaceWithExpression = [this, &Result, LHS, RHS,
|
||||
auto ReplaceWithExpression = [this, &Context, LHS, RHS,
|
||||
Bool](const Expr *ReplaceWith, bool Negated) {
|
||||
std::string Replacement =
|
||||
replacementExpression(Result, Negated, ReplaceWith);
|
||||
replacementExpression(Context, Negated, ReplaceWith);
|
||||
SourceRange Range(LHS->getBeginLoc(), RHS->getEndLoc());
|
||||
issueDiag(Result, Bool->getBeginLoc(), SimplifyOperatorDiagnostic, Range,
|
||||
issueDiag(Context, Bool->getBeginLoc(), SimplifyOperatorDiagnostic, Range,
|
||||
Replacement);
|
||||
};
|
||||
|
||||
|
|
@ -449,127 +620,6 @@ void SimplifyBooleanExprCheck::reportBinOp(
|
|||
}
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchBoolCondition(MatchFinder *Finder,
|
||||
bool Value,
|
||||
StringRef BooleanId) {
|
||||
Finder->addMatcher(
|
||||
ifStmt(hasCondition(literalOrNegatedBool(Value).bind(BooleanId)))
|
||||
.bind(IfStmtId),
|
||||
this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchTernaryResult(MatchFinder *Finder,
|
||||
bool Value, StringRef Id) {
|
||||
Finder->addMatcher(
|
||||
conditionalOperator(hasTrueExpression(literalOrNegatedBool(Value)),
|
||||
hasFalseExpression(literalOrNegatedBool(!Value)))
|
||||
.bind(Id),
|
||||
this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchIfReturnsBool(MatchFinder *Finder,
|
||||
bool Value, StringRef Id) {
|
||||
if (ChainedConditionalReturn)
|
||||
Finder->addMatcher(ifStmt(hasThen(returnsBool(Value, ThenLiteralId)),
|
||||
hasElse(returnsBool(!Value)))
|
||||
.bind(Id),
|
||||
this);
|
||||
else
|
||||
Finder->addMatcher(ifStmt(unless(hasParent(ifStmt())),
|
||||
hasThen(returnsBool(Value, ThenLiteralId)),
|
||||
hasElse(returnsBool(!Value)))
|
||||
.bind(Id),
|
||||
this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchIfAssignsBool(MatchFinder *Finder,
|
||||
bool Value, StringRef Id) {
|
||||
auto VarAssign = declRefExpr(hasDeclaration(decl().bind(IfAssignVarId)));
|
||||
auto VarRef = declRefExpr(hasDeclaration(equalsBoundNode(IfAssignVarId)));
|
||||
auto MemAssign = memberExpr(hasDeclaration(decl().bind(IfAssignVarId)));
|
||||
auto MemRef = memberExpr(hasDeclaration(equalsBoundNode(IfAssignVarId)));
|
||||
auto SimpleThen =
|
||||
binaryOperator(hasOperatorName("="), hasLHS(anyOf(VarAssign, MemAssign)),
|
||||
hasLHS(expr().bind(IfAssignVariableId)),
|
||||
hasRHS(literalOrNegatedBool(Value).bind(IfAssignLocId)));
|
||||
auto Then = anyOf(SimpleThen, compoundStmt(statementCountIs(1),
|
||||
hasAnySubstatement(SimpleThen)));
|
||||
auto SimpleElse =
|
||||
binaryOperator(hasOperatorName("="), hasLHS(anyOf(VarRef, MemRef)),
|
||||
hasRHS(literalOrNegatedBool(!Value)));
|
||||
auto Else = anyOf(SimpleElse, compoundStmt(statementCountIs(1),
|
||||
hasAnySubstatement(SimpleElse)));
|
||||
if (ChainedConditionalAssignment)
|
||||
Finder->addMatcher(ifStmt(hasThen(Then), hasElse(Else)).bind(Id), this);
|
||||
else
|
||||
Finder->addMatcher(
|
||||
ifStmt(unless(hasParent(ifStmt())), hasThen(Then), hasElse(Else))
|
||||
.bind(Id),
|
||||
this);
|
||||
}
|
||||
|
||||
static internal::Matcher<Stmt> ifReturnValue(bool Value) {
|
||||
return ifStmt(hasThen(returnsBool(Value)), unless(hasElse(stmt())))
|
||||
.bind(CompoundIfId);
|
||||
}
|
||||
|
||||
static internal::Matcher<Stmt> returnNotValue(bool Value) {
|
||||
return returnStmt(has(literalOrNegatedBool(!Value))).bind(CompoundReturnId);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchCompoundIfReturnsBool(MatchFinder *Finder,
|
||||
bool Value,
|
||||
StringRef Id) {
|
||||
if (ChainedConditionalReturn)
|
||||
Finder->addMatcher(
|
||||
compoundStmt(hasSubstatementSequence(ifReturnValue(Value),
|
||||
returnNotValue(Value)))
|
||||
.bind(Id),
|
||||
this);
|
||||
else
|
||||
Finder->addMatcher(
|
||||
compoundStmt(hasSubstatementSequence(ifStmt(hasThen(returnsBool(Value)),
|
||||
unless(hasElse(stmt())),
|
||||
unless(hasParent(ifStmt())))
|
||||
.bind(CompoundIfId),
|
||||
returnNotValue(Value)))
|
||||
.bind(Id),
|
||||
this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchCaseIfReturnsBool(MatchFinder *Finder,
|
||||
bool Value,
|
||||
StringRef Id) {
|
||||
internal::Matcher<Stmt> CaseStmt =
|
||||
caseStmt(hasSubstatement(ifReturnValue(Value))).bind(CaseId);
|
||||
internal::Matcher<Stmt> CompoundStmt =
|
||||
compoundStmt(hasSubstatementSequence(CaseStmt, returnNotValue(Value)))
|
||||
.bind(Id);
|
||||
Finder->addMatcher(switchStmt(has(CompoundStmt)), this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchDefaultIfReturnsBool(MatchFinder *Finder,
|
||||
bool Value,
|
||||
StringRef Id) {
|
||||
internal::Matcher<Stmt> DefaultStmt =
|
||||
defaultStmt(hasSubstatement(ifReturnValue(Value))).bind(DefaultId);
|
||||
internal::Matcher<Stmt> CompoundStmt =
|
||||
compoundStmt(hasSubstatementSequence(DefaultStmt, returnNotValue(Value)))
|
||||
.bind(Id);
|
||||
Finder->addMatcher(switchStmt(has(CompoundStmt)), this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::matchLabelIfReturnsBool(MatchFinder *Finder,
|
||||
bool Value,
|
||||
StringRef Id) {
|
||||
internal::Matcher<Stmt> LabelStmt =
|
||||
labelStmt(hasSubstatement(ifReturnValue(Value))).bind(LabelId);
|
||||
internal::Matcher<Stmt> CompoundStmt =
|
||||
compoundStmt(hasSubstatementSequence(LabelStmt, returnNotValue(Value)))
|
||||
.bind(Id);
|
||||
Finder->addMatcher(CompoundStmt, this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
|
||||
Options.store(Opts, "ChainedConditionalReturn", ChainedConditionalReturn);
|
||||
Options.store(Opts, "ChainedConditionalAssignment",
|
||||
|
|
@ -577,214 +627,90 @@ void SimplifyBooleanExprCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
|
|||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::registerMatchers(MatchFinder *Finder) {
|
||||
Finder->addMatcher(translationUnitDecl().bind("top"), this);
|
||||
|
||||
matchBoolCondition(Finder, true, ConditionThenStmtId);
|
||||
matchBoolCondition(Finder, false, ConditionElseStmtId);
|
||||
|
||||
matchTernaryResult(Finder, true, TernaryId);
|
||||
matchTernaryResult(Finder, false, TernaryNegatedId);
|
||||
|
||||
matchIfReturnsBool(Finder, true, IfReturnsBoolId);
|
||||
matchIfReturnsBool(Finder, false, IfReturnsNotBoolId);
|
||||
|
||||
matchIfAssignsBool(Finder, true, IfAssignBoolId);
|
||||
matchIfAssignsBool(Finder, false, IfAssignNotBoolId);
|
||||
|
||||
matchCompoundIfReturnsBool(Finder, true, CompoundBoolId);
|
||||
matchCompoundIfReturnsBool(Finder, false, CompoundNotBoolId);
|
||||
|
||||
matchCaseIfReturnsBool(Finder, true, CaseCompoundBoolId);
|
||||
matchCaseIfReturnsBool(Finder, false, CaseCompoundNotBoolId);
|
||||
|
||||
matchDefaultIfReturnsBool(Finder, true, DefaultCompoundBoolId);
|
||||
matchDefaultIfReturnsBool(Finder, false, DefaultCompoundNotBoolId);
|
||||
|
||||
matchLabelIfReturnsBool(Finder, true, LabelCompoundBoolId);
|
||||
matchLabelIfReturnsBool(Finder, false, LabelCompoundNotBoolId);
|
||||
Finder->addMatcher(translationUnitDecl(), this);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::check(const MatchFinder::MatchResult &Result) {
|
||||
if (Result.Nodes.getNodeAs<TranslationUnitDecl>("top"))
|
||||
Visitor(this, Result).TraverseAST(*Result.Context);
|
||||
else if (const Expr *TrueConditionRemoved =
|
||||
getBoolLiteral(Result, ConditionThenStmtId))
|
||||
replaceWithThenStatement(Result, TrueConditionRemoved);
|
||||
else if (const Expr *FalseConditionRemoved =
|
||||
getBoolLiteral(Result, ConditionElseStmtId))
|
||||
replaceWithElseStatement(Result, FalseConditionRemoved);
|
||||
else if (const auto *Ternary =
|
||||
Result.Nodes.getNodeAs<ConditionalOperator>(TernaryId))
|
||||
replaceWithCondition(Result, Ternary, false);
|
||||
else if (const auto *TernaryNegated =
|
||||
Result.Nodes.getNodeAs<ConditionalOperator>(TernaryNegatedId))
|
||||
replaceWithCondition(Result, TernaryNegated, true);
|
||||
else if (const auto *If = Result.Nodes.getNodeAs<IfStmt>(IfReturnsBoolId))
|
||||
replaceWithReturnCondition(Result, If, false);
|
||||
else if (const auto *IfNot =
|
||||
Result.Nodes.getNodeAs<IfStmt>(IfReturnsNotBoolId))
|
||||
replaceWithReturnCondition(Result, IfNot, true);
|
||||
else if (const auto *IfAssign =
|
||||
Result.Nodes.getNodeAs<IfStmt>(IfAssignBoolId))
|
||||
replaceWithAssignment(Result, IfAssign, false);
|
||||
else if (const auto *IfAssignNot =
|
||||
Result.Nodes.getNodeAs<IfStmt>(IfAssignNotBoolId))
|
||||
replaceWithAssignment(Result, IfAssignNot, true);
|
||||
else if (const auto *Compound =
|
||||
Result.Nodes.getNodeAs<CompoundStmt>(CompoundBoolId))
|
||||
replaceCompoundReturnWithCondition(Result, Compound, false);
|
||||
else if (const auto *CompoundNot =
|
||||
Result.Nodes.getNodeAs<CompoundStmt>(CompoundNotBoolId))
|
||||
replaceCompoundReturnWithCondition(Result, CompoundNot, true);
|
||||
else if (Result.Nodes.getNodeAs<CompoundStmt>(CaseCompoundBoolId))
|
||||
replaceCaseCompoundReturnWithCondition(Result, false);
|
||||
else if (Result.Nodes.getNodeAs<CompoundStmt>(CaseCompoundNotBoolId))
|
||||
replaceCaseCompoundReturnWithCondition(Result, true);
|
||||
else if (Result.Nodes.getNodeAs<CompoundStmt>(DefaultCompoundBoolId))
|
||||
replaceDefaultCompoundReturnWithCondition(Result, false);
|
||||
else if (Result.Nodes.getNodeAs<CompoundStmt>(DefaultCompoundNotBoolId))
|
||||
replaceDefaultCompoundReturnWithCondition(Result, true);
|
||||
else if (Result.Nodes.getNodeAs<CompoundStmt>(LabelCompoundBoolId))
|
||||
replaceLabelCompoundReturnWithCondition(Result, false);
|
||||
else if (Result.Nodes.getNodeAs<CompoundStmt>(LabelCompoundNotBoolId))
|
||||
replaceLabelCompoundReturnWithCondition(Result, true);
|
||||
else if (const auto TU = Result.Nodes.getNodeAs<Decl>("top"))
|
||||
Visitor(this, Result).TraverseDecl(const_cast<Decl *>(TU));
|
||||
Visitor(this, *Result.Context).traverse();
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::issueDiag(const MatchFinder::MatchResult &Result,
|
||||
void SimplifyBooleanExprCheck::issueDiag(const ASTContext &Context,
|
||||
SourceLocation Loc,
|
||||
StringRef Description,
|
||||
SourceRange ReplacementRange,
|
||||
StringRef Replacement) {
|
||||
CharSourceRange CharRange =
|
||||
Lexer::makeFileCharRange(CharSourceRange::getTokenRange(ReplacementRange),
|
||||
*Result.SourceManager, getLangOpts());
|
||||
Context.getSourceManager(), getLangOpts());
|
||||
|
||||
DiagnosticBuilder Diag = diag(Loc, Description);
|
||||
if (!containsDiscardedTokens(Result, CharRange))
|
||||
if (!containsDiscardedTokens(Context, CharRange))
|
||||
Diag << FixItHint::CreateReplacement(CharRange, Replacement);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceWithThenStatement(
|
||||
const MatchFinder::MatchResult &Result, const Expr *BoolLiteral) {
|
||||
const auto *IfStatement = Result.Nodes.getNodeAs<IfStmt>(IfStmtId);
|
||||
issueDiag(Result, BoolLiteral->getBeginLoc(), SimplifyConditionDiagnostic,
|
||||
const ASTContext &Context, const IfStmt *IfStatement,
|
||||
const Expr *BoolLiteral) {
|
||||
issueDiag(Context, BoolLiteral->getBeginLoc(), SimplifyConditionDiagnostic,
|
||||
IfStatement->getSourceRange(),
|
||||
getText(Result, *IfStatement->getThen()));
|
||||
getText(Context, *IfStatement->getThen()));
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceWithElseStatement(
|
||||
const MatchFinder::MatchResult &Result, const Expr *BoolLiteral) {
|
||||
const auto *IfStatement = Result.Nodes.getNodeAs<IfStmt>(IfStmtId);
|
||||
const ASTContext &Context, const IfStmt *IfStatement,
|
||||
const Expr *BoolLiteral) {
|
||||
const Stmt *ElseStatement = IfStatement->getElse();
|
||||
issueDiag(Result, BoolLiteral->getBeginLoc(), SimplifyConditionDiagnostic,
|
||||
issueDiag(Context, BoolLiteral->getBeginLoc(), SimplifyConditionDiagnostic,
|
||||
IfStatement->getSourceRange(),
|
||||
ElseStatement ? getText(Result, *ElseStatement) : "");
|
||||
ElseStatement ? getText(Context, *ElseStatement) : "");
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceWithCondition(
|
||||
const MatchFinder::MatchResult &Result, const ConditionalOperator *Ternary,
|
||||
const ASTContext &Context, const ConditionalOperator *Ternary,
|
||||
bool Negated) {
|
||||
std::string Replacement =
|
||||
replacementExpression(Result, Negated, Ternary->getCond());
|
||||
issueDiag(Result, Ternary->getTrueExpr()->getBeginLoc(),
|
||||
replacementExpression(Context, Negated, Ternary->getCond());
|
||||
issueDiag(Context, Ternary->getTrueExpr()->getBeginLoc(),
|
||||
"redundant boolean literal in ternary expression result",
|
||||
Ternary->getSourceRange(), Replacement);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceWithReturnCondition(
|
||||
const MatchFinder::MatchResult &Result, const IfStmt *If, bool Negated) {
|
||||
const ASTContext &Context, const IfStmt *If, const Expr *BoolLiteral,
|
||||
bool Negated) {
|
||||
StringRef Terminator = isa<CompoundStmt>(If->getElse()) ? ";" : "";
|
||||
std::string Condition = replacementExpression(Result, Negated, If->getCond());
|
||||
std::string Condition =
|
||||
replacementExpression(Context, Negated, If->getCond());
|
||||
std::string Replacement = ("return " + Condition + Terminator).str();
|
||||
SourceLocation Start =
|
||||
Result.Nodes.getNodeAs<CXXBoolLiteralExpr>(ThenLiteralId)->getBeginLoc();
|
||||
issueDiag(Result, Start, SimplifyConditionalReturnDiagnostic,
|
||||
SourceLocation Start = BoolLiteral->getBeginLoc();
|
||||
issueDiag(Context, Start, SimplifyConditionalReturnDiagnostic,
|
||||
If->getSourceRange(), Replacement);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceCompoundReturnWithCondition(
|
||||
const MatchFinder::MatchResult &Result, const CompoundStmt *Compound,
|
||||
bool Negated) {
|
||||
const auto *Ret = Result.Nodes.getNodeAs<ReturnStmt>(CompoundReturnId);
|
||||
|
||||
// Scan through the CompoundStmt to look for a chained-if construct.
|
||||
const IfStmt *BeforeIf = nullptr;
|
||||
CompoundStmt::const_body_iterator Current = Compound->body_begin();
|
||||
CompoundStmt::const_body_iterator After = Compound->body_begin();
|
||||
for (++After; After != Compound->body_end() && *Current != Ret;
|
||||
++Current, ++After) {
|
||||
if (const auto *If = dyn_cast<IfStmt>(*Current)) {
|
||||
if (const Expr *Lit = stmtReturnsBool(If, Negated)) {
|
||||
if (*After == Ret) {
|
||||
if (!ChainedConditionalReturn && BeforeIf)
|
||||
continue;
|
||||
|
||||
std::string Replacement =
|
||||
"return " + replacementExpression(Result, Negated, If->getCond());
|
||||
issueDiag(
|
||||
Result, Lit->getBeginLoc(), SimplifyConditionalReturnDiagnostic,
|
||||
SourceRange(If->getBeginLoc(), Ret->getEndLoc()), Replacement);
|
||||
return;
|
||||
}
|
||||
|
||||
BeforeIf = If;
|
||||
}
|
||||
} else {
|
||||
BeforeIf = nullptr;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceCompoundReturnWithCondition(
|
||||
const MatchFinder::MatchResult &Result, bool Negated, const IfStmt *If) {
|
||||
const ASTContext &Context, const ReturnStmt *Ret, bool Negated,
|
||||
const IfStmt *If) {
|
||||
const auto *Lit = stmtReturnsBool(If, Negated);
|
||||
const auto *Ret = Result.Nodes.getNodeAs<ReturnStmt>(CompoundReturnId);
|
||||
const std::string Replacement =
|
||||
"return " + replacementExpression(Result, Negated, If->getCond());
|
||||
issueDiag(Result, Lit->getBeginLoc(), SimplifyConditionalReturnDiagnostic,
|
||||
"return " + replacementExpression(Context, Negated, If->getCond());
|
||||
issueDiag(Context, Lit->getBeginLoc(), SimplifyConditionalReturnDiagnostic,
|
||||
SourceRange(If->getBeginLoc(), Ret->getEndLoc()), Replacement);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceCaseCompoundReturnWithCondition(
|
||||
const MatchFinder::MatchResult &Result, bool Negated) {
|
||||
const auto *CaseDefault = Result.Nodes.getNodeAs<CaseStmt>(CaseId);
|
||||
const auto *If = cast<IfStmt>(CaseDefault->getSubStmt());
|
||||
replaceCompoundReturnWithCondition(Result, Negated, If);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceDefaultCompoundReturnWithCondition(
|
||||
const MatchFinder::MatchResult &Result, bool Negated) {
|
||||
const SwitchCase *CaseDefault =
|
||||
Result.Nodes.getNodeAs<DefaultStmt>(DefaultId);
|
||||
const auto *If = cast<IfStmt>(CaseDefault->getSubStmt());
|
||||
replaceCompoundReturnWithCondition(Result, Negated, If);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceLabelCompoundReturnWithCondition(
|
||||
const MatchFinder::MatchResult &Result, bool Negated) {
|
||||
const auto *Label = Result.Nodes.getNodeAs<LabelStmt>(LabelId);
|
||||
const auto *If = cast<IfStmt>(Label->getSubStmt());
|
||||
replaceCompoundReturnWithCondition(Result, Negated, If);
|
||||
}
|
||||
|
||||
void SimplifyBooleanExprCheck::replaceWithAssignment(
|
||||
const MatchFinder::MatchResult &Result, const IfStmt *IfAssign,
|
||||
bool Negated) {
|
||||
void SimplifyBooleanExprCheck::replaceWithAssignment(const ASTContext &Context,
|
||||
const IfStmt *IfAssign,
|
||||
const Expr *Var,
|
||||
SourceLocation Loc,
|
||||
bool Negated) {
|
||||
SourceRange Range = IfAssign->getSourceRange();
|
||||
StringRef VariableName =
|
||||
getText(Result, *Result.Nodes.getNodeAs<Expr>(IfAssignVariableId));
|
||||
StringRef VariableName = getText(Context, *Var);
|
||||
StringRef Terminator = isa<CompoundStmt>(IfAssign->getElse()) ? ";" : "";
|
||||
std::string Condition =
|
||||
replacementExpression(Result, Negated, IfAssign->getCond());
|
||||
replacementExpression(Context, Negated, IfAssign->getCond());
|
||||
std::string Replacement =
|
||||
(VariableName + " = " + Condition + Terminator).str();
|
||||
SourceLocation Location =
|
||||
Result.Nodes.getNodeAs<CXXBoolLiteralExpr>(IfAssignLocId)->getBeginLoc();
|
||||
issueDiag(Result, Location,
|
||||
"redundant boolean literal in conditional assignment", Range,
|
||||
Replacement);
|
||||
issueDiag(Context, Loc, "redundant boolean literal in conditional assignment",
|
||||
Range, Replacement);
|
||||
}
|
||||
|
||||
} // namespace readability
|
||||
|
|
|
|||
|
|
@ -34,73 +34,32 @@ public:
|
|||
private:
|
||||
class Visitor;
|
||||
|
||||
void reportBinOp(const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
const BinaryOperator *Op);
|
||||
void reportBinOp(const ASTContext &Context, const BinaryOperator *Op);
|
||||
|
||||
void matchBoolCondition(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef BooleanId);
|
||||
void replaceWithThenStatement(const ASTContext &Context,
|
||||
const IfStmt *IfStatement,
|
||||
const Expr *BoolLiteral);
|
||||
|
||||
void matchTernaryResult(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
void replaceWithElseStatement(const ASTContext &Context,
|
||||
const IfStmt *IfStatement,
|
||||
const Expr *BoolLiteral);
|
||||
|
||||
void matchIfReturnsBool(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
void replaceWithCondition(const ASTContext &Context,
|
||||
const ConditionalOperator *Ternary, bool Negated);
|
||||
|
||||
void matchIfAssignsBool(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
void replaceWithReturnCondition(const ASTContext &Context, const IfStmt *If,
|
||||
const Expr *BoolLiteral, bool Negated);
|
||||
|
||||
void matchCompoundIfReturnsBool(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
void replaceWithAssignment(const ASTContext &Context, const IfStmt *If,
|
||||
const Expr *Var, SourceLocation Loc, bool Negated);
|
||||
|
||||
void matchCaseIfReturnsBool(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
void replaceCompoundReturnWithCondition(const ASTContext &Context,
|
||||
const ReturnStmt *Ret, bool Negated,
|
||||
const IfStmt *If);
|
||||
|
||||
void matchDefaultIfReturnsBool(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
|
||||
void matchLabelIfReturnsBool(ast_matchers::MatchFinder *Finder, bool Value,
|
||||
StringRef Id);
|
||||
|
||||
void
|
||||
replaceWithThenStatement(const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
const Expr *BoolLiteral);
|
||||
|
||||
void
|
||||
replaceWithElseStatement(const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
const Expr *BoolLiteral);
|
||||
|
||||
void
|
||||
replaceWithCondition(const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
const ConditionalOperator *Ternary, bool Negated);
|
||||
|
||||
void replaceWithReturnCondition(
|
||||
const ast_matchers::MatchFinder::MatchResult &Result, const IfStmt *If,
|
||||
bool Negated);
|
||||
|
||||
void
|
||||
replaceWithAssignment(const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
const IfStmt *If, bool Negated);
|
||||
|
||||
void replaceCompoundReturnWithCondition(
|
||||
const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
const CompoundStmt *Compound, bool Negated);
|
||||
|
||||
void replaceCompoundReturnWithCondition(
|
||||
const ast_matchers::MatchFinder::MatchResult &Result, bool Negated,
|
||||
const IfStmt *If);
|
||||
|
||||
void replaceCaseCompoundReturnWithCondition(
|
||||
const ast_matchers::MatchFinder::MatchResult &Result, bool Negated);
|
||||
|
||||
void replaceDefaultCompoundReturnWithCondition(
|
||||
const ast_matchers::MatchFinder::MatchResult &Result, bool Negated);
|
||||
|
||||
void replaceLabelCompoundReturnWithCondition(
|
||||
const ast_matchers::MatchFinder::MatchResult &Result, bool Negated);
|
||||
|
||||
void issueDiag(const ast_matchers::MatchFinder::MatchResult &Result,
|
||||
SourceLocation Loc, StringRef Description,
|
||||
SourceRange ReplacementRange, StringRef Replacement);
|
||||
void issueDiag(const ASTContext &Result, SourceLocation Loc,
|
||||
StringRef Description, SourceRange ReplacementRange,
|
||||
StringRef Replacement);
|
||||
|
||||
const bool ChainedConditionalReturn;
|
||||
const bool ChainedConditionalAssignment;
|
||||
|
|
|
|||
|
|
@ -1,68 +0,0 @@
|
|||
//===-- SimplifyBooleanExprMatchers.h - 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 "clang/ASTMatchers/ASTMatchersInternal.h"
|
||||
#include "clang/ASTMatchers/ASTMatchersMacros.h"
|
||||
|
||||
namespace clang {
|
||||
namespace ast_matchers {
|
||||
|
||||
/// Matches the substatement associated with a case, default or label statement.
|
||||
///
|
||||
/// Given
|
||||
/// \code
|
||||
/// switch (1) { case 1: break; case 2: return; break; default: return; break;
|
||||
/// }
|
||||
/// foo: return;
|
||||
/// bar: break;
|
||||
/// \endcode
|
||||
///
|
||||
/// caseStmt(hasSubstatement(returnStmt()))
|
||||
/// matches "case 2: return;"
|
||||
/// defaultStmt(hasSubstatement(returnStmt()))
|
||||
/// matches "default: return;"
|
||||
/// labelStmt(hasSubstatement(breakStmt()))
|
||||
/// matches "bar: break;"
|
||||
AST_POLYMORPHIC_MATCHER_P(hasSubstatement,
|
||||
AST_POLYMORPHIC_SUPPORTED_TYPES(CaseStmt, DefaultStmt,
|
||||
LabelStmt),
|
||||
internal::Matcher<Stmt>, InnerMatcher) {
|
||||
return InnerMatcher.matches(*Node.getSubStmt(), Finder, Builder);
|
||||
}
|
||||
|
||||
/// Matches two consecutive statements within a compound statement.
|
||||
///
|
||||
/// Given
|
||||
/// \code
|
||||
/// { if (x > 0) return true; return false; }
|
||||
/// \endcode
|
||||
/// compoundStmt(hasSubstatementSequence(ifStmt(), returnStmt()))
|
||||
/// matches '{ if (x > 0) return true; return false; }'
|
||||
AST_POLYMORPHIC_MATCHER_P2(hasSubstatementSequence,
|
||||
AST_POLYMORPHIC_SUPPORTED_TYPES(CompoundStmt,
|
||||
StmtExpr),
|
||||
internal::Matcher<Stmt>, InnerMatcher1,
|
||||
internal::Matcher<Stmt>, InnerMatcher2) {
|
||||
if (const CompoundStmt *CS = CompoundStmtMatcher<NodeType>::get(Node)) {
|
||||
auto It = matchesFirstInPointerRange(InnerMatcher1, CS->body_begin(),
|
||||
CS->body_end(), Finder, Builder);
|
||||
while (It != CS->body_end()) {
|
||||
++It;
|
||||
if (It == CS->body_end())
|
||||
return false;
|
||||
if (InnerMatcher2.matches(**It, Finder, Builder))
|
||||
return true;
|
||||
It = matchesFirstInPointerRange(InnerMatcher1, It, CS->body_end(), Finder,
|
||||
Builder);
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
} // namespace ast_matchers
|
||||
} // namespace clang
|
||||
|
|
@ -2,8 +2,6 @@
|
|||
#include "ClangTidyTest.h"
|
||||
#include "readability/BracesAroundStatementsCheck.h"
|
||||
#include "readability/NamespaceCommentCheck.h"
|
||||
#include "readability/SimplifyBooleanExprMatchers.h"
|
||||
#include "clang/ASTMatchers/ASTMatchers.h"
|
||||
#include "gtest/gtest.h"
|
||||
|
||||
namespace clang {
|
||||
|
|
@ -14,91 +12,6 @@ using readability::BracesAroundStatementsCheck;
|
|||
using readability::NamespaceCommentCheck;
|
||||
using namespace ast_matchers;
|
||||
|
||||
TEST_P(ASTMatchersTest, HasCaseSubstatement) {
|
||||
EXPECT_TRUE(matches(
|
||||
"void f() { switch (1) { case 1: return; break; default: break; } }",
|
||||
traverse(TK_AsIs, caseStmt(hasSubstatement(returnStmt())))));
|
||||
}
|
||||
|
||||
TEST_P(ASTMatchersTest, HasDefaultSubstatement) {
|
||||
EXPECT_TRUE(matches(
|
||||
"void f() { switch (1) { case 1: return; break; default: break; } }",
|
||||
traverse(TK_AsIs, defaultStmt(hasSubstatement(breakStmt())))));
|
||||
}
|
||||
|
||||
TEST_P(ASTMatchersTest, HasLabelSubstatement) {
|
||||
EXPECT_TRUE(
|
||||
matches("void f() { while (1) { bar: break; foo: return; } }",
|
||||
traverse(TK_AsIs, labelStmt(hasSubstatement(breakStmt())))));
|
||||
}
|
||||
|
||||
TEST_P(ASTMatchersTest, HasSubstatementSequenceSimple) {
|
||||
const char *Text = "int f() { int x = 5; if (x < 0) return 1; return 0; }";
|
||||
EXPECT_TRUE(matches(
|
||||
Text, compoundStmt(hasSubstatementSequence(ifStmt(), returnStmt()))));
|
||||
EXPECT_FALSE(matches(
|
||||
Text, compoundStmt(hasSubstatementSequence(ifStmt(), labelStmt()))));
|
||||
EXPECT_FALSE(matches(
|
||||
Text, compoundStmt(hasSubstatementSequence(returnStmt(), ifStmt()))));
|
||||
EXPECT_FALSE(matches(
|
||||
Text, compoundStmt(hasSubstatementSequence(switchStmt(), labelStmt()))));
|
||||
}
|
||||
|
||||
TEST_P(ASTMatchersTest, HasSubstatementSequenceAlmost) {
|
||||
const char *Text = R"code(
|
||||
int f() {
|
||||
int x = 5;
|
||||
if (x < 10)
|
||||
;
|
||||
if (x < 0)
|
||||
return 1;
|
||||
return 0;
|
||||
}
|
||||
)code";
|
||||
EXPECT_TRUE(matches(
|
||||
Text, compoundStmt(hasSubstatementSequence(ifStmt(), returnStmt()))));
|
||||
EXPECT_TRUE(
|
||||
matches(Text, compoundStmt(hasSubstatementSequence(ifStmt(), ifStmt()))));
|
||||
}
|
||||
|
||||
TEST_P(ASTMatchersTest, HasSubstatementSequenceComplex) {
|
||||
const char *Text = R"code(
|
||||
int f() {
|
||||
int x = 5;
|
||||
if (x < 10)
|
||||
x -= 10;
|
||||
if (x < 0)
|
||||
return 1;
|
||||
return 0;
|
||||
}
|
||||
)code";
|
||||
EXPECT_TRUE(matches(
|
||||
Text, compoundStmt(hasSubstatementSequence(ifStmt(), returnStmt()))));
|
||||
EXPECT_FALSE(
|
||||
matches(Text, compoundStmt(hasSubstatementSequence(ifStmt(), expr()))));
|
||||
}
|
||||
|
||||
TEST_P(ASTMatchersTest, HasSubstatementSequenceExpression) {
|
||||
const char *Text = R"code(
|
||||
int f() {
|
||||
return ({ int x = 5;
|
||||
int result;
|
||||
if (x < 10)
|
||||
x -= 10;
|
||||
if (x < 0)
|
||||
result = 1;
|
||||
else
|
||||
result = 0;
|
||||
result;
|
||||
});
|
||||
}
|
||||
)code";
|
||||
EXPECT_TRUE(
|
||||
matches(Text, stmtExpr(hasSubstatementSequence(ifStmt(), expr()))));
|
||||
EXPECT_FALSE(
|
||||
matches(Text, stmtExpr(hasSubstatementSequence(ifStmt(), returnStmt()))));
|
||||
}
|
||||
|
||||
// Copied from ASTMatchersTests
|
||||
static std::vector<TestClangConfig> allTestClangConfigs() {
|
||||
std::vector<TestClangConfig> all_configs;
|
||||
|
|
|
|||
Loading…
Reference in New Issue