feat: support comment folding builder

Author: xepozz

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/PHPOpCommentFoldingBuilder.kt

@@ -0,0 +1,29 @@
+package com.github.xepozz.php_opcodes_language.language
+
+import com.github.xepozz.php_opcodes_language.language.psi.PHPOpBlockComment
+import com.intellij.lang.ASTNode
+import com.intellij.lang.folding.FoldingBuilderEx
+import com.intellij.lang.folding.FoldingDescriptor
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.project.DumbAware
+import com.intellij.psi.PsiElement
+import com.intellij.psi.util.PsiTreeUtil
+
+class PHPOpCommentFoldingBuilder : FoldingBuilderEx(), DumbAware {
+    override fun buildFoldRegions(root: PsiElement, document: Document, quick: Boolean) =
+        collectFoldingBlocks(root).toTypedArray()
+
+    private fun collectFoldingBlocks(element: PsiElement) =
+        PsiTreeUtil
+            .findChildrenOfType(element, PHPOpBlockComment::class.java)
+            .mapNotNull {
+                FoldingDescriptor(
+                    it.node,
+                    it.textRange
+                )
+            }
+
+    override fun getPlaceholderText(node: ASTNode) = node.text.take(15)
+
+    override fun isCollapsedByDefault(node: ASTNode) = true
+}

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/parser/PHPOp.bnf

@@ -39,9 +39,11 @@
 
 phpOpFile ::= item_*
 
-private item_ ::= block | COMMENT | EOL
+private item_ ::= block | block_comment | EOL
 
-block ::= block_name COLON (statement | live_range | exception_table | COMMENT | EOL)+
+block_comment ::= COMMENT (EOL COMMENT)+
+
+block ::= block_name COLON (statement | live_range | exception_table | block_comment | EOL)+
 {
     pin=2
 }
@@ -197,9 +199,7 @@ line_number ::= INTEGER
 exception_table ::= 'EXCEPTION TABLE:'  exception_table_statements
 {
     pin=1
-//    recoverWhile=exception_table_recover
 }
-//private exception_table_recover ::= !(EOL)
 
 exception_table_statements ::= exception_table_statement+
 

src/main/kotlin/com/github/xepozz/php_opcodes_language/language/psi/PHPOpTokenSets.kt

@@ -5,6 +5,8 @@ import com.intellij.psi.tree.TokenSet
 object PHPOpTokenSets {
     val EMPTY_SET = TokenSet.EMPTY
 
-    val COMMENTS = TokenSet.create(PHPOpTypes.COMMENT)
+    val COMMENTS = TokenSet.EMPTY
+
+    //    val COMMENTS = TokenSet.create(PHPOpTypes.COMMENT)
     val WHITESPACES = TokenSet.WHITE_SPACE
 }

src/main/resources/META-INF/plugin.xml

@@ -46,6 +46,10 @@
                 language="PHP Opcodes"
                 implementationClass="com.github.xepozz.php_opcodes_language.language.PHPOpFoldingBuilder"/>
 
+        <lang.foldingBuilder
+                language="PHP Opcodes"
+                implementationClass="com.github.xepozz.php_opcodes_language.language.PHPOpCommentFoldingBuilder"/>
+
         <psi.referenceContributor
                 language="PHP Opcodes"
                 implementation="com.github.xepozz.php_opcodes_language.reference.PHPOpReferenceContributor"/>