commonMain.io.realm.kotlin.internal.schema.CompilerPluginBridgeUtils.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of library-base-jvm Show documentation

Library code for Realm Kotlin. This artifact is not supposed to be consumed directly, but through 'io.realm.kotlin:gradle-plugin:1.11.1' instead.

There is a newer version: 3.0.0

Show newest version

/*
 * 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.internal.schema

import io.realm.kotlin.internal.interop.CollectionType
import io.realm.kotlin.internal.interop.PropertyInfo
import io.realm.kotlin.internal.interop.PropertyType
import io.realm.kotlin.internal.realmObjectCompanionOrNull
import io.realm.kotlin.types.TypedRealmObject
import kotlin.reflect.KClass

/**
 * Helper method the compiler plugin can use to create PropertyInfo instances based on KClass
 * references rather than Strings. This needs to be placed in library-base, since the cinterop
 * module do not know about the public API classes.
 */
@Suppress("unused", "LongParameterList")
internal fun createPropertyInfo(
    name: String,
    publicName: String?,
    type: PropertyType,
    collectionType: CollectionType,
    linkTarget: KClass?,
    linkOriginPropertyName: String?,
    isNullable: Boolean,
    isPrimaryKey: Boolean,
    isIndexed: Boolean,
    isFullTextIndexed: Boolean
): PropertyInfo {

    // Locate the link target dynamically. We do this to work around incremental
    // compilation not triggering in some cases.
    // E.g. if you have a A -> B relationship, A will embed the name of B in its schema
    // definition, but a recompilation of A will not be triggered if @PersistedName on
    // B is changed. This will cause Realm to throw a schema mismatch error when the Realm
    // file is opened.
    //
    // Note, we do not need to do this for linkOriginPropertyName which is used by backlinks
    // since they are defined by `by backlinks(property)`, which will correctly cause both sides
    // of the relationship to be recompiled.
    val resolvedLinkTarget: String? = linkTarget?.let {
        it.realmObjectCompanionOrNull()?.io_realm_kotlin_className
            ?: throw IllegalStateException("Could not find RealmObjectCompanion for: ${linkTarget.qualifiedName}")
    }
    return PropertyInfo.create(
        name,
        publicName,
        type,
        collectionType,
        resolvedLinkTarget,
        linkOriginPropertyName,
        isNullable,
        isPrimaryKey,
        isIndexed,
        isFullTextIndexed
    )
}