org.jetbrains.kotlin.fir.caches.FirCacheWithPostCompute.kt Maven / Gradle / Ivy

Go to download

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

the Kotlin compiler embeddable

There is a newer version: 2.1.0-RC

Show newest version

/*
 * Copyright 2010-2021 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

package org.jetbrains.kotlin.fir.caches

import kotlin.reflect.KProperty

/**
 * A cache class with an embedded value computation strategy.
 * It uses key [K] and the passed context [CONTEXT] to compute and cache the value [V].
 *
 * **IMPORTANT**: While this cache uses both the key and the context to compute and cache the value [V],
 * it retrieves the cached value using **only the key**, and **ignores the passed context**.
 *
 * Because of that, you cannot use a single unique key with different non-unique contexts.
 * If you do, one of the contexts will be used to compute the cached value, and the others
 * will effectively be ignored.
 *
 * @see FirCachesFactory
 */
abstract class FirCache {
    abstract fun getValue(key: K, context: CONTEXT): V
    abstract fun getValueIfComputed(key: K): V?
}

@Suppress("NOTHING_TO_INLINE")
inline fun  FirCache.getValue(key: K): V =
    getValue(key, null)

operator fun  FirCache.contains(key: K): Boolean {
    return getValueIfComputed(key) != null
}

abstract class FirLazyValue {
    abstract fun getValue(): V
}

operator fun  FirLazyValue.getValue(thisRef: Any?, property: KProperty<*>): V {
    return getValue()
}