blob: f7b7cac42210f42d1edd31b584b11f495b14f4a5 (
plain)
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
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.allModulesPage
import org.jetbrains.dokka.DokkaConfiguration.DokkaModuleDescription
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentation
import org.jetbrains.dokka.base.resolvers.shared.PackageList
import org.jetbrains.dokka.base.resolvers.shared.PackageList.Companion.PACKAGE_LIST_NAME
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.query
import java.io.File
import java.net.URL
interface ExternalModuleLinkResolver {
fun resolve(dri: DRI, fileContext: File): String?
fun resolveLinkToModuleIndex(moduleName: String): String?
}
class DefaultExternalModuleLinkResolver(val context: DokkaContext) : ExternalModuleLinkResolver {
private val elpFactory = context.plugin<DokkaBase>().query { externalLocationProviderFactory }
private val externalDocumentations by lazy(::setupExternalDocumentations)
private val elps by lazy {
elpFactory.flatMap { externalDocumentations.map { ed -> it.getExternalLocationProvider(ed) } }.filterNotNull()
}
private fun setupExternalDocumentations(): List<ExternalDocumentation> =
context.configuration.modules.mapNotNull { module ->
loadPackageListForModule(module)?.let { packageList ->
ExternalDocumentation(
URL("file:/${module.relativePathToOutputDirectory.toRelativeOutputDir()}"),
packageList
)
}
}
private fun File.toRelativeOutputDir(): File = if (isAbsolute) {
relativeToOrSelf(context.configuration.outputDir)
} else {
this
}
private fun loadPackageListForModule(module: DokkaModuleDescription) =
module.sourceOutputDirectory.walkTopDown().maxDepth(3).firstOrNull { it.name == PACKAGE_LIST_NAME }?.let {
PackageList.load(
URL("file:" + it.path),
8,
true
)
}
override fun resolve(dri: DRI, fileContext: File): String? {
val absoluteLink = elps.mapNotNull { it.resolve(dri) }.firstOrNull() ?: return null
val modulePath = context.configuration.outputDir.absolutePath.split(File.separator)
val contextPath = fileContext.absolutePath.split(File.separator)
val commonPathElements = modulePath.zip(contextPath)
.takeWhile { (a, b) -> a == b }.count()
return (List(contextPath.size - commonPathElements - 1) { ".." } + modulePath.drop(commonPathElements)).joinToString(
"/"
) + absoluteLink.removePrefix("file:")
}
override fun resolveLinkToModuleIndex(moduleName: String): String? =
context.configuration.modules.firstOrNull { it.name == moduleName }
?.let { module ->
val packageList = loadPackageListForModule(module)
val extension = packageList?.linkFormat?.linkExtension?.let { ".$it" }.orEmpty()
"${module.relativePathToOutputDirectory}/index$extension"
}
}
|
