mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

clang-tidy module: look for sizeof string literal in cmStrLen() check

Browse Source
This commit is contained in:
Kyle Edwards
2022-11-16 09:44:29 -05:00
parent 0784261a68
commit c6368a23fe
4 changed files with 90 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Utilities/ClangTidyModule/Tests/cmake-use-cmstrlen-fixit.cxx
View File

@@ -27,11 +27,16 @@ int main()
(void)cmStrLen("Goodbye");
(void)cmStrLen("Hola");
(void)cmStrLen("Bonjour");
(void)(cmStrLen("Hallo"));
(void)(4 + cmStrLen("Hallo"));
(void)(cmStrLen("Hallo"));
(void)(4 + cmStrLen("Hallo"));
// No correction needed
(void)ns2::strlen("Salve");
(void)cmStrLen("Konnichiwa");
(void)strlen(s0);
(void)(sizeof("Hallo") - 2);
return 0;
}

32
Utilities/ClangTidyModule/Tests/cmake-use-cmstrlen-stdout.txt
View File

@@ -18,3 +18,35 @@ cmake-use-cmstrlen.cxx:29:9: warning: use cmStrLen() for string literals [cmake-
^~~~~~~~~~~
cmStrLen
cmake-use-cmstrlen.cxx:29:9: note: FIX-IT applied suggested code changes
cmake-use-cmstrlen.cxx:30:10: warning: use cmStrLen() for string literals [cmake-use-cmstrlen]
(void)(sizeof("Hallo") - 1);
^~~~~~ ~~~
cmStrLen
cmake-use-cmstrlen.cxx:30:10: note: FIX-IT applied suggested code changes
cmake-use-cmstrlen.cxx:30:26: note: FIX-IT applied suggested code changes
(void)(sizeof("Hallo") - 1);
^
cmake-use-cmstrlen.cxx:31:14: warning: use cmStrLen() for string literals [cmake-use-cmstrlen]
(void)(4 + sizeof("Hallo") - 1);
^~~~~~ ~~~
cmStrLen
cmake-use-cmstrlen.cxx:31:14: note: FIX-IT applied suggested code changes
cmake-use-cmstrlen.cxx:31:30: note: FIX-IT applied suggested code changes
(void)(4 + sizeof("Hallo") - 1);
^
cmake-use-cmstrlen.cxx:32:10: warning: use cmStrLen() for string literals [cmake-use-cmstrlen]
(void)(sizeof "Hallo" - 1);
^~~~~~ ~~~
cmStrLen( )
cmake-use-cmstrlen.cxx:32:10: note: FIX-IT applied suggested code changes
cmake-use-cmstrlen.cxx:32:25: note: FIX-IT applied suggested code changes
(void)(sizeof "Hallo" - 1);
^
cmake-use-cmstrlen.cxx:33:14: warning: use cmStrLen() for string literals [cmake-use-cmstrlen]
(void)(4 + sizeof "Hallo" - 1);
^~~~~~ ~~~
cmStrLen( )
cmake-use-cmstrlen.cxx:33:14: note: FIX-IT applied suggested code changes
cmake-use-cmstrlen.cxx:33:29: note: FIX-IT applied suggested code changes
(void)(4 + sizeof "Hallo" - 1);
^

5
Utilities/ClangTidyModule/Tests/cmake-use-cmstrlen.cxx
View File

@@ -27,11 +27,16 @@ int main()
(void)::strlen("Goodbye");
(void)std::strlen("Hola");
(void)ns1::strlen("Bonjour");
(void)(sizeof("Hallo") - 1);
(void)(4 + sizeof("Hallo") - 1);
(void)(sizeof "Hallo" - 1);
(void)(4 + sizeof "Hallo" - 1);
// No correction needed
(void)ns2::strlen("Salve");
(void)cmStrLen("Konnichiwa");
(void)strlen(s0);
(void)(sizeof("Hallo") - 2);
return 0;
}

52
Utilities/ClangTidyModule/UseCmstrlenCheck.cxx
View File

@@ -17,17 +17,61 @@ UseCmstrlenCheck::UseCmstrlenCheck(StringRef Name, ClangTidyContext* Context)
void UseCmstrlenCheck::registerMatchers(MatchFinder* Finder)
{
Finder->addMatcher(callExpr(callee(functionDecl(hasName("::strlen"))),
callee(expr().bind("callee")),
callee(expr().bind("strlen")),
hasArgument(0, stringLiteral())),
this);
auto IsSizeOfStringLiteral =
unaryExprOrTypeTraitExpr(
ofKind(UETT_SizeOf),
anyOf(has(parenExpr(has(stringLiteral())).bind("paren")),
has(stringLiteral())))
.bind("sizeOf");
Finder->addMatcher(
binaryOperator(
hasOperatorName("-"),
hasLHS(anyOf(
binaryOperator(hasOperatorName("+"), hasRHS(IsSizeOfStringLiteral)),
IsSizeOfStringLiteral)),
hasRHS(implicitCastExpr(has(integerLiteral(equals(1)).bind("literal")))))
.bind("sizeOfMinus"),
this);
}
void UseCmstrlenCheck::check(const MatchFinder::MatchResult& Result)
{
const Expr* Node = Result.Nodes.getNodeAs<Expr>("callee");
const Expr* Strlen = Result.Nodes.getNodeAs<Expr>("strlen");
const BinaryOperator* SizeOfMinus =
Result.Nodes.getNodeAs<BinaryOperator>("sizeOfMinus");
this->diag(Node->getBeginLoc(), "use cmStrLen() for string literals")
<< FixItHint::CreateReplacement(Node->getSourceRange(), "cmStrLen");
if (Strlen) {
this->diag(Strlen->getBeginLoc(), "use cmStrLen() for string literals")
<< FixItHint::CreateReplacement(Strlen->getSourceRange(), "cmStrLen");
}
if (SizeOfMinus) {
const ParenExpr* Paren = Result.Nodes.getNodeAs<ParenExpr>("paren");
const UnaryExprOrTypeTraitExpr* SizeOf =
Result.Nodes.getNodeAs<UnaryExprOrTypeTraitExpr>("sizeOf");
const IntegerLiteral* Literal =
Result.Nodes.getNodeAs<IntegerLiteral>("literal");
std::vector<FixItHint> FixIts;
if (Paren) {
FixIts.push_back(
FixItHint::CreateReplacement(SizeOf->getOperatorLoc(), "cmStrLen"));
FixIts.push_back(FixItHint::CreateRemoval(
SourceRange(SizeOfMinus->getOperatorLoc(), Literal->getLocation())));
} else {
FixIts.push_back(
FixItHint::CreateReplacement(SizeOf->getOperatorLoc(), "cmStrLen("));
FixIts.push_back(FixItHint::CreateReplacement(
SourceRange(SizeOfMinus->getOperatorLoc(), Literal->getLocation()),
")"));
}
this->diag(SizeOf->getOperatorLoc(), "use cmStrLen() for string literals")
<< FixIts;
}
}
}
}