package org.jetbrains.dokka.resolvers import org.jetbrains.dokka.DokkaConfiguration import org.jetbrains.dokka.htmlEscape import org.jetbrains.dokka.links.DRI import org.jetbrains.dokka.pages.* open class DefaultLocationProvider(private val pageGraphRoot: PageNode, val configuration: DokkaConfiguration, val extension: String): LocationProvider { // TODO: cache override fun resolve(node: PageNode, context: PageNode?): String = pathTo(node, context) + extension override fun resolve(dri: DRI, platforms: List, context: PageNode?): String { findInPageGraph(dri, platforms)?.let { return resolve(it, context) } // Not found in PageGraph, that means it's an external link val externalDocs = configuration.passesConfigurations .filter { passConfig -> passConfig.targets.toSet() == platforms.toSet() } // TODO: change targets to something better? .flatMap { it.externalDocumentationLinks }.map { it.packageListUrl }.distinct() return ExternalLocationProvider.getLocation(dri, externalDocs) } protected open fun findInPageGraph(dri: DRI, platforms: List): PageNode? = pageGraphRoot.dfs { it.dri == dri } protected open fun pathTo(node: PageNode, context: PageNode?): String { // TODO: can be refactored probably, also we should think about root fun parentPath(node: PageNode?): String { if (node == null) return "" val parts = node.parent?.let(::parentPath) ?: "" return if(node is PackagePageNode) { "$parts${node.name}/" } else if (parts.isNotBlank()) { "$parts${identifierToFilename(node.name)}/" } else { identifierToFilename(node.name) + "/" } } val resolved = parentPath(node.parent) + identifierToFilename(node.name) + if (node.children.isEmpty()) { "" } else { "/index" } return context?.let { resolved.replace(pathTo(it, null).dropLastWhile { it != '/' }, "") } ?: resolved } } fun DRI.toJavadocLocation(jdkVersion: Int): String { // TODO: classes without packages? val packageLink = packageName?.replace(".", "/") if (classNames == null) { return "$packageLink/package-summary.html".htmlEscape() } val classLink = if (packageLink == null) { "$classNames.html" } else { "$packageLink/$classNames.html" } if (callable == null) { return classLink.htmlEscape() } val callableLink = "$classLink#${callable.name}" + when { jdkVersion < 8 -> "(${callable.params.joinToString(", ")})" jdkVersion < 10 -> "-${callable.params.joinToString("-")}-" else -> "(${callable.params.joinToString(",")})" } return callableLink.htmlEscape() } fun DRI.toDokkaLocation(extension: String): String { // TODO: classes without packages? if (classNames == null) { return "$packageName/index$extension" } val classLink = if (packageName == null) { "" } else { "$packageName/" } + classNames.split('.').joinToString("/", transform = ::identifierToFilename) if (callable == null) { return "$classLink/index$extension" } return "$classLink/${identifierToFilename(callable.name)}$extension" } private val reservedFilenames = setOf("index", "con", "aux", "lst", "prn", "nul", "eof", "inp", "out") private fun identifierToFilename(name: String): String { if (name.isEmpty()) return "--root--" val escaped = name.replace('<', '-').replace('>', '-') val lowercase = escaped.replace("[A-Z]".toRegex()) { matchResult -> "-" + matchResult.value.toLowerCase() } return if (lowercase in reservedFilenames) "--$lowercase--" else lowercase }