1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
|
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.Task
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.gradle.api.tasks.Optional
import org.jetbrains.dokka.*
import org.jetbrains.dokka.ReflectDsl.isNotInstance
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.concurrent.Callable
import java.util.function.BiConsumer
open class DokkaPlugin : Plugin<Project> {
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() {
fun defaultKotlinTasks() = with(ReflectDsl) {
val abstractKotlinCompileClz = try {
project.buildscript.classLoader.loadClass(ABSTRACT_KOTLIN_COMPILE)
} catch (cnfe: ClassNotFoundException) {
logger.warn("$ABSTRACT_KOTLIN_COMPILE class not found, default kotlin tasks ignored")
return@with emptyList<Task>()
}
return@with project.tasks.filter { it isInstance abstractKotlinCompileClz }.filter { "Test" !in it.name }
}
init {
group = JavaBasePlugin.DOCUMENTATION_GROUP
description = "Generates dokka documentation for Kotlin"
@Suppress("LeakingThis")
dependsOn(Callable { kotlinTasks.flatMap { it.dependsOn } })
}
@Input
var moduleName: String = ""
@Input
var outputFormat: String = "html"
var outputDirectory: String = ""
@Deprecated("Going to be removed in 0.9.16, use classpath + sourceDirs instead if kotlinTasks is not suitable for you")
@Input var processConfigurations: List<Any?> = emptyList()
@InputFiles var classpath: Iterable<File> = arrayListOf()
@Input
var includes: List<Any?> = arrayListOf()
@Input
var linkMappings: ArrayList<LinkMapping> = arrayListOf()
@Input
var samples: List<Any?> = arrayListOf()
@Input
var jdkVersion: Int = 6
@Input
var sourceDirs: Iterable<File> = emptyList()
@Input
var sourceRoots: MutableList<SourceRoot> = arrayListOf()
@Input
var dokkaFatJar: Any = "org.jetbrains.dokka:dokka-fatjar:$version"
@Input var includeNonPublic = false
@Input var skipDeprecated = false
@Input var skipEmptyPackages = true
@Input var reportNotDocumented = true
@Input var perPackageOptions: MutableList<PackageOptions> = arrayListOf()
@Input var impliedPlatforms: MutableList<String> = arrayListOf()
@Input var externalDocumentationLinks = mutableListOf<DokkaConfiguration.ExternalDocumentationLink>()
@Input var noStdlibLink: Boolean = false
@Optional @Input
var cacheRoot: String? = null
@Optional @Input
var languageVersion: String? = null
@Optional @Input
var apiVersion: String? = null
@get:Input
internal val kotlinCompileBasedClasspathAndSourceRoots: ClasspathAndSourceRoots by lazy { extractClasspathAndSourceRootsFromKotlinTasks() }
private var kotlinTasksConfigurator: () -> List<Any?>? = { defaultKotlinTasks() }
private val kotlinTasks: List<Task> by lazy { extractKotlinCompileTasks() }
fun kotlinTasks(closure: Closure<Any?>) {
kotlinTasksConfigurator = { closure.call() as? List<Any?> }
}
fun linkMapping(closure: Closure<Any?>) {
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<Any?>) {
val sourceRoot = SourceRoot()
closure.delegate = sourceRoot
closure.call()
sourceRoots.add(sourceRoot)
}
fun packageOptions(closure: Closure<Any?>) {
val packageOptions = PackageOptions()
closure.delegate = packageOptions
closure.call()
perPackageOptions.add(packageOptions)
}
fun externalDocumentationLink(closure: Closure<Any?>) {
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)
}
}
internal data class ClasspathAndSourceRoots(val classpath: List<File>, val sourceRoots: List<File>) : Serializable
private fun extractKotlinCompileTasks(): List<Task> {
val inputList = (kotlinTasksConfigurator.invoke() ?: emptyList()).filterNotNull()
val (paths, other) = inputList.partition { it is String }
val taskContainer = project.tasks
val tasksByPath = paths.map { taskContainer.findByPath(it as String) ?: throw IllegalArgumentException("Task with path '$it' not found") }
other
.filter { it !is Task || it isNotInstance getAbstractKotlinCompileFor(it) }
.forEach { throw IllegalArgumentException("Illegal entry in kotlinTasks, must be subtype of $ABSTRACT_KOTLIN_COMPILE or String, but was $it") }
tasksByPath
.filter { it == null || it isNotInstance getAbstractKotlinCompileFor(it) }
.forEach { throw IllegalArgumentException("Illegal task path in kotlinTasks, must be subtype of $ABSTRACT_KOTLIN_COMPILE, but was $it") }
return (tasksByPath + other) as List<Task>
}
private fun extractClasspathAndSourceRootsFromKotlinTasks(): ClasspathAndSourceRoots {
val allTasks = kotlinTasks
val allClasspath = mutableSetOf<File>()
val allSourceRoots = mutableSetOf<File>()
allTasks.forEach {
logger.debug("Dokka found AbstractKotlinCompile task: $it")
with(ReflectDsl) {
val taskSourceRoots: List<File> = it["sourceRootsContainer"]["sourceRoots"].v()
val abstractKotlinCompileClz = getAbstractKotlinCompileFor(it)!!
val taskClasspath: Iterable<File> =
(it["compileClasspath", abstractKotlinCompileClz].takeIfIsProp()?.v() ?:
it["getClasspath", abstractKotlinCompileClz]())
allClasspath += taskClasspath.filter { it.exists() }
allSourceRoots += taskSourceRoots.filter { it.exists() }
}
}
return ClasspathAndSourceRoots(allClasspath.toList(), allSourceRoots.toList())
}
private fun Iterable<File>.toSourceRoots(): List<SourceRoot> = this.filter { it.exists() }.map { SourceRoot().apply { path = it.path } }
protected open fun collectSuppressedFiles(sourceRoots: List<SourceRoot>): List<String> = emptyList()
@TaskAction
fun generate() {
val kotlinColorsEnabledBefore = System.getProperty(COLORS_ENABLED_PROPERTY) ?: "false"
System.setProperty(COLORS_ENABLED_PROPERTY, "false")
try {
loadFatJar()
val (tasksClasspath, tasksSourceRoots) = kotlinCompileBasedClasspathAndSourceRoots
val project = project
val sourceRoots = collectSourceRoots() + tasksSourceRoots.toSourceRoots()
if (sourceRoots.isEmpty()) {
logger.warn("No source directories found: skipping dokka generation")
return
}
val fullClasspath = collectClasspathFromOldSources() + tasksClasspath + classpath
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,
fullClasspath.map { it.absolutePath },
sourceRoots,
samples.filterNotNull().map { project.file(it).absolutePath },
includes.filterNotNull().map { project.file(it).absolutePath },
outputDirectory,
outputFormat,
includeNonPublic,
false,
reportNotDocumented,
skipEmptyPackages,
skipDeprecated,
jdkVersion,
true,
linkMappings,
impliedPlatforms,
perPackageOptions,
externalDocumentationLinks,
noStdlibLink,
cacheRoot,
collectSuppressedFiles(sourceRoots),
languageVersion,
apiVersion)
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)
}
}
private fun collectClasspathFromOldSources(): List<File> {
val allConfigurations = project.configurations
val fromConfigurations =
processConfigurations.flatMap { allConfigurations.getByName(it.toString()) }
return fromConfigurations
}
private fun collectSourceRoots(): List<SourceRoot> {
val sourceDirs = if (sourceDirs.any()) {
logger.info("Dokka: Taking source directories provided by the user")
sourceDirs.toSet()
} else if (kotlinTasks.isEmpty()) {
project.convention.findPlugin(JavaPluginConvention::class.java)?.let { javaPluginConvention ->
logger.info("Dokka: Taking source directories from default java plugin")
val sourceSets = javaPluginConvention.sourceSets.findByName(SourceSet.MAIN_SOURCE_SET_NAME)
sourceSets?.allSource?.srcDirs
}
} else {
emptySet()
}
return sourceRoots + (sourceDirs?.toSourceRoots() ?: emptyList())
}
@InputFiles
fun getInputFiles(): FileCollection {
val (tasksClasspath, tasksSourceRoots) = extractClasspathAndSourceRootsFromKotlinTasks()
val fullClasspath = collectClasspathFromOldSources() + tasksClasspath + classpath
return project.files(tasksSourceRoots.map { project.fileTree(it) }) +
project.files(collectSourceRoots().map { project.fileTree(File(it.path)) }) +
project.files(fullClasspath.map { project.fileTree(it) }) +
project.files(includes) +
project.files(samples.filterNotNull().map { project.fileTree(it) })
}
@OutputDirectory
fun getOutputDirectoryAsFile(): File = project.file(outputDirectory)
companion object {
const val COLORS_ENABLED_PROPERTY = "kotlin.colors.enabled"
const val ABSTRACT_KOTLIN_COMPILE = "org.jetbrains.kotlin.gradle.tasks.AbstractKotlinCompile"
private fun getAbstractKotlinCompileFor(task: Task) = try {
task.project.buildscript.classLoader.loadClass(ABSTRACT_KOTLIN_COMPILE)
} catch (e: ClassNotFoundException) {
null
}
}
}
class SourceRoot : DokkaConfiguration.SourceRoot {
override var path: String = ""
set(value) {
field = File(value).absolutePath
}
override var platforms: List<String> = arrayListOf()
override fun toString(): String {
return "${platforms.joinToString()}::$path"
}
}
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 : Serializable, DokkaConfiguration.PackageOptions {
override var prefix: String = ""
override var includeNonPublic: Boolean = false
override var reportUndocumented: Boolean = true
override var skipDeprecated: Boolean = false
override var suppress: Boolean = false
}
|