feat(devins-lang): add support for single-line comments #100

Add support for single-line comments in DevInsCommenter.kt and update DevInLexer.flex to handle comments properly.

This commit adds the necessary code to support single-line comments in the DevInsCommenter.kt file and updates the DevInLexer.flex file to handle comments properly. This enhancement allows the DevIns language to recognize and process single-line comments.

exts/devins-lang/src/grammar/DevInLexer.flex

@@ -112,7 +112,6 @@ SHARP=#
 
     private IElementType comment() {
         String text = yytext().toString().trim();
-        System.out.println("comment: " + text);
         if (text.contains("[") && text.contains("]")) {
             return COMMENTS;
         } else {

exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/commenter/DevInsCommenter.kt

@@ -0,0 +1,111 @@
+package cc.unitmesh.devti.language.commenter
+
+import cc.unitmesh.devti.language.DevInLanguage
+import cc.unitmesh.devti.language.psi.DevInTypes
+import com.intellij.application.options.CodeStyle
+import com.intellij.codeInsight.generation.CommenterDataHolder
+import com.intellij.codeInsight.generation.SelfManagingCommenter
+import com.intellij.codeInsight.generation.SelfManagingCommenterUtil
+import com.intellij.lang.CodeDocumentationAwareCommenter
+import com.intellij.lang.Commenter
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiComment
+import com.intellij.psi.PsiFile
+import com.intellij.psi.tree.IElementType
+import com.intellij.util.text.CharArrayUtil
+
+data class CommentHolder(val file: PsiFile) : CommenterDataHolder() {
+    fun useSpaceAfterLineComment(): Boolean = CodeStyle.getLanguageSettings(file, DevInLanguage).LINE_COMMENT_ADD_SPACE
+}
+
+class DevInsCommenter : Commenter, CodeDocumentationAwareCommenter, SelfManagingCommenter<CommentHolder> {
+    override fun isDocumentationComment(element: PsiComment?) = false
+    override fun getDocumentationCommentTokenType(): IElementType? = null
+    override fun getDocumentationCommentLinePrefix(): String? = null
+    override fun getDocumentationCommentPrefix(): String? = null
+    override fun getDocumentationCommentSuffix(): String? = null
+
+    override fun getLineCommentTokenType(): IElementType? = DevInTypes.COMMENTS
+    override fun getBlockCommentTokenType(): IElementType? = null
+
+    override fun getLineCommentPrefix(): String = "[]"
+
+    override fun getBlockCommentPrefix(): String? = null
+    override fun getBlockCommentSuffix(): String? = null
+
+    // unused because we implement SelfManagingCommenter
+    override fun getCommentedBlockCommentPrefix(): String? = null
+    override fun getCommentedBlockCommentSuffix(): String? = null
+
+    override fun getBlockCommentPrefix(
+        selectionStart: Int,
+        document: Document,
+        data: CommentHolder
+    ): String? = null
+
+    override fun getBlockCommentSuffix(
+        selectionEnd: Int,
+        document: Document,
+        data: CommentHolder
+    ): String? = null
+
+    override fun getBlockCommentRange(
+        selectionStart: Int,
+        selectionEnd: Int,
+        document: Document,
+        data: CommentHolder
+    ): TextRange? = null
+
+    override fun insertBlockComment(
+        startOffset: Int,
+        endOffset: Int,
+        document: Document,
+        data: CommentHolder?
+    ): TextRange? = null
+
+    override fun uncommentBlockComment(
+        startOffset: Int,
+        endOffset: Int,
+        document: Document,
+        data: CommentHolder?
+    ) {
+    }
+
+    override fun isLineCommented(line: Int, offset: Int, document: Document, data: CommentHolder): Boolean {
+        return LINE_PREFIXES.any { CharArrayUtil.regionMatches(document.charsSequence, offset, it) }
+    }
+
+    override fun commentLine(line: Int, offset: Int, document: Document, data: CommentHolder) {
+        val addSpace = data.useSpaceAfterLineComment()
+        document.insertString(offset, "[]" + if (addSpace) " " else "")
+    }
+
+    override fun uncommentLine(line: Int, offset: Int, document: Document, data: CommentHolder) {
+        val prefixLen = LINE_PREFIXES.find { CharArrayUtil.regionMatches(document.charsSequence, offset, it) }?.length
+            ?: return
+        val hasSpace = data.useSpaceAfterLineComment() &&
+                CharArrayUtil.regionMatches(document.charsSequence, offset + prefixLen, " ")
+        document.deleteString(offset, offset + prefixLen + if (hasSpace) 1 else 0)
+    }
+
+    override fun getCommentPrefix(line: Int, document: Document, data: CommentHolder): String = lineCommentPrefix
+
+    override fun createBlockCommentingState(
+        selectionStart: Int,
+        selectionEnd: Int,
+        document: Document,
+        file: PsiFile
+    ): CommentHolder = CommentHolder(file)
+
+    override fun createLineCommentingState(
+        startLine: Int,
+        endLine: Int,
+        document: Document,
+        file: PsiFile
+    ): CommentHolder = CommentHolder(file)
+
+    companion object {
+        private val LINE_PREFIXES: List<String> = listOf("[]")
+    }
+}

exts/devins-lang/src/main/resources/cc.unitmesh.devti.language.xml

@@ -42,6 +42,8 @@
         <runLineMarkerContributor language="DevIn"
                                   implementationClass="cc.unitmesh.devti.language.run.DevInsRunLineMarkersProvider"/>
 
+        <lang.commenter language="DevIn" implementationClass="cc.unitmesh.devti.language.commenter.DevInsCommenter"/>
+
         <lang.documentationProvider language="DevIn"
                                     id="devinsDocumentationProvider"
                                     implementationClass="cc.unitmesh.devti.language.documentation.DevInsDocumentationProvider"/>