MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-05-06 05:10:22 +07:00
Code Issues Packages Projects Releases Wiki Activity

[java-inspections] JavadocBlankLines: Reduce the number of false positives

Browse Source 
GitOrigin-RevId: 873419b519056a436b0a22a2e88fce7da412901d
This commit is contained in:
Andrey.Cherkasov
2022-02-21 15:13:15 +03:00
committed by intellij-monorepo-bot
parent 25d66ae825
commit 0ab3b77293
10 changed files with 172 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
java/java-impl/src/com/intellij/codeInspection/javaDoc/JavadocBlankLinesInspection.java
View File

@@ -9,14 +9,18 @@ import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.*;
import com.intellij.psi.javadoc.PsiDocTag;
import com.intellij.psi.javadoc.PsiDocToken;
import com.intellij.psi.javadoc.PsiInlineDocTag;
import com.intellij.util.ObjectUtils;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.xml.util.HtmlUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import static com.intellij.openapi.util.text.CharFilter.NOT_WHITESPACE_FILTER;
public class JavadocBlankLinesInspection extends LocalInspectionTool {
@Override
public @NotNull PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
@@ -24,30 +28,79 @@ public class JavadocBlankLinesInspection extends LocalInspectionTool {
@Override
public void visitDocToken(PsiDocToken token) {
super.visitDocToken(token);
PsiElement nextSibling = token.getNextSibling();
PsiElement nextWhitespace = token.getNextSibling();
PsiElement prevWhitespace = token.getPrevSibling();
if (token.getTokenType() == JavaDocTokenType.DOC_COMMENT_LEADING_ASTERISKS &&
token.getPrevSibling() instanceof PsiWhiteSpace &&
nextSibling instanceof PsiWhiteSpace && !isBeforeParagraphOrBlockTag(nextSibling)) {
prevWhitespace instanceof PsiWhiteSpace &&
nextWhitespace instanceof PsiWhiteSpace &&
!isAfterParagraphOrBlockTag(prevWhitespace) &&
!isBeforeParagraphOrBlockTag(nextWhitespace) &&
!isAfterPreTag(token)) {
holder.registerProblem(token, JavaBundle.message("inspection.javadoc.blank.lines.message"), new InsertParagraphTagFix(token));
}
}
};
}
private static boolean isBeforeParagraphOrBlockTag(PsiElement element) {
PsiDocToken maybeLeadingAsterisks = ObjectUtils.tryCast(element.getNextSibling(), PsiDocToken.class);
if (maybeLeadingAsterisks == null || maybeLeadingAsterisks.getTokenType() != JavaDocTokenType.DOC_COMMENT_LEADING_ASTERISKS) {
return false;
private static boolean isAfterPreTag(PsiDocToken token) {
PsiElement parent = token.getParent();
if (parent instanceof PsiInlineDocTag) {
return isAfterPreTagInner(PsiTreeUtil.getPrevSiblingOfType(parent, PsiDocToken.class));
}
PsiElement nextSibling = maybeLeadingAsterisks.getNextSibling();
if (nextSibling == null) return false;
return nextSibling.getText().stripLeading().startsWith("<p>") ||
isBlockTag(nextSibling) ||
isBlockTag(nextSibling.getNextSibling());
return isAfterPreTagInner(token);
}
private static boolean isBlockTag(PsiElement element) {
return element instanceof PsiDocTag && !(element instanceof PsiInlineDocTag);
private static boolean isAfterPreTagInner(PsiDocToken token) {
boolean result = false;
while (token != null) {
String text = token.getText();
int closingPreTagIndex = StringUtil.toLowerCase(text).lastIndexOf("</pre>");
int openingPreTagIndex = StringUtil.toLowerCase(text).lastIndexOf("<pre>");
result = openingPreTagIndex != -1 && (closingPreTagIndex == -1 || closingPreTagIndex < openingPreTagIndex);
if (closingPreTagIndex != -1 || openingPreTagIndex != -1) break;
token = PsiTreeUtil.getPrevSiblingOfType(token, PsiDocToken.class);
}
return result;
}
private static boolean isAfterParagraphOrBlockTag(PsiElement element) {
PsiElement prevSibling = element.getPrevSibling();
if (!(prevSibling instanceof PsiDocToken)) return true;
if (((PsiDocToken)prevSibling).getTokenType() != JavaDocTokenType.DOC_COMMENT_DATA) return true;
String text = prevSibling.getText();
return endsWithHtmlBlockTag(text) || isNullOrBlockTag(prevSibling);
}
private static boolean isBeforeParagraphOrBlockTag(PsiElement element) {
PsiElement nextSibling = element.getNextSibling();
if (!(nextSibling instanceof PsiDocToken)) return true;
if (((PsiDocToken)nextSibling).getTokenType() != JavaDocTokenType.DOC_COMMENT_LEADING_ASTERISKS) return true;
nextSibling = nextSibling.getNextSibling();
if (nextSibling == null) return true;
String text = nextSibling.getText();
return isNullOrBlockTag(nextSibling) ||
startsWithHtmlBlockTag(text) ||
isNullOrBlockTag(nextSibling.getNextSibling());
}
private static boolean startsWithHtmlBlockTag(String text) {
text = text.stripLeading();
if (text.isEmpty() || text.charAt(0) != '<') return false;
String maybeBlockTag = text.substring(1, text.indexOf('>'));
String trimmed = StringUtil.trim(maybeBlockTag.strip(), ch -> NOT_WHITESPACE_FILTER.accept(ch) && ch != '/');
return HtmlUtil.isHtmlBlockTag(trimmed) || "br".equalsIgnoreCase(trimmed);
}
private static boolean endsWithHtmlBlockTag(String text) {
text = text.stripTrailing();
if (text.isEmpty() || text.charAt(text.length() - 1) != '>') return false;
String maybeBlockTag = text.substring(text.lastIndexOf('<') + 1, text.length() - 1);
String trimmed = StringUtil.trim(maybeBlockTag.strip(), ch -> NOT_WHITESPACE_FILTER.accept(ch) && ch != '/');
return HtmlUtil.isHtmlBlockTag(trimmed) || "br".equalsIgnoreCase(trimmed);
}
private static boolean isNullOrBlockTag(PsiElement element) {
return element == null || (element instanceof PsiDocTag && !(element instanceof PsiInlineDocTag));
}
private static class InsertParagraphTagFix extends LocalQuickFixAndIntentionActionOnPsiElement {

13
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeBetweenJavadocBlockTags.java Normal file
View File

@@ -0,0 +1,13 @@
// "Insert <p>" "false"
class Test {
/**
* Answer to the ultimate question of life, the universe, and everything
*
* @author Douglas Adams
*<caret>
* @return The number 42
*/
int answer() {
return 42;
}
}

15
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeBr.java Normal file
View File

@@ -0,0 +1,15 @@
// "Insert <p>" "false"
class Test {
/**
* <pre>
* Blah
* <br />
*<caret>
* Blah
* Blah
* </pre>
*/
int answer() {
return 42;
}
}

12
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeCommentEnd.java Normal file
View File

@@ -0,0 +1,12 @@
// "Insert <p>" "false"
class Test {
/**
* Answer to the ultimate question of life, the universe, and everything
*
* @return The number 42
*<caret>
*/
int answer() {
return 42;
}
}

12
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeCommentStart.java Normal file
View File

@@ -0,0 +1,12 @@
// "Insert <p>" "false"
class Test {
/**
*<caret>
* Answer to the ultimate question of life, the universe, and everything
*
* @return The number 42
*/
int answer() {
return 42;
}
}

16
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeHtmlBlockTag1.java Normal file
View File

@@ -0,0 +1,16 @@
// "Insert <p>" "false"
class Test {
/**
* Answer to the ultimate question of life, the universe, and everything
* <pre>{@code
* 6 * 7 = 42
* }</pre>
*<caret>
* That's it. That's all there is.
*
* @return The number 42
*/
int answer() {
return 42;
}
}

0
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeParagraphTag.java → java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeHtmlBlockTag2.java
View File

11
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforeJavadocBlockTagsWithoutSpace.java Normal file
View File

@@ -0,0 +1,11 @@
// "Insert <p>" "false"
class Test {
/**
* Answer to the ultimate question of life, the universe, and everything
*<caret>
*@return The number 42
*/
int answer() {
return 42;
}
}

12
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforePreformattedText.java Normal file
View File

@@ -0,0 +1,12 @@
// "Insert <p>" "false"
class Test {
/**
* <pre>
* Blah
*<caret>
* Blah
* Blah
* </pre>
*/
void foo() { }
}

13
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/quickFix/javadocBlankLines/beforePreformattedTextInsideInlineTag.java Normal file
View File

@@ -0,0 +1,13 @@
// "Insert <p>" "false"
class Test {
/**
* <pre>{@code
* 1
*<caret>
* 2 3 4
* 5 6
* }
* </pre>
*/
void foo() { }
}