ComposeFqNames.kt
/*
* Copyright 2019 The Android Open Source Project
*
* 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 androidx.compose.compiler.plugins.kotlin
import org.jetbrains.kotlin.descriptors.ModuleDescriptor
import org.jetbrains.kotlin.descriptors.SourceElement
import org.jetbrains.kotlin.descriptors.annotations.Annotated
import org.jetbrains.kotlin.descriptors.annotations.AnnotationDescriptor
import org.jetbrains.kotlin.descriptors.annotations.Annotations
import org.jetbrains.kotlin.descriptors.findClassAcrossModuleDependencies
import org.jetbrains.kotlin.descriptors.impl.AnonymousFunctionDescriptor
import org.jetbrains.kotlin.ir.declarations.IrAnnotationContainer
import org.jetbrains.kotlin.ir.types.IrType
import org.jetbrains.kotlin.ir.util.hasAnnotation
import org.jetbrains.kotlin.name.CallableId
import org.jetbrains.kotlin.name.ClassId
import org.jetbrains.kotlin.name.FqName
import org.jetbrains.kotlin.name.Name
import org.jetbrains.kotlin.resolve.constants.ConstantValue
import org.jetbrains.kotlin.resolve.descriptorUtil.annotationClass
import org.jetbrains.kotlin.types.KotlinType
import org.jetbrains.kotlin.types.TypeUtils.NO_EXPECTED_TYPE
import org.jetbrains.kotlin.types.TypeUtils.UNIT_EXPECTED_TYPE
import org.jetbrains.kotlin.types.typeUtil.replaceAnnotations
private const val root = "androidx.compose.runtime"
private const val internalRoot = "$root.internal"
private val rootFqName = FqName(root)
private val internalRootFqName = FqName(internalRoot)
object ComposeClassIds {
private fun classIdFor(cname: String) =
ClassId(rootFqName, Name.identifier(cname))
internal fun internalClassIdFor(cname: String) =
ClassId(internalRootFqName, Name.identifier(cname))
val Composable = classIdFor("Composable")
val ComposableInferredTarget = classIdFor("ComposableInferredTarget")
val ComposableLambda = internalClassIdFor("ComposableLambda")
val ComposableOpenTarget = classIdFor("ComposableOpenTarget")
val ComposableTarget = classIdFor("ComposableTarget")
val ComposeVersion = classIdFor("ComposeVersion")
val Composer = classIdFor("Composer")
val FunctionKeyMetaClass = internalClassIdFor("FunctionKeyMetaClass")
val FunctionKeyMeta = internalClassIdFor("FunctionKeyMeta")
val LiveLiteralFileInfo = internalClassIdFor("LiveLiteralFileInfo")
val LiveLiteralInfo = internalClassIdFor("LiveLiteralInfo")
val NoLiveLiterals = classIdFor("NoLiveLiterals")
val State = classIdFor("State")
val StabilityInferred = internalClassIdFor("StabilityInferred")
}
object ComposeCallableIds {
private fun topLevelCallableId(name: String) =
CallableId(rootFqName, Name.identifier(name))
internal fun internalTopLevelCallableId(name: String) =
CallableId(internalRootFqName, Name.identifier(name))
val cache = topLevelCallableId("cache")
val composableLambda = internalTopLevelCallableId("composableLambda")
val composableLambdaInstance =
internalTopLevelCallableId("composableLambdaInstance")
val composableLambdaN = internalTopLevelCallableId("composableLambdaN")
val composableLambdaNInstance =
internalTopLevelCallableId("composableLambdaNInstance")
val currentComposer = topLevelCallableId("currentComposer")
val isLiveLiteralsEnabled =
internalTopLevelCallableId("isLiveLiteralsEnabled")
val isTraceInProgress =
topLevelCallableId(KtxNameConventions.IS_TRACE_IN_PROGRESS)
val liveLiteral = internalTopLevelCallableId("liveLiteral")
val remember = topLevelCallableId("remember")
val sourceInformation =
topLevelCallableId(KtxNameConventions.SOURCEINFORMATION)
val sourceInformationMarkerEnd =
topLevelCallableId(KtxNameConventions.SOURCEINFORMATIONMARKEREND)
val sourceInformationMarkerStart =
topLevelCallableId(KtxNameConventions.SOURCEINFORMATIONMARKERSTART)
val traceEventEnd = topLevelCallableId(KtxNameConventions.TRACE_EVENT_END)
val traceEventStart = topLevelCallableId(KtxNameConventions.TRACE_EVENT_START)
val updateChangedFlags = topLevelCallableId(KtxNameConventions.UPDATE_CHANGED_FLAGS)
}
object ComposeFqNames {
internal fun fqNameFor(cname: String) = FqName("$root.$cname")
private fun internalFqNameFor(cname: String) = FqName("$internalRoot.$cname")
private fun composablesFqNameFor(cname: String) = fqNameFor("ComposablesKt.$cname")
val Composable = ComposeClassIds.Composable.asSingleFqName()
val ComposableTarget = ComposeClassIds.ComposableTarget.asSingleFqName()
val ComposableTargetMarker = fqNameFor("ComposableTargetMarker")
val ComposableTargetMarkerDescription = "description"
val ComposableTargetApplierArgument = Name.identifier("applier")
val ComposableOpenTarget = ComposeClassIds.ComposableOpenTarget.asSingleFqName()
val ComposableOpenTargetIndexArgument = Name.identifier("index")
val ComposableInferredTarget = ComposeClassIds.ComposableInferredTarget.asSingleFqName()
val ComposableInferredTargetSchemeArgument = Name.identifier("scheme")
val CurrentComposerIntrinsic = fqNameFor("<get-currentComposer>")
val getCurrentComposerFullName = composablesFqNameFor("<get-currentComposer>")
val DisallowComposableCalls = fqNameFor("DisallowComposableCalls")
val ReadOnlyComposable = fqNameFor("ReadOnlyComposable")
val ExplicitGroupsComposable = fqNameFor("ExplicitGroupsComposable")
val NonRestartableComposable = fqNameFor("NonRestartableComposable")
val composableLambdaType = ComposeClassIds.ComposableLambda.asSingleFqName()
val composableLambda = ComposeCallableIds.composableLambda.asSingleFqName()
val composableLambdaFullName =
internalFqNameFor("ComposableLambdaKt.composableLambda")
val remember = ComposeCallableIds.remember.asSingleFqName()
val cache = ComposeCallableIds.cache.asSingleFqName()
val key = fqNameFor("key")
val StableMarker = fqNameFor("StableMarker")
val Stable = fqNameFor("Stable")
val Immutable = fqNameFor("Immutable")
val Composer = ComposeClassIds.Composer.asSingleFqName()
val ComposeVersion = fqNameFor("ComposeVersion")
val Package = FqName(root)
val StabilityInferred = ComposeClassIds.StabilityInferred.asSingleFqName()
fun makeComposableAnnotation(module: ModuleDescriptor): AnnotationDescriptor =
object : AnnotationDescriptor {
override val type: KotlinType
get() = module.findClassAcrossModuleDependencies(
ClassId.topLevel(Composable)
)!!.defaultType
override val allValueArguments: Map<Name, ConstantValue<*>> get() = emptyMap()
override val source: SourceElement get() = SourceElement.NO_SOURCE
override fun toString() = "[@Composable]"
}
}
private fun makeComposableAnnotation(module: ModuleDescriptor): AnnotationDescriptor =
object : AnnotationDescriptor {
override val type: KotlinType
get() = module.findClassAcrossModuleDependencies(
ComposeClassIds.Composable
)!!.defaultType
override val allValueArguments: Map<Name, ConstantValue<*>> get() = emptyMap()
override val source: SourceElement get() = SourceElement.NO_SOURCE
override fun toString() = "[@Composable]"
}
fun KotlinType.makeComposable(module: ModuleDescriptor): KotlinType {
if (hasComposableAnnotation()) return this
val annotation = makeComposableAnnotation(module)
return replaceAnnotations(Annotations.create(annotations + annotation))
}
fun AnonymousFunctionDescriptor.annotateAsComposable(module: ModuleDescriptor) =
AnonymousFunctionDescriptor(
containingDeclaration,
Annotations.create(annotations + makeComposableAnnotation(module)),
kind,
source,
isSuspend
)
fun IrType.hasComposableAnnotation(): Boolean =
hasAnnotation(ComposeFqNames.Composable)
fun IrAnnotationContainer.hasComposableAnnotation(): Boolean =
hasAnnotation(ComposeFqNames.Composable)
fun KotlinType.hasComposableAnnotation(): Boolean =
!isSpecialType && annotations.findAnnotation(ComposeFqNames.Composable) != null
fun Annotated.hasComposableAnnotation(): Boolean =
annotations.findAnnotation(ComposeFqNames.Composable) != null
fun Annotated.hasNonRestartableComposableAnnotation(): Boolean =
annotations.findAnnotation(ComposeFqNames.NonRestartableComposable) != null
fun Annotated.hasReadonlyComposableAnnotation(): Boolean =
annotations.findAnnotation(ComposeFqNames.ReadOnlyComposable) != null
fun Annotated.hasExplicitGroupsAnnotation(): Boolean =
annotations.findAnnotation(ComposeFqNames.ExplicitGroupsComposable) != null
fun Annotated.hasDisallowComposableCallsAnnotation(): Boolean =
annotations.findAnnotation(ComposeFqNames.DisallowComposableCalls) != null
fun Annotated.compositionTarget(): String? =
annotations.map { it.compositionTarget() }.firstOrNull { it != null }
fun Annotated.hasCompositionTargetMarker(): Boolean =
annotations.findAnnotation(
ComposeFqNames.ComposableTargetMarker
) != null
fun AnnotationDescriptor.compositionTarget(): String? =
if (fqName == ComposeFqNames.ComposableTarget)
allValueArguments[ComposeFqNames.ComposableTargetApplierArgument]?.value as? String
else if (annotationClass?.hasCompositionTargetMarker() == true) this.fqName.toString() else null
fun Annotated.compositionScheme(): String? =
annotations.findAnnotation(
ComposeFqNames.ComposableInferredTarget
)?.allValueArguments?.let {
it[ComposeFqNames.ComposableInferredTargetSchemeArgument]?.value as? String
}
fun Annotated.compositionOpenTarget(): Int? =
annotations.findAnnotation(
ComposeFqNames.ComposableOpenTarget
)?.allValueArguments?.let {
it[ComposeFqNames.ComposableOpenTargetIndexArgument]?.value as Int
}
internal val KotlinType.isSpecialType: Boolean get() =
this === NO_EXPECTED_TYPE || this === UNIT_EXPECTED_TYPE
val AnnotationDescriptor.isComposableAnnotation: Boolean get() = fqName == ComposeFqNames.Composable