Fixed folding of named characters in comments

Author: halirutan

src/de/halirutan/mathematica/actions/CollapseExpandNamedCharactersHandler.java

@@ -32,6 +32,7 @@
 import com.intellij.psi.PsiDocumentManager;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
+import de.halirutan.mathematica.codeinsight.folding.MathematicaFoldingGroups;
 import de.halirutan.mathematica.lang.parsing.MathematicaElementTypes;
 import org.jetbrains.annotations.NotNull;
 
@@ -43,7 +44,7 @@ class CollapseExpandNamedCharactersHandler implements CodeInsightActionHandler {
 
   private final boolean myExpand;
 
-  public CollapseExpandNamedCharactersHandler(final boolean myExpand) {
+  CollapseExpandNamedCharactersHandler(final boolean myExpand) {
     this.myExpand = myExpand;
   }
 
@@ -57,10 +58,7 @@ public void invoke(@NotNull final Project project, @NotNull final Editor editor,
     Runnable processor = () -> {
       for (FoldRegion region : allFoldRegions) {
 
-        PsiElement element = EditorFoldingInfo.get(editor).getPsiElement(region);
-        final ASTNode node = element != null ? element.getNode() : null;
-        if (node != null &&
-            (node.getElementType() == MathematicaElementTypes.IDENTIFIER || node.getElementType() == MathematicaElementTypes.STRING_NAMED_CHARACTER)) {
+        if (region.getGroup() == MathematicaFoldingGroups.NAMED_CHARACTER_GROUP) {
           region.setExpanded(myExpand);
         }
       }

src/de/halirutan/mathematica/codeinsight/folding/MathematicaExpressionFoldingBuilder.java

@@ -50,6 +50,8 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import static de.halirutan.mathematica.codeinsight.folding.MathematicaFoldingGroups.NAMED_CHARACTER_GROUP;
+
 /**
  * Creates fold-regions from particular nodes of the AST tree. Currently, we support the folding of functions, lists,
  * and special "sectioning comments".
@@ -98,15 +100,15 @@ private void collectRegionsRecursively(@NotNull final ASTNode node,
           final TextRange nodeRange = node.getTextRange();
           final TextRange range = TextRange.create(nodeRange.getStartOffset() + matcher.start(), nodeRange.getStartOffset() + matcher.end());
           if (ourNamedCharacters.containsKey(key)) {
-            descriptors.add(new MathematicaNamedFoldingDescriptor(node, range, null, ourNamedCharacters.get(key), false));
+            descriptors.add(new MathematicaNamedFoldingDescriptor(node, range, NAMED_CHARACTER_GROUP, ourNamedCharacters.get(key), false));
           }
         }
       }
     } else if (foldCharacters && elementType == MathematicaElementTypes.STRING_NAMED_CHARACTER) {
       final String name = node.getText();
       final String key = name.substring(2, name.length() - 1);
       if (ourNamedCharacters.containsKey(key)) {
-        descriptors.add(new MathematicaNamedFoldingDescriptor(node, node.getTextRange(), null, ourNamedCharacters.get(key), false));
+        descriptors.add(new MathematicaNamedFoldingDescriptor(node, node.getTextRange(), NAMED_CHARACTER_GROUP, ourNamedCharacters.get(key), false));
       }
     } else if (elementType == MathematicaElementTypes.LIST_EXPRESSION) {
       // Well, we count the number of elements by counting the commas and adding one. Not bullet-proof, but will do.
@@ -120,7 +122,7 @@ private void collectRegionsRecursively(@NotNull final ASTNode node,
       final PsiElement psi = node.getPsi();
       if (psi instanceof FunctionCall) {
         final FunctionCall functionCall = (FunctionCall) psi;
-        if (functionCall.getScopingConstruct() != MScope.NULL) {
+        if (functionCall.getScopingConstruct() != MScope.NULL_SCOPE) {
           descriptors.add(new NamedFoldingDescriptor(
               node,
               node.getTextRange(),
@@ -130,6 +132,9 @@ private void collectRegionsRecursively(@NotNull final ASTNode node,
         }
       }
     } else if (node instanceof PsiComment) {
+      if (foldCharacters) {
+        foldNamedCharacters(node, descriptors);
+      }
       collectCommentRegion(node, document, descriptors);
     }
 
@@ -140,8 +145,6 @@ private void collectRegionsRecursively(@NotNull final ASTNode node,
   }
 
   /**
-   * Entry method that only check if we have a valid section-comment. The work is done in
-   * {@link MathematicaExpressionFoldingBuilder#collectCommentRegion(PsiComment, Document, List)}
    *
    * @param node        node to a PsiComment
    * @param document    the document of the code
@@ -233,6 +236,21 @@ private void collectCommentRegion(@NotNull ASTNode node,
 
   }
 
+  private void foldNamedCharacters(final ASTNode node, @NotNull List<FoldingDescriptor> descriptors ) {
+    final String text = node.getText();
+    final Matcher matcher = namedCharacterPattern.matcher(text);
+    while (matcher.find()) {
+      if (matcher.end() - matcher.start() > 3) {
+        final String key = text.substring(matcher.start() + 2, matcher.end() - 1);
+        final TextRange nodeRange = node.getTextRange();
+        final TextRange range = TextRange.create(nodeRange.getStartOffset() + matcher.start(), nodeRange.getStartOffset() + matcher.end());
+        if (ourNamedCharacters.containsKey(key)) {
+          descriptors.add(new MathematicaNamedFoldingDescriptor(node, range, NAMED_CHARACTER_GROUP, ourNamedCharacters.get(key), false));
+        }
+      }
+    }
+  }
+
   @Nullable
   @Override
   public String getPlaceholderText(@NotNull final ASTNode node) {

src/de/halirutan/mathematica/codeinsight/folding/MathematicaFoldingGroups.java

@@ -0,0 +1,10 @@
+package de.halirutan.mathematica.codeinsight.folding;
+
+import com.intellij.openapi.editor.FoldingGroup;
+
+/**
+ * @author patrick (17.09.17).
+ */
+public interface MathematicaFoldingGroups {
+  FoldingGroup NAMED_CHARACTER_GROUP = FoldingGroup.newGroup("NamedCharactersGroup");
+}