org.jetbrains.kotlin.incremental.storage.BasicMap.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-build-common Show documentation
Kotlin Build Common
There is a newer version: 2.1.0
/*
 * Copyright 2010-2015 JetBrains s.r.o.
 *
 * 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 org.jetbrains.kotlin.incremental.storage

import com.intellij.util.io.DataExternalizer
import com.intellij.util.io.EnumeratorStringDescriptor
import com.intellij.util.io.KeyDescriptor
import org.jetbrains.annotations.TestOnly
import org.jetbrains.kotlin.incremental.IncrementalCompilationContext
import org.jetbrains.kotlin.utils.Printer
import java.io.File

abstract class BasicMap, V, StorageType : LazyStorage>(
    internal val storageFile: File,
    protected val storage: StorageType,
    protected val icContext: IncrementalCompilationContext,
) {
    protected val pathConverter
        get() = icContext.pathConverter

    fun clean() {
        storage.clean()
    }

    fun flush(memoryCachesOnly: Boolean) {
        storage.flush(memoryCachesOnly)
    }

    // avoid unsynchronized close
    fun close() {
        storage.close()
    }

    @TestOnly
    fun closeForTest() {
        close()
    }

    @TestOnly
    fun dump(): String {
        return with(StringBuilder()) {
            with(Printer(this)) {
                println("${storageFile.name.substringBefore(".tab")} (${this@BasicMap::class.java.simpleName})")
                pushIndent()

                for (key in storage.keys.sorted()) {
                    println("${dumpKey(key)} -> ${dumpValue(storage[key]!!)}")
                }

                popIndent()
            }

            this
        }.toString()
    }

    @TestOnly
    protected abstract fun dumpKey(key: K): String

    @TestOnly
    protected abstract fun dumpValue(value: V): String
}

abstract class NonAppendableBasicMap, V>(
    storageFile: File,
    keyDescriptor: KeyDescriptor,
    valueExternalizer: DataExternalizer,
    icContext: IncrementalCompilationContext,
) : BasicMap>(
    storageFile,
    createLazyStorage(storageFile, keyDescriptor, valueExternalizer, icContext),
    icContext
)

abstract class AppendableBasicMap, V>(
    storageFile: File,
    keyDescriptor: KeyDescriptor,
    valueExternalizer: AppendableDataExternalizer,
    icContext: IncrementalCompilationContext,
) : BasicMap>(
    storageFile,
    createLazyStorage(storageFile, keyDescriptor, valueExternalizer, icContext),
    icContext
)

abstract class BasicStringMap(
    storageFile: File,
    keyDescriptor: KeyDescriptor,
    valueExternalizer: DataExternalizer,
    icContext: IncrementalCompilationContext,
) : NonAppendableBasicMap(storageFile, keyDescriptor, valueExternalizer, icContext) {
    constructor(
        storageFile: File,
        valueExternalizer: DataExternalizer,
        icContext: IncrementalCompilationContext,
    ) : this(storageFile, EnumeratorStringDescriptor.INSTANCE, valueExternalizer, icContext)

    override fun dumpKey(key: String): String = key
}

abstract class AppendableBasicStringMap(
    storageFile: File,
    keyDescriptor: KeyDescriptor,
    valueExternalizer: AppendableDataExternalizer,
    icContext: IncrementalCompilationContext,
) : AppendableBasicMap(storageFile, keyDescriptor, valueExternalizer, icContext) {
    constructor(
        storageFile: File,
        valueExternalizer: AppendableDataExternalizer,
        icContext: IncrementalCompilationContext,
    ) : this(storageFile, EnumeratorStringDescriptor.INSTANCE, valueExternalizer, icContext)

    override fun dumpKey(key: String): String = key
}