package org.jetbrains.dokka.gradle import groovy.lang.Closure import org.gradle.api.DefaultTask import org.gradle.api.Plugin import org.gradle.api.Project import org.gradle.api.file.FileCollection import org.gradle.api.plugins.JavaBasePlugin import org.gradle.api.plugins.JavaPluginConvention import org.gradle.api.tasks.* import org.jetbrains.dokka.DokkaBootstrap import org.jetbrains.dokka.DokkaConfiguration import org.jetbrains.dokka.SerializeOnlyDokkaConfiguration import org.jetbrains.dokka.automagicTypedProxy import org.jetbrains.dokka.gradle.ClassloaderContainer.fatJarClassLoader import org.jetbrains.dokka.gradle.DokkaVersion.version import ru.yole.jkid.JsonExclude import ru.yole.jkid.serialization.serialize import java.io.File import java.io.InputStream import java.io.Serializable import java.net.URLClassLoader import java.util.* import java.util.function.BiConsumer open class DokkaPlugin : Plugin { override fun apply(project: Project) { DokkaVersion.loadFrom(javaClass.getResourceAsStream("/META-INF/gradle-plugins/org.jetbrains.dokka.properties")) project.tasks.create("dokka", DokkaTask::class.java).apply { moduleName = project.name outputDirectory = File(project.buildDir, "dokka").absolutePath } } } object DokkaVersion { var version: String? = null fun loadFrom(stream: InputStream) { version = Properties().apply { load(stream) }.getProperty("dokka-version") } } object ClassloaderContainer { @JvmField var fatJarClassLoader: ClassLoader? = null } open class DokkaTask : DefaultTask() { init { group = JavaBasePlugin.DOCUMENTATION_GROUP description = "Generates dokka documentation for Kotlin" } @Input var moduleName: String = "" @Input var outputFormat: String = "html" var outputDirectory: String = "" @Input var processConfigurations: List = arrayListOf("compile") @Input var includes: List = arrayListOf() @Input var linkMappings: ArrayList = arrayListOf() @Input var samples: List = arrayListOf() @Input var jdkVersion: Int = 6 @Input var sourceDirs: Iterable = emptyList() @Input var sourceRoots: MutableList = arrayListOf() @Input var dokkaFatJar: Any = "org.jetbrains.dokka:dokka-fatjar:$version" @Input var skipDeprecated = false @Input var skipEmptyPackages = true @Input var reportNotDocumented = true @Input var perPackageOptions: MutableList = arrayListOf() @Input var impliedPlatforms: MutableList = arrayListOf() @Input var externalDocumentationLinks = mutableListOf() protected open val sdkProvider: SdkProvider? = null fun linkMapping(closure: Closure) { val mapping = LinkMapping() closure.delegate = mapping closure.call() if (mapping.path.isEmpty()) { throw IllegalArgumentException("Link mapping should have dir") } if (mapping.url.isEmpty()) { throw IllegalArgumentException("Link mapping should have url") } linkMappings.add(mapping) } fun sourceRoot(closure: Closure) { val sourceRoot = SourceRoot() closure.delegate = sourceRoot closure.call() sourceRoots.add(sourceRoot) } fun packageOptions(closure: Closure) { val packageOptions = PackageOptions() closure.delegate = packageOptions closure.call() perPackageOptions.add(packageOptions) } fun externalDocumentationLink(closure: Closure) { val builder = DokkaConfiguration.ExternalDocumentationLink.Builder() closure.delegate = builder closure.call() externalDocumentationLinks.add(builder.build()) } fun tryResolveFatJar(project: Project): File { return try { val dependency = project.buildscript.dependencies.create(dokkaFatJar) val configuration = project.buildscript.configurations.detachedConfiguration(dependency) configuration.description = "Dokka main jar" configuration.resolve().first() } catch (e: Exception) { project.parent?.let { tryResolveFatJar(it) } ?: throw e } } fun loadFatJar() { if (fatJarClassLoader == null) { val fatjar = if (dokkaFatJar is File) dokkaFatJar as File else tryResolveFatJar(project) fatJarClassLoader = URLClassLoader(arrayOf(fatjar.toURI().toURL()), ClassLoader.getSystemClassLoader().parent) } } @TaskAction fun generate() { val kotlinColorsEnabledBefore = System.getProperty(COLORS_ENABLED_PROPERTY) ?: "false" System.setProperty(COLORS_ENABLED_PROPERTY, "false") try { loadFatJar() val project = project val sdkProvider = sdkProvider val sourceRoots = collectSourceRoots() val allConfigurations = project.configurations val classpath = if (sdkProvider != null && sdkProvider.isValid) sdkProvider.classpath else emptyList() + processConfigurations .map { allConfigurations?.getByName(it.toString()) ?: throw IllegalArgumentException("No configuration $it found") } .flatMap { it } if (sourceRoots.isEmpty()) { logger.warn("No source directories found: skipping dokka generation") return } val bootstrapClass = fatJarClassLoader!!.loadClass("org.jetbrains.dokka.DokkaBootstrapImpl") val bootstrapInstance = bootstrapClass.constructors.first().newInstance() val bootstrapProxy: DokkaBootstrap = automagicTypedProxy(javaClass.classLoader, bootstrapInstance) val configuration = SerializeOnlyDokkaConfiguration( moduleName, classpath.map { it.absolutePath }, sourceRoots, samples.filterNotNull().map { project.file(it).absolutePath }, includes.filterNotNull().map { project.file(it).absolutePath }, outputDirectory, outputFormat, false, false, reportNotDocumented, skipEmptyPackages, skipDeprecated, jdkVersion, true, linkMappings, impliedPlatforms, perPackageOptions, externalDocumentationLinks) bootstrapProxy.configure( BiConsumer { level, message -> when (level) { "info" -> logger.info(message) "warn" -> logger.warn(message) "error" -> logger.error(message) } }, serialize(configuration) ) bootstrapProxy.generate() } finally { System.setProperty(COLORS_ENABLED_PROPERTY, kotlinColorsEnabledBefore) } } fun collectSourceRoots(): List { if (sourceRoots.any()) { return sourceRoots } val provider = sdkProvider val sourceDirs = if (sourceDirs.any()) { logger.info("Dokka: Taking source directories provided by the user") sourceDirs.toSet() } else if (provider != null && provider.isValid) { logger.info("Dokka: Taking source directories from ${provider.name} sdk provider") provider.sourceDirs } else { logger.info("Dokka: Taking source directories from default java plugin") val javaPluginConvention = project.convention.getPlugin(JavaPluginConvention::class.java) val sourceSets = javaPluginConvention.sourceSets?.findByName(SourceSet.MAIN_SOURCE_SET_NAME) sourceSets?.allSource?.srcDirs } return sourceDirs?.filter { it.exists() }?.map { SourceRoot().apply { path = it.path } } ?: emptyList() } @InputFiles @SkipWhenEmpty fun getInputFiles(): FileCollection = project.files(collectSourceRoots().map { project.fileTree(File(it.path)) }) + project.files(includes) + project.files(samples.map { project.fileTree(it) }) @OutputDirectory fun getOutputDirectoryAsFile(): File = project.file(outputDirectory) companion object { const val COLORS_ENABLED_PROPERTY = "kotlin.colors.enabled" } } class SourceRoot : DokkaConfiguration.SourceRoot { override var path: String = "" set(value) { field = File(value).absolutePath } override var platforms: List = arrayListOf() } open class LinkMapping : Serializable, DokkaConfiguration.SourceLinkDefinition { @JsonExclude var dir: String get() = path set(value) { path = value } override var path: String = "" override var url: String = "" @JsonExclude var suffix: String? get() = lineSuffix set(value) { lineSuffix = value } override var lineSuffix: String? = null override fun equals(other: Any?): Boolean { if (this === other) return true if (other?.javaClass != javaClass) return false other as LinkMapping if (path != other.path) return false if (url != other.url) return false if (lineSuffix != other.lineSuffix) return false return true } override fun hashCode(): Int { var result = path.hashCode() result = 31 * result + url.hashCode() result = 31 * result + (lineSuffix?.hashCode() ?: 0) return result } companion object { const val serialVersionUID: Long = -8133501684312445981L } } class PackageOptions : DokkaConfiguration.PackageOptions { override var prefix: String = "" override var includeNonPublic: Boolean = false override var reportUndocumented: Boolean = true override var skipDeprecated: Boolean = false } /** * A provider for SDKs that can be used if a project uses classes that live outside the JDK or uses a * different method to determine the source directories. * * For example an Android library project configures its sources through the Android extension instead * of the basic java convention. Also it has its custom classes located in the SDK installation directory. */ interface SdkProvider { /** * The name of this provider. Only used for logging purposes. */ val name: String /** * Checks whether this provider has everything it needs to provide the source directories. */ val isValid: Boolean /** * Provides additional classpath files where Dokka should search for external classes. * The file list is injected **after** JDK Jars and **before** project dependencies. * * This is only called if [isValid] returns `true`. */ val classpath: List /** * Provides a list of directories where Dokka should search for source files. * * This is only called if [isValid] returns `true`. */ val sourceDirs: Set? }