aboutsummaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorBłażej Kardyś <bkardys@virtuslab.com>2020-11-20 17:23:10 +0100
committerBłażej Kardyś <bkardys@virtuslab.com>2020-11-27 03:15:02 +0100
commit3cb4702a68139788de6e1f7b087ced345f2b71ba (patch)
treea383471c9915ae4aaff078b4f3b81bb99a4fde35 /plugins
parent076a5f421c5e4621539efd814be612f43fef33f5 (diff)
downloaddokka-3cb4702a68139788de6e1f7b087ced345f2b71ba.tar.gz
dokka-3cb4702a68139788de6e1f7b087ced345f2b71ba.tar.bz2
dokka-3cb4702a68139788de6e1f7b087ced345f2b71ba.zip
Changing how multimodule location provider works and improving gfm link substitution
Diffstat (limited to 'plugins')
-rw-r--r--plugins/all-module-page/src/main/kotlin/MultimoduleLocationProvider.kt40
-rw-r--r--plugins/all-module-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt49
-rw-r--r--plugins/all-modules-page/build.gradle.kts (renamed from plugins/all-module-page/build.gradle.kts)0
-rw-r--r--plugins/all-modules-page/src/main/kotlin/AllModulesPageGeneration.kt (renamed from plugins/all-module-page/src/main/kotlin/AllModulesPageGeneration.kt)13
-rw-r--r--plugins/all-modules-page/src/main/kotlin/AllModulesPagePlugin.kt (renamed from plugins/all-module-page/src/main/kotlin/AllModulesPagePlugin.kt)23
-rw-r--r--plugins/all-modules-page/src/main/kotlin/MultimoduleLocationProvider.kt36
-rw-r--r--plugins/all-modules-page/src/main/kotlin/MultimodulePageCreator.kt (renamed from plugins/all-module-page/src/main/kotlin/MultimodulePageCreator.kt)8
-rw-r--r--plugins/all-modules-page/src/main/kotlin/templates/DirectiveBasedTemplateProcessing.kt (renamed from plugins/all-module-page/src/main/kotlin/templates/DirectiveBasedTemplateProcessing.kt)55
-rw-r--r--plugins/all-modules-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt77
-rw-r--r--plugins/all-modules-page/src/main/kotlin/templates/FallbackTemplateProcessingStrategy.kt (renamed from plugins/all-module-page/src/main/kotlin/templates/FallbackTemplateProcessingStrategy.kt)0
-rw-r--r--plugins/all-modules-page/src/main/kotlin/templates/PathToRootSubstitutor.kt (renamed from plugins/all-module-page/src/main/kotlin/templates/PathToRootSubstitutor.kt)0
-rw-r--r--plugins/all-modules-page/src/main/kotlin/templates/Substitutor.kt (renamed from plugins/all-module-page/src/main/kotlin/templates/Substitutor.kt)0
-rw-r--r--plugins/all-modules-page/src/main/kotlin/templates/TemplateProcessor.kt (renamed from plugins/all-module-page/src/main/kotlin/templates/TemplateProcessor.kt)0
-rw-r--r--plugins/all-modules-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin (renamed from plugins/all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin)0
-rw-r--r--plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt2
-rw-r--r--plugins/base/src/main/kotlin/DokkaBase.kt3
-rw-r--r--plugins/base/src/main/kotlin/generation/SingleModuleGeneration.kt2
-rw-r--r--plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt1
-rw-r--r--plugins/base/src/main/kotlin/renderers/html/htmlPreprocessors.kt3
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt4
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/DokkaBaseLocationProvider.kt5
-rw-r--r--plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt4
-rw-r--r--plugins/base/src/main/kotlin/resolvers/shared/PackageList.kt5
-rw-r--r--plugins/base/src/main/kotlin/templating/ImmediateHtmlCommandConsumer.kt3
-rw-r--r--plugins/gfm/.DS_Storebin0 -> 6148 bytes
-rw-r--r--plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmAllModulesPagaPlugin.kt28
-rw-r--r--plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmMultimoduleLocationProvider.kt17
-rw-r--r--plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmTemplateProcessingStrategy.kt45
-rw-r--r--plugins/gfm/gfm-all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin1
-rw-r--r--plugins/gfm/gfm-template-processing/build.gradle.kts (renamed from plugins/gfm/gfm-all-module-page/build.gradle.kts)6
-rw-r--r--plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingPlugin.kt31
-rw-r--r--plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingStrategy.kt51
-rw-r--r--plugins/gfm/gfm-template-processing/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin1
-rw-r--r--plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt4
-rw-r--r--plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/gfmTemplating.kt15
-rw-r--r--plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/location/MarkdownLocationProvider.kt12
-rw-r--r--plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/renderer/CommonmarkRenderer.kt15
-rw-r--r--plugins/gfm/src/test/kotlin/renderers/gfm/GfmRenderingOnlyTestBase.kt16
-rw-r--r--plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/location/JavadocLocationProvider.kt2
39 files changed, 312 insertions, 265 deletions
diff --git a/plugins/all-module-page/src/main/kotlin/MultimoduleLocationProvider.kt b/plugins/all-module-page/src/main/kotlin/MultimoduleLocationProvider.kt
deleted file mode 100644
index cb1eca7b..00000000
--- a/plugins/all-module-page/src/main/kotlin/MultimoduleLocationProvider.kt
+++ /dev/null
@@ -1,40 +0,0 @@
-package org.jetbrains.dokka.allModulesPage
-
-import org.jetbrains.dokka.base.resolvers.local.DokkaBaseLocationProvider
-import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProvider
-import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProvider.Companion.identifierToFilename
-import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
-import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.model.DisplaySourceSet
-import org.jetbrains.dokka.pages.PageNode
-import org.jetbrains.dokka.pages.RootPageNode
-import org.jetbrains.dokka.plugability.DokkaContext
-
-open class MultimoduleLocationProvider(private val root: RootPageNode, val context: DokkaContext, private val fileExtension: String = ".html") : DokkaBaseLocationProvider(root, context, fileExtension) {
-
- protected open val defaultLocationProvider = DokkaLocationProvider(root, context)
- val paths = context.configuration.modules.map {
- it.name to it.relativePathToOutputDirectory
- }.toMap()
-
- override fun resolve(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode?) =
- dri.takeIf { it.packageName == MULTIMODULE_PACKAGE_PLACEHOLDER }?.classNames?.let { paths[it] }?.let {
- "$it/${identifierToFilename(dri.classNames.orEmpty())}/index$fileExtension"
- } ?: defaultLocationProvider.resolve(dri, sourceSets, context)
-
- override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean) =
- defaultLocationProvider.resolve(node, context, skipExtension)
-
- override fun pathToRoot(from: PageNode): String = defaultLocationProvider.pathToRoot(from)
-
- override fun ancestors(node: PageNode): List<PageNode> = listOf(root)
-
- companion object {
- const val MULTIMODULE_PACKAGE_PLACEHOLDER = ".ext"
- }
-
- class Factory(private val context: DokkaContext): LocationProviderFactory {
- override fun getLocationProvider(pageNode: RootPageNode) =
- MultimoduleLocationProvider(pageNode, context)
- }
-}
diff --git a/plugins/all-module-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt b/plugins/all-module-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt
deleted file mode 100644
index 5a3d3d33..00000000
--- a/plugins/all-module-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt
+++ /dev/null
@@ -1,49 +0,0 @@
-package org.jetbrains.dokka.allModulesPage.templates
-
-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.links.DRI
-import org.jetbrains.dokka.plugability.DokkaContext
-import org.jetbrains.dokka.plugability.plugin
-import org.jetbrains.dokka.plugability.query
-import java.net.URL
-import java.io.File
-
-class ExternalModuleLinkResolver(val context: DokkaContext) {
- 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> {
- val packageLists =
- context.configuration.modules.map { it.sourceOutputDirectory.resolve(it.relativePathToOutputDirectory) }
- .map { module ->
- module to PackageList.load(
- URL("file:" + module.resolve("package-list").path),
- 8,
- true
- )
- }.toMap()
- return packageLists.map { (module, pckgList) ->
- ExternalDocumentation(
- URL("file:/${module.name}/${module.name}"),
- pckgList!!
- )
- }
- }
-
- 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:")
- }
-} \ No newline at end of file
diff --git a/plugins/all-module-page/build.gradle.kts b/plugins/all-modules-page/build.gradle.kts
index a0c5a5ed..a0c5a5ed 100644
--- a/plugins/all-module-page/build.gradle.kts
+++ b/plugins/all-modules-page/build.gradle.kts
diff --git a/plugins/all-module-page/src/main/kotlin/AllModulesPageGeneration.kt b/plugins/all-modules-page/src/main/kotlin/AllModulesPageGeneration.kt
index 1ba63627..5ac854b4 100644
--- a/plugins/all-module-page/src/main/kotlin/AllModulesPageGeneration.kt
+++ b/plugins/all-modules-page/src/main/kotlin/AllModulesPageGeneration.kt
@@ -11,9 +11,11 @@ import org.jetbrains.dokka.plugability.querySingle
class AllModulesPageGeneration(private val context: DokkaContext) : Generation {
+ private val allModulesPagePlugin by lazy { context.plugin<AllModulesPagePlugin>() }
+
override fun Timer.generate() {
report("Creating all modules page")
- val pages = createAllModulePage()
+ val pages = createAllModulesPage()
report("Transforming pages")
val transformedPages = transformAllModulesPage(pages)
@@ -22,19 +24,20 @@ class AllModulesPageGeneration(private val context: DokkaContext) : Generation {
render(transformedPages)
report("Processing submodules")
- allModulesPagePlugin().querySingle { templateProcessor }.process()
+ processSubmodules()
}
override val generationName = "index page for project"
- fun createAllModulePage() = allModulesPagePlugin().querySingle { allModulePageCreator }.invoke()
+ fun createAllModulesPage() = allModulesPagePlugin.querySingle { allModulesPageCreator }.invoke()
fun transformAllModulesPage(pages: RootPageNode) =
- allModulesPagePlugin().query { allModulePageTransformer }.fold(pages) { acc, t -> t(acc) }
+ allModulesPagePlugin.query { allModulesPageTransformer }.fold(pages) { acc, t -> t(acc) }
fun render(transformedPages: RootPageNode) {
context.single(CoreExtensions.renderer).render(transformedPages)
}
- private fun allModulesPagePlugin() = context.plugin<AllModulesPagePlugin>()
+ fun processSubmodules() =
+ allModulesPagePlugin.querySingle { templateProcessor }.process()
} \ No newline at end of file
diff --git a/plugins/all-module-page/src/main/kotlin/AllModulesPagePlugin.kt b/plugins/all-modules-page/src/main/kotlin/AllModulesPagePlugin.kt
index bcc43043..95a94cf4 100644
--- a/plugins/all-module-page/src/main/kotlin/AllModulesPagePlugin.kt
+++ b/plugins/all-modules-page/src/main/kotlin/AllModulesPagePlugin.kt
@@ -3,6 +3,8 @@ package org.jetbrains.dokka.allModulesPage
import org.jetbrains.dokka.CoreExtensions
import org.jetbrains.dokka.allModulesPage.templates.*
import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.transformers.pages.PageCreator
import org.jetbrains.dokka.transformers.pages.PageTransformer
@@ -11,20 +13,25 @@ class AllModulesPagePlugin : DokkaPlugin() {
val templateProcessor by extensionPoint<TemplateProcessor>()
val templateProcessingStrategy by extensionPoint<TemplateProcessingStrategy>()
- val allModulePageCreator by extensionPoint<PageCreator>()
- val allModulePageTransformer by extensionPoint<PageTransformer>()
+ val partialLocationProviderFactory by extensionPoint<LocationProviderFactory>()
+ val allModulesPageCreator by extensionPoint<PageCreator>()
+ val allModulesPageTransformer by extensionPoint<PageTransformer>()
+ val externalModuleLinkResolver by extensionPoint<ExternalModuleLinkResolver>()
val substitutor by extensionPoint<Substitutor>()
- val allModulePageCreators by extending {
- allModulePageCreator providing ::MultimodulePageCreator
+ val allModulesPageCreators by extending {
+ allModulesPageCreator providing ::MultimodulePageCreator
}
val multimoduleLocationProvider by extending {
(plugin<DokkaBase>().locationProviderFactory
providing MultimoduleLocationProvider::Factory
- override plugin<DokkaBase>().locationProvider
- applyIf { modules.size > 1 })
+ override plugin<DokkaBase>().locationProvider)
+ }
+
+ val baseLocationProviderFactory by extending {
+ partialLocationProviderFactory providing ::DokkaLocationProviderFactory
}
val allModulesPageGeneration by extending {
@@ -50,4 +57,8 @@ class AllModulesPagePlugin : DokkaPlugin() {
val pathToRootSubstitutor by extending {
substitutor providing ::PathToRootSubstitutor
}
+
+ val multiModuleLinkResolver by extending {
+ externalModuleLinkResolver providing ::DefaultExternalModuleLinkResolver
+ }
} \ No newline at end of file
diff --git a/plugins/all-modules-page/src/main/kotlin/MultimoduleLocationProvider.kt b/plugins/all-modules-page/src/main/kotlin/MultimoduleLocationProvider.kt
new file mode 100644
index 00000000..1dbbd386
--- /dev/null
+++ b/plugins/all-modules-page/src/main/kotlin/MultimoduleLocationProvider.kt
@@ -0,0 +1,36 @@
+package org.jetbrains.dokka.allModulesPage
+
+import org.jetbrains.dokka.allModulesPage.MultimodulePageCreator.Companion.MULTIMODULE_PACKAGE_PLACEHOLDER
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.resolvers.local.DokkaBaseLocationProvider
+import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.model.DisplaySourceSet
+import org.jetbrains.dokka.pages.PageNode
+import org.jetbrains.dokka.pages.RootPageNode
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.plugability.plugin
+import org.jetbrains.dokka.plugability.querySingle
+
+open class MultimoduleLocationProvider(private val root: RootPageNode, dokkaContext: DokkaContext) : DokkaBaseLocationProvider(root, dokkaContext) {
+
+ private val defaultLocationProvider = dokkaContext.plugin<AllModulesPagePlugin>().querySingle { partialLocationProviderFactory }.getLocationProvider(root)
+ private val externalModuleLinkResolver = dokkaContext.plugin<AllModulesPagePlugin>().querySingle { externalModuleLinkResolver }
+
+ override fun resolve(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode?) =
+ if (dri == MultimodulePageCreator.MULTIMODULE_ROOT_DRI) pathToRoot(root)
+ else dri.takeIf { it.packageName == MULTIMODULE_PACKAGE_PLACEHOLDER }?.classNames
+ ?.let(externalModuleLinkResolver::resolveLinkToModuleIndex)
+
+ override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean) =
+ defaultLocationProvider.resolve(node, context, skipExtension)
+
+ override fun pathToRoot(from: PageNode): String = defaultLocationProvider.pathToRoot(from)
+
+ override fun ancestors(node: PageNode): List<PageNode> = listOf(root)
+
+ class Factory(private val context: DokkaContext) : LocationProviderFactory {
+ override fun getLocationProvider(pageNode: RootPageNode) =
+ MultimoduleLocationProvider(pageNode, context)
+ }
+}
diff --git a/plugins/all-module-page/src/main/kotlin/MultimodulePageCreator.kt b/plugins/all-modules-page/src/main/kotlin/MultimodulePageCreator.kt
index 123dee2b..7f441aa1 100644
--- a/plugins/all-module-page/src/main/kotlin/MultimodulePageCreator.kt
+++ b/plugins/all-modules-page/src/main/kotlin/MultimodulePageCreator.kt
@@ -2,7 +2,6 @@ package org.jetbrains.dokka.allModulesPage
import org.jetbrains.dokka.DokkaConfiguration.DokkaModuleDescription
import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
-import org.jetbrains.dokka.allModulesPage.MultimoduleLocationProvider.Companion.MULTIMODULE_PACKAGE_PLACEHOLDER
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentation.Classifier.Module
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentationParsingContext
@@ -62,7 +61,7 @@ class MultimodulePageCreator(
}
}
return MultimoduleRootPageNode(
- setOf(DRI(packageName = MULTIMODULE_PACKAGE_PLACEHOLDER, classNames = "allModules")),
+ setOf(MULTIMODULE_ROOT_DRI),
contentNode
)
}
@@ -94,4 +93,9 @@ class MultimodulePageCreator(
return if (firstChildParagraph == null && this is P) this
else firstChildParagraph
}
+
+ companion object {
+ const val MULTIMODULE_PACKAGE_PLACEHOLDER = ".ext"
+ val MULTIMODULE_ROOT_DRI = DRI(packageName = MULTIMODULE_PACKAGE_PLACEHOLDER, classNames = "allModules")
+ }
}
diff --git a/plugins/all-module-page/src/main/kotlin/templates/DirectiveBasedTemplateProcessing.kt b/plugins/all-modules-page/src/main/kotlin/templates/DirectiveBasedTemplateProcessing.kt
index feba2d4e..2b065731 100644
--- a/plugins/all-module-page/src/main/kotlin/templates/DirectiveBasedTemplateProcessing.kt
+++ b/plugins/all-modules-page/src/main/kotlin/templates/DirectiveBasedTemplateProcessing.kt
@@ -9,6 +9,7 @@ import org.jetbrains.dokka.base.templating.*
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.jsoup.Jsoup
import org.jsoup.nodes.*
import org.jsoup.parser.Tag
@@ -20,7 +21,7 @@ class DirectiveBasedHtmlTemplateProcessingStrategy(private val context: DokkaCon
private val navigationFragments = ConcurrentHashMap<String, Element>()
private val substitutors = context.plugin<AllModulesPagePlugin>().query { substitutor }
- private val externalModuleLinkResolver = ExternalModuleLinkResolver(context)
+ private val externalModuleLinkResolver = context.plugin<AllModulesPagePlugin>().querySingle { externalModuleLinkResolver }
override suspend fun process(input: File, output: File): Boolean = coroutineScope {
if (input.extension == "html") {
@@ -78,35 +79,37 @@ class DirectiveBasedHtmlTemplateProcessingStrategy(private val context: DokkaCon
substitutors.asSequence().mapNotNull { it.trySubstitute(commandContext, match) }.firstOrNull() ?: match.value
override suspend fun finish(output: File) {
- val attributes = Attributes().apply {
- put("class", "sideMenu")
- }
- val node = Element(Tag.valueOf("div"), "", attributes)
- navigationFragments.entries.sortedBy { it.key }.forEach { (moduleName, command) ->
- command.select("a").forEach { a ->
- a.attr("href")?.also { a.attr("href", "${moduleName}/${it}") }
+ if (navigationFragments.isNotEmpty()) {
+ val attributes = Attributes().apply {
+ put("class", "sideMenu")
}
- command.childNodes().toList().forEachIndexed { index, child ->
- if (index == 0) {
- child.attr("id", "$moduleName-nav-submenu")
+ val node = Element(Tag.valueOf("div"), "", attributes)
+ navigationFragments.entries.sortedBy { it.key }.forEach { (moduleName, command) ->
+ command.select("a").forEach { a ->
+ a.attr("href")?.also { a.attr("href", "${moduleName}/${it}") }
+ }
+ command.childNodes().toList().forEachIndexed { index, child ->
+ if (index == 0) {
+ child.attr("id", "$moduleName-nav-submenu")
+ }
+ node.appendChild(child)
}
- node.appendChild(child)
}
- }
- withContext(IO) {
- Files.write(output.resolve("navigation.html").toPath(), listOf(node.outerHtml()))
- }
-
- node.select("a").forEach { a ->
- a.attr("href")?.also { a.attr("href", "../${it}") }
- }
- navigationFragments.keys.forEach {
withContext(IO) {
- Files.write(
- output.resolve(it).resolve("navigation.html").toPath(),
- listOf(node.outerHtml())
- )
+ Files.write(output.resolve("navigation.html").toPath(), listOf(node.outerHtml()))
+ }
+
+ node.select("a").forEach { a ->
+ a.attr("href")?.also { a.attr("href", "../${it}") }
+ }
+ navigationFragments.keys.forEach {
+ withContext(IO) {
+ Files.write(
+ output.resolve(it).resolve("navigation.html").toPath(),
+ listOf(node.outerHtml())
+ )
+ }
}
}
}
@@ -127,7 +130,7 @@ class DirectiveBasedHtmlTemplateProcessingStrategy(private val context: DokkaCon
}
val attributes = Attributes().apply {
- put("href", link) // TODO: resolve
+ put("href", link)
}
val children = it.childNodes().toList()
val element = Element(Tag.valueOf("a"), "", attributes).apply {
diff --git a/plugins/all-modules-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt b/plugins/all-modules-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt
new file mode 100644
index 00000000..d0e787b6
--- /dev/null
+++ b/plugins/all-modules-page/src/main/kotlin/templates/ExternalModuleLinkResolver.kt
@@ -0,0 +1,77 @@
+package org.jetbrains.dokka.allModulesPage.templates
+
+import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProvider.Companion.identifierToFilename
+import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentation
+import org.jetbrains.dokka.base.resolvers.shared.PackageList
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
+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> {
+ val packageLists =
+ context.configuration.modules.map(::loadPackageListForModule).toMap()
+ return packageLists.mapNotNull { (module, packageList) ->
+ packageList?.let {
+ ExternalDocumentation(
+ URL("file:/${module.name}/${module.name}"),
+ packageList
+ )
+ }
+ }
+ }
+
+ private fun loadPackageListForModule(module: DokkaConfiguration.DokkaModuleDescription) =
+ module.sourceOutputDirectory.resolve(File(identifierToFilename(module.name))).let {
+ it to PackageList.load(
+ URL("file:" + it.resolve("package-list").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 = when (packageList?.linkFormat) {
+ RecognizedLinkFormat.KotlinWebsiteHtml,
+ RecognizedLinkFormat.DokkaOldHtml,
+ RecognizedLinkFormat.DokkaHtml -> ".html"
+ RecognizedLinkFormat.DokkaGFM,
+ RecognizedLinkFormat.DokkaJekyll -> ".md"
+ else -> ""
+ }
+ "${module.relativePathToOutputDirectory}/${identifierToFilename(moduleName)}/index$extension"
+ }
+
+}
diff --git a/plugins/all-module-page/src/main/kotlin/templates/FallbackTemplateProcessingStrategy.kt b/plugins/all-modules-page/src/main/kotlin/templates/FallbackTemplateProcessingStrategy.kt
index 9b5251ac..9b5251ac 100644
--- a/plugins/all-module-page/src/main/kotlin/templates/FallbackTemplateProcessingStrategy.kt
+++ b/plugins/all-modules-page/src/main/kotlin/templates/FallbackTemplateProcessingStrategy.kt
diff --git a/plugins/all-module-page/src/main/kotlin/templates/PathToRootSubstitutor.kt b/plugins/all-modules-page/src/main/kotlin/templates/PathToRootSubstitutor.kt
index 5056b724..5056b724 100644
--- a/plugins/all-module-page/src/main/kotlin/templates/PathToRootSubstitutor.kt
+++ b/plugins/all-modules-page/src/main/kotlin/templates/PathToRootSubstitutor.kt
diff --git a/plugins/all-module-page/src/main/kotlin/templates/Substitutor.kt b/plugins/all-modules-page/src/main/kotlin/templates/Substitutor.kt
index 98f1d88e..98f1d88e 100644
--- a/plugins/all-module-page/src/main/kotlin/templates/Substitutor.kt
+++ b/plugins/all-modules-page/src/main/kotlin/templates/Substitutor.kt
diff --git a/plugins/all-module-page/src/main/kotlin/templates/TemplateProcessor.kt b/plugins/all-modules-page/src/main/kotlin/templates/TemplateProcessor.kt
index 18d63df0..18d63df0 100644
--- a/plugins/all-module-page/src/main/kotlin/templates/TemplateProcessor.kt
+++ b/plugins/all-modules-page/src/main/kotlin/templates/TemplateProcessor.kt
diff --git a/plugins/all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/plugins/all-modules-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
index 3ac59dc6..3ac59dc6 100644
--- a/plugins/all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
+++ b/plugins/all-modules-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
diff --git a/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt b/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt
index cfc5ed43..a0c681eb 100644
--- a/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt
+++ b/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt
@@ -104,7 +104,7 @@ class BaseTestBuilder : TestBuilder<BaseTestMethods>() {
)
}
-open class BaseAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger)) : AbstractTest<BaseTestMethods, BaseTestBuilder, BaseDokkaTestGenerator>(
+abstract class BaseAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger)) : AbstractTest<BaseTestMethods, BaseTestBuilder, BaseDokkaTestGenerator>(
::BaseTestBuilder,
::BaseDokkaTestGenerator,
logger,
diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
index c4dacdcd..ac070ab4 100644
--- a/plugins/base/src/main/kotlin/DokkaBase.kt
+++ b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -32,8 +32,7 @@ import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.transformers.documentation.PreMergeDocumentableTransformer
import org.jetbrains.dokka.transformers.pages.PageTransformer
-class
-DokkaBase : DokkaPlugin() {
+class DokkaBase : DokkaPlugin() {
val preMergeDocumentableTransformer by extensionPoint<PreMergeDocumentableTransformer>()
val pageMergerStrategy by extensionPoint<PageMergerStrategy>()
diff --git a/plugins/base/src/main/kotlin/generation/SingleModuleGeneration.kt b/plugins/base/src/main/kotlin/generation/SingleModuleGeneration.kt
index eb405a3d..1689a1dd 100644
--- a/plugins/base/src/main/kotlin/generation/SingleModuleGeneration.kt
+++ b/plugins/base/src/main/kotlin/generation/SingleModuleGeneration.kt
@@ -8,6 +8,8 @@ import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.DokkaException
import org.jetbrains.dokka.Timer
import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.generation.Generation
+import org.jetbrains.dokka.generation.exitGenerationGracefully
import org.jetbrains.dokka.model.DModule
import org.jetbrains.dokka.pages.RootPageNode
import org.jetbrains.dokka.plugability.DokkaContext
diff --git a/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt b/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
index ba5329bf..3bafb8f5 100644
--- a/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
+++ b/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
@@ -712,7 +712,6 @@ open class HtmlRenderer(
buildHtml(page, page.embeddedResources) {
div("main-content") {
id = "content"
- // TODO: Investigate possible problem
attributes["pageIds"] = "${context.configuration.moduleName}::${page.pageId}"
content(this, page)
}
diff --git a/plugins/base/src/main/kotlin/renderers/html/htmlPreprocessors.kt b/plugins/base/src/main/kotlin/renderers/html/htmlPreprocessors.kt
index fbebec70..cc97bb72 100644
--- a/plugins/base/src/main/kotlin/renderers/html/htmlPreprocessors.kt
+++ b/plugins/base/src/main/kotlin/renderers/html/htmlPreprocessors.kt
@@ -70,7 +70,8 @@ open class NavigationSearchInstaller(val context: DokkaContext) : NavigationData
open class NavigationPageInstaller(val context: DokkaContext) : NavigationDataProvider(), PageTransformer {
override fun invoke(input: RootPageNode): RootPageNode =
- input.modified(children = input.children + NavigationPage(navigableChildren(input)))
+ input.modified(children = input.children + NavigationPage(navigableChildren(input),
+ (listOf(input) + input.children).firstOrNull { it is ContentPage && it.name.isNotBlank() }?.name.orEmpty()))
}
class CustomResourceInstaller(val dokkaContext: DokkaContext) : PageTransformer {
diff --git a/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt
index 293ca2d4..c956b308 100644
--- a/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt
+++ b/plugins/base/src/main/kotlin/resolvers/local/DefaultLocationProvider.kt
@@ -4,7 +4,6 @@ import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.resolvers.external.ExternalLocationProvider
import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentation
import org.jetbrains.dokka.base.resolvers.shared.PackageList
-import org.jetbrains.dokka.base.resolvers.anchors.SymbolAnchorHint
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.DisplaySourceSet
import org.jetbrains.dokka.pages.RootPageNode
@@ -14,8 +13,7 @@ import org.jetbrains.dokka.plugability.query
abstract class DefaultLocationProvider(
protected val pageGraphRoot: RootPageNode,
- protected val dokkaContext: DokkaContext,
- protected val extension: String
+ protected val dokkaContext: DokkaContext
) : LocationProvider {
protected val externalLocationProviderFactories =
dokkaContext.plugin<DokkaBase>().query { externalLocationProviderFactory }
diff --git a/plugins/base/src/main/kotlin/resolvers/local/DokkaBaseLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/local/DokkaBaseLocationProvider.kt
index b1213b19..fa133045 100644
--- a/plugins/base/src/main/kotlin/resolvers/local/DokkaBaseLocationProvider.kt
+++ b/plugins/base/src/main/kotlin/resolvers/local/DokkaBaseLocationProvider.kt
@@ -8,9 +8,8 @@ import org.jetbrains.dokka.utilities.urlEncoded
abstract class DokkaBaseLocationProvider(
pageGraphRoot: RootPageNode,
- dokkaContext: DokkaContext,
- extension: String
-) : DefaultLocationProvider(pageGraphRoot, dokkaContext, extension) {
+ dokkaContext: DokkaContext
+) : DefaultLocationProvider(pageGraphRoot, dokkaContext) {
/**
* Anchors should be unique and should contain sourcesets, dri and contentKind.
diff --git a/plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt b/plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt
index 437a1c58..c10029bc 100644
--- a/plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt
+++ b/plugins/base/src/main/kotlin/resolvers/local/DokkaLocationProvider.kt
@@ -14,8 +14,8 @@ import java.util.*
open class DokkaLocationProvider(
pageGraphRoot: RootPageNode,
dokkaContext: DokkaContext,
- extension: String = ".html"
-) : DokkaBaseLocationProvider(pageGraphRoot, dokkaContext, extension) {
+ val extension: String = ".html"
+) : DokkaBaseLocationProvider(pageGraphRoot, dokkaContext) {
protected open val PAGE_WITH_CHILDREN_SUFFIX = "index"
protected open val pathsIndex: Map<PageNode, List<String>> = IdentityHashMap<PageNode, List<String>>().apply {
diff --git a/plugins/base/src/main/kotlin/resolvers/shared/PackageList.kt b/plugins/base/src/main/kotlin/resolvers/shared/PackageList.kt
index e4b8fb6f..089bda55 100644
--- a/plugins/base/src/main/kotlin/resolvers/shared/PackageList.kt
+++ b/plugins/base/src/main/kotlin/resolvers/shared/PackageList.kt
@@ -1,7 +1,6 @@
package org.jetbrains.dokka.base.resolvers.shared
import org.jetbrains.dokka.base.renderers.PackageListService
-import java.io.File
import java.net.URL
data class PackageList(
@@ -15,9 +14,6 @@ data class PackageList(
if (offlineMode && url.protocol.toLowerCase() != "file")
return null
- /*if (!File(url.file).isFile)
- return null*/
-
val packageListStream = url.readContent()
val (params, packages) = packageListStream
@@ -31,7 +27,6 @@ data class PackageList(
return PackageList(format, packages.filter(String::isNotBlank).toSet(), locations, url)
}
-
private fun splitParams(params: List<String>) = params.asSequence()
.map { it.removePrefix("${PackageListService.DOKKA_PARAM_PREFIX}.").split(":", limit = 2) }
.groupBy({ (key, _) -> key }, { (_, value) -> value })
diff --git a/plugins/base/src/main/kotlin/templating/ImmediateHtmlCommandConsumer.kt b/plugins/base/src/main/kotlin/templating/ImmediateHtmlCommandConsumer.kt
index a2a3b31e..2b721e8c 100644
--- a/plugins/base/src/main/kotlin/templating/ImmediateHtmlCommandConsumer.kt
+++ b/plugins/base/src/main/kotlin/templating/ImmediateHtmlCommandConsumer.kt
@@ -2,10 +2,9 @@ package org.jetbrains.dokka.base.templating
import org.jetbrains.dokka.base.renderers.html.TemplateBlock
import org.jetbrains.dokka.base.renderers.html.command.consumers.ImmediateResolutionTagConsumer
-import org.jetbrains.dokka.plugability.DokkaContext
interface ImmediateHtmlCommandConsumer {
- fun canProcess(command:Command): Boolean
+ fun canProcess(command: Command): Boolean
fun <R> processCommand(command: Command, block: TemplateBlock, tagConsumer: ImmediateResolutionTagConsumer<R>)
diff --git a/plugins/gfm/.DS_Store b/plugins/gfm/.DS_Store
new file mode 100644
index 00000000..343f9af6
--- /dev/null
+++ b/plugins/gfm/.DS_Store
Binary files differ
diff --git a/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmAllModulesPagaPlugin.kt b/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmAllModulesPagaPlugin.kt
deleted file mode 100644
index eb5e7e45..00000000
--- a/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmAllModulesPagaPlugin.kt
+++ /dev/null
@@ -1,28 +0,0 @@
-package org.jetbrains.dokka.gfm.allModulesPage
-
-import org.jetbrains.dokka.allModulesPage.AllModulesPagePlugin
-import org.jetbrains.dokka.allModulesPage.templates.DefaultTemplateProcessor
-import org.jetbrains.dokka.base.DokkaBase
-import org.jetbrains.dokka.gfm.GfmPlugin
-import org.jetbrains.dokka.plugability.DokkaPlugin
-
-class GfmAllModulesPagePlugin : DokkaPlugin() {
-
- private val gfmPlugin by lazy { plugin<GfmPlugin>() }
-
- private val dokkaBase by lazy { plugin<DokkaBase>() }
-
- private val allModulesPagePlugin by lazy { plugin<AllModulesPagePlugin>() }
-
- val locationProvider by extending {
- (dokkaBase.locationProviderFactory providing GfmMultimoduleLocationProvider::Factory
- override listOf(allModulesPagePlugin.multimoduleLocationProvider, gfmPlugin.locationProvider))
- }
-
- val defaultTemplateProcessor by extending {
- (allModulesPagePlugin.templateProcessingStrategy
- providing ::GfmTemplateProcessingStrategy
- override allModulesPagePlugin.directiveBasedHtmlTemplateProcessingStrategy
- order { before(allModulesPagePlugin.fallbackProcessingStrategy) })
- }
-} \ No newline at end of file
diff --git a/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmMultimoduleLocationProvider.kt b/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmMultimoduleLocationProvider.kt
deleted file mode 100644
index 9f2ee140..00000000
--- a/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmMultimoduleLocationProvider.kt
+++ /dev/null
@@ -1,17 +0,0 @@
-package org.jetbrains.dokka.gfm.allModulesPage
-
-import org.jetbrains.dokka.allModulesPage.MultimoduleLocationProvider
-import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
-import org.jetbrains.dokka.gfm.location.MarkdownLocationProvider
-import org.jetbrains.dokka.pages.RootPageNode
-import org.jetbrains.dokka.plugability.DokkaContext
-
-class GfmMultimoduleLocationProvider(root: RootPageNode, context: DokkaContext) : MultimoduleLocationProvider(root, context, ".md") {
-
- override val defaultLocationProvider = MarkdownLocationProvider(root, context)
-
- class Factory(private val context: DokkaContext): LocationProviderFactory {
- override fun getLocationProvider(pageNode: RootPageNode) =
- GfmMultimoduleLocationProvider(pageNode, context)
- }
-} \ No newline at end of file
diff --git a/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmTemplateProcessingStrategy.kt b/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmTemplateProcessingStrategy.kt
deleted file mode 100644
index 37226d1e..00000000
--- a/plugins/gfm/gfm-all-module-page/src/main/kotlin/org/jetbrains/dokka/gfm/allModulesPage/GfmTemplateProcessingStrategy.kt
+++ /dev/null
@@ -1,45 +0,0 @@
-package org.jetbrains.dokka.gfm.allModulesPage
-
-import kotlinx.coroutines.Dispatchers.IO
-import kotlinx.coroutines.coroutineScope
-import kotlinx.coroutines.launch
-import org.jetbrains.dokka.allModulesPage.templates.ExternalModuleLinkResolver
-import org.jetbrains.dokka.allModulesPage.templates.TemplateProcessingStrategy
-import org.jetbrains.dokka.base.templating.parseJson
-import org.jetbrains.dokka.gfm.GfmCommand
-import org.jetbrains.dokka.gfm.GfmCommand.Companion.templateCommandRegex
-import org.jetbrains.dokka.gfm.ResolveLinkGfmCommand
-import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.plugability.DokkaContext
-import java.io.File
-
-class GfmTemplateProcessingStrategy(val context: DokkaContext) : TemplateProcessingStrategy {
-
- private val externalModuleLinkResolver = ExternalModuleLinkResolver(context)
-
- override suspend fun process(input: File, output: File): Boolean = coroutineScope {
- if (input.extension == "md") {
- launch(IO) {
- val reader = input.bufferedReader()
- val writer = output.bufferedWriter()
- do {
- val line = reader.readLine()
- if (line != null) {
- writer.write(line.replace(templateCommandRegex) {
- when (val command = parseJson<GfmCommand>(it.groupValues.last())) {
- is ResolveLinkGfmCommand -> resolveLink(output, command.dri)
- }
- })
- writer.newLine()
- }
- } while (line != null)
- reader.close()
- writer.close()
- }
- true
- } else false
- }
-
- private fun resolveLink(fileContext: File, dri: DRI): String =
- externalModuleLinkResolver.resolve(dri, fileContext) ?: ""
-} \ No newline at end of file
diff --git a/plugins/gfm/gfm-all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/plugins/gfm/gfm-all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
deleted file mode 100644
index 1a8acd51..00000000
--- a/plugins/gfm/gfm-all-module-page/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
+++ /dev/null
@@ -1 +0,0 @@
-org.jetbrains.dokka.gfm.allModulesPage.GfmAllModulesPagePlugin \ No newline at end of file
diff --git a/plugins/gfm/gfm-all-module-page/build.gradle.kts b/plugins/gfm/gfm-template-processing/build.gradle.kts
index 85f83587..f95ef0e4 100644
--- a/plugins/gfm/gfm-all-module-page/build.gradle.kts
+++ b/plugins/gfm/gfm-template-processing/build.gradle.kts
@@ -3,12 +3,12 @@ import org.jetbrains.registerDokkaArtifactPublication
dependencies {
implementation(project(":plugins:base"))
implementation(project(":plugins:gfm"))
- implementation(project(":plugins:all-module-page"))
+ implementation(project(":plugins:all-modules-page"))
val coroutines_version: String by project
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version")
}
-registerDokkaArtifactPublication("dokkaGfmAllModulePage") {
- artifactId = "gfm-all-module-page-plugin"
+registerDokkaArtifactPublication("dokkaGfmTemplateProcessing") {
+ artifactId = "gfm-template-processing-plugin"
} \ No newline at end of file
diff --git a/plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingPlugin.kt b/plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingPlugin.kt
new file mode 100644
index 00000000..7df740a5
--- /dev/null
+++ b/plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingPlugin.kt
@@ -0,0 +1,31 @@
+package org.jetbrains.dokka.gfm.templateProcessing
+
+import org.jetbrains.dokka.allModulesPage.AllModulesPagePlugin
+import org.jetbrains.dokka.allModulesPage.MultimoduleLocationProvider
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.gfm.GfmPlugin
+import org.jetbrains.dokka.gfm.location.MarkdownLocationProvider
+import org.jetbrains.dokka.plugability.DokkaPlugin
+
+class GfmTemplateProcessingPlugin : DokkaPlugin() {
+
+ private val allModulesPagePlugin by lazy { plugin<AllModulesPagePlugin>() }
+
+ private val gfmPlugin by lazy { plugin<GfmPlugin>() }
+
+ private val dokkaBase by lazy { plugin<DokkaBase>()}
+
+ val gfmTemplateProcessingStrategy by extending {
+ (allModulesPagePlugin.templateProcessingStrategy
+ providing ::GfmTemplateProcessingStrategy
+ order { before(allModulesPagePlugin.fallbackProcessingStrategy) })
+ }
+
+ val gfmLocationProvider by extending {
+ dokkaBase.locationProviderFactory providing MultimoduleLocationProvider::Factory override listOf(gfmPlugin.locationProvider, allModulesPagePlugin.multimoduleLocationProvider)
+ }
+
+ val gfmPartialLocationProvider by extending {
+ allModulesPagePlugin.partialLocationProviderFactory providing MarkdownLocationProvider::Factory override allModulesPagePlugin.baseLocationProviderFactory
+ }
+} \ No newline at end of file
diff --git a/plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingStrategy.kt b/plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingStrategy.kt
new file mode 100644
index 00000000..b2ef4d06
--- /dev/null
+++ b/plugins/gfm/gfm-template-processing/src/main/kotlin/org/jetbrains/dokka/gfm/templateProcessing/GfmTemplateProcessingStrategy.kt
@@ -0,0 +1,51 @@
+package org.jetbrains.dokka.gfm.templateProcessing
+
+import kotlinx.coroutines.Dispatchers.IO
+import kotlinx.coroutines.coroutineScope
+import kotlinx.coroutines.launch
+import org.jetbrains.dokka.allModulesPage.AllModulesPagePlugin
+import org.jetbrains.dokka.allModulesPage.templates.TemplateProcessingStrategy
+import org.jetbrains.dokka.base.templating.parseJson
+import org.jetbrains.dokka.gfm.GfmCommand
+import org.jetbrains.dokka.gfm.GfmCommand.Companion.command
+import org.jetbrains.dokka.gfm.GfmCommand.Companion.label
+import org.jetbrains.dokka.gfm.GfmCommand.Companion.templateCommandRegex
+import org.jetbrains.dokka.gfm.ResolveLinkGfmCommand
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.plugability.plugin
+import org.jetbrains.dokka.plugability.querySingle
+import java.io.File
+
+class GfmTemplateProcessingStrategy(context: DokkaContext) : TemplateProcessingStrategy {
+
+ private val externalModuleLinkResolver = context.plugin<AllModulesPagePlugin>().querySingle { externalModuleLinkResolver }
+
+ override suspend fun process(input: File, output: File): Boolean = coroutineScope {
+ if (input.extension == "md") {
+ launch(IO) {
+ input.bufferedReader().use { reader ->
+ output.bufferedWriter().use { writer ->
+ do {
+ val line = reader.readLine()
+ if (line != null) {
+ writer.write(line.replace(templateCommandRegex) {
+ when (val command = parseJson<GfmCommand>(it.command)) {
+ is ResolveLinkGfmCommand -> resolveLink(output, command.dri, it.label)
+ }
+ })
+ writer.newLine()
+ }
+ } while (line != null)
+ }
+ }
+ }
+ true
+ } else false
+ }
+
+ private fun resolveLink(fileContext: File, dri: DRI, label: String): String =
+ externalModuleLinkResolver.resolve(dri, fileContext)?.let { address ->
+ "[$label]($address)"
+ } ?: label
+} \ No newline at end of file
diff --git a/plugins/gfm/gfm-template-processing/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/plugins/gfm/gfm-template-processing/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
new file mode 100644
index 00000000..197823e7
--- /dev/null
+++ b/plugins/gfm/gfm-template-processing/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
@@ -0,0 +1 @@
+org.jetbrains.dokka.gfm.templateProcessing.GfmTemplateProcessingPlugin \ No newline at end of file
diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt
index 3f2eae4d..4ca639b2 100644
--- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt
+++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt
@@ -5,7 +5,7 @@ import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.renderers.PackageListCreator
import org.jetbrains.dokka.base.renderers.RootCreator
import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
-import org.jetbrains.dokka.gfm.location.MarkdownLocationProviderFactory
+import org.jetbrains.dokka.gfm.location.MarkdownLocationProvider
import org.jetbrains.dokka.gfm.renderer.CommonmarkRenderer
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.transformers.pages.PageTransformer
@@ -21,7 +21,7 @@ class GfmPlugin : DokkaPlugin() {
}
val locationProvider by extending {
- dokkaBase.locationProviderFactory providing ::MarkdownLocationProviderFactory override dokkaBase.locationProvider
+ dokkaBase.locationProviderFactory providing MarkdownLocationProvider::Factory override dokkaBase.locationProvider
}
val rootCreator by extending {
diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/gfmTemplating.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/gfmTemplating.kt
index 1473ceee..4fa6a36e 100644
--- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/gfmTemplating.kt
+++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/gfmTemplating.kt
@@ -9,11 +9,20 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo.Id.CLASS
sealed class GfmCommand {
companion object {
private const val delimiter = "\u1680"
- fun templateCommand(command: GfmCommand): String = "$delimiter GfmCommand ${toJsonString(command)}$delimiter"
- val templateCommandRegex: Regex = Regex("$delimiter GfmCommand ([^$delimiter ]*)$delimiter")
+ val templateCommandRegex: Regex =
+ Regex("<!---$delimiter GfmCommand ([^$delimiter ]*)$delimiter--->(.+?)(?=<!---$delimiter)<!---$delimiter--->")
+ val MatchResult.command
+ get() = groupValues[1]
+ val MatchResult.label
+ get() = groupValues[2]
+ fun Appendable.templateCommand(command: GfmCommand, content: Appendable.() -> Unit): Unit {
+ append("<!---$delimiter GfmCommand ${toJsonString(command)}$delimiter--->")
+ content()
+ append("<!---$delimiter--->")
+ }
}
}
-class ResolveLinkGfmCommand(val dri: DRI): GfmCommand()
+class ResolveLinkGfmCommand(val dri: DRI) : GfmCommand()
diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/location/MarkdownLocationProvider.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/location/MarkdownLocationProvider.kt
index 6f96dbd5..bd789464 100644
--- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/location/MarkdownLocationProvider.kt
+++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/location/MarkdownLocationProvider.kt
@@ -5,12 +5,14 @@ import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
import org.jetbrains.dokka.pages.RootPageNode
import org.jetbrains.dokka.plugability.DokkaContext
-class MarkdownLocationProviderFactory(val context: DokkaContext) : LocationProviderFactory {
- override fun getLocationProvider(pageNode: RootPageNode) = MarkdownLocationProvider(pageNode, context)
-}
-
class MarkdownLocationProvider(
pageGraphRoot: RootPageNode,
dokkaContext: DokkaContext
-) : DokkaLocationProvider(pageGraphRoot, dokkaContext, ".md")
+) : DokkaLocationProvider(pageGraphRoot, dokkaContext, ".md") {
+
+ class Factory(private val context: DokkaContext) : LocationProviderFactory {
+ override fun getLocationProvider(pageNode: RootPageNode) =
+ MarkdownLocationProvider(pageNode, context)
+ }
+}
diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/renderer/CommonmarkRenderer.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/renderer/CommonmarkRenderer.kt
index 25b24f0c..9fb92272 100644
--- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/renderer/CommonmarkRenderer.kt
+++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/renderer/CommonmarkRenderer.kt
@@ -18,6 +18,8 @@ open class CommonmarkRenderer(
override val preprocessors = context.plugin<GfmPlugin>().query { gfmPreprocessors }
+ private val isPartial = context.configuration.delayTemplateSubstitution
+
override fun StringBuilder.wrapGroup(
node: ContentGroup,
pageContext: ContentPage,
@@ -87,10 +89,15 @@ open class CommonmarkRenderer(
pageContext: ContentPage,
sourceSetRestriction: Set<DisplaySourceSet>?
) {
- val address = locationProvider.resolve(node.address, node.sourceSets, pageContext)
- buildLink(address ?: templateCommand(ResolveLinkGfmCommand(node.address))) {
- buildText(node.children, pageContext, sourceSetRestriction)
- }
+ locationProvider.resolve(node.address, node.sourceSets, pageContext)?.let {
+ buildLink(it) {
+ buildText(node.children, pageContext, sourceSetRestriction)
+ }
+ } ?: if (isPartial) {
+ templateCommand(ResolveLinkGfmCommand(node.address)) {
+ buildText(node.children, pageContext, sourceSetRestriction)
+ }
+ } else Unit
}
override fun StringBuilder.buildNewLine() {
diff --git a/plugins/gfm/src/test/kotlin/renderers/gfm/GfmRenderingOnlyTestBase.kt b/plugins/gfm/src/test/kotlin/renderers/gfm/GfmRenderingOnlyTestBase.kt
index 165aef98..1fa78423 100644
--- a/plugins/gfm/src/test/kotlin/renderers/gfm/GfmRenderingOnlyTestBase.kt
+++ b/plugins/gfm/src/test/kotlin/renderers/gfm/GfmRenderingOnlyTestBase.kt
@@ -1,13 +1,13 @@
package renderers.gfm
import org.jetbrains.dokka.DokkaConfigurationImpl
-import org.jetbrains.dokka.gfm.GfmPlugin
-import org.jetbrains.dokka.gfm.location.MarkdownLocationProviderFactory
-import org.jetbrains.dokka.testApi.context.MockContext
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.renderers.RootCreator
import org.jetbrains.dokka.base.resolvers.external.DefaultExternalLocationProviderFactory
import org.jetbrains.dokka.base.resolvers.external.javadoc.JavadocExternalLocationProviderFactory
+import org.jetbrains.dokka.gfm.GfmPlugin
+import org.jetbrains.dokka.gfm.location.MarkdownLocationProvider
+import org.jetbrains.dokka.testApi.context.MockContext
import renderers.RenderingOnlyTestBase
import utils.TestOutputWriter
@@ -15,11 +15,11 @@ abstract class GfmRenderingOnlyTestBase : RenderingOnlyTestBase<String>() {
val files = TestOutputWriter()
override val context = MockContext(
- DokkaBase().outputWriter to { _ -> files },
- DokkaBase().locationProviderFactory to ::MarkdownLocationProviderFactory,
- DokkaBase().externalLocationProviderFactory to { ::JavadocExternalLocationProviderFactory },
- DokkaBase().externalLocationProviderFactory to { ::DefaultExternalLocationProviderFactory },
- GfmPlugin().gfmPreprocessors to { _ -> RootCreator },
+ DokkaBase().outputWriter to { files },
+ DokkaBase().locationProviderFactory to MarkdownLocationProvider::Factory,
+ DokkaBase().externalLocationProviderFactory to ::JavadocExternalLocationProviderFactory,
+ DokkaBase().externalLocationProviderFactory to ::DefaultExternalLocationProviderFactory,
+ GfmPlugin().gfmPreprocessors to { RootCreator },
testConfiguration = DokkaConfigurationImpl(moduleName = "root")
)
diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/location/JavadocLocationProvider.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/location/JavadocLocationProvider.kt
index b9828e9b..440bfc2f 100644
--- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/location/JavadocLocationProvider.kt
+++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/location/JavadocLocationProvider.kt
@@ -13,7 +13,7 @@ import org.jetbrains.dokka.plugability.DokkaContext
import java.util.*
class JavadocLocationProvider(pageRoot: RootPageNode, dokkaContext: DokkaContext) :
- DefaultLocationProvider(pageRoot, dokkaContext, ".html") {
+ DefaultLocationProvider(pageRoot, dokkaContext) {
private val pathIndex = IdentityHashMap<PageNode, List<String>>().apply {
fun registerPath(page: PageNode, prefix: List<String> = emptyList()) {