io.realm.kotlin.compiler.fir.model.RealmModelRegistrar.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2023 Realm Inc.
 *
 * 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 io.realm.kotlin.compiler.fir.model

import org.jetbrains.kotlin.fir.extensions.FirExtensionRegistrar

/**
 * Fir extension registrar that adds extensions to modify the Realm object API.
 *
 * This consists of:
 * - A [CompanionExtension] that adds a (or updates existing) companion object to
 *   RealmObject-classes and modifies it to implement the [RealmObjectCompanion] interface and its
 *   methods.
 * - An [ObjectExtension] that adds `toString`, `equals` and `hashCode` methods to
 *   RealmObject-classes.
 *
 * All API modifications should be tagged with the [RealmPluginGeneratorKey] to make it recognizable
 * in other compiler plugin phases.
 */
class RealmModelRegistrar : FirExtensionRegistrar() {
    override fun ExtensionRegistrarContext.configurePlugin() {
        +::CompanionExtension
        +::ObjectExtension
    }
}