Fix Android SuppressLint and Api quickfixes: proper annotation placing
#KT-17783 Fixed #KT-17787 Fixed
This commit is contained in:
@@ -16,7 +16,18 @@
|
|||||||
|
|
||||||
package org.jetbrains.kotlin.android
|
package org.jetbrains.kotlin.android
|
||||||
|
|
||||||
|
import org.jetbrains.kotlin.descriptors.PropertyDescriptor
|
||||||
|
import org.jetbrains.kotlin.idea.caches.resolve.analyze
|
||||||
import org.jetbrains.kotlin.idea.editor.fixers.range
|
import org.jetbrains.kotlin.idea.editor.fixers.range
|
||||||
|
import org.jetbrains.kotlin.idea.search.usagesSearch.descriptor
|
||||||
import org.jetbrains.kotlin.psi.KtClass
|
import org.jetbrains.kotlin.psi.KtClass
|
||||||
|
import org.jetbrains.kotlin.psi.KtProperty
|
||||||
|
import org.jetbrains.kotlin.resolve.BindingContext
|
||||||
|
import org.jetbrains.kotlin.resolve.lazy.BodyResolveMode
|
||||||
|
|
||||||
internal fun KtClass.insideBody(offset: Int): Boolean = getBody()?.range?.contains(offset) ?: false
|
internal fun KtClass.insideBody(offset: Int): Boolean = getBody()?.range?.contains(offset) ?: false
|
||||||
|
|
||||||
|
fun KtProperty.hasBackingField(): Boolean {
|
||||||
|
val propertyDescriptor = descriptor as? PropertyDescriptor ?: return false
|
||||||
|
return analyze(BodyResolveMode.PARTIAL)[BindingContext.BACKING_FIELD_REQUIRED, propertyDescriptor] ?: false
|
||||||
|
}
|
||||||
+12
@@ -113,6 +113,12 @@ public class AndroidLintQuickfixTestGenerated extends AbstractAndroidLintQuickfi
|
|||||||
doTest(fileName);
|
doTest(fileName);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@TestMetadata("topLevelProperty.kt")
|
||||||
|
public void testTopLevelProperty() throws Exception {
|
||||||
|
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lintQuickfix/requiresApi/topLevelProperty.kt");
|
||||||
|
doTest(fileName);
|
||||||
|
}
|
||||||
|
|
||||||
@TestMetadata("when.kt")
|
@TestMetadata("when.kt")
|
||||||
public void testWhen() throws Exception {
|
public void testWhen() throws Exception {
|
||||||
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lintQuickfix/requiresApi/when.kt");
|
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lintQuickfix/requiresApi/when.kt");
|
||||||
@@ -239,6 +245,12 @@ public class AndroidLintQuickfixTestGenerated extends AbstractAndroidLintQuickfi
|
|||||||
doTest(fileName);
|
doTest(fileName);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@TestMetadata("topLevelProperty.kt")
|
||||||
|
public void testTopLevelProperty() throws Exception {
|
||||||
|
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lintQuickfix/targetApi/topLevelProperty.kt");
|
||||||
|
doTest(fileName);
|
||||||
|
}
|
||||||
|
|
||||||
@TestMetadata("when.kt")
|
@TestMetadata("when.kt")
|
||||||
public void testWhen() throws Exception {
|
public void testWhen() throws Exception {
|
||||||
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lintQuickfix/targetApi/when.kt");
|
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/android/lintQuickfix/targetApi/when.kt");
|
||||||
|
|||||||
@@ -0,0 +1,7 @@
|
|||||||
|
// INTENTION_TEXT: Add @RequiresApi(M) Annotation
|
||||||
|
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintNewApiInspection
|
||||||
|
// DEPENDENCY: RequiresApi.java -> android/support/annotation/RequiresApi.java
|
||||||
|
import android.app.Activity
|
||||||
|
|
||||||
|
val top: Int
|
||||||
|
get() = Activity().<caret>checkSelfPermission(READ_CONTACTS)
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
// INTENTION_TEXT: Add @RequiresApi(M) Annotation
|
||||||
|
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintNewApiInspection
|
||||||
|
// DEPENDENCY: RequiresApi.java -> android/support/annotation/RequiresApi.java
|
||||||
|
import android.app.Activity
|
||||||
|
import android.os.Build
|
||||||
|
import android.support.annotation.RequiresApi
|
||||||
|
|
||||||
|
val top: Int
|
||||||
|
@RequiresApi(Build.VERSION_CODES.M)
|
||||||
|
get() = Activity().checkSelfPermission(READ_CONTACTS)
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
// INTENTION_TEXT: Add @TargetApi(M) Annotation
|
||||||
|
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintNewApiInspection
|
||||||
|
import android.app.Activity
|
||||||
|
|
||||||
|
val top: Int
|
||||||
|
get() = Activity().<caret>checkSelfPermission(READ_CONTACTS)
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
// INTENTION_TEXT: Add @TargetApi(M) Annotation
|
||||||
|
// INSPECTION_CLASS: org.jetbrains.android.inspections.klint.AndroidLintInspectionToolProvider$AndroidKLintNewApiInspection
|
||||||
|
import android.annotation.TargetApi
|
||||||
|
import android.app.Activity
|
||||||
|
import android.os.Build
|
||||||
|
|
||||||
|
val top: Int
|
||||||
|
@TargetApi(Build.VERSION_CODES.M)
|
||||||
|
get() = Activity().checkSelfPermission(READ_CONTACTS)
|
||||||
+23
-16
@@ -22,6 +22,7 @@ import com.intellij.codeInsight.FileModificationService
|
|||||||
import com.intellij.psi.PsiElement
|
import com.intellij.psi.PsiElement
|
||||||
import com.intellij.psi.util.PsiTreeUtil
|
import com.intellij.psi.util.PsiTreeUtil
|
||||||
import org.jetbrains.android.util.AndroidBundle
|
import org.jetbrains.android.util.AndroidBundle
|
||||||
|
import org.jetbrains.kotlin.android.hasBackingField
|
||||||
import org.jetbrains.kotlin.idea.util.addAnnotation
|
import org.jetbrains.kotlin.idea.util.addAnnotation
|
||||||
import org.jetbrains.kotlin.name.FqName
|
import org.jetbrains.kotlin.name.FqName
|
||||||
import org.jetbrains.kotlin.psi.*
|
import org.jetbrains.kotlin.psi.*
|
||||||
@@ -60,27 +61,33 @@ class AddTargetApiQuickFix(
|
|||||||
annotationContainer.addAnnotation(
|
annotationContainer.addAnnotation(
|
||||||
if (useRequiresApi) FQNAME_REQUIRES_API else FQNAME_TARGET_API,
|
if (useRequiresApi) FQNAME_REQUIRES_API else FQNAME_TARGET_API,
|
||||||
getAnnotationValue(true),
|
getAnnotationValue(true),
|
||||||
whiteSpaceText = "\n")
|
whiteSpaceText = if (annotationContainer.isNewLineNeededForAnnotation()) "\n" else " ")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private fun KtElement.isNewLineNeededForAnnotation() = !(this is KtParameter || this is KtTypeParameter || this is KtPropertyAccessor)
|
||||||
|
|
||||||
private fun getAnnotationValue(fullyQualified: Boolean) = getVersionField(api, fullyQualified)
|
private fun getAnnotationValue(fullyQualified: Boolean) = getVersionField(api, fullyQualified)
|
||||||
|
|
||||||
private fun getAnnotationContainer(element: PsiElement, useRequiresApi: Boolean) =
|
private fun getAnnotationContainer(element: PsiElement, useRequiresApi: Boolean): PsiElement? {
|
||||||
PsiTreeUtil.findFirstParent(element) {
|
return PsiTreeUtil.findFirstParent(element) {
|
||||||
if (useRequiresApi)
|
if (useRequiresApi)
|
||||||
it.isRequiresApiAnnotationValidTarget()
|
it.isRequiresApiAnnotationValidTarget()
|
||||||
else
|
else
|
||||||
it.isTargetApiAnnotationValidTarget()
|
it.isTargetApiAnnotationValidTarget()
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun PsiElement.isRequiresApiAnnotationValidTarget(): Boolean {
|
||||||
|
return this is KtClassOrObject ||
|
||||||
|
(this is KtFunction && this !is KtFunctionLiteral) ||
|
||||||
|
(this is KtProperty && !isLocal && hasBackingField()) ||
|
||||||
|
this is KtPropertyAccessor
|
||||||
|
}
|
||||||
|
|
||||||
// TODO: KtFunctionLiteral is not supported now because addAnnotation fails to shorten references, investigate
|
private fun PsiElement.isTargetApiAnnotationValidTarget(): Boolean {
|
||||||
private fun PsiElement.isRequiresApiAnnotationValidTarget() = this is KtClassOrObject ||
|
return this is KtClassOrObject ||
|
||||||
(this is KtFunction && this !is KtFunctionLiteral) ||
|
(this is KtFunction && this !is KtFunctionLiteral) ||
|
||||||
(this is KtProperty && !this.isLocal)
|
this is KtPropertyAccessor
|
||||||
|
}
|
||||||
// TODO: KtFunctionLiteral is not supported now because addAnnotation fails to shorten references, investigate
|
|
||||||
private fun PsiElement.isTargetApiAnnotationValidTarget() = this is KtClassOrObject ||
|
|
||||||
(this is KtFunction && this !is KtFunctionLiteral)
|
|
||||||
}
|
}
|
||||||
+12
-4
@@ -27,6 +27,7 @@ import com.intellij.psi.PsiElement
|
|||||||
import com.intellij.psi.PsiFile
|
import com.intellij.psi.PsiFile
|
||||||
import com.intellij.psi.util.PsiTreeUtil
|
import com.intellij.psi.util.PsiTreeUtil
|
||||||
import org.jetbrains.android.util.AndroidBundle
|
import org.jetbrains.android.util.AndroidBundle
|
||||||
|
import org.jetbrains.kotlin.android.hasBackingField
|
||||||
import org.jetbrains.kotlin.idea.util.addAnnotation
|
import org.jetbrains.kotlin.idea.util.addAnnotation
|
||||||
import org.jetbrains.kotlin.name.FqName
|
import org.jetbrains.kotlin.name.FqName
|
||||||
import org.jetbrains.kotlin.psi.*
|
import org.jetbrains.kotlin.psi.*
|
||||||
@@ -97,9 +98,16 @@ class SuppressLintIntentionAction(val id: String, val element: PsiElement) : Int
|
|||||||
private fun getLintId(intentionId: String) =
|
private fun getLintId(intentionId: String) =
|
||||||
if (intentionId.startsWith(INTENTION_NAME_PREFIX)) intentionId.substring(INTENTION_NAME_PREFIX.length) else intentionId
|
if (intentionId.startsWith(INTENTION_NAME_PREFIX)) intentionId.substring(INTENTION_NAME_PREFIX.length) else intentionId
|
||||||
|
|
||||||
private fun KtElement.isNewLineNeededForAnnotation() = !(this is KtParameter || this is KtTypeParameter)
|
private fun KtElement.isNewLineNeededForAnnotation(): Boolean {
|
||||||
|
return !(this is KtParameter ||
|
||||||
|
this is KtTypeParameter ||
|
||||||
|
this is KtPropertyAccessor)
|
||||||
|
}
|
||||||
|
|
||||||
private fun PsiElement.isSuppressLintTarget() = this is KtDeclaration &&
|
private fun PsiElement.isSuppressLintTarget(): Boolean {
|
||||||
this !is KtDestructuringDeclaration &&
|
return this is KtDeclaration &&
|
||||||
this !is KtFunctionLiteral
|
(this as? KtProperty)?.hasBackingField() ?: true &&
|
||||||
|
this !is KtFunctionLiteral &&
|
||||||
|
this !is KtDestructuringDeclaration
|
||||||
|
}
|
||||||
}
|
}
|
||||||
Reference in New Issue
Block a user