-
Notifications
You must be signed in to change notification settings - Fork 680
/
IndentationAfterConditionalCheck.java
102 lines (92 loc) · 4.25 KB
/
IndentationAfterConditionalCheck.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*
* SonarQube Java
* Copyright (C) 2012-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.java.checks;
import java.util.Collections;
import org.sonar.check.Rule;
import org.sonar.java.model.LineUtils;
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.location.Position;
import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
import org.sonar.plugins.java.api.tree.BlockTree;
import org.sonar.plugins.java.api.tree.ForEachStatement;
import org.sonar.plugins.java.api.tree.ForStatementTree;
import org.sonar.plugins.java.api.tree.IfStatementTree;
import org.sonar.plugins.java.api.tree.StatementTree;
import org.sonar.plugins.java.api.tree.SyntaxToken;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.WhileStatementTree;
@Rule(key = "S3973")
public class IndentationAfterConditionalCheck extends BaseTreeVisitor implements JavaFileScanner {
private JavaFileScannerContext context;
@Override
public void scanFile(JavaFileScannerContext context) {
this.context = context;
scan(context.getTree());
}
@Override
public void visitIfStatement(IfStatementTree tree) {
Tree parentTree = tree.parent();
if (parentTree.is(Tree.Kind.IF_STATEMENT) && tree.equals(((IfStatementTree) parentTree).elseStatement())) {
checkForReport(tree.thenStatement(), getAcceptableStartOfElse((IfStatementTree) parentTree), tree.closeParenToken(), tree.ifKeyword().firstToken().text());
} else {
checkForReport(tree.thenStatement(), tree.ifKeyword(), tree.closeParenToken(), tree.ifKeyword().text());
}
SyntaxToken elseKeyword = tree.elseKeyword();
if (elseKeyword != null && !tree.elseStatement().is(Tree.Kind.IF_STATEMENT)) {
checkForReport(tree.elseStatement(), getAcceptableStartOfElse(tree), elseKeyword, elseKeyword.firstToken().text());
}
super.visitIfStatement(tree);
}
@Override
public void visitWhileStatement(WhileStatementTree tree) {
super.visitWhileStatement(tree);
checkForReport(tree.statement(), tree.whileKeyword(), tree.closeParenToken(), tree.whileKeyword().text());
}
@Override
public void visitForStatement(ForStatementTree tree) {
super.visitForStatement(tree);
checkForReport(tree.statement(), tree.forKeyword(), tree.closeParenToken(), tree.forKeyword().text());
}
@Override
public void visitForEachStatement(ForEachStatement tree) {
super.visitForEachStatement(tree);
checkForReport(tree.statement(), tree.forKeyword(), tree.closeParenToken(), tree.forKeyword().text());
}
private static Tree getAcceptableStartOfElse(IfStatementTree ifStatement) {
StatementTree thenStatement = ifStatement.thenStatement();
SyntaxToken elseKeyword = ifStatement.elseKeyword();
if (thenStatement.is(Tree.Kind.BLOCK)) {
SyntaxToken closeBrace = ((BlockTree) thenStatement).closeBraceToken();
if (LineUtils.startLine(closeBrace) == LineUtils.startLine(elseKeyword)) {
return closeBrace;
}
}
return elseKeyword;
}
private void checkForReport(StatementTree statement, Tree startTree, Tree endTree, String name) {
if (!(statement.is(Tree.Kind.BLOCK) ||
Position.startOf(statement).column() > Position.startOf(startTree).column())) {
context.reportIssue(this, startTree, endTree,
"Use indentation to denote the code conditionally executed by this \"" + name + "\".",
Collections.singletonList(new JavaFileScannerContext.Location("", statement)), null);
}
}
}