Fix documentation for empty scripts

Author: waleedyaseen

CHANGELOG.md

@@ -1,6 +1,9 @@
 # intellij-runescript Changelog
 
 ## [Unreleased]
+### Fixed
+
+- Fix documentation for empty scripts.
 
 ## [1.4.0] - 2023-10-15
 

src/main/gen/io/runescript/plugin/lang/parser/RsParser.java

@@ -4,12 +4,13 @@
 import com.intellij.lang.PsiBuilder;
 import com.intellij.lang.PsiBuilder.Marker;
 import static io.runescript.plugin.lang.psi.RsElementTypes.*;
-import static com.intellij.lang.parser.GeneratedParserUtilBase.*;
+import static io.runescript.plugin.lang.parser.RsParserUtil.*;
 import com.intellij.psi.tree.IElementType;
 import com.intellij.lang.ASTNode;
 import com.intellij.psi.tree.TokenSet;
 import com.intellij.lang.PsiParser;
 import com.intellij.lang.LightPsiParser;
+import static com.intellij.lang.WhitespacesBinders.*;
 
 @SuppressWarnings({"SimplifiableIfStatement", "UnusedAssignment"})
 public class RsParser implements PsiParser, LightPsiParser {
@@ -1204,6 +1205,8 @@ public static boolean Script(PsiBuilder b, int l) {
     r = r && Script_5(b, l + 1);
     r = r && Script_6(b, l + 1);
     r = r && StatementList(b, l + 1);
+    register_hook_(b, LEFT_BINDER, SCRIPT_LEFT_BINDER);
+    register_hook_(b, RIGHT_BINDER, SCRIPT_RIGHT_BINDER);
     exit_section_(b, m, SCRIPT, r);
     return r;
   }
@@ -1261,6 +1264,7 @@ public static boolean StatementList(PsiBuilder b, int l) {
       if (!Statement(b, l + 1)) break;
       if (!empty_element_parsed_guard_(b, "StatementList", c)) break;
     }
+    register_hook_(b, LEFT_BINDER, GREEDY_LEFT_BINDER);
     exit_section_(b, l, m, true, false, null);
     return true;
   }

src/main/grammars/RuneScript.bnf

@@ -8,6 +8,7 @@
   psiPackage="io.runescript.plugin.lang.psi"
   psiImplPackage="io.runescript.plugin.lang.psi.impl"
   psiImplUtilClass="io.runescript.plugin.lang.psi.RsPsiImplUtil"
+  parserUtilClass="io.runescript.plugin.lang.parser.RsParserUtil"
   elementTypeHolderClass="io.runescript.plugin.lang.psi.RsElementTypes"
   elementTypeClass="io.runescript.plugin.lang.psi.RsElementType"
   tokenTypeClass="io.runescript.plugin.lang.psi.RsElementType"
@@ -25,6 +26,9 @@
   implements("Script")="io.runescript.plugin.lang.psi.RsNamedElement"
   implements("Script|HookFragment")="io.runescript.plugin.lang.psi.type.inference.RsInferenceDataHolder"
   classHeader="// This class is automatically generated. Do not edit."
+  parserImports=[
+    "static com.intellij.lang.WhitespacesBinders.*"
+  ]
   tokens=[
     LBRACKET='['
     RBRACKET=']'
@@ -57,6 +61,10 @@
 File ::= Script*
 
 Script ::= '[' NameLiteral ',' NameLiteral ']' ParameterList? ReturnList? StatementList {
+    hooks=[
+        leftBinder="SCRIPT_LEFT_BINDER"
+        rightBinder="SCRIPT_RIGHT_BINDER"
+    ]
     stubClass="io.runescript.plugin.lang.stubs.RsScriptStub"
     elementTypeFactory = "io.runescript.plugin.lang.stubs.StubElementTypeFactory.create"
     implements="com.intellij.psi.NavigatablePsiElement"
@@ -85,6 +93,9 @@ TypeName ::= TYPE_LITERAL {
 }
 StatementList ::= Statement* {
     mixin="io.runescript.plugin.lang.psi.mixin.RsStatementListMixin"
+    hooks=[
+        leftBinder="GREEDY_LEFT_BINDER"
+    ]
 }
 Statement ::= BlockStatement
             | IfStatement

src/main/kotlin/io/runescript/plugin/ide/doc/RsDocumentationProvider.kt

@@ -8,10 +8,8 @@ import com.intellij.lang.documentation.DocumentationSettings
 import com.intellij.openapi.editor.colors.TextAttributesKey
 import com.intellij.openapi.editor.richcopy.HtmlSyntaxInfoUtil
 import com.intellij.psi.*
-import com.intellij.psi.tree.TokenSet
+import com.intellij.psi.util.childrenOfType
 import com.intellij.psi.util.parentOfType
-import com.intellij.psi.util.siblings
-import com.intellij.psi.util.skipTokens
 import io.runescript.plugin.ide.doc.RsDocRenderer.renderRsDoc
 import io.runescript.plugin.ide.highlight.RsSyntaxHighlighterColors
 import io.runescript.plugin.lang.doc.psi.api.RsDoc
@@ -194,7 +192,5 @@ private fun StringBuilder.appendColon(text: String = ":") {
 }
 
 fun RsScript.findDoc(): RsDoc? {
-    return siblings(false, withSelf = false)
-        .skipTokens(TokenSet.WHITE_SPACE)
-        .firstOrNull() as? RsDoc
+    return childrenOfType<RsDoc>().firstOrNull()
 }

src/main/kotlin/io/runescript/plugin/lang/doc/psi/impl/RsDocImpl.kt

@@ -7,9 +7,7 @@ package io.runescript.plugin.lang.doc.psi.impl
 import com.intellij.lang.Language
 import com.intellij.psi.impl.source.tree.LazyParseablePsiElement
 import com.intellij.psi.tree.IElementType
-import com.intellij.psi.tree.TokenSet
-import com.intellij.psi.util.siblings
-import com.intellij.psi.util.skipTokens
+import com.intellij.psi.util.parentOfType
 import io.runescript.plugin.lang.RuneScript
 import io.runescript.plugin.lang.doc.getChildOfType
 import io.runescript.plugin.lang.doc.getChildrenOfType
@@ -28,9 +26,7 @@ class RsDocImpl(buffer: CharSequence?) : LazyParseablePsiElement(RsDocTokens.RSD
     override fun getTokenType(): IElementType = RsTokenTypes.DOC_COMMENT
 
     override fun getOwner(): RsScript? {
-        return siblings(true, withSelf = false)
-            .skipTokens(TokenSet.WHITE_SPACE)
-            .firstOrNull() as? RsScript
+        return parentOfType<RsScript>()
     }
 
     override fun getDefaultSection(): RsDocSection = getChildOfType()!!

src/main/kotlin/io/runescript/plugin/lang/parser/RsParserUtil.kt

@@ -0,0 +1,37 @@
+package io.runescript.plugin.lang.parser
+
+import com.intellij.lang.WhitespacesAndCommentsBinder
+import com.intellij.lang.parser.GeneratedParserUtilBase
+import com.intellij.openapi.util.text.StringUtil
+import com.intellij.psi.TokenType
+import io.runescript.plugin.lang.psi.RsTokenTypes
+
+object RsParserUtil : GeneratedParserUtilBase() {
+
+    @JvmField
+    val SCRIPT_LEFT_BINDER = WhitespacesAndCommentsBinder { tokens, _, _ ->
+        for (idx in tokens.indices.reversed()) {
+            if (tokens[idx] == RsTokenTypes.DOC_COMMENT) {
+                return@WhitespacesAndCommentsBinder idx
+            }
+        }
+        return@WhitespacesAndCommentsBinder tokens.size
+    }
+
+    @JvmField
+    val SCRIPT_RIGHT_BINDER = WhitespacesAndCommentsBinder { tokens, _, getter ->
+        if (tokens.isEmpty()) return@WhitespacesAndCommentsBinder 0
+
+        var result = 0
+        tokens@ for (idx in tokens.indices) {
+            val tokenType = tokens[idx]
+            when (tokenType) {
+                TokenType.WHITE_SPACE -> if (StringUtil.containsLineBreak(getter[idx])) break@tokens
+                RsTokenTypes.LINE_COMMENT, RsTokenTypes.BLOCK_COMMENT -> result = idx + 1
+                else -> break@tokens
+            }
+        }
+
+        return@WhitespacesAndCommentsBinder result
+    }
+}