From a5557f43c004d34026807d2d25b39fe1144bae94 Mon Sep 17 00:00:00 2001 From: Andrzej Ratajczak Date: Wed, 8 Apr 2020 13:10:28 +0200 Subject: Refactors sources to documentables translation --- plugins/base/src/main/kotlin/DokkaBase.kt | 9 ++--- .../DefaultDescriptorToDocumentableTranslator.kt | 37 +++++++++++--------- .../psi/DefaultPsiToDocumentableTranslator.kt | 40 +++++++++++++++------- 3 files changed, 54 insertions(+), 32 deletions(-) (limited to 'plugins/base/src') diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt index 5a86780b..50d86892 100644 --- a/plugins/base/src/main/kotlin/DokkaBase.kt +++ b/plugins/base/src/main/kotlin/DokkaBase.kt @@ -28,6 +28,7 @@ import org.jetbrains.dokka.base.translators.documentables.DefaultDocumentableToP import org.jetbrains.dokka.base.translators.psi.DefaultPsiToDocumentableTranslator import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.kotlin.descriptors.PackageFragmentDescriptor class DokkaBase : DokkaPlugin() { val pageMergerStrategy by extensionPoint() @@ -39,12 +40,12 @@ class DokkaBase : DokkaPlugin() { val htmlPreprocessors by extensionPoint() val samplesTransformer by extensionPoint() - val descriptorToDocumentableTranslator by extending(isFallback = true) { - CoreExtensions.descriptorToDocumentableTranslator providing ::DefaultDescriptorToDocumentableTranslator + val descriptorToDocumentableTranslator by extending { + CoreExtensions.sourceToDocumentableTranslator with DefaultDescriptorToDocumentableTranslator } - val psiToDocumentableTranslator by extending(isFallback = true) { - CoreExtensions.psiToDocumentableTranslator with DefaultPsiToDocumentableTranslator + val psiToDocumentableTranslator by extending { + CoreExtensions.sourceToDocumentableTranslator with DefaultPsiToDocumentableTranslator } val documentableMerger by extending(isFallback = true) { diff --git a/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt b/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt index 25e6f6ac..678ac0ec 100644 --- a/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt +++ b/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt @@ -10,8 +10,8 @@ import org.jetbrains.dokka.model.properties.PropertyContainer import org.jetbrains.dokka.pages.PlatformData import org.jetbrains.dokka.parsers.MarkdownParser import org.jetbrains.dokka.plugability.DokkaContext -import org.jetbrains.dokka.transformers.descriptors.DescriptorToDocumentableTranslator import org.jetbrains.dokka.utilities.DokkaLogger +import org.jetbrains.dokka.transformers.sources.SourceToDocumentableTranslator import org.jetbrains.kotlin.builtins.isExtensionFunctionType import org.jetbrains.kotlin.builtins.isFunctionType import org.jetbrains.kotlin.codegen.isJvmStaticInObjectOrClassOrInterface @@ -33,23 +33,28 @@ import org.jetbrains.kotlin.resolve.scopes.MemberScope import org.jetbrains.kotlin.resolve.source.KotlinSourceElement import org.jetbrains.kotlin.types.KotlinType import org.jetbrains.kotlin.types.TypeProjection +import org.jetbrains.kotlin.utils.addToStdlib.safeAs -class DefaultDescriptorToDocumentableTranslator( - private val context: DokkaContext -) : DescriptorToDocumentableTranslator { - override fun invoke( - moduleName: String, - packageFragments: Iterable, - platformData: PlatformData - ) = DokkaDescriptorVisitor(platformData, context.platforms.getValue(platformData).facade, context.logger).run { - packageFragments.map { - visitPackageFragmentDescriptor( - it, - DRIWithPlatformInfo(DRI.topLevel, PlatformDependent.empty()) - ) - } - }.let { DModule(moduleName, it, PlatformDependent.empty(), listOf(platformData)) } +object DefaultDescriptorToDocumentableTranslator : SourceToDocumentableTranslator { + + override fun invoke(platformData: PlatformData, context: DokkaContext): DModule { + + val (environment, facade) = context.platforms.getValue(platformData) + val packageFragments = environment.getSourceFiles().asSequence() + .map { it.packageFqName } + .distinct() + .mapNotNull { facade.resolveSession.getPackageFragment(it) } + .toList() + return DokkaDescriptorVisitor(platformData, context.platforms.getValue(platformData).facade, context.logger).run { + packageFragments.mapNotNull { it.safeAs() }.map { + visitPackageFragmentDescriptor( + it, + DRIWithPlatformInfo(DRI.topLevel, PlatformDependent.empty()) + ) + } + }.let { DModule(platformData.name, it, PlatformDependent.empty(), listOf(platformData)) } + } } data class DRIWithPlatformInfo( diff --git a/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt b/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt index 33100e3e..c0e1b4af 100644 --- a/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt +++ b/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt @@ -2,6 +2,7 @@ package org.jetbrains.dokka.base.translators.psi import com.intellij.lang.jvm.JvmModifier import com.intellij.lang.jvm.types.JvmReferenceType +import com.intellij.openapi.vfs.VirtualFileManager import com.intellij.psi.* import com.intellij.psi.impl.source.PsiClassReferenceType import org.jetbrains.dokka.links.DRI @@ -10,8 +11,10 @@ import org.jetbrains.dokka.model.* import org.jetbrains.dokka.model.properties.PropertyContainer import org.jetbrains.dokka.pages.PlatformData import org.jetbrains.dokka.plugability.DokkaContext -import org.jetbrains.dokka.transformers.psi.PsiToDocumentableTranslator +import org.jetbrains.dokka.transformers.sources.SourceToDocumentableTranslator import org.jetbrains.dokka.utilities.DokkaLogger +import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys +import org.jetbrains.kotlin.cli.jvm.config.JavaSourceRoot import org.jetbrains.kotlin.descriptors.Visibilities import org.jetbrains.kotlin.load.java.JvmAbi import org.jetbrains.kotlin.load.java.propertyNameByGetMethodName @@ -19,30 +22,43 @@ import org.jetbrains.kotlin.load.java.propertyNamesBySetMethodName import org.jetbrains.kotlin.name.Name import org.jetbrains.kotlin.psi.psiUtil.getChildOfType import org.jetbrains.kotlin.resolve.DescriptorUtils +import org.jetbrains.kotlin.utils.addToStdlib.safeAs -object DefaultPsiToDocumentableTranslator : PsiToDocumentableTranslator { +object DefaultPsiToDocumentableTranslator : SourceToDocumentableTranslator { + + override fun invoke(platformData: PlatformData, context: DokkaContext): DModule { + + val (environment, _) = context.platforms.getValue(platformData) + + val sourceRoots = environment.configuration.get(CLIConfigurationKeys.CONTENT_ROOTS) + ?.filterIsInstance() + ?.map { it.file } + ?: listOf() + val localFileSystem = VirtualFileManager.getInstance().getFileSystem("file") + + val psiFiles = sourceRoots.map { sourceRoot -> + sourceRoot.absoluteFile.walkTopDown().mapNotNull { + localFileSystem.findFileByPath(it.path)?.let { vFile -> + PsiManager.getInstance(environment.project).findFile(vFile) as? PsiJavaFile + } + }.toList() + }.flatten() - override fun invoke( - moduleName: String, - psiFiles: List, - platformData: PlatformData, - context: DokkaContext - ): DModule { val docParser = DokkaPsiParser( platformData, context.logger ) return DModule( - moduleName, - psiFiles.groupBy { it.packageName }.map { (packageName, psiFiles) -> + platformData.name, + psiFiles.mapNotNull { it.safeAs() }.groupBy { it.packageName }.map { (packageName, psiFiles) -> val dri = DRI(packageName = packageName) DPackage( dri, emptyList(), emptyList(), - psiFiles.flatMap { psFile -> - psFile.classes.map { docParser.parseClasslike(it, dri) } + psiFiles.flatMap { psiFile -> + psiFile.classes.map { docParser.parseClasslike(it, dri) } }, emptyList(), PlatformDependent.empty(), -- cgit