-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3716 from oowekyala:merge-empty-rules
[java] Merge rules that check for empty things #3716
- Loading branch information
Showing
13 changed files
with
990 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <?xml version="1.0"?> | ||
|
|
||
| <ruleset name="6460" | ||
| xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd"> | ||
| <description> | ||
| This ruleset contains links to rules that are new in PMD v6.46.0 | ||
| </description> | ||
|
|
||
| <rule ref="category/java/codestyle.xml/EmptyControlStatement"/> | ||
| <rule ref="category/java/codestyle.xml/UnnecessarySemicolon"/> | ||
|
|
||
| </ruleset> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
161 changes: 161 additions & 0 deletions
161
...src/main/java/net/sourceforge/pmd/lang/java/rule/codestyle/EmptyControlStatementRule.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /** | ||
| * BSD-style license; for more info see http://pmd.sourceforge.net/license.html | ||
| */ | ||
|
|
||
| package net.sourceforge.pmd.lang.java.rule.codestyle; | ||
|
|
||
| import net.sourceforge.pmd.lang.java.ast.ASTBlock; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTDoStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTEmptyStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTFinallyStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTForStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTIfStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTInitializer; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTLocalVariableDeclaration; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTResource; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTResourceSpecification; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTSwitchStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTSynchronizedStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTTryStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTVariableDeclaratorId; | ||
| import net.sourceforge.pmd.lang.java.ast.ASTWhileStatement; | ||
| import net.sourceforge.pmd.lang.java.ast.JavaNode; | ||
| import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule; | ||
| import net.sourceforge.pmd.lang.java.rule.internal.JavaRuleUtil; | ||
|
|
||
| public class EmptyControlStatementRule extends AbstractJavaRule { | ||
|
|
||
| public EmptyControlStatementRule() { | ||
| addRuleChainVisit(ASTFinallyStatement.class); | ||
| addRuleChainVisit(ASTSynchronizedStatement.class); | ||
| addRuleChainVisit(ASTTryStatement.class); | ||
| addRuleChainVisit(ASTDoStatement.class); | ||
| addRuleChainVisit(ASTBlock.class); | ||
| addRuleChainVisit(ASTForStatement.class); | ||
| addRuleChainVisit(ASTWhileStatement.class); | ||
| addRuleChainVisit(ASTIfStatement.class); | ||
| addRuleChainVisit(ASTSwitchStatement.class); | ||
| addRuleChainVisit(ASTInitializer.class); | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(JavaNode node, Object data) { | ||
| throw new UnsupportedOperationException("should not be called"); | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTFinallyStatement node, Object data) { | ||
| if (isEmpty(node.getBody())) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty finally clause"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTSynchronizedStatement node, Object data) { | ||
| if (isEmpty(node.getBody())) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty synchronized statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTSwitchStatement node, Object data) { | ||
| if (node.getNumChildren() == 1) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty switch statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTBlock node, Object data) { | ||
| if (isEmpty(node) && node.getNthParent(3) instanceof ASTBlock) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty block"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTIfStatement node, Object data) { | ||
| if (isEmpty(node.getThenBranch().getChild(0))) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty if statement"); | ||
| } | ||
| if (node.hasElse() && isEmpty(node.getElseBranch().getChild(0))) { | ||
| asCtx(data).addViolationWithMessage(node.getElseBranch(), "Empty else statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTWhileStatement node, Object data) { | ||
| if (isEmpty(node.getBody())) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty while statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTForStatement node, Object data) { | ||
| if (node.isForeach() && JavaRuleUtil.isExplicitUnusedVarName(node.getFirstChildOfType(ASTLocalVariableDeclaration.class) | ||
| .getFirstDescendantOfType(ASTVariableDeclaratorId.class).getName())) { | ||
| // allow `for (ignored : iterable) {}` | ||
| return null; | ||
| } | ||
| if (isEmpty(node.getBody())) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty for statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTDoStatement node, Object data) { | ||
| if (isEmpty(node.getBody())) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty do..while statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTInitializer node, Object data) { | ||
| if (isEmpty(node.getBody())) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty initializer statement"); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public Object visit(ASTTryStatement node, Object data) { | ||
| if (isEmpty(node.getBody())) { | ||
| // all resources must be explicitly ignored | ||
| boolean allResourcesIgnored = true; | ||
| boolean hasResource = false; | ||
| ASTResourceSpecification resources = node.getFirstChildOfType(ASTResourceSpecification.class); | ||
| if (resources != null) { | ||
| for (ASTResource resource : resources.findDescendantsOfType(ASTResource.class)) { | ||
| hasResource = true; | ||
| String name = resource.getStableName(); | ||
| if (!JavaRuleUtil.isExplicitUnusedVarName(name)) { | ||
| allResourcesIgnored = false; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (hasResource && !allResourcesIgnored) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty try body - you could rename the resource to ''ignored''"); | ||
| } else if (!hasResource) { | ||
| asCtx(data).addViolationWithMessage(node, "Empty try body"); | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private boolean isEmpty(JavaNode node) { | ||
| if (node instanceof ASTStatement) { | ||
| node = node.getChild(0); | ||
| } | ||
| return node instanceof ASTBlock && node.getNumChildren() == 0 | ||
| || node instanceof ASTEmptyStatement; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.