Merge pull request #559 from JetBrains/rr/yole/template-context-comments

live template context type for comments in Kotlin; disable other context...

idea/src/META-INF/plugin.xml

@@ -305,6 +305,7 @@
     <liveTemplateContext implementation="org.jetbrains.kotlin.idea.liveTemplates.JetTemplateContextType$Statement"/>
     <liveTemplateContext implementation="org.jetbrains.kotlin.idea.liveTemplates.JetTemplateContextType$Class"/>
     <liveTemplateContext implementation="org.jetbrains.kotlin.idea.liveTemplates.JetTemplateContextType$Expression"/>
+    <liveTemplateContext implementation="org.jetbrains.kotlin.idea.liveTemplates.JetTemplateContextType$Comment"/>
     <defaultLiveTemplatesProvider implementation="org.jetbrains.kotlin.idea.liveTemplates.JetLiveTemplatesProvider"/>
     <liveTemplateMacro implementation="org.jetbrains.kotlin.idea.liveTemplates.macro.JetAnyVariableMacro"/>
     <liveTemplateMacro implementation="org.jetbrains.kotlin.idea.liveTemplates.macro.JetFunctionParametersMacro"/>

idea/src/org/jetbrains/kotlin/idea/liveTemplates/JetTemplateContextType.java

@@ -43,9 +43,15 @@ public abstract class JetTemplateContextType extends TemplateContextType {
     public boolean isInContext(@NotNull PsiFile file, int offset) {
         if (PsiUtilBase.getLanguageAtOffset(file, offset).isKindOf(JetLanguage.INSTANCE)) {
             PsiElement element = file.findElementAt(offset);
-            if (element instanceof PsiWhiteSpace || element instanceof PsiComment) {
+            if (element == null) {
+                element = file.findElementAt(offset - 1);
+            }
+            if (element instanceof PsiWhiteSpace) {
                 return false;
             }
+            else if (PsiTreeUtil.getParentOfType(element, PsiComment.class, false) != null) {
+                return isCommentInContext();
+            }
             else if (PsiTreeUtil.getParentOfType(element, JetPackageDirective.class) != null
                     || PsiTreeUtil.getParentOfType(element, JetImportDirective.class) != null) {
                 return false;
@@ -71,6 +77,10 @@ public abstract class JetTemplateContextType extends TemplateContextType {
         return false;
     }
 
+    protected boolean isCommentInContext() {
+        return false;
+    }
+
     protected abstract boolean isInContext(@NotNull PsiElement element);
 
     public static class Generic extends JetTemplateContextType {
@@ -82,6 +92,11 @@ public abstract class JetTemplateContextType extends TemplateContextType {
         protected boolean isInContext(@NotNull PsiElement element) {
             return true;
         }
+
+        @Override
+        protected boolean isCommentInContext() {
+            return true;
+        }
     }
 
     public static class TopLevel extends JetTemplateContextType {
@@ -133,7 +148,7 @@ public abstract class JetTemplateContextType extends TemplateContextType {
                 }
                 e = e.getParent();
             }
-            return true;
+            return e != null;
         }
     }
 
@@ -170,4 +185,20 @@ public abstract class JetTemplateContextType extends TemplateContextType {
                    && !(element.getParent() instanceof JetParameter);
         }
     }
+
+    public static class Comment extends JetTemplateContextType {
+        public Comment() {
+            super("KOTLIN_COMMENT", "Comment", Generic.class);
+        }
+
+        @Override
+        protected boolean isInContext(@NotNull PsiElement element) {
+            return false;
+        }
+
+        @Override
+        protected boolean isCommentInContext() {
+            return true;
+        }
+    }
 }

idea/testData/templates/context/InDocComment.kt

@@ -0,0 +1,4 @@
+/**
+ * In <caret>Comment
+ */
+fun foo() {}

idea/testData/templates/context/TopLevel.kt

@@ -0,0 +1 @@
+psvm<caret>

idea/tests/org/jetbrains/kotlin/idea/codeInsight/LiveTemplatesContextTest.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2010-2015 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.jetbrains.kotlin.idea.codeInsight
+
+import org.jetbrains.kotlin.idea.JetLightCodeInsightFixtureTestCase
+import org.jetbrains.kotlin.idea.PluginTestCaseBase
+
+import java.io.File
+import org.jetbrains.kotlin.idea.liveTemplates.JetTemplateContextType
+import com.intellij.codeInsight.template.TemplateContextType
+import com.intellij.testFramework.UsefulTestCase
+
+public class LiveTemplatesContextTest : JetLightCodeInsightFixtureTestCase() {
+    override fun getTestDataPath(): String =
+            File(PluginTestCaseBase.getTestDataPathBase(), "/templates/context").getPath() + File.separator
+
+    public fun testInDocComment() {
+        myFixture.configureByFile(getTestName(false) + ".kt")
+        assertInContexts(javaClass<JetTemplateContextType.Generic>(), javaClass<JetTemplateContextType.Comment>())
+    }
+
+    public fun testTopLevel() {
+        myFixture.configureByFile(getTestName(false) + ".kt")
+        assertInContexts(javaClass<JetTemplateContextType.Generic>(),
+                         javaClass<JetTemplateContextType.TopLevel>(),
+                         javaClass<JetTemplateContextType.Expression>())
+    }
+
+    private fun assertInContexts(vararg expectedContexts: Class<out JetTemplateContextType>) {
+        val allContexts = TemplateContextType.EP_NAME.getExtensions().filter { it is JetTemplateContextType }
+        val enabledContexts = allContexts.filter { it.isInContext(myFixture.getFile(), myFixture.getCaretOffset()) }.map { it.javaClass }
+        UsefulTestCase.assertSameElements(enabledContexts, *expectedContexts)
+    }
+}