https://github.com/SimplyDanny created
https://github.com/llvm/llvm-project/pull/81420
None
From 71a6a9810c9c3b67058f09969417ebac0f950fdb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Danny=20M=C3=B6sch?= <danny.moe...@icloud.com>
Date: Sun, 11 Feb 2024 17:04:12 +0100
Subject: [PATCH] [clang-tidy] Add fix-its to `avoid-return-with-void-value`
check
---
.../AvoidReturnWithVoidValueCheck.cpp | 23 +++++++++++++++++--
clang-tools-extra/docs/ReleaseNotes.rst | 4 ++++
.../avoid-return-with-void-value.cpp | 14 +++++++++--
3 files changed, 37 insertions(+), 4 deletions(-)
diff --git
a/clang-tools-extra/clang-tidy/readability/AvoidReturnWithVoidValueCheck.cpp
b/clang-tools-extra/clang-tidy/readability/AvoidReturnWithVoidValueCheck.cpp
index e3400f614fa564..1aa03fe9ba5da7 100644
--- a/clang-tools-extra/clang-tidy/readability/AvoidReturnWithVoidValueCheck.cpp
+++ b/clang-tools-extra/clang-tidy/readability/AvoidReturnWithVoidValueCheck.cpp
@@ -10,6 +10,7 @@
#include "clang/AST/Stmt.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchers.h"
+#include "clang/Lex/Lexer.h"
using namespace clang::ast_matchers;
@@ -42,10 +43,28 @@ void AvoidReturnWithVoidValueCheck::check(
const auto *VoidReturn = Result.Nodes.getNodeAs<ReturnStmt>("void_return");
if (IgnoreMacros && VoidReturn->getBeginLoc().isMacroID())
return;
- if (!StrictMode && !Result.Nodes.getNodeAs<CompoundStmt>("compound_parent"))
+ const auto *SurroundingBlock =
+ Result.Nodes.getNodeAs<CompoundStmt>("compound_parent");
+ if (!StrictMode && !SurroundingBlock)
return;
+ const auto ReturnExpr =
+ Lexer::getSourceText(CharSourceRange::getTokenRange(
+ VoidReturn->getRetValue()->getSourceRange()),
+ *Result.SourceManager, getLangOpts());
+ SourceLocation SemicolonPos;
+ if (const auto NextToken =
+ Lexer::findNextToken(VoidReturn->getRetValue()->getEndLoc(),
+ *Result.SourceManager, getLangOpts()))
+ SemicolonPos = NextToken->getEndLoc();
+ auto Replacement = (ReturnExpr + "; return;").str();
+ if (!SurroundingBlock)
+ Replacement = "{" + Replacement + "}";
diag(VoidReturn->getBeginLoc(), "return statement within a void function "
- "should not have a specified return value");
+ "should not have a specified return value")
+ << FixItHint::CreateReplacement(
+ CharSourceRange::getTokenRange(VoidReturn->getBeginLoc(),
+ SemicolonPos),
+ Replacement);
}
void AvoidReturnWithVoidValueCheck::storeOptions(
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst
b/clang-tools-extra/docs/ReleaseNotes.rst
index ee68c8f49b3df2..bfe0e4ba2e131d 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -160,6 +160,10 @@ Changes in existing checks
`AllowStringArrays` option, enabling the exclusion of array types with
deduced
length initialized from string literals.
+- Improved :doc:`readability-avoid-return-with-void-value
+ <clang-tidy/checks/readability/avoid-return-with-void-value>` check by adding
+ fix-its.
+
Removed checks
^^^^^^^^^^^^^^
diff --git
a/clang-tools-extra/test/clang-tidy/checkers/readability/avoid-return-with-void-value.cpp
b/clang-tools-extra/test/clang-tidy/checkers/readability/avoid-return-with-void-value.cpp
index f00407c99ce570..0d269ceee82bc9 100644
---
a/clang-tools-extra/test/clang-tidy/checkers/readability/avoid-return-with-void-value.cpp
+++
b/clang-tools-extra/test/clang-tidy/checkers/readability/avoid-return-with-void-value.cpp
@@ -12,14 +12,18 @@ void f2() {
return f1();
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: return statement within a void
function should not have a specified return value
[readability-avoid-return-with-void-value]
// CHECK-MESSAGES-LENIENT: :[[@LINE-2]]:5: warning: return statement
within a void function should not have a specified return value
[readability-avoid-return-with-void-value]
+ // CHECK-FIXES: f1(); return;
}
void f3(bool b) {
if (b) return f1();
// CHECK-MESSAGES: :[[@LINE-1]]:12: warning: return statement within a
void function should not have a specified return value
[readability-avoid-return-with-void-value]
+ // CHECK-FIXES: if (b) {f1(); return;}
return f2();
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: return statement within a void
function should not have a specified return value
[readability-avoid-return-with-void-value]
// CHECK-MESSAGES-LENIENT: :[[@LINE-2]]:5: warning: return statement
within a void function should not have a specified return value
[readability-avoid-return-with-void-value]
+ // CHECK-FIXES: f2(); return;
+ // CHECK-FIXES-LENIENT: f2(); return;
}
template<class T>
@@ -29,6 +33,8 @@ void f5() {
return f4<void>();
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: return statement within a void
function should not have a specified return value
[readability-avoid-return-with-void-value]
// CHECK-MESSAGES-LENIENT: :[[@LINE-2]]:5: warning: return statement
within a void function should not have a specified return value
[readability-avoid-return-with-void-value]
+ // CHECK-FIXES: f4<void>(); return;
+ // CHECK-FIXES-LENIENT: f4<void>(); return;
}
void f6() { return; }
@@ -41,6 +47,8 @@ void f9() {
return (void)f7();
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: return statement within a void
function should not have a specified return value
[readability-avoid-return-with-void-value]
// CHECK-MESSAGES-LENIENT: :[[@LINE-2]]:5: warning: return statement
within a void function should not have a specified return value
[readability-avoid-return-with-void-value]
+ // CHECK-FIXES: (void)f7(); return;
+ // CHECK-FIXES-LENIENT: (void)f7(); return;
}
#define RETURN_VOID return (void)1
@@ -50,12 +58,12 @@ void f10() {
// CHECK-MESSAGES-INCLUDE-MACROS: :[[@LINE-1]]:5: warning: return
statement within a void function should not have a specified return value
[readability-avoid-return-with-void-value]
}
-template <typename A>
+template <typename A>
struct C {
C(A) {}
};
-template <class T>
+template <class T>
C<T> f11() { return {}; }
using VOID = void;
@@ -66,4 +74,6 @@ VOID f13() {
return f12();
// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: return statement within a void
function should not have a specified return value
[readability-avoid-return-with-void-value]
// CHECK-MESSAGES-LENIENT: :[[@LINE-2]]:5: warning: return statement
within a void function should not have a specified return value
[readability-avoid-return-with-void-value]
+ // CHECK-FIXES: f12(); return;
+ // CHECK-FIXES-LENIENT: f12(); return;
}
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
