Implement Intention to add @JvmOverloads (#860)

Implement Intention to add @JvmOverloads Fixes #KT-11523
2016-04-29 13:32:00 +02:00
parent f309920af8
commit 8e5481b5d5
15 changed files with 199 additions and 0 deletions
@@ -1104,6 +1104,11 @@
      <category>Kotlin</category>
    </intentionAction>

+    <intentionAction>
+      <className>org.jetbrains.kotlin.idea.intentions.AddJvmOverloadsIntention</className>
+      <category>Kotlin</category>
+    </intentionAction>
+
    <intentionAction>
      <className>org.jetbrains.kotlin.idea.intentions.RemoveArgumentNameIntention</className>
      <category>Kotlin</category>
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2010-2016 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.intentions
+
+import com.intellij.codeInsight.intention.LowPriorityAction
+import com.intellij.openapi.editor.Editor
+import org.jetbrains.kotlin.idea.project.ProjectStructureUtil
+import org.jetbrains.kotlin.idea.util.addAnnotation
+import org.jetbrains.kotlin.idea.util.findAnnotation
+import org.jetbrains.kotlin.name.FqName
+import org.jetbrains.kotlin.psi.*
+import org.jetbrains.kotlin.psi.psiUtil.endOffset
+import org.jetbrains.kotlin.psi.psiUtil.startOffset
+
+private val annotationFqName = FqName("kotlin.jvm.JvmOverloads")
+
+class AddJvmOverloadsIntention : SelfTargetingIntention<KtModifierListOwner>(
+        KtModifierListOwner::class.java, "Add '@JvmOverloads' annotation"
+), LowPriorityAction {
+
+    override fun isApplicableTo(element: KtModifierListOwner, caretOffset: Int): Boolean {
+        val (targetName, parameters) = when (element) {
+            is KtNamedFunction -> {
+                val funKeyword = element.funKeyword ?: return false
+                val valueParameterList = element.valueParameterList ?: return false
+                if (caretOffset !in funKeyword.startOffset..valueParameterList.endOffset) {
+                    return false
+                }
+
+                "function '${element.name}'" to valueParameterList.parameters
+            }
+            is KtSecondaryConstructor -> {
+                val constructorKeyword = element.getConstructorKeyword()
+                val valueParameterList = element.valueParameterList ?: return false
+                if (caretOffset !in constructorKeyword.startOffset..valueParameterList.endOffset) {
+                    return false
+                }
+
+                "secondary constructor" to valueParameterList.parameters
+            }
+            is KtPrimaryConstructor -> {
+                val parameters = (element.valueParameterList ?: return false).parameters
+
+                // For primary constructors with all default values, a zero-arg constructor is generated anyway. If there's only one
+                // parameter and it has a default value, the bytecode with and without @JvmOverloads is exactly the same.
+                if (parameters.singleOrNull()?.hasDefaultValue() == true) {
+                    return false
+                }
+
+                "primary constructor" to parameters
+            }
+            else -> return false
+        }
+
+        text = "Add '@JvmOverloads' annotation to $targetName"
+
+        return !ProjectStructureUtil.isJsKotlinModule(element.getContainingKtFile())
+               && parameters.any { it.hasDefaultValue() }
+               && element.findAnnotation(annotationFqName) == null
+    }
+
+    override fun applyTo(element: KtModifierListOwner, editor: Editor?) {
+        if (element is KtPrimaryConstructor) {
+            if (element.getConstructorKeyword() == null) {
+                element.addBefore(KtPsiFactory(element).createConstructorKeyword(), element.valueParameterList)
+            }
+            element.addAnnotation(annotationFqName, whiteSpaceText = " ")
+        }
+        else {
+            element.addAnnotation(annotationFqName)
+        }
+    }
+
+}
@@ -0,0 +1 @@
+org.jetbrains.kotlin.idea.intentions.AddJvmOverloadsIntention
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+// IS_APPLICABLE: false
+
+@kotlin.jvm.JvmOverloads
+fun foo(a: String = ""<caret>, b: Int) {
+}
@@ -0,0 +1,5 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to function 'foo'"
+
+fun foo(a: String = ""<caret>) {
+}
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to function 'foo'"
+
+@JvmOverloads
+fun foo(a: String = ""<caret>) {
+}
@@ -0,0 +1,4 @@
+// IS_APPLICABLE: false
+
+fun foo(a: String<caret>, b: Int) {
+}
@@ -0,0 +1,4 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to primary constructor"
+
+class A(val a: String = ""<caret>, b: Int = 0)
@@ -0,0 +1,4 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to primary constructor"
+
+class A @JvmOverloads constructor(val a: String = ""<caret>, b: Int = 0)
@@ -0,0 +1,4 @@
+// IS_APPLICABLE: false
+
+class A(a: String<caret> = "") {
+}
@@ -0,0 +1,4 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to primary constructor"
+
+class A constructor(val a: String = ""<caret>, b: Int)
@@ -0,0 +1,4 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to primary constructor"
+
+class A @JvmOverloads constructor(val a: String = ""<caret>, b: Int)
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to secondary constructor"
+
+class A {
+    constructor(a: String = ""<caret>, b: Int)
+}
@@ -0,0 +1,7 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: "Add '@JvmOverloads' annotation to secondary constructor"
+
+class A {
+    @JvmOverloads
+    constructor(a: String = ""<caret>, b: Int)
+}
@@ -194,6 +194,57 @@ public class IntentionTestGenerated extends AbstractIntentionTest {
        }
    }

+    @TestMetadata("idea/testData/intentions/addJvmOverloads")
+    @TestDataPath("$PROJECT_ROOT")
+    @RunWith(JUnit3RunnerWithInners.class)
+    public static class AddJvmOverloads extends AbstractIntentionTest {
+        public void testAllFilesPresentInAddJvmOverloads() throws Exception {
+            KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/intentions/addJvmOverloads"), Pattern.compile("^([\\w\\-_]+)\\.kt$"), true);
+        }
+
+        @TestMetadata("alreadyHasAnnotation.kt")
+        public void testAlreadyHasAnnotation() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/alreadyHasAnnotation.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("method.kt")
+        public void testMethod() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/method.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("noDefaultParams.kt")
+        public void testNoDefaultParams() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/noDefaultParams.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("primaryConstructor.kt")
+        public void testPrimaryConstructor() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/primaryConstructor.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("primaryConstructorOneWithDefault.kt")
+        public void testPrimaryConstructorOneWithDefault() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/primaryConstructorOneWithDefault.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("primaryConstructorWithConstructorKeyword.kt")
+        public void testPrimaryConstructorWithConstructorKeyword() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/primaryConstructorWithConstructorKeyword.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("secondaryConstructor.kt")
+        public void testSecondaryConstructor() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/addJvmOverloads/secondaryConstructor.kt");
+            doTest(fileName);
+        }
+    }
+
    @TestMetadata("idea/testData/intentions/addNameToArgument")
    @TestDataPath("$PROJECT_ROOT")
    @RunWith(JUnit3RunnerWithInners.class)
				`@@ -0,0 +1 @@`
				`org.jetbrains.kotlin.idea.intentions.AddJvmOverloadsIntention`