it.unibo.alchemist.boundary.LoadAlchemist.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alchemist-loading Show documentation
Alchemist Machinery to load from files
There is a newer version: 35.0.2
/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.boundary

import it.unibo.alchemist.boundary.loader.Overrides.overrideAll
import it.unibo.alchemist.boundary.loader.SimulationModel
import it.unibo.alchemist.util.ClassPathScanner
import java.io.File
import java.io.InputStream
import java.io.Reader
import java.net.URL
import kotlin.reflect.jvm.jvmName

/**
 * Loads Alchemist simulations from a variety of resources.
 */
object LoadAlchemist {

    private val packageExtractor = Regex("""((?:\w|\.)+)\.\w+$""")
    private inline fun  extractPackageFrom() = packageExtractor
        .matchEntire(T::class.jvmName)
        ?.let { it.groupValues[1] }
        ?: error("Cannot extract package from ${T::class.jvmName}")

    /**
     * Load from an [input] [String] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(input: String, model: AlchemistModelProvider, overrides: List = emptyList()): Loader =
        SimulationModel.fromMap(
            applyOverrides(model.from(input), overrides),
        )

    /**
     * Load from a [reader] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(reader: Reader, model: AlchemistModelProvider, overrides: List = emptyList()): Loader =
        SimulationModel.fromMap(
            applyOverrides(model.from(reader), overrides),
        )

    /**
     * Load from an [InputStream] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(stream: InputStream, model: AlchemistModelProvider, overrides: List = emptyList()): Loader =
        SimulationModel.fromMap(
            applyOverrides(model.from(stream), overrides),
        )

    /**
     * Load from an [url] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(url: URL, model: AlchemistModelProvider, overrides: List = emptyList()): Loader =
        SimulationModel.fromMap(applyOverrides(model.from(url), overrides))

    /**
     * Load from an [url] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(url: URL, overrides: List = emptyList()): Loader =
        from(url, modelForExtension(url.path.takeLastWhile { it != '.' }), overrides)

    /**
     * Load from a [file] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(file: File, overrides: List = emptyList()): Loader =
        from(file.inputStream(), modelForExtension(file.extension), overrides)

    /**
     * Load from a [string] with overrides.
     */
    @JvmStatic
    @JvmOverloads
    fun from(string: String, overrides: List = emptyList()): Loader = from(File(string), overrides)

    @JvmStatic
    private fun modelForExtension(extension: String) = ClassPathScanner
        .subTypesOf(extractPackageFrom())
        .mapNotNull { it.kotlin.objectInstance }
        .filter { it.fileExtensions.matches(extension) }
        .also { require(it.size == 1) { "None or conflicting loaders for extension $extension: $it" } }
        .first()

    @JvmStatic
    private fun applyOverrides(map: Map, overrides: List = emptyList()): Map {
        return map.overrideAll(overrides)
    }
}