diff options
author | Błażej Kardyś <bkardys@virtuslab.com> | 2019-11-29 03:28:17 +0100 |
---|---|---|
committer | Błażej Kardyś <bkardys@virtuslab.com> | 2019-12-05 16:15:47 +0100 |
commit | ac521e75eadb384e005d73ec5818e01b742cbe19 (patch) | |
tree | ef147f96b8fa550fa763d972b5534edbf2417ee7 /core/src/main/kotlin/resolvers/DefaultLocationProvider.kt | |
parent | cf97771a0805b62532cda2cdf3bfebeed21652ab (diff) | |
download | dokka-ac521e75eadb384e005d73ec5818e01b742cbe19.tar.gz dokka-ac521e75eadb384e005d73ec5818e01b742cbe19.tar.bz2 dokka-ac521e75eadb384e005d73ec5818e01b742cbe19.zip |
Parentless page navigation
Diffstat (limited to 'core/src/main/kotlin/resolvers/DefaultLocationProvider.kt')
-rw-r--r-- | core/src/main/kotlin/resolvers/DefaultLocationProvider.kt | 44 |
1 files changed, 29 insertions, 15 deletions
diff --git a/core/src/main/kotlin/resolvers/DefaultLocationProvider.kt b/core/src/main/kotlin/resolvers/DefaultLocationProvider.kt index 5139b3c1..fb9ac6cd 100644 --- a/core/src/main/kotlin/resolvers/DefaultLocationProvider.kt +++ b/core/src/main/kotlin/resolvers/DefaultLocationProvider.kt @@ -9,10 +9,10 @@ import org.jetbrains.dokka.plugability.DokkaContext import org.jetbrains.dokka.plugability.single open class DefaultLocationProvider( - private val pageGraphRoot: PageNode, + private val pageGraphRoot: ModulePageNode, private val configuration: DokkaConfiguration, context: DokkaContext -): LocationProvider { // TODO: cache +) : LocationProvider { // TODO: cache private val extension = context.single(CoreExtensions.fileExtension) override fun resolve(node: PageNode, context: PageNode?): String = pathTo(node, context) + extension @@ -22,14 +22,25 @@ open class DefaultLocationProvider( // Not found in PageGraph, that means it's an external link ExternalLocationProvider.getLocation(dri, configuration.passesConfigurations - .filter { passConfig -> platforms.toSet().contains(PlatformData(passConfig.analysisPlatform, passConfig.targets)) } // TODO: change targets to something better? - .flatMap { it.externalDocumentationLinks }.distinct() + .filter { passConfig -> + platforms.toSet().contains(PlatformData(passConfig.analysisPlatform, passConfig.targets)) + } // TODO: change targets to something better? + .flatMap { it.externalDocumentationLinks }.distinct() ) override fun resolveRoot(node: PageNode): String = "../${pathTo(pageGraphRoot, node).removeSuffix( - PAGE_WITH_CHILDREN_SUFFIX)}" + PAGE_WITH_CHILDREN_SUFFIX + )}" - protected open fun findInPageGraph(dri: DRI, platforms: List<PlatformData>): PageNode? = pageGraphRoot.dfs { it.dri == dri } + private fun PageNode.parent() = pageGraphRoot.parentMap[this] + + override fun ancestors(node: PageNode?): List<PageNode> = when (node) { + null -> emptyList() + else -> ancestors(node.parent()) + node + } + + protected open fun findInPageGraph(dri: DRI, platforms: List<PlatformData>): PageNode? = + pageGraphRoot.dfs { it.dri == dri } protected open fun pathTo(node: PageNode, context: PageNode?): String { @@ -37,20 +48,20 @@ open class DefaultLocationProvider( if (this is PackagePageNode) name else identifierToFilename(name) - fun getPath(pathNode: PageNode?, path: List<String> = mutableListOf()): List<String> = when(pathNode) { + fun getPath(pathNode: PageNode?, path: List<String> = mutableListOf()): List<String> = when (pathNode) { null -> path pageGraphRoot -> path + "root" - else -> getPath(pathNode.parent, path + pathNode.pathName()) + else -> getPath(pathNode.parent(), path + pathNode.pathName()) } - val contextNode = if (context?.children?.isEmpty() == true) context.parent else context + val contextNode = if (context?.children?.isEmpty() == true) context.parent() else context val nodePath = getPath(node).reversed() val contextPath = getPath(contextNode).reversed() val commonPathElements = nodePath.zip(contextPath).takeWhile { (a, b) -> a == b }.size - return ( List(contextPath.size - commonPathElements) { ".." } + nodePath.drop(commonPathElements) + - if(node.children.isNotEmpty()) listOf(PAGE_WITH_CHILDREN_SUFFIX) else emptyList()).joinToString("/") + return (List(contextPath.size - commonPathElements) { ".." } + nodePath.drop(commonPathElements) + + if (node.children.isNotEmpty()) listOf(PAGE_WITH_CHILDREN_SUFFIX) else emptyList()).joinToString("/") } private companion object { @@ -63,7 +74,7 @@ fun DRI.toJavadocLocation(jdkVersion: Int): String { // TODO: classes without pa if (classNames == null) { return "$packageLink/package-summary.html".htmlEscape() } - val classLink = if (packageLink == null) { "$classNames.html" } else { "$packageLink/$classNames.html" } + val classLink = if (packageLink == null) "$classNames.html" else "$packageLink/$classNames.html" if (callable == null) { return classLink.htmlEscape() } @@ -81,8 +92,11 @@ fun DRI.toDokkaLocation(extension: String): String { // TODO: classes without pa if (classNames == null) { return "$packageName/index$extension" } - val classLink = if (packageName == null) { "" } else { "$packageName/" } + - classNames.split('.').joinToString("/", transform = ::identifierToFilename) + val classLink = if (packageName == null) { + "" + } else { + "$packageName/" + } + classNames.split('.').joinToString("/", transform = ::identifierToFilename) if (callable == null) { return "$classLink/index$extension" @@ -98,4 +112,4 @@ private fun identifierToFilename(name: String): String { val escaped = name.replace('<', '-').replace('>', '-') val lowercase = escaped.replace("[A-Z]".toRegex()) { matchResult -> "-" + matchResult.value.toLowerCase() } return if (lowercase in reservedFilenames) "--$lowercase--" else lowercase -} +}
\ No newline at end of file |