openide/java/java-tests/testSrc/com/intellij/codeInsight/documentation/render/JavaDocRenderTest.java

// Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.codeInsight.documentation.render;

import com.intellij.codeInsight.folding.CodeFoldingSettings;
import com.intellij.ide.highlighter.JavaFileType;
import com.intellij.openapi.actionSystem.IdeActions;
import com.intellij.openapi.application.impl.NonBlockingReadActionImpl;
import com.intellij.openapi.editor.CustomFoldRegion;
import com.intellij.openapi.editor.FoldRegion;
import com.intellij.openapi.editor.ex.EditorSettingsExternalizable;
import com.intellij.openapi.editor.ex.util.EditorUtil;
import com.intellij.openapi.editor.impl.AbstractEditorTest;
import com.intellij.openapi.editor.impl.Interval;
import com.intellij.openapi.util.Pair;
import com.intellij.psi.PsiDocumentManager;
import com.intellij.testFramework.EditorTestUtil;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.awt.*;
import java.util.List;

public class JavaDocRenderTest extends AbstractEditorTest {
  private boolean myStoredSetting;

  @Override
  protected void setUp() throws Exception {
    super.setUp();
    myStoredSetting = EditorSettingsExternalizable.getInstance().isDocCommentRenderingEnabled();
  }

  @Override
  protected void tearDown() throws Exception {
    try {
      EditorSettingsExternalizable.getInstance().setDocCommentRenderingEnabled(myStoredSetting);
    }
    catch (Throwable e) {
      addSuppressedException(e);
    }
    finally {
      super.tearDown();
    }
  }

  public void testDeleteLine() {
    configure("""
                class C {
                <caret>
                  /** doc */
                  int a;
                }
                """, true);
    verifyFoldingState(11, 23);
    executeAction(IdeActions.ACTION_EDITOR_DELETE_LINE);
    checkResultByText("""
                        class C {
                        <caret>  /** doc */
                          int a;
                        }
                        """);
  }

  public void testTypingAtLineStart() {
    configure("""
                class C {
                /** doc */
                int a;<caret>
                }
                """, true);
    verifyFoldingState(10, 20);
    executeAction(IdeActions.ACTION_EDITOR_MOVE_LINE_START);
    type(' ');
    checkResultByText("""
                        class C {
                        /** doc */
                         <caret>int a;
                        }
                        """);
  }

  public void testCommentModification() {
    configure("""
                class C {
                  /** doc */
                  int a;<caret>
                }
                """, false);
    verifyFoldingState();
    verifyItem(12, 22, null);
    toggleItem();
    verifyFoldingState(10, 22);
    verifyItem(12, 22, "doc");
    toggleItem();
    verifyFoldingState();
    verifyItem(12, 22, null);
    runWriteCommand(() -> getEditor().getDocument().setText(getEditor().getDocument().getText().replace("doc", "another")));
    toggleItem();
    verifyFoldingState(10, 26);
    verifyItem(12, 26, "another");
  }

  public void testMultipleAuthors() {
    configure("""
                package some;

                /**
                 * @author foo
                 * @author bar
                 */
                class C {}""", true);
    verifyItem(15, 52,"<table class=\"sections\"><tbody><tr><td valign=\"top\" class=\"section\"><p>Author:</p></td>" +
                      "<td valign=\"top\"><p>foo, bar</p></td></tr></tbody></table>");
  }

  public void testDocumentStart() {
    configure("""
                /**
                 * comment
                 */
                class C {}""", true);
    verifyFoldingState(0, 18);
  }

  public void testPackageInfo() {
    EditorSettingsExternalizable.getInstance().setDocCommentRenderingEnabled(true);
    configureFromFileText("package-info.java",
                          """
                            /**
                             * whatever
                             */
                            package some;""");
    updateRenderedItems(true);
    verifyItem(0, 19, "whatever");
  }

  public void testModuleInfo() {
    EditorSettingsExternalizable.getInstance().setDocCommentRenderingEnabled(true);
    configureFromFileText("module-info.java",
                          """
                            /**
                             * whatever
                             */
                            module some {}""");
    updateRenderedItems(true);
    verifyItem(0, 19, "whatever");
  }

  public void testToggleNestedMember() {
    configure("""
                /**
                 * class
                 */
                class C {
                  /**
                   * method
                   */
                  void m() {
                    <caret>
                  }
                }""", false);
    verifyFoldingState();
    toggleItem();
    verifyFoldingState(27, 50);
  }

  public void testExpandAll() {
    boolean savedValue = CodeFoldingSettings.getInstance().COLLAPSE_METHODS;
    try {
      CodeFoldingSettings.getInstance().COLLAPSE_METHODS = true;
      configure("""
                  /** class */
                  class C {
                    void m() {
                    }
                  }""", true);
      int methodBodyPos = getEditor().getDocument().getText().indexOf("{\n  }");
      EditorTestUtil.buildInitialFoldingsInBackground(getEditor());
      executeAction(IdeActions.ACTION_COLLAPSE_ALL_REGIONS);
      assertNotNull(getEditor().getFoldingModel().getCollapsedRegionAtOffset(methodBodyPos));
      executeAction(IdeActions.ACTION_EXPAND_ALL_REGIONS);
      assertNull(getEditor().getFoldingModel().getCollapsedRegionAtOffset(methodBodyPos));
    }
    finally {
      CodeFoldingSettings.getInstance().COLLAPSE_METHODS = savedValue;
    }
  }

  public void testTypingAfterCollapse() {
    configure("""
                /**
                 * doc<caret>
                 */
                class C {}""", false);
    toggleItem();
    type("  ");
    checkResultByText("""
                          <caret>/**
                         * doc
                         */
                        class C {}""");
  }

  public void testAddedCommentIsNotCollapsed() {
    configure("class C {}", true);
    runWriteCommand(() -> getEditor().getDocument().insertString(0, "/**\n * comment\n */\n"));
    updateRenderedItems(false);
    verifyFoldingState();
  }

  public void testLineToYAndBackConversions() {
    configure("""
                class C {
                  /**
                   * comment
                   */
                  void m() {}
                }""", true);
    FoldRegion foldRegion = getEditor().getFoldingModel().getCollapsedRegionAtOffset(10);
    assertInstanceOf(foldRegion, CustomFoldRegion.class);
    CustomFoldRegion cfr = (CustomFoldRegion)foldRegion;
    Point location = cfr.getLocation();
    assertNotNull(location);
    Rectangle rendererBounds = new Rectangle(location, new Dimension(cfr.getWidthInPixels(), cfr.getHeightInPixels()));
    assertFalse(rendererBounds.isEmpty());

    @NotNull Pair<@NotNull Interval, @Nullable Interval> p = EditorUtil.logicalLineToYRange(getEditor(), 2);
    assertEquals(rendererBounds.y, p.first.intervalStart());
    assertEquals(rendererBounds.y + rendererBounds.height, p.first.intervalEnd());
    assertNull(p.second);

    Interval lineRange = EditorUtil.yToLogicalLineRange(getEditor(), rendererBounds.y + rendererBounds.height / 2);
    assertEquals(1, lineRange.intervalStart());
    assertEquals(3, lineRange.intervalEnd());
  }

  public void testCommentAnnotationAfterDoc() {
    configure("""
                /**
                 * doc
                 */
                <caret>@Deprecated
                class C {}""", true);
    executeAction(IdeActions.ACTION_COMMENT_LINE);
    checkResultByText("""
                        /**
                         * doc
                         */
                        //@Deprecated
                        class C {}""");
  }

  private void configure(@NotNull String text, boolean enableRendering) {
    EditorSettingsExternalizable.getInstance().setDocCommentRenderingEnabled(enableRendering);
    init(text, JavaFileType.INSTANCE);
    updateRenderedItems(enableRendering);
  }

  private void updateRenderedItems(boolean collapseNewRegions) {
    PsiDocumentManager.getInstance(getProject()).commitAllDocuments();
    DocRenderPassFactory.Items items = DocRenderPassFactory.calculateItemsToRender(getEditor(), getFile());
    DocRenderPassFactory.applyItemsToRender(getEditor(), getProject(), items, collapseNewRegions);
  }

  private void toggleItem() {
    executeAction(IdeActions.ACTION_TOGGLE_RENDERED_DOC);
    NonBlockingReadActionImpl.waitForAsyncTaskCompletion();
  }

  private void verifyItem(int startOffset, int endOffset, @Nullable String textInContent) {
    DocRenderItem item = DocRenderItemManager.getInstance().getItemAroundOffset(getEditor(), startOffset);
    assertNotNull("Item is not found at offset " + startOffset, item);
    assertEquals("Unexpected item start offset", startOffset, item.getHighlighter().getStartOffset());
    assertEquals("Unexpected item end offset", endOffset, item.getHighlighter().getEndOffset());
    Object toCheck = item.getFoldRegion();
    if (textInContent == null) {
      assertNull("Item in rendered state", toCheck);
    }
    else {
      assertNotNull("Item not in rendered state", toCheck);
      assertTrue("Unexpected rendered text: " + item.getTextToRender(), item.getTextToRender() != null && item.getTextToRender().contains(textInContent));
    }
  }

  private void verifyFoldingState(int... collapsedRegionOffsets) {
    int expectedNumberOfCollapsedRegions = collapsedRegionOffsets.length / 2;
    List<FoldRegion> foldRegions = ContainerUtil.filter(getEditor().getFoldingModel().getAllFoldRegions(), region -> !region.isExpanded());
    assertEquals("Unexpected number of collapsed fold regions", expectedNumberOfCollapsedRegions, foldRegions.size());
    for (int i = 0; i < expectedNumberOfCollapsedRegions; i++) {
      FoldRegion region = foldRegions.get(i);
      assertEquals("Unexpected region " + i + " start offset", collapsedRegionOffsets[i * 2], region.getStartOffset());
      assertEquals("Unexpected region " + i + " end offset", collapsedRegionOffsets[i * 2 + 1], region.getEndOffset());
    }
  }
}