Gradle Task supporting multimodular projects

3 files changed, 95 insertions, 0 deletions

diff --git a/plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt
new file mode 100644
index 00000000..ff9186f7
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/DokkaExternalLocationProviderFactory.kt
@@ -0,0 +1,35 @@
+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/ExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt
new file mode 100644
index 00000000..6fb05024
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/ExternalLocationProviderFactory.kt
@@ -0,0 +1,23 @@
+package org.jetbrains.dokka.base.resolvers.external
+
+import org.jetbrains.dokka.links.DRI
+
+
+interface ExternalLocationProvider {
+
+    val param: String
+    fun DRI.toLocation(): String
+}
+
+interface ExternalLocationProviderFactory {
+
+    fun getExternalLocationProvider(param: String): ExternalLocationProvider?
+}
+
+class ExternalLocationProviderFactoryWithCache(val ext: ExternalLocationProviderFactory) : ExternalLocationProviderFactory {
+
+    private val locationProviders: MutableList<ExternalLocationProvider> = mutableListOf()
+
+    override fun getExternalLocationProvider(param: String): ExternalLocationProvider? =
+        locationProviders.find { it.param == param } ?: ext.getExternalLocationProvider(param)?.also { locationProviders.add(it) }
+}
\ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt b/plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt
new file mode 100644
index 00000000..c52c9bbb
--- /dev/null
+++ b/plugins/base/src/main/kotlin/resolvers/external/JavadocExternalLocationProviderFactory.kt
@@ -0,0 +1,37 @@
+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