org.jetbrains.kotlinx.jupyter.api.libraries.LibraryDefinition.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-jupyter-api Show documentation
API for libraries supporting Kotlin Jupyter notebooks
There is a newer version: 0.12.0-335
package org.jetbrains.kotlinx.jupyter.api.libraries

import org.jetbrains.kotlinx.jupyter.api.AfterCellExecutionCallback
import org.jetbrains.kotlinx.jupyter.api.ClassAnnotationHandler
import org.jetbrains.kotlinx.jupyter.api.CodePreprocessor
import org.jetbrains.kotlinx.jupyter.api.ExecutionCallback
import org.jetbrains.kotlinx.jupyter.api.FieldHandler
import org.jetbrains.kotlinx.jupyter.api.FileAnnotationHandler
import org.jetbrains.kotlinx.jupyter.api.InternalVariablesMarker
import org.jetbrains.kotlinx.jupyter.api.InterruptionCallback
import org.jetbrains.kotlinx.jupyter.api.KotlinKernelVersion
import org.jetbrains.kotlinx.jupyter.api.RendererFieldHandler
import org.jetbrains.kotlinx.jupyter.api.TextRendererWithPriority
import org.jetbrains.kotlinx.jupyter.api.ThrowableRenderer
import org.jetbrains.kotlinx.jupyter.util.AcceptanceRule

/**
 * Library definition represents "library" concept in Kotlin kernel.
 */
interface LibraryDefinition {
    /**
     * Key-value options.
     * Options are passed to the constructors of transitively loaded libraries
     * and could be used in their construction
     */
    val options: Map
        get() = emptyMap()

    /**
     * Optional textual description of this library
     */
    val description: String?
        get() = null

    /**
     * Optional link to this library's website
     */
    val website: String?
        get() = null

    /**
     * List of artifact dependencies in gradle colon-separated format
     */
    val dependencies: List
        get() = emptyList()

    /**
     * List of repositories to resolve dependencies in
     */
    val repositories: List
        get() = emptyList()

    /**
     * List of imports: simple and star imports are both allowed
     */
    val imports: List
        get() = emptyList()

    /**
     * List of code snippets evaluated on library initialization
     */
    val init: List>
        get() = emptyList()

    /**
     * List of code snippets evaluated before every cell evaluation
     */
    val initCell: List>
        get() = emptyList()

    /**
     * List of callbacks called after cell evaluation
     */
    val afterCellExecution: List
        get() = emptyList()

    /**
     * List of code snippets evaluated on kernel shutdown
     */
    val shutdown: List>
        get() = emptyList()

    /**
     * List of type renderers. Consider using [org.jetbrains.kotlinx.jupyter.api.Renderable]
     * as it's generally more convenient
     */
    val renderers: List
        get() = emptyList()

    /**
     * List of text renderers which are used as fallback rendering option.
     * Check out README for more information
     */
    val textRenderers: List
        get() = emptyList()

    /**
     * List of type converters used by type providers processors
     */
    val converters: List
        get() = emptyList()

    /**
     * List of type annotations used by annotations processor
     */
    val classAnnotations: List
        get() = emptyList()

    /**
     * List of file annotation handlers
     */
    val fileAnnotations: List
        get() = emptyList()

    /**
     * List of library resources
     */
    val resources: List
        get() = emptyList()

    /**
     * List of code preprocessors
     */
    val codePreprocessors: List
        get() = emptyList()

    /**
     * Minimal kernel version that is supported by this library
     */
    val minKernelVersion: KotlinKernelVersion?

    /**
     * Original descriptor text, or **null** if it has non-textual nature
     */
    val originalDescriptorText: String?
        get() = null

    /**
     * Renderers of thrown exceptions
     */
    val throwableRenderers: List
        get() = emptyList()

    /**
     * Predicates to tell if the declaration is internal.
     * Internal declarations tend to be not shown to a user in the variables view, but take place in resolution
     */
    val internalVariablesMarkers: List
        get() = emptyList()

    /**
     * Integration type name rules for the library integration classes which are about to be loaded transitively
     */
    val integrationTypeNameRules: List>
        get() = emptyList()

    /**
     * Callbacks that are run if [java.lang.ThreadDeath] was thrown during cell execution.
     * In normal conditions, it happens if the user interrupted cell execution via UI
     */
    val interruptionCallbacks: List
        get() = emptyList()

    /**
     * Callbacks that might be called when client changes its color scheme, or on library initialization.
     * New color scheme value is passed to the callback
     */
    val colorSchemeChangedCallbacks: List
        get() = emptyList()
}