Implement a simple comment enter handler that inserts * at the beginning

Author: halirutan

resources/META-INF/plugin.xml

@@ -66,6 +66,7 @@
 
         <enterHandlerDelegate implementation="de.halirutan.mathematica.codeinsight.editoractions.enter.MathematicaEnterInsideFunctionHandler"/>
         <enterHandlerDelegate implementation="de.halirutan.mathematica.codeinsight.editoractions.enter.MathematicaEnterAfterOperatorHandler"/>
+        <enterHandlerDelegate implementation="de.halirutan.mathematica.codeinsight.editoractions.enter.CommentStarInsertEnterHandler"/>
 
         <liveTemplateContext implementation="de.halirutan.mathematica.codeinsight.livetemplates.MathematicaTemplateContextType"/>
         <defaultLiveTemplatesProvider implementation="de.halirutan.mathematica.codeinsight.livetemplates.MathematicaDefaultLiveTemplateProvider"/>

src/de/halirutan/mathematica/codeinsight/editoractions/enter/CommentStarInsertEnterHandler.kt

@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2017. Patrick Scheibe
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package de.halirutan.mathematica.codeinsight.editoractions.enter
+
+import com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.actionSystem.DataContext
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiComment
+import com.intellij.psi.PsiDocumentManager
+import com.intellij.psi.PsiFile
+
+/**/
+
+/**
+ *
+ * @author patrick (04.12.17).
+ */
+class CommentStarInsertEnterHandler : MathematicaEnterHandler() {
+  override fun postProcessEnter(file: PsiFile, editor: Editor, dataContext: DataContext): EnterHandlerDelegate.Result {
+    skipWithResultQ(file, editor, dataContext)?.let { return it }
+    val caretModel = editor.caretModel
+    val offset = caretModel.offset
+    val project = dataContext.getData(CommonDataKeys.PROJECT) ?: return EnterHandlerDelegate.Result.Continue
+    val psiDocManager = PsiDocumentManager.getInstance(project)
+    val element = file.findElementAt(offset) ?: return EnterHandlerDelegate.Result.Continue
+    if (element is PsiComment) {
+      val document = editor.document
+      val textLength = document.textLength
+
+      // The case that we opened a comment with (*|) and therefore the complete file is commented
+      // We insert the missing *
+      if (element.textRange.endOffset == textLength && offset < textLength && document.getText(TextRange.create(offset, offset + 1)) == ")") {
+        document.insertString(offset, " * \n *")
+        caretModel.moveToOffset(offset + 3)
+        psiDocManager.commitDocument(document)
+        return EnterHandlerDelegate.Result.Stop
+      }
+
+
+      val lineNumber = document.getLineNumber(offset)
+      val elementStartLine = document.getLineNumber(element.textOffset)
+      val elementEndLine = document.getLineNumber(element.textOffset + element.textLength)
+
+      val insertString: String
+      val move: Int
+      if (lineNumber == elementStartLine + 1) {
+        insertString = " * "
+        move = 3
+      } else {
+        insertString = "* "
+        move = 2
+      }
+      document.insertString(offset, insertString)
+      caretModel.moveToOffset(offset + move)
+
+      if (lineNumber == elementEndLine) {
+        document.insertString(offset + move, "\n ")
+      }
+      psiDocManager.commitDocument(document)
+      return EnterHandlerDelegate.Result.DefaultSkipIndent
+    }
+    return EnterHandlerDelegate.Result.Continue
+  }
+}

src/de/halirutan/mathematica/codeinsight/editoractions/enter/MathematicaEnterHandler.kt

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2017. Patrick Scheibe
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package de.halirutan.mathematica.codeinsight.editoractions.enter
+
+import com.intellij.codeInsight.CodeInsightSettings
+import com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate
+import com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.actionSystem.DataContext
+import com.intellij.openapi.editor.Editor
+import com.intellij.psi.PsiDocumentManager
+import com.intellij.psi.PsiFile
+import de.halirutan.mathematica.lang.MathematicaLanguage
+
+/**
+ *
+ * @author patrick (04.12.17).
+ */
+open class MathematicaEnterHandler : EnterHandlerDelegateAdapter() {
+
+  fun skipWithResultQ(file: PsiFile, editor: Editor, dataContext: DataContext): EnterHandlerDelegate.Result? {
+    val project = CommonDataKeys.PROJECT.getData(dataContext) ?: return EnterHandlerDelegate.Result.Continue
+
+    if (!file.viewProvider.languages.contains(MathematicaLanguage.INSTANCE)) {
+      return EnterHandlerDelegate.Result.Continue
+    }
+
+    if (editor.isViewer) {
+      return EnterHandlerDelegate.Result.Continue
+    }
+
+    val document = editor.document
+    if (!document.isWritable) {
+      return EnterHandlerDelegate.Result.Continue
+    }
+
+    if (!CodeInsightSettings.getInstance().SMART_INDENT_ON_ENTER) {
+      return EnterHandlerDelegate.Result.Continue
+    }
+
+    PsiDocumentManager.getInstance(project).commitDocument(document)
+
+    val caret = editor.caretModel.offset
+    if (caret == 0) {
+      return EnterHandlerDelegate.Result.DefaultSkipIndent
+    }
+    return if (caret <= 0) {
+      EnterHandlerDelegate.Result.Continue
+    } else null
+  }
+
+}

src/de/halirutan/mathematica/codeinsight/livetemplates/MathematicaTemplateContextType.java

@@ -49,7 +49,8 @@ protected MathematicaTemplateContextType() {
   public boolean isInContext(@NotNull PsiFile file, int offset) {
     if (PsiUtilBase.getLanguageAtOffset(file, offset).isKindOf(MathematicaFileType.INSTANCE.getLanguage())) {
       PsiElement element = PsiUtilBase.getElementAtOffset(file, offset);
-      return PsiTreeUtil.getParentOfType(element, PsiComment.class, MString.class) == null;
+      return !(element instanceof PsiComment) &&
+          PsiTreeUtil.getParentOfType(element, PsiComment.class, MString.class) == null;
     }
     return false;
   }