/* * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. */ package org.jetbrains.dokka.base.renderers import org.jetbrains.dokka.base.DokkaBase import org.jetbrains.dokka.base.resolvers.shared.LinkFormat import org.jetbrains.dokka.base.resolvers.shared.PackageList.Companion.DOKKA_PARAM_PREFIX import org.jetbrains.dokka.base.resolvers.shared.PackageList.Companion.MODULE_DELIMITER import org.jetbrains.dokka.base.resolvers.shared.PackageList.Companion.SINGLE_MODULE_NAME import org.jetbrains.dokka.links.DRI import org.jetbrains.dokka.pages.* import org.jetbrains.dokka.plugability.DokkaContext import org.jetbrains.dokka.plugability.plugin import org.jetbrains.dokka.plugability.querySingle public class PackageListService( public val context: DokkaContext, public val rootPage: RootPageNode ) { public fun createPackageList(module: ModulePage, format: LinkFormat): String { val packages = mutableSetOf() val nonStandardLocations = mutableMapOf() val locationProvider = context.plugin().querySingle { locationProviderFactory }.getLocationProvider(rootPage) fun visit(node: PageNode) { if (node is PackagePage) { node.name .takeUnless { name -> name.startsWith("[") && name.endsWith("]") } // Do not include the package name for declarations without one ?.let { packages.add(it) } } val contentPage = node as? ContentPage contentPage?.dri?.forEach { dri -> val nodeLocation = locationProvider.resolve(node, context = module, skipExtension = true) ?: run { context.logger.error("Cannot resolve path for ${node.name}!"); null } if (dri != DRI.topLevel && locationProvider.expectedLocationForDri(dri) != nodeLocation) { nonStandardLocations[dri.toString()] = "$nodeLocation.${format.linkExtension}" } } node.children.forEach { visit(it) } } visit(module) return renderPackageList( nonStandardLocations = nonStandardLocations, modules = mapOf(SINGLE_MODULE_NAME to packages), format = format.formatName, linkExtension = format.linkExtension ) } public companion object { public fun renderPackageList( nonStandardLocations: Map, modules: Map>, format: String, linkExtension: String ): String = buildString { 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") modules.mapNotNull { (module, packages) -> ("$MODULE_DELIMITER$module\n".takeIf { module != SINGLE_MODULE_NAME }.orEmpty() + packages.filter(String::isNotBlank).sorted().joinToString(separator = "\n")) .takeIf { packages.isNotEmpty() } }.joinTo(this, separator = "\n", postfix = "\n") } } }