aboutsummaryrefslogtreecommitdiff
path: root/plugins/all-modules-page/src/main/kotlin/MultimoduleLocationProvider.kt
blob: b0fa13d0349b3d9dda635831f38482565020cd45 (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
/*
 * 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.allModulesPage.MultimodulePageCreator.Companion.MULTIMODULE_PACKAGE_PLACEHOLDER
import org.jetbrains.dokka.base.resolvers.local.DokkaBaseLocationProvider
import org.jetbrains.dokka.base.resolvers.local.LocationProvider
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.ContentPage
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

public open class MultimoduleLocationProvider(
    private val root: RootPageNode, dokkaContext: DokkaContext,
    public val extension: String = ".html"
) : 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?): String? {
        return if (dri == MultimodulePageCreator.MULTIMODULE_ROOT_DRI) {
            pathToRoot(root) + "index"
        } else {
            dri.takeIf { it.packageName == MULTIMODULE_PACKAGE_PLACEHOLDER }
                ?.classNames
                ?.let(externalModuleLinkResolver::resolveLinkToModuleIndex)
        }
    }

    override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean): String? {
        return if (node is ContentPage && MultimodulePageCreator.MULTIMODULE_ROOT_DRI in node.dri) {
            pathToRoot(root) + "index" + if (!skipExtension) extension else ""
        } else {
            defaultLocationProvider.resolve(node, context, skipExtension)
        }
    }

    override fun pathToRoot(from: PageNode): String = defaultLocationProvider.pathToRoot(from)

    override fun ancestors(node: PageNode): List<PageNode> = listOf(root)

    public class Factory(
        private val context: DokkaContext
    ) : LocationProviderFactory {
        override fun getLocationProvider(pageNode: RootPageNode): LocationProvider =
            MultimoduleLocationProvider(pageNode, context)
    }
}