chaitanyav updated this revision to Diff 525926.
chaitanyav marked an inline comment as done.
chaitanyav added a comment.
Use single backticks for options
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D151383/new/
https://reviews.llvm.org/D151383
Files:
clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.cpp
clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.h
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/clang-tidy/checks/bugprone/unused-return-value.rst
clang-tools-extra/test/clang-tidy/checkers/bugprone/unused-return-value.cpp
Index: clang-tools-extra/test/clang-tidy/checkers/bugprone/unused-return-value.cpp
===================================================================
--- clang-tools-extra/test/clang-tidy/checkers/bugprone/unused-return-value.cpp
+++ clang-tools-extra/test/clang-tidy/checkers/bugprone/unused-return-value.cpp
@@ -52,6 +52,9 @@
bool empty() const noexcept;
};
+class error_code {
+};
+
// the check should be able to match std lib calls even if the functions are
// declared inside inline namespaces
inline namespace v1 {
@@ -72,6 +75,10 @@
void useFuture(const std::future &fut);
+std::error_code errorFunc() {
+ return std::error_code();
+}
+
void warning() {
std::async(increment, 42);
// CHECK-NOTES: [[@LINE-1]]:3: warning: the value returned by this function should be used
@@ -185,6 +192,10 @@
// CHECK-NOTES: [[@LINE-1]]:5: warning: the value {{.*}} should be used
// CHECK-NOTES: [[@LINE-2]]:5: note: cast {{.*}} this warning
}
+
+ errorFunc();
+ // CHECK-NOTES: [[@LINE-1]]:3: warning: the value {{.*}} should be used
+ // CHECK-NOTES: [[@LINE-2]]:3: note: cast {{.*}} this warning
}
void noWarning() {
@@ -209,6 +220,8 @@
std::vector<Foo> VecNoWarning;
auto VecEmptyRetval = VecNoWarning.empty();
+ (void) errorFunc();
+
// test using the return value in different kinds of expressions
useFuture(std::async(increment, 42));
std::launder(&FNoWarning)->f();
Index: clang-tools-extra/docs/clang-tidy/checks/bugprone/unused-return-value.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/bugprone/unused-return-value.rst
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone/unused-return-value.rst
@@ -46,5 +46,11 @@
return value often indicates that the programmer confused the function with
``clear()``.
+.. option:: CheckedReturnTypes
+
+ Semicolon-separated list of function return types to check.
+ By default the following function return types are checked:
+ `std::error_code, std::expected, boost::system::error_code, abseil::Status`
+
`cert-err33-c <../cert/err33-c.html>`_ is an alias of this check that checks a
fixed and large set of standard library functions.
Index: clang-tools-extra/docs/ReleaseNotes.rst
===================================================================
--- clang-tools-extra/docs/ReleaseNotes.rst
+++ clang-tools-extra/docs/ReleaseNotes.rst
@@ -248,6 +248,10 @@
constructor initializers. Correctly handle constructor arguments as being
sequenced when constructor call is written as list-initialization.
+- Extend :doc:`bugprone-unused-return-value
+ <clang-tidy/checks/bugprone/unused-return-value>` check to check for all functions
+ with specified return types using the ``CheckedReturnTypes`` option.
+
- Deprecated :doc:`cert-dcl21-cpp
<clang-tidy/checks/cert/dcl21-cpp>` check.
@@ -391,6 +395,7 @@
<clang-tidy/checks/performance/no-automatic-move>`: warn on ``const &&``
constructors.
+
Removed checks
^^^^^^^^^^^^^^
Index: clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.h
===================================================================
--- clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.h
+++ clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.h
@@ -27,6 +27,7 @@
private:
std::string CheckedFunctions;
+ std::string CheckedReturnTypes;
};
} // namespace clang::tidy::bugprone
Index: clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.cpp
===================================================================
--- clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.cpp
+++ clang-tools-extra/clang-tidy/bugprone/UnusedReturnValueCheck.cpp
@@ -28,6 +28,17 @@
Finder, Builder);
}
+// Checks if the function return type is in CheckedReturnedTypes
+AST_MATCHER_P(FunctionDecl, hasAnyReturnType, std::vector<llvm::StringRef>,
+ RetTypes) {
+ auto FuncRetType = Node.getReturnType().getAsString();
+ for (const auto RetType : RetTypes) {
+ if (RetType == FuncRetType) {
+ return true;
+ }
+ }
+ return false;
+}
} // namespace
UnusedReturnValueCheck::UnusedReturnValueCheck(llvm::StringRef Name,
@@ -124,19 +135,28 @@
"::sigismember;"
"::strcasecmp;"
"::strsignal;"
- "::ttyname")) {}
+ "::ttyname")),
+ CheckedReturnTypes(Options.get("CheckedReturnTypes",
+ "std::error_code;"
+ "std::expected;"
+ "boost::system::error_code;"
+ "abseil::Status")) {}
void UnusedReturnValueCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
Options.store(Opts, "CheckedFunctions", CheckedFunctions);
+ Options.store(Opts, "CheckedReturnTypes", CheckedReturnTypes);
}
void UnusedReturnValueCheck::registerMatchers(MatchFinder *Finder) {
auto FunVec = utils::options::parseStringList(CheckedFunctions);
+ auto RetTypeVec = utils::options::parseStringList(CheckedReturnTypes);
+
auto MatchedCallExpr = expr(ignoringImplicit(ignoringParenImpCasts(
callExpr(callee(functionDecl(
// Don't match void overloads of checked functions.
unless(returns(voidType())),
- isInstantiatedFrom(hasAnyName(FunVec)))))
+ anyOf(isInstantiatedFrom(hasAnyName(FunVec)),
+ hasAnyReturnType(RetTypeVec)))))
.bind("match"))));
auto UnusedInCompoundStmt =
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
