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

[javadoc] IDEA-372322 Refactor FixDocCommentAction#generateComment to avoid Editor dependency

Browse Source 
Also convert AddJavadocIntention to ModCommand

GitOrigin-RevId: f33816159a5805395a63ad3107f4b895659f375b
This commit is contained in:
Tagir Valeev
2025-05-12 09:58:57 +00:00
committed by intellij-monorepo-bot
parent e6b5e6c06d
commit 6dbdc8338e
26 changed files with 111 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/java-impl/src/com/intellij/codeInsight/intention/impl/AddJavadocIntention.java
+23 -18
View File
@@ -2,27 +2,38 @@
package com.intellij.codeInsight.intention.impl;
import com.intellij.codeInsight.editorActions.FixDocCommentAction;
import com.intellij.codeInsight.intention.BaseElementAtCaretIntentionAction;
import com.intellij.codeInsight.intention.LowPriorityAction;
import com.intellij.codeInsight.intention.PriorityAction;
import com.intellij.ide.util.PackageUtil;
import com.intellij.java.JavaBundle;
import com.intellij.lang.java.JavaDocumentationProvider;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.DumbAware;
import com.intellij.openapi.project.Project;
import com.intellij.modcommand.ActionContext;
import com.intellij.modcommand.ModPsiUpdater;
import com.intellij.modcommand.Presentation;
import com.intellij.modcommand.PsiUpdateModCommandAction;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.psi.util.PsiUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public class AddJavadocIntention extends BaseElementAtCaretIntentionAction implements LowPriorityAction, DumbAware {
@Override
public void invoke(@NotNull Project project, @NotNull Editor editor, @NotNull PsiElement element) {
FixDocCommentAction.generateOrFixComment(element, project, editor);
public class AddJavadocIntention extends PsiUpdateModCommandAction<PsiElement> {
public AddJavadocIntention() {
super(PsiElement.class);
}
@Override
public boolean isAvailable(@NotNull Project project, @NotNull Editor editor, @NotNull PsiElement element) {
protected void invoke(@NotNull ActionContext context, @NotNull PsiElement element, @NotNull ModPsiUpdater updater) {
FixDocCommentAction.generateComment(element, context.project(), updater);
}
@Override
protected @Nullable Presentation getPresentation(@NotNull ActionContext context, @NotNull PsiElement element) {
//noinspection DialogTitleCapitalization
return Presentation.of(getFamilyName()).withPriority(PriorityAction.Priority.LOW);
}
@Override
protected boolean isElementApplicable(@NotNull PsiElement element, @NotNull ActionContext context) {
if (element instanceof PsiIdentifier ||
element instanceof PsiJavaCodeReferenceElement ||
element instanceof PsiJavaModuleReferenceElement) {
@@ -33,10 +44,10 @@ public class AddJavadocIntention extends BaseElementAtCaretIntentionAction imple
if ( targetElement instanceof PsiClass aClass && PsiUtil.isLocalClass(aClass)) {
return false;
}
if (targetElement instanceof PsiJavaDocumentedElement &&
if (targetElement instanceof PsiJavaDocumentedElement documentedElement &&
!(targetElement instanceof PsiTypeParameter) &&
!(targetElement instanceof PsiAnonymousClass)) {
return ((PsiJavaDocumentedElement)targetElement).getDocComment() == null;
return documentedElement.getDocComment() == null;
}
if (targetElement instanceof PsiPackageStatement) {
@@ -55,10 +66,4 @@ public class AddJavadocIntention extends BaseElementAtCaretIntentionAction imple
//noinspection DialogTitleCapitalization
return JavaBundle.message("intention.family.add.javadoc");
}
@Override
public @NotNull String getText() {
//noinspection DialogTitleCapitalization
return getFamilyName();
}
}
java/java-impl/src/com/intellij/codeInspection/javaDoc/MissingJavadocInspection.java
+5 -2
View File
@@ -2,7 +2,10 @@
package com.intellij.codeInspection.javaDoc;
import com.intellij.codeInsight.intention.impl.AddJavadocIntention;
import com.intellij.codeInspection.*;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.LocalQuickFix;
import com.intellij.codeInspection.ProblemHighlightType;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.codeInspection.options.*;
import com.intellij.codeInspection.reference.RefJavaUtil;
import com.intellij.ide.nls.NlsMessages;
@@ -444,7 +447,7 @@ public final class MissingJavadocInspection extends LocalInspectionTool {
private static void reportMissingJavadoc(@NotNull PsiElement toHighlight, @NotNull ProblemsHolder holder, boolean isOnTheFly) {
String message = JavaBundle.message("inspection.javadoc.problem.descriptor");
LocalQuickFix fix = isOnTheFly ? IntentionWrapper.wrapToQuickFix(new AddJavadocIntention(), holder.getFile()) : null;
LocalQuickFix fix = isOnTheFly ? LocalQuickFix.from(new AddJavadocIntention()) : null;
problem(holder, toHighlight, message, fix);
}
java/java-tests/testData/codeInsight/addJavadoc/afterClass.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
/**
*
java/java-tests/testData/codeInsight/addJavadoc/afterDifferentParamNames.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
/**
java/java-tests/testData/codeInsight/addJavadoc/afterField.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
java/java-tests/testData/codeInsight/addJavadoc/afterField2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Test {
java/java-tests/testData/codeInsight/addJavadoc/afterField3.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Test {
java/java-tests/testData/codeInsight/addJavadoc/afterMethod.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
/**
java/java-tests/testData/codeInsight/addJavadoc/afterMethod2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
/**
java/java-tests/testData/codeInsight/addJavadoc/afterMethodCommentInheritance.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
//Method Comments Algorithm
//
java/java-tests/testData/codeInsight/addJavadoc/afterMultiFieldDeclaration.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Foo {
int x = 2, /**
*
java/java-tests/testData/codeInsight/addJavadoc/afterMultiFieldDeclaration2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Foo {
/**
*
java/java-tests/testData/codeInsight/addJavadoc/afterRecord.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
/**
java/java-tests/testData/codeInsight/addJavadoc/beforeClass.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Fo<caret>o {
java/java-tests/testData/codeInsight/addJavadoc/beforeDifferentParamNames.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
/**
java/java-tests/testData/codeInsight/addJavadoc/beforeField.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
java/java-tests/testData/codeInsight/addJavadoc/beforeField2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Test {
java/java-tests/testData/codeInsight/addJavadoc/beforeField3.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Test {
java/java-tests/testData/codeInsight/addJavadoc/beforeMethod.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
public void f<caret>oo() {
java/java-tests/testData/codeInsight/addJavadoc/beforeMethod2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class A {
public int foo<caret>(final String s) throws Exception {
java/java-tests/testData/codeInsight/addJavadoc/beforeMethodCommentInheritance.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
//Method Comments Algorithm
//
java/java-tests/testData/codeInsight/addJavadoc/beforeMultiFieldDeclaration.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Foo {
int x = 2, <caret>y = 1;
}
java/java-tests/testData/codeInsight/addJavadoc/beforeMultiFieldDeclaration2.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
class Foo {
int <caret>x = 2, y = 1;
}
java/java-tests/testData/codeInsight/addJavadoc/beforeRecord.java
+1 -1
View File
@@ -1,4 +1,4 @@
// "Add Javadoc" "true"
// "Add Javadoc" "true-preview"
record Te<caret>st(int u) {
platform/lang-impl/api-dump-unreviewed.txt
+1
View File
@@ -2974,6 +2974,7 @@ f:com.intellij.codeInsight.editorActions.FixDocCommentAction
- com.intellij.openapi.editor.actionSystem.EditorAction
- sf:ACTION_ID:java.lang.String
- <init>():V
- s:generateComment(com.intellij.psi.PsiElement,com.intellij.openapi.project.Project,com.intellij.modcommand.ModPsiNavigator):V
- s:generateOrFixComment(com.intellij.psi.PsiElement,com.intellij.openapi.project.Project,com.intellij.openapi.editor.Editor):V
f:com.intellij.codeInsight.editorActions.IndentTransferableData
- com.intellij.codeInsight.editorActions.TextBlockTransferableData
platform/lang-impl/src/com/intellij/codeInsight/editorActions/FixDocCommentAction.java
+60 -30
View File
@@ -9,18 +9,20 @@ import com.intellij.lang.*;
import com.intellij.lang.documentation.CodeDocumentationProvider;
import com.intellij.lang.documentation.CompositeDocumentationProvider;
import com.intellij.lang.documentation.DocumentationProvider;
import com.intellij.modcommand.ModPsiNavigator;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.actionSystem.DataContext;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.command.CommandProcessor;
import com.intellij.openapi.editor.Caret;
import com.intellij.openapi.editor.CaretModel;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.editor.actionSystem.EditorAction;
import com.intellij.openapi.editor.actionSystem.EditorActionHandler;
import com.intellij.openapi.editor.ex.util.EditorUtil;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.*;
import com.intellij.psi.codeStyle.CodeStyleManager;
@@ -72,6 +74,47 @@ public final class FixDocCommentAction extends EditorAction {
generateOrFixComment(elementAtOffset, project, editor);
}
/**
* Generates a comment if it does not exist
*
* @param element target element for which a comment should be generated
* @param project current project
* @param navigator navigator to use to set caret position
*/
public static void generateComment(final @NotNull PsiElement element, final @NotNull Project project, final @NotNull ModPsiNavigator navigator) {
Language language = element.getLanguage();
final CodeDocumentationProvider docProvider = getDocumentationProvider(language);
if (docProvider == null) {
return;
}
final Pair<PsiElement, PsiComment> pair = docProvider.parseContext(element);
if (pair == null || pair.second != null) {
return;
}
Commenter c = LanguageCommenters.INSTANCE.forLanguage(language);
if (!(c instanceof CodeDocumentationAwareCommenter commenter)) {
return;
}
generateComment(pair.first, navigator, docProvider, commenter, project);
}
private static @Nullable CodeDocumentationProvider getDocumentationProvider(Language language) {
final CodeDocumentationProvider docProvider;
final DocumentationProvider langDocumentationProvider = LanguageDocumentation.INSTANCE.forLanguage(language);
if (langDocumentationProvider instanceof CompositeDocumentationProvider provider) {
docProvider = provider.getFirstCodeDocumentationProvider();
}
else if (langDocumentationProvider instanceof CodeDocumentationProvider provider) {
docProvider = provider;
}
else {
docProvider = null;
}
return docProvider;
}
/**
* Generates comment if it's not exist or try to fix if exists
*
@@ -81,17 +124,7 @@ public final class FixDocCommentAction extends EditorAction {
*/
public static void generateOrFixComment(final @NotNull PsiElement element, final @NotNull Project project, final @NotNull Editor editor) {
Language language = element.getLanguage();
final CodeDocumentationProvider docProvider;
final DocumentationProvider langDocumentationProvider = LanguageDocumentation.INSTANCE.forLanguage(language);
if (langDocumentationProvider instanceof CompositeDocumentationProvider) {
docProvider = ((CompositeDocumentationProvider)langDocumentationProvider).getFirstCodeDocumentationProvider();
}
else if (langDocumentationProvider instanceof CodeDocumentationProvider) {
docProvider = (CodeDocumentationProvider)langDocumentationProvider;
}
else {
docProvider = null;
}
final CodeDocumentationProvider docProvider = getDocumentationProvider(language);
if (docProvider == null) {
return;
}
@@ -107,7 +140,7 @@ public final class FixDocCommentAction extends EditorAction {
}
final Runnable task;
if (pair.second == null || pair.second.getTextRange().isEmpty()) {
task = () -> generateComment(pair.first, editor, docProvider, commenter, project);
task = () -> generateComment(pair.first, EditorUtil.asPsiNavigator(editor), docProvider, commenter, project);
}
else {
final DocCommentFixer fixer = DocCommentFixer.EXTENSION.forLanguage(language);
@@ -133,19 +166,19 @@ public final class FixDocCommentAction extends EditorAction {
* changes during the processing.
*
* @param anchor target element for which a comment should be generated
* @param editor target editor
* @param navigator navigator to use
* @param commenter commenter to use
* @param project current project
*/
private static void generateComment(@NotNull PsiElement anchor,
@NotNull Editor editor,
@NotNull ModPsiNavigator navigator,
@NotNull CodeDocumentationProvider documentationProvider,
@NotNull CodeDocumentationAwareCommenter commenter,
@NotNull Project project)
{
Document document = editor.getDocument();
@NotNull Project project) {
Document document = anchor.getContainingFile().getFileDocument();
int commentStartOffset = anchor.getTextRange().getStartOffset();
int lineStartOffset = document.getLineStartOffset(document.getLineNumber(commentStartOffset));
CharSequence charSequence = document.getCharsSequence();
if (lineStartOffset > 0 && lineStartOffset < commentStartOffset) {
// Example:
// void test1() {
@@ -154,16 +187,17 @@ public final class FixDocCommentAction extends EditorAction {
// <offset>
// }
// We want to insert the comment at the start of the line where 'test2()' is declared.
int nonWhiteSpaceOffset = CharArrayUtil.shiftBackward(document.getCharsSequence(), lineStartOffset, commentStartOffset - 1, " \t") + 1;
int nonWhiteSpaceOffset = CharArrayUtil.shiftBackward(charSequence, lineStartOffset, commentStartOffset - 1, " \t") + 1;
commentStartOffset = Math.max(nonWhiteSpaceOffset, lineStartOffset);
}
int commentBodyRelativeOffset = 0;
int caretOffsetToSet = -1;
int caretLineOffset = 0;
StringBuilder buffer = new StringBuilder();
String commentPrefix = commenter.getDocumentationCommentPrefix();
if (commentPrefix != null) {
buffer.append(commentPrefix).append("\n");
caretLineOffset++;
commentBodyRelativeOffset += commentPrefix.length() + 1;
}
@@ -171,7 +205,6 @@ public final class FixDocCommentAction extends EditorAction {
if (linePrefix != null) {
buffer.append(linePrefix);
commentBodyRelativeOffset += linePrefix.length();
caretOffsetToSet = commentStartOffset + commentBodyRelativeOffset;
}
buffer.append("\n");
commentBodyRelativeOffset++;
@@ -195,7 +228,6 @@ public final class FixDocCommentAction extends EditorAction {
}
String stub = documentationProvider.generateDocumentationContentStub(pair.second);
CaretModel caretModel = editor.getCaretModel();
if (stub != null) {
int insertionOffset = commentStartOffset + commentBodyRelativeOffset;
document.insertString(insertionOffset, stub);
@@ -203,10 +235,8 @@ public final class FixDocCommentAction extends EditorAction {
pair = documentationProvider.parseContext(anchor);
}
if (caretOffsetToSet >= 0) {
caretModel.moveToOffset(caretOffsetToSet);
editor.getSelectionModel().removeSelection();
}
navigator.moveCaretTo(commentStartOffset);
navigator.select(TextRange.from(commentStartOffset, 0));
if (pair == null || pair.second == null) {
return;
@@ -216,14 +246,14 @@ public final class FixDocCommentAction extends EditorAction {
int end = pair.second.getTextRange().getEndOffset();
reformatCommentKeepingEmptyTags(anchor.getContainingFile(), project, start, end);
editor.getCaretModel().moveToOffset(document.getLineEndOffset(document.getLineNumber(editor.getCaretModel().getOffset())));
int caretOffset = document.getLineEndOffset(document.getLineNumber(navigator.getCaretOffset()) + caretLineOffset);
navigator.moveCaretTo(caretOffset);
int caretOffset = caretModel.getOffset();
if (caretOffset > 0 && caretOffset <= document.getTextLength()) {
char c = document.getCharsSequence().charAt(caretOffset - 1);
char c = charSequence.charAt(caretOffset - 1);
if (!StringUtil.isWhiteSpace(c)) {
document.insertString(caretOffset, " ");
caretModel.moveToOffset(caretOffset + 1);
navigator.moveCaretTo(caretOffset + 1);
}
}
}