androidx.compose.compiler.plugins.kotlin.k2.ComposablePropertyChecker.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-compose-compiler-plugin-embeddable Show documentation

Compiler plugin that enables Compose

There is a newer version: 2.1.0-RC

Show newest version

/*
 * Copyright 2023 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.k2

import org.jetbrains.kotlin.diagnostics.DiagnosticReporter
import org.jetbrains.kotlin.diagnostics.reportOn
import org.jetbrains.kotlin.fir.analysis.checkers.MppCheckerKind
import org.jetbrains.kotlin.fir.analysis.checkers.context.CheckerContext
import org.jetbrains.kotlin.fir.analysis.checkers.declaration.FirPropertyChecker
import org.jetbrains.kotlin.fir.declarations.FirProperty
import org.jetbrains.kotlin.fir.declarations.utils.hasBackingField

object ComposablePropertyChecker : FirPropertyChecker(MppCheckerKind.Common) {
    override fun check(
        declaration: FirProperty,
        context: CheckerContext,
        reporter: DiagnosticReporter,
    ) {
        // `@Composable` is only applicable to property getters, but in K1 we were also checking
        // properties with the annotation on the setter.
        if (declaration.getter?.hasComposableAnnotation(context.session) != true &&
            declaration.setter?.hasComposableAnnotation(context.session) != true
        ) {
            return
        }

        if (declaration.isVar) {
            reporter.reportOn(declaration.source, ComposeErrors.COMPOSABLE_VAR, context)
        }

        if (declaration.hasBackingField) {
            reporter.reportOn(
                declaration.source,
                ComposeErrors.COMPOSABLE_PROPERTY_BACKING_FIELD,
                context
            )
        }
    }
}