package org.jetbrains.dokka

import java.io.File

/**
 * Represents locations in the documentation in the form of [path](File).
 *
 * Locations are provided by [LocationService.location] function.
 *
 * $file: [File] for this location
 * $path: [String] representing path of this location
 */
public data class Location(val file: File) {
    public val path : String
        get() = file.path
}

/**
 * Provides means of retrieving locations for [DocumentationNode](documentation nodes)
 *
 * `LocationService` determines where documentation for particular node should be generated
 *
 * * [FoldersLocationService] – represent packages and types as folders, members as files in those folders.
 * * [SingleFolderLocationService] – all documentation is generated into single folder using fully qualified names
 * for file names.
 */
public trait LocationService {
    /**
     * Calculates location for particular node in output structure
     */
    fun location(node: DocumentationNode): Location
}


public fun identifierToFilename(path: String): String {
    val escaped = path.replace('<', '-').replace('>', '-')
    val lowercase = escaped.replaceAll("[A-Z]") { matchResult -> "-" + matchResult.group().toLowerCase() }
    return if (lowercase == "index") "--index--" else lowercase
}

/**
 * Returns relative location between two nodes. Used for relative links in documentation.
 */
fun LocationService.relativeLocation(owner: DocumentationNode, node: DocumentationNode, extension: String): Location {
    return relativeLocation(location(owner), node, extension)
}

/**
 * Returns relative location between base location and a node. Used for relative links in documentation.
 */
fun LocationService.relativeLocation(owner: Location, node: DocumentationNode, extension: String): Location {
    val ownerFolder = owner.file.getParentFile()!!
    val memberPath = location(node).file.appendExtension(extension)
    return Location(ownerFolder.getRelativePath(memberPath))
}