path: root/core/src/main/kotlin/Kotlin/DocumentationBuilder.kt

package org.jetbrains.dokka

import com.google.inject.Inject
import com.intellij.openapi.util.text.StringUtil
import com.intellij.psi.PsiJavaFile
import org.jetbrains.dokka.DokkaConfiguration.*
import org.jetbrains.dokka.Kotlin.DescriptorDocumentationParser
import org.jetbrains.kotlin.builtins.KotlinBuiltIns
import org.jetbrains.kotlin.descriptors.*
import org.jetbrains.kotlin.descriptors.annotations.Annotated
import org.jetbrains.kotlin.descriptors.annotations.AnnotationDescriptor
import org.jetbrains.kotlin.descriptors.impl.EnumEntrySyntheticClassDescriptor
import org.jetbrains.kotlin.idea.kdoc.findKDoc
import org.jetbrains.kotlin.idea.util.fuzzyExtensionReceiverType
import org.jetbrains.kotlin.idea.util.makeNotNullable
import org.jetbrains.kotlin.idea.util.toFuzzyType
import org.jetbrains.kotlin.js.resolve.diagnostics.findPsi
import org.jetbrains.kotlin.kdoc.psi.impl.KDocSection
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.name.ClassId
import org.jetbrains.kotlin.name.FqName
import org.jetbrains.kotlin.name.Name
import org.jetbrains.kotlin.psi.KtModifierListOwner
import org.jetbrains.kotlin.psi.KtParameter
import org.jetbrains.kotlin.psi.addRemoveModifier.MODIFIERS_ORDER
import org.jetbrains.kotlin.resolve.DescriptorUtils
import org.jetbrains.kotlin.resolve.constants.ConstantValue
import org.jetbrains.kotlin.resolve.descriptorUtil.*
import org.jetbrains.kotlin.resolve.findTopMostOverriddenDescriptors
import org.jetbrains.kotlin.resolve.scopes.DescriptorKindFilter
import org.jetbrains.kotlin.resolve.scopes.getDescriptorsFiltered
import org.jetbrains.kotlin.resolve.source.PsiSourceElement
import org.jetbrains.kotlin.resolve.source.getPsi
import org.jetbrains.kotlin.types.*
import org.jetbrains.kotlin.types.typeUtil.supertypes
import org.jetbrains.kotlin.util.supertypesWithAny
import java.io.File
import java.nio.file.Path
import java.nio.file.Paths
import com.google.inject.name.Named as GuiceNamed

class DocumentationOptions(val outputDir: String,
                           val outputFormat: String,
                           includeNonPublic: Boolean = false,
                           val includeRootPackage: Boolean = false,
                           reportUndocumented: Boolean = true,
                           val skipEmptyPackages: Boolean = true,
                           skipDeprecated: Boolean = false,
                           jdkVersion: Int = 6,
                           val generateIndexPages: Boolean = true,
                           val sourceLinks: List<SourceLinkDefinition> = emptyList(),
                           val impliedPlatforms: List<String> = emptyList(),
                           // Sorted by pattern length
                           perPackageOptions: List<PackageOptions> = emptyList(),
                           externalDocumentationLinks: List<ExternalDocumentationLink> = emptyList(),
                           noStdlibLink: Boolean,
                           noJdkLink: Boolean = false,
                           val languageVersion: String?,
                           val apiVersion: String?,
                           cacheRoot: String? = null,
                           val suppressedFiles: Set<File> = emptySet(),
                           val collectInheritedExtensionsFromLibraries: Boolean = false) {
    init {
        if (perPackageOptions.any { it.prefix == "" })
            throw IllegalArgumentException("Please do not register packageOptions with all match pattern, use global settings instead")
    }

    val perPackageOptions = perPackageOptions.sortedByDescending { it.prefix.length }
    val rootPackageOptions = PackageOptionsImpl("", includeNonPublic, reportUndocumented, skipDeprecated)

    fun effectivePackageOptions(pack: String): PackageOptions = perPackageOptions.firstOrNull { pack == it.prefix || pack.startsWith(it.prefix + ".") } ?: rootPackageOptions
    fun effectivePackageOptions(pack: FqName): PackageOptions = effectivePackageOptions(pack.asString())

    val defaultLinks = run {
        val links = mutableListOf<ExternalDocumentationLink>()
        if (!noJdkLink)
            links += ExternalDocumentationLink.Builder("https://docs.oracle.com/javase/$jdkVersion/docs/api/").