aboutsummaryrefslogtreecommitdiff
path: root/plugins/base
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2020-08-11 21:47:26 +0200
committerSebastian Sellmair <34319766+sellmair@users.noreply.github.com>2020-08-19 13:34:10 +0200
commit852a6ce6c0f43c9b2044320dcceb4c6cc0a3b302 (patch)
treefb95be79e816769ca5305cf3a601348549000c6d /plugins/base
parent822653f017fa58352148e1c586690debb6773965 (diff)
downloaddokka-852a6ce6c0f43c9b2044320dcceb4c6cc0a3b302.tar.gz
dokka-852a6ce6c0f43c9b2044320dcceb4c6cc0a3b302.tar.bz2
dokka-852a6ce6c0f43c9b2044320dcceb4c6cc0a3b302.zip
Refactor location providers
Diffstat (limited to 'plugins/base')
-rw-r--r--plugins/base/src/main/kotlin/DokkaBase.kt24
-rw-r--r--plugins/base/src/main/kotlin/renderers/PackageListService.kt9
-rw-r--r--plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt9
-rw-r--r--plugins/base/src/main/kotlin/renderers/preprocessors.kt5
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProvider.kt22
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProviderFactory.kt20
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt35
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProvider.kt7
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt25
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactoryWithCache.kt17
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt37
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProvider.kt31
-rw-r--r--plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProviderFactory.kt25
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/BaseLocationProvider.kt141
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt232
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt103
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProviderFactory.kt (renamed from plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProviderFactory.kt)17
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/LocationProvider.kt8
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/LocationProviderFactory.kt7
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/MultimoduleLocationProvider.kt6
-rw-r--r--plugins/base/src/main/kotlin/resolvers/shared/ExternalDocumentationInfo.kt5
-rw-r--r--plugins/base/src/main/kotlin/resolvers/shared/LinkFormat.kt6
-rw-r--r--plugins/base/src/main/kotlin/resolvers/shared/PackageList.kt42
-rw-r--r--plugins/base/src/main/kotlin/resolvers/shared/RecognizedLinkFormat.kt18
-rw-r--r--plugins/base/src/main/kotlin/resolvers/shared/utils.kt36
-rw-r--r--plugins/base/src/test/kotlin/locationProvider/DefaultLocationProviderTest.kt4
-rw-r--r--plugins/base/src/test/kotlin/renderers/html/HtmlRenderingOnlyTestBase.kt10
27 files changed, 418 insertions, 483 deletions
diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
index cf268ec1..e74bc6d9 100644
--- a/plugins/base/src/main/kotlin/DokkaBase.kt
+++ b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -7,15 +7,15 @@ import org.jetbrains.dokka.analysis.KotlinAnalysis
import org.jetbrains.dokka.base.allModulePage.MultimodulePageCreator
import org.jetbrains.dokka.base.renderers.*
import org.jetbrains.dokka.base.renderers.html.*
+import org.jetbrains.dokka.base.resolvers.external.ExternalLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.external.DefaultExternalLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.external.javadoc.JavadocExternalLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
import org.jetbrains.dokka.base.signatures.KotlinSignatureProvider
import org.jetbrains.dokka.base.signatures.SignatureProvider
-import org.jetbrains.dokka.base.resolvers.external.*
-import org.jetbrains.dokka.base.resolvers.local.DefaultLocationProviderFactory
-import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
import org.jetbrains.dokka.base.transformers.documentables.*
-import org.jetbrains.dokka.base.transformers.documentables.DefaultDocumentableMerger
-import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocumentationTransformer
-import org.jetbrains.dokka.base.transformers.documentables.ReportUndocumentedTransformer
import org.jetbrains.dokka.base.transformers.pages.annotations.SinceKotlinTransformer
import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConverter
@@ -154,15 +154,15 @@ class DokkaBase : DokkaPlugin() {
}
val locationProvider by extending {
- locationProviderFactory providing ::DefaultLocationProviderFactory
+ locationProviderFactory providing ::DokkaLocationProviderFactory
}
val javadocLocationProvider by extending {
- externalLocationProviderFactory with JavadocExternalLocationProviderFactory()
+ externalLocationProviderFactory providing ::JavadocExternalLocationProviderFactory
}
val dokkaLocationProvider by extending {
- externalLocationProviderFactory with DokkaExternalLocationProviderFactory()
+ externalLocationProviderFactory providing ::DefaultExternalLocationProviderFactory
}
val fileWriter by extending {
@@ -210,11 +210,7 @@ class DokkaBase : DokkaPlugin() {
val packageListCreator by extending {
htmlPreprocessors providing {
- PackageListCreator(
- it,
- "html",
- "html"
- )
+ PackageListCreator(it, RecognizedLinkFormat.DokkaHtml)
} order { after(rootCreator) }
}
diff --git a/plugins/base/src/main/kotlin/renderers/PackageListService.kt b/plugins/base/src/main/kotlin/renderers/PackageListService.kt
index 0cf84ddd..42c8d66e 100644
--- a/plugins/base/src/main/kotlin/renderers/PackageListService.kt
+++ b/plugins/base/src/main/kotlin/renderers/PackageListService.kt
@@ -39,9 +39,9 @@ class PackageListService(val context: DokkaContext) {
visit(module, setOf())
return buildString {
- appendln("\$dokka.format:${format}")
- appendln("\$dokka.linkExtension:${linkExtension}")
- nonStandardLocations.map { (signature, location) -> "\$dokka.location:$signature\u001f$location" }
+ appendLine("$DOKKA_PARAM_PREFIX.format:${format}")
+ appendLine("$DOKKA_PARAM_PREFIX.linkExtension:${linkExtension}")
+ nonStandardLocations.map { (signature, location) -> "$DOKKA_PARAM_PREFIX.location:$signature\u001f$location" }
.sorted().joinTo(this, separator = "\n", postfix = "\n")
packages.sorted().joinTo(this, separator = "\n", postfix = "\n")
@@ -49,4 +49,7 @@ class PackageListService(val context: DokkaContext) {
}
+ companion object {
+ const val DOKKA_PARAM_PREFIX = "\$dokka"
+ }
} \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt b/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
index e3d54e49..d9833e43 100644
--- a/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
+++ b/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
@@ -21,6 +21,7 @@ import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.query
import org.jetbrains.dokka.plugability.querySingle
+import org.jetbrains.dokka.utilities.htmlEscape
import java.io.File
import java.net.URI
@@ -550,7 +551,7 @@ open class HtmlRenderer(
platforms: List<DisplaySourceSet>,
from: PageNode? = null,
block: FlowContent.() -> Unit
- ) = buildLink(locationProvider.resolve(to, platforms.toSet(), from).orEmpty(), block)
+ ) = buildLink(locationProvider.resolve(to, platforms.toSet(), from)!!, block)
override fun buildError(node: ContentNode) {
context.logger.error("Unknown ContentNode type: $node")
@@ -573,7 +574,7 @@ open class HtmlRenderer(
buildText(node.children, pageContext, sourceSetRestriction)
}
} ?: span {
- attributes["data-unresolved-link"] = "true"
+ attributes["data-unresolved-link"] = node.address.toString().htmlEscape()
buildText(node.children, pageContext, sourceSetRestriction)
}
@@ -625,7 +626,7 @@ open class HtmlRenderer(
}
}
- private fun PageNode.root(path: String) = locationProvider.resolveRoot(this) + path
+ private fun PageNode.root(path: String) = locationProvider.pathToRoot(this) + path
override fun buildPage(page: ContentPage, content: (FlowContent, ContentPage) -> Unit): String =
buildHtml(page, page.embeddedResources) {
@@ -658,7 +659,7 @@ open class HtmlRenderer(
else -> unsafe { +it }
}
}
- script { unsafe { +"""var pathToRoot = "${locationProvider.resolveRoot(page)}";""" } }
+ script { unsafe { +"""var pathToRoot = "${locationProvider.pathToRoot(page)}";""" } }
}
body {
div {
diff --git a/plugins/base/src/main/kotlin/renderers/preprocessors.kt b/plugins/base/src/main/kotlin/renderers/preprocessors.kt
index bf2a9eb4..b07db2bd 100644
--- a/plugins/base/src/main/kotlin/renderers/preprocessors.kt
+++ b/plugins/base/src/main/kotlin/renderers/preprocessors.kt
@@ -1,5 +1,6 @@
package org.jetbrains.dokka.base.renderers
+import org.jetbrains.dokka.base.resolvers.shared.LinkFormat
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.transformers.pages.PageTransformer
@@ -10,7 +11,7 @@ object RootCreator : PageTransformer {
}
-class PackageListCreator(val context: DokkaContext, val format: String, val linkExtension: String) : PageTransformer {
+class PackageListCreator(val context: DokkaContext, val format: LinkFormat) : PageTransformer {
override fun invoke(input: RootPageNode) =
input.modified(children = input.children.map {
it.takeUnless { it is ModulePageNode }
@@ -22,6 +23,6 @@ class PackageListCreator(val context: DokkaContext, val format: String, val link
RendererSpecificResourcePage(
"${pageNode.name}/package-list",
emptyList(),
- RenderingStrategy.Write(PackageListService(context).formatPackageList(pageNode, format, linkExtension))
+ RenderingStrategy.Write(PackageListService(context).formatPackageList(pageNode, format.formatName, format.linkExtension))
)
}
diff --git a/plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProvider.kt
new file mode 100644
index 00000000..5e22206b
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProvider.kt
@@ -0,0 +1,22 @@
+package org.jetbrains.dokka.base.resolvers.external
+
+import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProvider.Companion.identifierToFilename
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.plugability.DokkaContext
+
+open class DefaultExternalLocationProvider(
+ val externalDocumentationInfo: ExternalDocumentationInfo,
+ val extension: String,
+ val dokkaContext: DokkaContext
+) : ExternalLocationProvider {
+ override fun resolve(dri: DRI): String? { // TODO: classes without packages?
+ val docURL = externalDocumentationInfo.documentationURL.toString().removeSuffix("/") + "/"
+ val classNamesChecked = dri.classNames ?: return "$docURL${dri.packageName ?: ""}/index$extension"
+ val classLink = (listOfNotNull(dri.packageName) + classNamesChecked.split('.'))
+ .joinToString("/", transform = ::identifierToFilename)
+
+ val callableChecked = dri.callable ?: return "$docURL$classLink/index$extension"
+ return "$docURL$classLink/" + identifierToFilename(callableChecked.name) + extension
+ }
+}
diff --git a/plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProviderFactory.kt
new file mode 100644
index 00000000..a6e09bac
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/DefaultExternalLocationProviderFactory.kt
@@ -0,0 +1,20 @@
+package org.jetbrains.dokka.base.resolvers.external
+
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
+import org.jetbrains.dokka.plugability.DokkaContext
+
+class DefaultExternalLocationProviderFactory(val context: DokkaContext) :
+ ExternalLocationProviderFactory by ExternalLocationProviderFactoryWithCache(
+ object : ExternalLocationProviderFactory {
+ override fun getExternalLocationProvider(docInfo: ExternalDocumentationInfo): ExternalLocationProvider? =
+ when (docInfo.packageList.linkFormat) {
+ RecognizedLinkFormat.KotlinWebsiteHtml,
+ RecognizedLinkFormat.DokkaOldHtml,
+ RecognizedLinkFormat.DokkaHtml -> DefaultExternalLocationProvider(docInfo, ".html", context)
+ RecognizedLinkFormat.DokkaGFM,
+ RecognizedLinkFormat.DokkaJekyll -> DefaultExternalLocationProvider(docInfo, ".md", context)
+ else -> null
+ }
+ }
+ ) \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt
deleted file mode 100644
index ff9186f7..00000000
--- a/plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt
+++ /dev/null
@@ -1,35 +0,0 @@
-package org.jetbrains.dokka.base.resolvers.external
-
-import org.jetbrains.dokka.base.resolvers.local.identifierToFilename
-import org.jetbrains.dokka.links.DRI
-
-
-class DokkaExternalLocationProviderFactory : ExternalLocationProviderFactory by ExternalLocationProviderFactoryWithCache(
- object : ExternalLocationProviderFactory {
- override fun getExternalLocationProvider(param: String): ExternalLocationProvider? =
- when (param) {
- "kotlin-website-html", "html" -> DokkaExternalLocationProvider(param, ".html")
- "markdown" -> DokkaExternalLocationProvider(param, ".md")
- else -> null
- }
- }
-)
-
-class DokkaExternalLocationProvider(override val param: String, val extension: String) : ExternalLocationProvider {
-
- override fun DRI.toLocation(): String { // TODO: classes without packages?
-
- val classNamesChecked = classNames ?: return "${packageName ?: ""}/index$extension"
-
- val classLink = (listOfNotNull(packageName) + classNamesChecked.split('.')).joinToString(
- "/",
- transform = ::identifierToFilename
- )
-
- val callableChecked = callable ?: return "$classLink/index$extension"
-
- return "$classLink/${identifierToFilename(
- callableChecked.name
- )}$extension"
- }
-}
diff --git a/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProvider.kt
new file mode 100644
index 00000000..51df1504
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProvider.kt
@@ -0,0 +1,7 @@
+package org.jetbrains.dokka.base.resolvers.external
+
+import org.jetbrains.dokka.links.DRI
+
+interface ExternalLocationProvider {
+ fun resolve(dri: DRI): String?
+}
diff --git a/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt
index 83de9911..10d9fffa 100644
--- a/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt
+++ b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt
@@ -1,26 +1,7 @@
package org.jetbrains.dokka.base.resolvers.external
-import org.jetbrains.dokka.links.DRI
-import java.util.concurrent.ConcurrentHashMap
-
-
-interface ExternalLocationProvider {
-
- val param: String
- fun DRI.toLocation(): String
-}
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
interface ExternalLocationProviderFactory {
-
- fun getExternalLocationProvider(param: String): ExternalLocationProvider?
-}
-
-class ExternalLocationProviderFactoryWithCache(val ext: ExternalLocationProviderFactory) : ExternalLocationProviderFactory {
-
- private val locationProviders = ConcurrentHashMap<String, CacheWrapper>()
-
- override fun getExternalLocationProvider(param: String): ExternalLocationProvider? =
- locationProviders.getOrPut(param) { CacheWrapper(ext.getExternalLocationProvider(param)) }.provider
-}
-
-private class CacheWrapper(val provider: ExternalLocationProvider?) \ No newline at end of file
+ fun getExternalLocationProvider(docInfo: ExternalDocumentationInfo): ExternalLocationProvider?
+} \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactoryWithCache.kt b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactoryWithCache.kt
new file mode 100644
index 00000000..4fa1f391
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactoryWithCache.kt
@@ -0,0 +1,17 @@
+package org.jetbrains.dokka.base.resolvers.external
+
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
+import org.jetbrains.dokka.base.resolvers.shared.PackageList
+import java.util.concurrent.ConcurrentHashMap
+
+class ExternalLocationProviderFactoryWithCache(val ext: ExternalLocationProviderFactory) :
+ ExternalLocationProviderFactory {
+
+ private val locationProviders = ConcurrentHashMap<ExternalDocumentationInfo, CacheWrapper>()
+
+ override fun getExternalLocationProvider(docInfo: ExternalDocumentationInfo): ExternalLocationProvider? =
+ locationProviders.getOrPut(docInfo) { CacheWrapper(ext.getExternalLocationProvider(docInfo)) }.provider
+
+ private class CacheWrapper(val provider: ExternalLocationProvider?)
+}
+
diff --git a/plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt
deleted file mode 100644
index c52c9bbb..00000000
--- a/plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt
+++ /dev/null
@@ -1,37 +0,0 @@
-package org.jetbrains.dokka.base.resolvers.external
-
-import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.utilities.htmlEscape
-
-class JavadocExternalLocationProviderFactory : ExternalLocationProviderFactory by ExternalLocationProviderFactoryWithCache(
- object : ExternalLocationProviderFactory {
- override fun getExternalLocationProvider(param: String): ExternalLocationProvider? =
- when(param) {
- "javadoc1" -> JavadocExternalLocationProvider(param, "()", ", ") // Covers JDK 1 - 7
- "javadoc8" -> JavadocExternalLocationProvider(param, "--", "-") // Covers JDK 8 - 9
- "javadoc10" -> JavadocExternalLocationProvider(param, "()", ",") // Covers JDK 10
- else -> null
- }
- }
-)
-
-class JavadocExternalLocationProvider(override val param: String, val brackets: String, val separator: String) : ExternalLocationProvider {
-
- override fun DRI.toLocation(): String {
-
- val packageLink = packageName?.replace(".", "/")
- if (classNames == null) {
- return "$packageLink/package-summary.html".htmlEscape()
- }
- val classLink = if (packageLink == null) "$classNames.html" else "$packageLink/$classNames.html"
- val callableChecked = callable ?: return classLink.htmlEscape()
-
- val callableLink = "$classLink#" +
- callableChecked.name +
- "${brackets.first()}" +
- callableChecked.params.joinToString(separator) +
- "${brackets.last()}"
-
- return callableLink.htmlEscape()
- }
-} \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProvider.kt
new file mode 100644
index 00000000..d42b5b5c
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProvider.kt
@@ -0,0 +1,31 @@
+package org.jetbrains.dokka.base.resolvers.external.javadoc
+
+import org.jetbrains.dokka.base.resolvers.external.DefaultExternalLocationProvider
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.utilities.htmlEscape
+
+class JavadocExternalLocationProvider(
+ externalDocumentationInfo: ExternalDocumentationInfo,
+ val brackets: String,
+ val separator: String,
+ dokkaContext: DokkaContext
+) : DefaultExternalLocationProvider(externalDocumentationInfo, ".html", dokkaContext) {
+
+ override fun resolve(dri: DRI): String? {
+ val docURL = externalDocumentationInfo.documentationURL.toString().removeSuffix("/") + "/"
+ val packageLink = dri.packageName?.replace(".", "/")
+ if (dri.classNames == null) {
+ return "$docURL$packageLink/package-summary$extension".htmlEscape()
+ }
+ val classLink = if (packageLink == null) "${dri.classNames}$extension" else "$packageLink/${dri.classNames}$extension"
+ val callableChecked = dri.callable ?: return "$docURL$classLink".htmlEscape()
+
+ return ("$docURL$classLink#" +
+ callableChecked.name +
+ "${brackets.first()}" +
+ callableChecked.params.joinToString(separator) +
+ "${brackets.last()}").htmlEscape()
+ }
+} \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProviderFactory.kt
new file mode 100644
index 00000000..1cfd73a8
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProviderFactory.kt
@@ -0,0 +1,25 @@
+package org.jetbrains.dokka.base.resolvers.external.javadoc
+
+import org.jetbrains.dokka.base.resolvers.external.ExternalLocationProvider
+import org.jetbrains.dokka.base.resolvers.external.ExternalLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.external.ExternalLocationProviderFactoryWithCache
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
+import org.jetbrains.dokka.plugability.DokkaContext
+
+class JavadocExternalLocationProviderFactory(val context: DokkaContext) :
+ ExternalLocationProviderFactory by ExternalLocationProviderFactoryWithCache(
+ object : ExternalLocationProviderFactory {
+ override fun getExternalLocationProvider(docInfo: ExternalDocumentationInfo): ExternalLocationProvider? =
+ when (docInfo.packageList.linkFormat) {
+ RecognizedLinkFormat.Javadoc1 ->
+ JavadocExternalLocationProvider(docInfo, "()", ", ", context) // Covers JDK 1 - 7
+ RecognizedLinkFormat.Javadoc8,
+ RecognizedLinkFormat.DokkaJavadoc ->
+ JavadocExternalLocationProvider(docInfo, "--", "-", context) // Covers JDK 8 - 9
+ RecognizedLinkFormat.Javadoc10 ->
+ JavadocExternalLocationProvider(docInfo, "()", ",", context) // Covers JDK 10
+ else -> null
+ }
+ }
+ ) \ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/resolvers/local/BaseLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/local/BaseLocationProvider.kt
deleted file mode 100644
index 06730641..00000000
--- a/plugins/base/src/main/kotlin/resolvers/local/BaseLocationProvider.kt
+++ /dev/null
@@ -1,141 +0,0 @@
-package org.jetbrains.dokka.base.resolvers.local
-
-import org.jetbrains.dokka.DokkaConfiguration
-import org.jetbrains.dokka.base.DokkaBase
-import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.model.DisplaySourceSet
-import org.jetbrains.dokka.model.sourceSetIDs
-import org.jetbrains.dokka.plugability.DokkaContext
-import org.jetbrains.dokka.plugability.plugin
-import org.jetbrains.dokka.plugability.query
-import java.net.HttpURLConnection
-import java.net.URL
-import java.net.URLConnection
-import java.util.concurrent.locks.ReentrantReadWriteLock
-import kotlin.concurrent.read
-import kotlin.concurrent.write
-
-abstract class BaseLocationProvider(protected val dokkaContext: DokkaContext) : LocationProvider {
-
- protected val externalLocationProviderFactories =
- dokkaContext.plugin<DokkaBase>().query { externalLocationProviderFactory }
- private val cache: MutableMap<URL, DefaultLocationProvider.LocationInfo> = mutableMapOf()
- private val lock = ReentrantReadWriteLock()
-
- protected fun getExternalLocation(
- dri: DRI,
- sourceSets: Set<DisplaySourceSet>
- ): String? {
- val jdkToExternalDocumentationLinks = dokkaContext.configuration.sourceSets
- .filter { sourceSet -> sourceSet.sourceSetID in sourceSets.sourceSetIDs }
- .groupBy({ it.jdkVersion }, { it.externalDocumentationLinks })
- .map { it.key to it.value.flatten().distinct() }.toMap()
-
- val toResolve: MutableMap<Int, MutableList<DokkaConfiguration.ExternalDocumentationLink>> = mutableMapOf()
- for ((jdk, links) in jdkToExternalDocumentationLinks) {
- for (link in links) {
- val info = lock.read { cache[link.packageListUrl] }
- if (info == null) {
- toResolve.getOrPut(jdk) { mutableListOf() }.add(link)
- } else if (info.packages.contains(dri.packageName)) {
- return link.url.toExternalForm() + getLink(dri, info)
- }
- }
- }
- // Not in cache, resolve packageLists
- for ((jdk, links) in toResolve) {
- for (link in links) {
- if (dokkaContext.configuration.offlineMode && link.packageListUrl.protocol.toLowerCase() != "file")
- continue
- val locationInfo =
- loadPackageList(jdk, link.packageListUrl)
- if (locationInfo.packages.contains(dri.packageName)) {
- return link.url.toExternalForm() + getLink(dri, locationInfo)
- }
- }
- toResolve.remove(jdk)
- }
- return null
- }
-
- private fun getLink(dri: DRI, locationInfo: DefaultLocationProvider.LocationInfo): String =
- locationInfo.locations[dri.packageName + "." + dri.classNames]
- ?: // Not sure if it can be here, previously it shadowed only kotlin/dokka related sources, here it shadows both dokka/javadoc, cause I cannot distinguish what LocationProvider has been hypothetically chosen
- if (locationInfo.externalLocationProvider != null)
- with(locationInfo.externalLocationProvider) {
- dri.toLocation()
- }
- else
- throw IllegalStateException("Have not found any convenient ExternalLocationProvider for $dri DRI!")
-
- private fun loadPackageList(jdk: Int, url: URL): DefaultLocationProvider.LocationInfo = lock.write {
- val packageListStream = url.doOpenConnectionToReadContent().getInputStream()
- val (params, packages) =
- packageListStream
- .bufferedReader()
- .useLines { lines -> lines.partition { it.startsWith(DOKKA_PARAM_PREFIX) } }
-
- val paramsMap = params.asSequence()
- .map { it.removePrefix(DOKKA_PARAM_PREFIX).split(":", limit = 2) }
- .groupBy({ (key, _) -> key }, { (_, value) -> value })
-
- val format = paramsMap["format"]?.singleOrNull() ?: when {
- jdk < 8 -> "javadoc1" // Covers JDK 1 - 7
- jdk < 10 -> "javadoc8" // Covers JDK 8 - 9
- else -> "javadoc10" // Covers JDK 10+
- }
-
- val locations = paramsMap["location"].orEmpty()
- .map { it.split("\u001f", limit = 2) }
- .map { (key, value) -> key to value }
- .toMap()
-
- val externalLocationProvider =
- externalLocationProviderFactories.asSequence().map { it.getExternalLocationProvider(format) }
- .filterNotNull().take(1).firstOrNull()
-
- val info = DefaultLocationProvider.LocationInfo(
- externalLocationProvider,
- packages.toSet(),
- locations
- )
- cache[url] = info
- return info
- }
-
- private fun URL.doOpenConnectionToReadContent(timeout: Int = 10000, redirectsAllowed: Int = 16): URLConnection {
- val connection = this.openConnection().apply {
- connectTimeout = timeout
- readTimeout = timeout
- }
-
- when (connection) {
- is HttpURLConnection -> {
- return when (connection.responseCode) {
- in 200..299 -> {
- connection
- }
- HttpURLConnection.HTTP_MOVED_PERM,
- HttpURLConnection.HTTP_MOVED_TEMP,
- HttpURLConnection.HTTP_SEE_OTHER -> {
- if (redirectsAllowed > 0) {
- val newUrl = connection.getHeaderField("Location")
- URL(newUrl).doOpenConnectionToReadContent(timeout, redirectsAllowed - 1)
- } else {
- throw RuntimeException("Too many redirects")
- }
- }
- else -> {
- throw RuntimeException("Unhandled http code: ${connection.responseCode}")
- }
- }
- }
- else -> return connection
- }
- }
-
- companion object {
- const val DOKKA_PARAM_PREFIX = "\$dokka."
- }
-
-}
diff --git a/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt
index 1c27959f..1e20dc7e 100644
--- a/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt
+++ b/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt
@@ -1,217 +1,51 @@
package org.jetbrains.dokka.base.resolvers.local
-import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
+import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.resolvers.anchors.SymbolAnchorHint
import org.jetbrains.dokka.base.resolvers.external.ExternalLocationProvider
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentationInfo
+import org.jetbrains.dokka.base.resolvers.shared.PackageList
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.DisplaySourceSet
import org.jetbrains.dokka.model.withDescendants
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.DokkaContext
-import java.net.HttpURLConnection
-import java.net.URL
-import java.net.U