- Added folding for heredoc and nowdoc

troizet · troizet · commit a2fae5bf667d · 2025-12-01T12:44:19.000+07:00
- Fixed test FoldingTest
- Added new tests in FoldingTest
diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/csl/FoldingScanner.java b/php/php.editor/src/org/netbeans/modules/php/editor/csl/FoldingScanner.java
@@ -63,6 +63,7 @@
 import org.netbeans.modules.php.editor.parser.astnodes.IfStatement;
 import org.netbeans.modules.php.editor.parser.astnodes.MatchExpression;
 import org.netbeans.modules.php.editor.parser.astnodes.Program;
+import org.netbeans.modules.php.editor.parser.astnodes.Quote;
 import org.netbeans.modules.php.editor.parser.astnodes.Statement;
 import org.netbeans.modules.php.editor.parser.astnodes.SwitchCase;
 import org.netbeans.modules.php.editor.parser.astnodes.SwitchStatement;
@@ -139,6 +140,12 @@ public final class FoldingScanner {
             new FoldTemplate(0, 0, "#[...]") // NOI18N
     );
 
+    @NbBundle.Messages("FT_HEREDOC_NOWDOC=Heredoc/Nowdoc")
+    public static final FoldType TYPE_HEREDOC_NOWDOC = FoldType.MEMBER.derive(
+            "heredoc/nowdoc", // NOI18N
+            Bundle.FT_HEREDOC_NOWDOC(),
+            new FoldTemplate(0, 0, "<<<...") // NOI18N
+    );
     private static final String LAST_CORRECT_FOLDING_PROPERTY = "LAST_CORRECT_FOLDING_PROPERY"; //NOI18N
     private static final boolean FOLD_PHPTAG = !Boolean.getBoolean("nb.php.editor.doNotFoldPhptag"); // NOI18N NETBEANS-5480
 
@@ -183,6 +190,7 @@ public Map<String, List<OffsetRange>> folds(ParserResult info) {
             if (FOLD_PHPTAG) {
                 processPHPTags(folds, doc);
             }
+            processNowdoc(folds, doc);
             setFoldingProperty(doc, folds);
             return folds;
         }
@@ -271,6 +279,42 @@ private void processPHPTags(Map<String, List<OffsetRange>> folds, Document docum
         }
     }
 
+    private void processNowdoc(Map<String, List<OffsetRange>> folds, Document document) {
+        if (document instanceof BaseDocument) {
+            BaseDocument doc = (BaseDocument) document;
+            doc.readLock();
+            try {
+                TokenSequence<PHPTokenId> ts = LexUtilities.getPHPTokenSequence(doc, 0);
+                if (ts == null) {
+                    return;
+                }
+                ts.move(0);
+                int startOffset = -1;
+                int endOffset = -1;
+                while (ts.moveNext()) {
+                    Token<PHPTokenId> token = ts.token();
+                    if (token != null) {
+                        PHPTokenId id = token.id();
+                        switch (id) {
+                            case PHP_NOWDOC_TAG_START:
+                                startOffset = ts.offset();
+                                break;
+                            case PHP_NOWDOC_TAG_END:
+                                assert startOffset != -1;
+                                endOffset = ts.offset() + token.length();
+                                getRanges(folds, TYPE_HEREDOC_NOWDOC).add(new OffsetRange(startOffset, endOffset));
+                                break;
+                            default:
+                                break;
+                        }
+                    }
+                }
+            } finally {
+                doc.readUnlock();
+            }
+        }
+    }
+
     private void processScopes(Map<String, List<OffsetRange>> folds, List<Scope> scopes) {
         processUseScopes(folds, scopes);
         processTypeAndFunctionScopes(folds, scopes);
@@ -541,6 +585,15 @@ public void visit(Attribute node) {
             super.visit(node);
         }
 
+        public void visit(Quote node) {
+            if (CancelSupport.getDefault().isCancelled()) {
+                return;
+            }
+            if (node.getQuoteType().equals(Quote.Type.HEREDOC)) {
+                addFold(node, TYPE_HEREDOC_NOWDOC);
+            }
+        }
+
         private void addFold(final ASTNode node) {
             if (!(node instanceof ASTError) && !(node instanceof EmptyStatement)) {
                 addFold(createOffsetRange(node));
diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/csl/PHPFoldingProvider.java b/php/php.editor/src/org/netbeans/modules/php/editor/csl/PHPFoldingProvider.java
@@ -44,6 +44,7 @@ public class PHPFoldingProvider implements FoldTypeProvider {
         TYPES.add(FoldingScanner.TYPE_USE);
         TYPES.add(FoldingScanner.TYPE_PHPTAG);
         TYPES.add(FoldingScanner.TYPE_ATTRIBUTES);
+        TYPES.add(FoldingScanner.TYPE_HEREDOC_NOWDOC);
     }
 
     @Override
diff --git a/php/php.editor/test/unit/data/testfiles/enumerations_01.php.folds b/php/php.editor/test/unit/data/testfiles/enumerations_01.php.folds
@@ -46,16 +46,16 @@
 |     case C = "C";
 |     case D = "D";
 |     case E = "E" . "E";
-|     case F = <<<F
++     case F = <<<F
 |     Test
 |     Test
 |     Test
-|     F;
-|     case G = <<<'G'
+-     F;
++     case G = <<<'G'
 |     Test
 |     Test
 |     Test
-|     G;
+-     G;
 - }
   
 + enum Impl implements Iface1, Iface2 {
diff --git a/php/php.editor/test/unit/data/testfiles/foldingHeredocNowdoc.php.folds b/php/php.editor/test/unit/data/testfiles/foldingHeredocNowdoc.php.folds
@@ -0,0 +1,17 @@
+  <?php
+  
++ echo <<<HEREDOC
+|     Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+|     Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+|     Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+|     Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+- HEREDOC;
+  
+  
++ echo <<<'NOWDOC'
+|     Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+|     Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+|     Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+|     Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+- NOWDOC;
+
diff --git a/php/php.editor/test/unit/data/testfiles/parser/foldingHeredocNowdoc.php b/php/php.editor/test/unit/data/testfiles/parser/foldingHeredocNowdoc.php
@@ -0,0 +1,16 @@
+<?php
+
+echo <<<HEREDOC
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+    Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+    Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+HEREDOC;
+
+
+echo <<<'NOWDOC'
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+    Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+    Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+NOWDOC;
diff --git a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/csl/FoldingTest.java b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/csl/FoldingTest.java
@@ -121,4 +121,7 @@ public void testEnumerations_01() throws Exception {
         checkFolds("testfiles/parser/php81/enumerations_01.php");
     }
 
+    public void testFoldingHeredocNowdoc() throws Exception {
+        checkFolds("testfiles/parser/foldingHeredocNowdoc.php");
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ public class PHPFoldingProvider implements FoldTypeProvider {`
`44`	`44`	`TYPES.add(FoldingScanner.TYPE_USE);`
`45`	`45`	`TYPES.add(FoldingScanner.TYPE_PHPTAG);`
`46`	`46`	`TYPES.add(FoldingScanner.TYPE_ATTRIBUTES);`
	`47`	`+ TYPES.add(FoldingScanner.TYPE_HEREDOC_NOWDOC);`
`47`	`48`	`}`
`48`	`49`
`49`	`50`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -121,4 +121,7 @@ public void testEnumerations_01() throws Exception {`
`121`	`121`	`checkFolds("testfiles/parser/php81/enumerations_01.php");`
`122`	`122`	`}`
`123`	`123`
	`124`	`+ public void testFoldingHeredocNowdoc() throws Exception {`
	`125`	`+ checkFolds("testfiles/parser/foldingHeredocNowdoc.php");`
	`126`	`+ }`
`124`	`127`	`}`