Skip to content

[clang-tidy] Ignore if consteval in else-after-return #91588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 13, 2024

Conversation

JoverZhang
Copy link
Contributor

Fixes #91561.

Copy link

github-actions bot commented May 9, 2024

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@cjdb
Copy link
Contributor

cjdb commented May 10, 2024

Thanks for your patch! Would you be able to add a test case for this please?

@JoverZhang
Copy link
Contributor Author

Thanks for your patch! Would you be able to add a test case for this please?

Yes, thanks. I added a test case.

@JoverZhang JoverZhang marked this pull request as ready for review May 12, 2024 14:46
@llvmbot
Copy link
Member

llvmbot commented May 12, 2024

@llvm/pr-subscribers-clang-tools-extra

@llvm/pr-subscribers-clang-tidy

Author: Jover (JoverZhang)

Changes

Fixes #91561.


Full diff: https://github.com/llvm/llvm-project/pull/91588.diff

2 Files Affected:

  • (modified) clang-tools-extra/clang-tidy/readability/ElseAfterReturnCheck.cpp (+2-2)
  • (added) clang-tools-extra/test/clang-tidy/checkers/readability/else-after-return-if-consteval.cpp (+17)
diff --git a/clang-tools-extra/clang-tidy/readability/ElseAfterReturnCheck.cpp b/clang-tools-extra/clang-tidy/readability/ElseAfterReturnCheck.cpp
index 1e85caf688355..2b185e7594add 100644
--- a/clang-tools-extra/clang-tidy/readability/ElseAfterReturnCheck.cpp
+++ b/clang-tools-extra/clang-tidy/readability/ElseAfterReturnCheck.cpp
@@ -113,7 +113,7 @@ static bool containsDeclInScope(const Stmt *Node) {
 }
 
 static void removeElseAndBrackets(DiagnosticBuilder &Diag, ASTContext &Context,
-                           const Stmt *Else, SourceLocation ElseLoc) {
+                                  const Stmt *Else, SourceLocation ElseLoc) {
   auto Remap = [&](SourceLocation Loc) {
     return Context.getSourceManager().getExpansionLoc(Loc);
   };
@@ -172,7 +172,7 @@ void ElseAfterReturnCheck::registerMatchers(MatchFinder *Finder) {
       breakStmt().bind(InterruptingStr), cxxThrowExpr().bind(InterruptingStr)));
   Finder->addMatcher(
       compoundStmt(
-          forEach(ifStmt(unless(isConstexpr()),
+          forEach(ifStmt(unless(isConstexpr()), unless(isConsteval()),
                          hasThen(stmt(
                              anyOf(InterruptsControlFlow,
                                    compoundStmt(has(InterruptsControlFlow))))),
diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/else-after-return-if-consteval.cpp b/clang-tools-extra/test/clang-tidy/checkers/readability/else-after-return-if-consteval.cpp
new file mode 100644
index 0000000000000..6235d8623ca7b
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/checkers/readability/else-after-return-if-consteval.cpp
@@ -0,0 +1,17 @@
+// RUN: %check_clang_tidy -std=c++20 %s readability-else-after-return %t 
+
+// Consteval if is an exception to the rule, we cannot remove the else.
+void f() {
+  if (sizeof(int) > 4) {
+    return;
+  } else {
+    return;
+  }
+  // CHECK-MESSAGES: [[@LINE-3]]:5: warning: do not use 'else' after 'return'
+
+  if consteval {
+    return;
+  } else {
+    return;
+  }
+}

Copy link
Contributor

@5chmidti 5chmidti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add an entry to the release notes here:

Changes in existing checks

do note that the entries are sorted by their check names.

Otherwise looks good.

@@ -0,0 +1,17 @@
// RUN: %check_clang_tidy -std=c++20 %s readability-else-after-return %t
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While consteval was added in C++20, if consteval is a C++23 feature. Please use -std=c++23
https://en.cppreference.com/w/cpp/language/if#Consteval_if

@JoverZhang
Copy link
Contributor Author

Please add an entry to the release notes here:

Changes in existing checks

do note that the entries are sorted by their check names.
Otherwise looks good.

Okay, I added.

@JoverZhang JoverZhang changed the title [WIP][clang-tidy] Ignore if consteval in else-after-return [clang-tidy] Ignore if consteval in else-after-return May 13, 2024
@JoverZhang JoverZhang requested a review from 5chmidti May 13, 2024 02:20
Co-authored-by: Danny Mösch <danny.moesch@icloud.com>
@SimplyDanny SimplyDanny merged commit 2a114d1 into llvm:main May 13, 2024
Copy link

@JoverZhang Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested
by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as
the builds can include changes from many authors. It is not uncommon for your
change to be included in a build that fails due to someone else's changes, or
infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself.
This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

@SimplyDanny
Copy link
Member

Thank you, @JoverZhang!

@JoverZhang JoverZhang deleted the i91561 branch May 14, 2024 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

readability-else-after-return/llvm-else-after-return warn on else after if consteval
6 participants