10 #include "clang/AST/ASTContext.h"
11 #include "clang/ASTMatchers/ASTMatchFinder.h"
21 "enum values are from different enum types";
24 "enum type seems like a bitmask (contains mostly "
25 "power-of-2 literals), but this literal is not a "
29 "enum type seems like a bitmask (contains mostly "
30 "power-of-2 literals) but %plural{1:a literal is|:some literals are}0 not "
41 const auto MinMaxVal = std::minmax_element(
42 EnumDec->enumerator_begin(), EnumDec->enumerator_end(),
43 [](
const EnumConstantDecl *E1,
const EnumConstantDecl *E2) {
44 return llvm::APSInt::compareValues(E1->getInitVal(),
45 E2->getInitVal()) < 0;
47 MinVal = MinMaxVal.first->getInitVal();
48 MaxVal = MinMaxVal.second->getInitVal();
54 return std::distance(EnumDec->enumerator_begin(), EnumDec->enumerator_end());
58 const EnumDecl *Enum2) {
60 return llvm::APSInt::compareValues(Range1.MaxVal, Range2.
MinVal) < 0 ||
61 llvm::APSInt::compareValues(Range2.
MaxVal, Range1.MinVal) < 0;
65 llvm::APSInt Val = EnumConst->getInitVal();
66 if (Val.isPowerOf2() || !Val.getBoolValue())
68 const Expr *InitExpr = EnumConst->getInitExpr();
71 return isa<IntegerLiteral>(InitExpr->IgnoreImpCasts());
75 auto EnumConst = std::max_element(
76 EnumDec->enumerator_begin(), EnumDec->enumerator_end(),
77 [](
const EnumConstantDecl *E1,
const EnumConstantDecl *E2) {
78 return E1->getInitVal() < E2->getInitVal();
81 if (
const Expr *InitExpr = EnumConst->getInitExpr()) {
82 return EnumConst->getInitVal().countTrailingOnes() ==
83 EnumConst->getInitVal().getActiveBits() &&
84 isa<IntegerLiteral>(InitExpr->IgnoreImpCasts());
91 EnumDec->enumerator_begin(), EnumDec->enumerator_end(),
104 return NonPowOfTwoCounter >= 1 && NonPowOfTwoCounter <= 2 &&
105 NonPowOfTwoCounter < EnumLen / 2 &&
110 SuspiciousEnumUsageCheck::SuspiciousEnumUsageCheck(StringRef
Name,
113 StrictMode(Options.getLocalOrGlobal(
"StrictMode", false)) {}
120 const auto enumExpr = [](StringRef RefName, StringRef DeclName) {
121 return expr(ignoringImpCasts(expr().bind(RefName)),
122 ignoringImpCasts(hasType(enumDecl().bind(DeclName))));
126 binaryOperator(hasOperatorName(
"|"), hasLHS(enumExpr(
"",
"enumDecl")),
127 hasRHS(expr(enumExpr(
"",
"otherEnumDecl"),
128 ignoringImpCasts(hasType(enumDecl(
129 unless(equalsBoundNode(
"enumDecl"))))))))
134 binaryOperator(hasAnyOperatorName(
"+",
"|"),
135 hasLHS(enumExpr(
"lhsExpr",
"enumDecl")),
136 hasRHS(expr(enumExpr(
"rhsExpr",
""),
137 ignoringImpCasts(hasType(
138 enumDecl(equalsBoundNode(
"enumDecl"))))))),
143 hasAnyOperatorName(
"+",
"|"),
144 hasOperands(expr(hasType(isInteger()), unless(enumExpr(
"",
""))),
145 enumExpr(
"enumExpr",
"enumDecl"))),
148 Finder->addMatcher(binaryOperator(hasAnyOperatorName(
"|=",
"+="),
149 hasRHS(enumExpr(
"enumExpr",
"enumDecl"))),
153 void SuspiciousEnumUsageCheck::checkSuspiciousBitmaskUsage(
154 const Expr *NodeExpr,
const EnumDecl *EnumDec) {
155 const auto *EnumExpr = dyn_cast<DeclRefExpr>(NodeExpr);
156 const auto *EnumConst =
157 EnumExpr ? dyn_cast<EnumConstantDecl>(EnumExpr->getDecl()) :
nullptr;
172 if (
const auto *DiffEnumOp =
173 Result.Nodes.getNodeAs<BinaryOperator>(
"diffEnumOp")) {
174 const auto *EnumDec = Result.Nodes.getNodeAs<EnumDecl>(
"enumDecl");
175 const auto *OtherEnumDec =
176 Result.Nodes.getNodeAs<EnumDecl>(
"otherEnumDecl");
180 if (EnumDec->enumerator_begin() == EnumDec->enumerator_end() ||
181 OtherEnumDec->enumerator_begin() == OtherEnumDec->enumerator_end())
194 const auto *EnumDec = Result.Nodes.getNodeAs<EnumDecl>(
"enumDecl");
201 if (
const auto *EnumExpr = Result.Nodes.getNodeAs<Expr>(
"enumExpr")) {
202 checkSuspiciousBitmaskUsage(EnumExpr, EnumDec);
208 const auto *LhsExpr = Result.Nodes.getNodeAs<Expr>(
"lhsExpr");
209 checkSuspiciousBitmaskUsage(LhsExpr, EnumDec);
211 const auto *RhsExpr = Result.Nodes.getNodeAs<Expr>(
"rhsExpr");
212 checkSuspiciousBitmaskUsage(RhsExpr, EnumDec);