aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/main/kotlin/renderers/PackageListService.kt
blob: d433320075a1e7f90c2890c8655e6ff2d18943d0 (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
package org.jetbrains.dokka.base.renderers

import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.links.parent
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.querySingle
import org.jetbrains.kotlin.utils.addToStdlib.safeAs

class PackageListService(val context: DokkaContext) {

    fun formatPackageList(module: RootPageNode, format: String, linkExtension: String): String {

        val packages = mutableSetOf<String>()
        val nonStandardLocations = mutableMapOf<String, String>()

        val locationProvider =
            context.plugin<DokkaBase>().querySingle { locationProviderFactory }.getLocationProvider(module)

        fun visit(node: PageNode, parentDris: Set<DRI>) {

            if (node is PackagePageNode) {
                packages.add(node.name)
            }

            val contentPage = node.safeAs<ContentPage>()
            contentPage?.dri?.forEach {
                if (parentDris.isNotEmpty() && it.parent !in parentDris) {
                    nonStandardLocations[it.toString()] = locationProvider.resolve(node)
                }
            }

            node.children.forEach { visit(it, contentPage?.dri ?: setOf()) }
        }

        visit(module, setOf())

        return buildString {
            appendln("\$dokka.format:${format}")
            appendln("\$dokka.linkExtension:${linkExtension}")
            nonStandardLocations.map { (signature, location) -> "\$dokka.location:$signature\u001f$location" }
                .sorted().joinTo(this, separator = "\n", postfix = "\n")

            packages.sorted().joinTo(this, separator = "\n", postfix = "\n")
        }

    }

}