com.zeoflow.depot.compiler.processing.XRoundEnv.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2021 ZeoFlow SRL
 *
 * 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 com.zeoflow.depot.compiler.processing

import com.zeoflow.depot.compiler.processing.javac.JavacProcessingEnv
import com.zeoflow.depot.compiler.processing.javac.JavacRoundEnv
import com.zeoflow.depot.compiler.processing.ksp.KspProcessingEnv
import com.zeoflow.depot.compiler.processing.ksp.KspRoundEnv
import javax.annotation.processing.RoundEnvironment
import kotlin.reflect.KClass

/**
 * Representation of an annotation processing round.
 *
 * @see javax.annotation.processing.RoundEnvironment
 */
interface XRoundEnv {
    /**
     * The root elements in the round.
     */
    val rootElements: Set

    /**
     * Returns the set of [XElement]s that are annotated with the given annotation [klass].
     */
    fun getElementsAnnotatedWith(klass: KClass): Set

    fun getElementsAnnotatedWith(annotationQualifiedName: String): Set

    companion object {
        /**
         * Creates an [XRoundEnv] from the given Java processing parameters.
         */
        @JvmStatic
        fun create(
            processingEnv: XProcessingEnv,
            roundEnvironment: RoundEnvironment? = null
        ): XRoundEnv {
            return when (processingEnv) {
                is JavacProcessingEnv -> {
                    checkNotNull(roundEnvironment)
                    JavacRoundEnv(processingEnv, roundEnvironment)
                }
                is KspProcessingEnv -> {
                    KspRoundEnv(processingEnv)
                }
                else -> error("invalid processing environment type: $processingEnv")
            }
        }
    }
}