package org.jetbrains.dokka.plugability import com.fasterxml.jackson.dataformat.xml.JacksonXmlModule import com.fasterxml.jackson.dataformat.xml.XmlMapper import com.fasterxml.jackson.module.kotlin.readValue import org.jetbrains.dokka.DokkaConfiguration import org.jetbrains.dokka.utilities.parseJson import kotlin.properties.ReadOnlyProperty import kotlin.reflect.KProperty import kotlin.reflect.KProperty1 abstract class DokkaPlugin { private val extensionDelegates = mutableListOf>() private val unsafePlugins = mutableListOf>>() @PublishedApi internal var context: DokkaContext? = null protected inline fun plugin(): T = context?.plugin(T::class) ?: throwIllegalQuery() protected fun extensionPoint() = ReadOnlyProperty> { thisRef, property -> ExtensionPoint( thisRef::class.qualifiedName ?: throw AssertionError("Plugin must be named class"), property.name ) } protected fun extending(definition: ExtendingDSL.() -> Extension) = ExtensionProvider(definition) protected class ExtensionProvider internal constructor( private val definition: ExtendingDSL.() -> Extension ) { operator fun provideDelegate(thisRef: DokkaPlugin, property: KProperty<*>) = lazy { ExtendingDSL( thisRef::class.qualifiedName ?: throw AssertionError("Plugin must be named class"), property.name ).definition() }.also { thisRef.extensionDelegates += property } } internal fun internalInstall(ctx: DokkaContextConfiguration, configuration: DokkaConfiguration) { val extensionsToInstall = extensionDelegates.asSequence() .filterIsInstance>>() // should be always true .map { it.get(this) } + unsafePlugins.map { it.value } extensionsToInstall.forEach { if (configuration.(it.condition)()) ctx.installExtension(it) } } protected fun unsafeInstall(ext: Lazy>) { unsafePlugins.add(ext) } } interface WithUnsafeExtensionSuppression { val extensionsSuppressed: List> } interface ConfigurableBlock inline fun P.query(extension: P.() -> ExtensionPoint): List = context?.let { it[extension()] } ?: throwIllegalQuery() inline fun P.querySingle(extension: P.() -> ExtensionPoint): E = context?.single(extension()) ?: throwIllegalQuery() fun throwIllegalQuery(): Nothing = throw IllegalStateException("Querying about plugins is only possible with dokka context initialised") inline fun configuration(context: DokkaContext): R? = context.configuration.pluginsConfiguration.firstOrNull { it.fqPluginName == T::class.qualifiedName } ?.let { configuration -> when (configuration.serializationFormat) { DokkaConfiguration.SerializationFormat.JSON -> parseJson(configuration.values) DokkaConfiguration.SerializationFormat.XML -> XmlMapper(JacksonXmlModule().apply { setDefaultUseWrapper( true ) }).readValue(configuration.values) } }