Android: Extract dependencies to Android plugin to extensions

2018-03-19 22:58:13 +03:00
parent 39e9d28c63
commit 8f02d338a6
15 changed files with 298 additions and 79 deletions
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
+ * that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.android.model
+
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.extensions.ExtensionPointName
+import com.intellij.openapi.extensions.Extensions
+import com.intellij.openapi.module.Module
+import com.intellij.openapi.module.ModuleUtilCore
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiElement
+import java.io.File
+
+val Module.isAndroidModule
+
+    get() = AndroidModuleInfoProvider.getInstance(this)?.isAndroidModule() ?: false
+
+interface AndroidModuleInfoProvider {
+    companion object {
+        val EP_NAME = ExtensionPointName.create<AndroidModuleInfoProvider>("org.jetbrains.kotlin.android.model.androidModuleInfoProvider")
+
+        fun getInstance(module: Module): AndroidModuleInfoProvider? {
+            val extensionArea = Extensions.getArea(module)
+            if (!extensionArea.hasExtensionPoint(EP_NAME.name)) {
+                return null
+            }
+            return extensionArea.getExtensionPoint(EP_NAME).extension
+        }
+
+        fun getInstance(element: PsiElement): AndroidModuleInfoProvider? {
+            val module = ApplicationManager.getApplication().runReadAction<Module> {
+                ModuleUtilCore.findModuleForPsiElement(element)
+            }
+            return getInstance(module)
+        }
+    }
+
+    val module: Module
+
+    fun isAndroidModule(): Boolean
+    fun isGradleModule(): Boolean
+
+    fun getApplicationPackage(): String?
+
+    // For old Android Extensions
+    fun getMainSourceProvider(): SourceProviderMirror?
+    fun getFlavorSourceProviders(): List<SourceProviderMirror>
+    fun getAllResourceDirectories(): List<VirtualFile>
+
+    // For experimental Android Extensions
+    fun getApplicationResourceDirectories(createIfNecessary: Boolean): Collection<VirtualFile>
+    fun getAllSourceProviders(): List<SourceProviderMirror>
+    fun getActiveSourceProviders(): List<SourceProviderMirror>
+
+
+    interface SourceProviderMirror {
+        val name: String
+        val resDirectories: Collection<File>
+    }
+}
+
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2010-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
+ * that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.android.model.impl
+
+import com.android.builder.model.SourceProvider
+import com.android.tools.idea.gradle.project.GradleProjectInfo
+import com.android.tools.idea.gradle.project.model.AndroidModuleModel
+import com.intellij.openapi.module.Module
+import com.intellij.openapi.vfs.VirtualFile
+import org.jetbrains.android.facet.AndroidFacet
+import org.jetbrains.kotlin.android.model.AndroidModuleInfoProvider
+import java.io.File
+
+class AndroidModuleInfoProviderImpl(override val module: Module) : AndroidModuleInfoProvider {
+    private val androidFacet: AndroidFacet?
+        get() = AndroidFacet.getInstance(module)
+
+    private val androidModuleModel: AndroidModuleModel?
+        get() = AndroidModuleModel.get(module)
+
+    override fun isAndroidModule() = androidFacet != null
+    override fun isGradleModule() = GradleProjectInfo.getInstance(module.project).isBuildWithGradle
+
+    override fun getAllResourceDirectories(): List<VirtualFile> {
+        return androidFacet?.allResourceDirectories ?: emptyList()
+    }
+
+    override fun getApplicationPackage() = androidFacet?.manifest?.`package`?.toString()
+
+    override fun getMainSourceProvider(): AndroidModuleInfoProvider.SourceProviderMirror? {
+        return androidFacet?.mainSourceProvider?.let(::SourceProviderMirrorImpl)
+    }
+
+    override fun getApplicationResourceDirectories(createIfNecessary: Boolean): Collection<VirtualFile> {
+        return androidFacet?.getAppResources(createIfNecessary)?.resourceDirs ?: emptyList()
+    }
+
+    override fun getAllSourceProviders(): List<AndroidModuleInfoProvider.SourceProviderMirror> {
+        val androidModuleModel = this.androidModuleModel ?: return emptyList()
+        return androidModuleModel.allSourceProviders.map(::SourceProviderMirrorImpl)
+    }
+
+    override fun getActiveSourceProviders(): List<AndroidModuleInfoProvider.SourceProviderMirror> {
+        val androidModuleModel = this.androidModuleModel ?: return emptyList()
+        return androidModuleModel.activeSourceProviders.map(::SourceProviderMirrorImpl)
+    }
+
+    override fun getFlavorSourceProviders(): List<AndroidModuleInfoProvider.SourceProviderMirror> {
+        val androidModuleModel = this.androidModuleModel ?: return emptyList()
+
+        val getFlavorSourceProvidersMethod = try {
+            AndroidFacet::class.java.getMethod("getFlavorSourceProviders")
+        } catch (e: NoSuchMethodException) {
+            null
+        }
+
+        return if (getFlavorSourceProvidersMethod != null) {
+            @Suppress("UNCHECKED_CAST")
+            val sourceProviders = getFlavorSourceProvidersMethod.invoke(androidFacet) as? List<SourceProvider>
+            sourceProviders?.map(::SourceProviderMirrorImpl) ?: emptyList()
+        } else {
+            androidModuleModel.flavorSourceProviders.map(::SourceProviderMirrorImpl)
+        }
+    }
+
+    private class SourceProviderMirrorImpl(val sourceProvider: SourceProvider) :
+        AndroidModuleInfoProvider.SourceProviderMirror {
+        override val name: String
+            get() = sourceProvider.name
+
+        override val resDirectories: Collection<File>
+            get() = sourceProvider.resDirectories
+    }
+}
@@ -16,7 +16,7 @@

 package org.jetbrains.kotlin.android.parcel.quickfixes

-import com.android.SdkConstants.CLASS_PARCELABLE
+import org.jetbrains.kotlin.android.parcel.ANDROID_PARCELABLE_CLASS_FQNAME
 import org.jetbrains.kotlin.psi.*

 class ParcelableAddSupertypeQuickfix(clazz: KtClassOrObject) : AbstractParcelableQuickFix<KtClassOrObject>(clazz) {
@@ -24,6 +24,7 @@ class ParcelableAddSupertypeQuickfix(clazz: KtClassOrObject) : AbstractParcelabl
    override fun getText() = "Add ''Parcelable'' supertype"

    override fun invoke(ktPsiFactory: KtPsiFactory, element: KtClassOrObject) {
-        element.addSuperTypeListEntry(ktPsiFactory.createSuperTypeEntry(CLASS_PARCELABLE)).shortenReferences()
+        val supertypeName = ANDROID_PARCELABLE_CLASS_FQNAME.asString()
+        element.addSuperTypeListEntry(ktPsiFactory.createSuperTypeEntry(supertypeName)).shortenReferences()
    }
 }
@@ -19,8 +19,7 @@ package org.jetbrains.kotlin.android.synthetic.idea
 import com.intellij.psi.PsiElement
 import com.intellij.psi.xml.XmlAttributeValue
 import com.intellij.psi.xml.XmlFile
-import org.jetbrains.android.facet.AndroidFacet
-import org.jetbrains.android.util.AndroidResourceUtil
+import org.jetbrains.kotlin.android.model.AndroidModuleInfoProvider
 import org.jetbrains.kotlin.android.synthetic.AndroidConst
 import org.jetbrains.kotlin.android.synthetic.androidIdToName
 import org.jetbrains.kotlin.idea.references.KtSimpleNameReference
@@ -41,7 +40,7 @@ class AndroidSimpleNameReferenceExtension : SimpleNameReferenceExtension {

    override fun handleElementRename(reference: KtSimpleNameReference, psiFactory: KtPsiFactory, newElementName: String): PsiElement? {
        val resolvedElement = reference.resolve()
-        if (resolvedElement is XmlAttributeValue && AndroidResourceUtil.isIdDeclaration(resolvedElement)) {
+        if (resolvedElement is XmlAttributeValue && isIdDeclaration(resolvedElement)) {
            val newSyntheticPropertyName = androidIdToName(newElementName) ?: return null
            return psiFactory.createNameIdentifier(newSyntheticPropertyName.name)
        }
@@ -52,6 +51,8 @@ class AndroidSimpleNameReferenceExtension : SimpleNameReferenceExtension {
        return null
    }

+    private fun isIdDeclaration(declaration: XmlAttributeValue) = declaration.value?.startsWith("@+id/") ?: false
+
    private fun KtSimpleNameReference.isReferenceToXmlFile(xmlFile: XmlFile): Boolean {
        if (!isLayoutPackageIdentifier(this)) {
            return false
@@ -67,7 +68,7 @@ class AndroidSimpleNameReferenceExtension : SimpleNameReferenceExtension {
            return false
        }

-        val resourceDirectories = AndroidFacet.getInstance(element)?.allResourceDirectories ?: return false
+        val resourceDirectories = AndroidModuleInfoProvider.getInstance(element)?.getAllResourceDirectories() ?: return false
        val resourceDirectory = virtualFile.parent?.parent ?: return false
        return resourceDirectories.any { it == resourceDirectory }
    }
@@ -19,8 +19,9 @@ package org.jetbrains.kotlin.android.synthetic.idea
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.module.Module
 import kotlinx.android.extensions.CacheImplementation
-import org.jetbrains.android.facet.AndroidFacet
 import org.jetbrains.kotlin.analyzer.ModuleInfo
+import org.jetbrains.kotlin.android.model.AndroidModuleInfoProvider
+import org.jetbrains.kotlin.android.model.isAndroidModule
 import org.jetbrains.kotlin.android.synthetic.AndroidCommandLineProcessor.Companion.ANDROID_COMPILER_PLUGIN_ID
 import org.jetbrains.kotlin.android.synthetic.AndroidCommandLineProcessor.Companion.EXPERIMENTAL_OPTION
 import org.jetbrains.kotlin.android.synthetic.AndroidCommandLineProcessor.Companion.ENABLED_OPTION
@@ -46,7 +47,7 @@ private fun Module.getOptionValueInFacet(option: CliOption): String? {
 }

 private fun isTestMode(module: Module): Boolean {
-    return ApplicationManager.getApplication().isUnitTestMode && AndroidFacet.getInstance(module) != null
+    return ApplicationManager.getApplication().isUnitTestMode && module.isAndroidModule
 }

 internal val Module.androidExtensionsIsEnabled: Boolean
@@ -16,15 +16,14 @@

 package org.jetbrains.kotlin.android.synthetic.idea.res

-import com.android.builder.model.SourceProvider
-import com.android.tools.idea.gradle.project.model.AndroidModuleModel
 import com.intellij.openapi.module.Module
 import com.intellij.openapi.roots.ProjectRootModificationTracker
 import com.intellij.psi.PsiElement
 import com.intellij.psi.impl.PsiTreeChangePreprocessor
 import com.intellij.psi.util.CachedValue
 import com.intellij.psi.util.CachedValueProvider
-import org.jetbrains.android.facet.AndroidFacet
+import org.jetbrains.kotlin.android.model.AndroidModuleInfoProvider
+import org.jetbrains.kotlin.android.model.AndroidModuleInfoProvider.SourceProviderMirror
 import org.jetbrains.kotlin.android.synthetic.AndroidConst.SYNTHETIC_PACKAGE_PATH_LENGTH
 import org.jetbrains.kotlin.android.synthetic.idea.AndroidPsiTreeChangePreprocessor
 import org.jetbrains.kotlin.android.synthetic.idea.AndroidXmlVisitor
@@ -37,7 +36,7 @@ import org.jetbrains.kotlin.utils.addToStdlib.firstIsInstance

 class IDEAndroidLayoutXmlFileManager(val module: Module) : AndroidLayoutXmlFileManager(module.project) {
    override val androidModule: AndroidModule?
-        get() = AndroidFacet.getInstance(module)?.let { getAndroidModuleInfo(it) }
+        get() = AndroidModuleInfoProvider.getInstance(module)?.let { getAndroidModuleInfo(it) }

    @Volatile
    private var _moduleData: CachedValue<AndroidModuleData>? = null
@@ -108,56 +107,45 @@ class IDEAndroidLayoutXmlFileManager(val module: Module) : AndroidLayoutXmlFileM
        return listOf()
    }

-    private fun SourceProvider.toVariant() = AndroidVariant(name, resDirectories.map { it.canonicalPath })
+    private fun SourceProviderMirror.toVariant() = AndroidVariant(name, resDirectories.map { it.canonicalPath })

-    private fun getAndroidModuleInfo(androidFacet: AndroidFacet): AndroidModule? {
-        if (androidFacet.module.androidExtensionsIsExperimental) {
-            return getAndroidModuleInfoExperimental(androidFacet)
+    private fun getAndroidModuleInfo(androidInfoProvider: AndroidModuleInfoProvider): AndroidModule? {
+        if (androidInfoProvider.module.androidExtensionsIsExperimental) {
+            return getAndroidModuleInfoExperimental(androidInfoProvider)
        }

-        val applicationPackage = androidFacet.manifest?.`package`?.toString()
+        val applicationPackage = androidInfoProvider.getApplicationPackage()

        if (applicationPackage != null) {
-            val mainVariant = androidFacet.mainSourceProvider.toVariant()
+            val mainVariant = androidInfoProvider.getMainSourceProvider()?.toVariant()
+            val variantsForFlavorts = androidInfoProvider.getFlavorSourceProviders().map { it.toVariant() }
+            val allVariants = listOfNotNull(mainVariant) + variantsForFlavorts

-            val method = try { androidFacet::class.java.getMethod("getFlavorSourceProviders") } catch (e: NoSuchMethodException) { null }
-            val variants: List<AndroidVariant>? = if (method != null) {
-                val sourceProviders = method.invoke(androidFacet) as List<SourceProvider>?
-                sourceProviders?.map { it.toVariant() } ?: listOf()
-            }
-            else {
-                val model = AndroidModuleModel.get(androidFacet.module)
-                model?.flavorSourceProviders?.map { it.toVariant() } ?: listOf(androidFacet.mainSourceProvider.toVariant())
-            }
-
-            if (variants != null) {
-                return AndroidModule(applicationPackage, listOf(mainVariant) + variants)
+            if (allVariants.isNotEmpty()) {
+                return AndroidModule(applicationPackage, allVariants)
            }
        }
        return null
    }

-    private fun getAndroidModuleInfoExperimental(androidFacet: AndroidFacet): AndroidModule? {
-        val applicationPackage = androidFacet.manifest?.`package`?.toString() ?: return null
-
-        val allResDirectories = androidFacet.getAppResources(true)?.resourceDirs.orEmpty().mapNotNull { it.canonicalPath }
+    private fun getAndroidModuleInfoExperimental(androidFacet: AndroidModuleInfoProvider): AndroidModule? {
+        val applicationPackage = androidFacet.getApplicationPackage() ?: return null
+        val appResourceDirectories = androidFacet.getApplicationResourceDirectories(true).mapNotNull { it.canonicalPath }

        val resDirectoriesForMainVariant = androidFacet.run {
-            val resDirsFromSourceProviders = AndroidModuleModel.get(this.module)?.allSourceProviders.orEmpty()
-                    .filter { it.name != "main" }
-                    .flatMap { it.resDirectories }
-                    .map { it.canonicalPath }
+            val resDirsFromSourceProviders = androidFacet.getAllSourceProviders()
+                .filter { it.name != "main" }
+                .flatMap { it.resDirectories }
+                .map { it.canonicalPath }

-            allResDirectories - resDirsFromSourceProviders
+            appResourceDirectories - resDirsFromSourceProviders
        }

        val variants = mutableListOf(AndroidVariant("main", resDirectoriesForMainVariant))

-        AndroidModuleModel.get(androidFacet.module)?.let { androidGradleModel ->
-            androidGradleModel.activeSourceProviders.filter { it.name != "main" }.forEach { sourceProvider ->
-                variants += sourceProvider.toVariant()
-            }
-        }
+        androidFacet.getActiveSourceProviders()
+            .filter { it.name != "main" }
+            .forEach { sourceProvider -> variants += sourceProvider.toVariant() }

        return AndroidModule(applicationPackage, variants)
    }
@@ -16,12 +16,12 @@

 package org.jetbrains.kotlin.android.synthetic.idea.res

-import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.module.Module
 import com.intellij.openapi.module.ModuleServiceManager
 import com.intellij.openapi.project.Project
-import org.jetbrains.android.facet.AndroidFacet
 import org.jetbrains.kotlin.analyzer.ModuleInfo
+import org.jetbrains.kotlin.android.model.AndroidModuleInfoProvider
+import org.jetbrains.kotlin.android.model.isAndroidModule
 import org.jetbrains.kotlin.android.synthetic.idea.androidExtensionsIsEnabled
 import org.jetbrains.kotlin.android.synthetic.idea.androidExtensionsIsExperimental
 import org.jetbrains.kotlin.android.synthetic.res.AndroidLayoutXmlFileManager
@@ -36,14 +36,10 @@ class IDEAndroidPackageFragmentProviderExtension(val project: Project) : Android
    override fun getLayoutXmlFileManager(project: Project, moduleInfo: ModuleInfo?): AndroidLayoutXmlFileManager? {
        val moduleSourceInfo = moduleInfo as? ModuleSourceInfo ?: return null
        val module = moduleSourceInfo.module
-        if (!isAndroidExtensionsEnabled(module) && !isTestMode(module)) return null
+        if (!isAndroidExtensionsEnabled(module)) return null
        return ModuleServiceManager.getService(module, AndroidLayoutXmlFileManager::class.java)
    }

-    private fun isTestMode(module: Module): Boolean {
-        return ApplicationManager.getApplication().isUnitTestMode && AndroidFacet.getInstance(module) != null
-    }
-
    private fun isAndroidExtensionsEnabled(module: Module): Boolean {
        // Android Extensions should be always enabled for Android/JPS
        if (isLegacyIdeaAndroidModule(module)) return true
@@ -51,7 +47,7 @@ class IDEAndroidPackageFragmentProviderExtension(val project: Project) : Android
    }

    private fun isLegacyIdeaAndroidModule(module: Module): Boolean {
-        val facet = AndroidFacet.getInstance(module)
-        return facet != null && !facet.requiresAndroidModel()
+        val infoProvider = AndroidModuleInfoProvider.getInstance(module) ?: return false
+        return infoProvider.isAndroidModule() && !infoProvider.isGradleModule()
    }
 }