diff options
author | Andrzej Ratajczak <andrzej.ratajczak98@gmail.com> | 2020-04-08 13:10:28 +0200 |
---|---|---|
committer | BarkingBad <32793002+BarkingBad@users.noreply.github.com> | 2020-04-22 10:37:59 +0200 |
commit | a5557f43c004d34026807d2d25b39fe1144bae94 (patch) | |
tree | cc65cf97e9d6b2ead623cab6a0f6da196ddf6f9c /core | |
parent | acc2670f6d641880325bb9826a202486a9410c24 (diff) | |
download | dokka-a5557f43c004d34026807d2d25b39fe1144bae94.tar.gz dokka-a5557f43c004d34026807d2d25b39fe1144bae94.tar.bz2 dokka-a5557f43c004d34026807d2d25b39fe1144bae94.zip |
Refactors sources to documentables translation
Diffstat (limited to 'core')
6 files changed, 26 insertions, 72 deletions
diff --git a/core/src/main/kotlin/CoreExtensions.kt b/core/src/main/kotlin/CoreExtensions.kt index d7b0b285..7b4c9baa 100644 --- a/core/src/main/kotlin/CoreExtensions.kt +++ b/core/src/main/kotlin/CoreExtensions.kt @@ -2,18 +2,16 @@ package org.jetbrains.dokka import org.jetbrains.dokka.plugability.ExtensionPoint import org.jetbrains.dokka.renderers.Renderer -import org.jetbrains.dokka.transformers.descriptors.DescriptorToDocumentableTranslator import org.jetbrains.dokka.transformers.documentation.DocumentableMerger import org.jetbrains.dokka.transformers.documentation.DocumentableToPageTranslator import org.jetbrains.dokka.transformers.documentation.DocumentableTransformer import org.jetbrains.dokka.transformers.documentation.PreMergeDocumentableTransformer import org.jetbrains.dokka.transformers.pages.PageTransformer -import org.jetbrains.dokka.transformers.psi.PsiToDocumentableTranslator +import org.jetbrains.dokka.transformers.sources.SourceToDocumentableTranslator import kotlin.reflect.KProperty object CoreExtensions { - val descriptorToDocumentableTranslator by coreExtension<DescriptorToDocumentableTranslator>() - val psiToDocumentableTranslator by coreExtension<PsiToDocumentableTranslator>() + val sourceToDocumentableTranslator by coreExtension<SourceToDocumentableTranslator>() val preMergeDocumentableTransformer by coreExtension<PreMergeDocumentableTransformer>() val documentableMerger by coreExtension<DocumentableMerger>() val documentableTransformer by coreExtension<DocumentableTransformer>() diff --git a/core/src/main/kotlin/DokkaGenerator.kt b/core/src/main/kotlin/DokkaGenerator.kt index 9616b013..053b4cb6 100644 --- a/core/src/main/kotlin/DokkaGenerator.kt +++ b/core/src/main/kotlin/DokkaGenerator.kt @@ -77,8 +77,7 @@ class DokkaGenerator( fun createDocumentationModels( platforms: Map<PlatformData, EnvironmentAndFacade>, context: DokkaContext - ) = platforms.map { (pdata, _) -> translateDescriptors(pdata, context) } + - platforms.map { (pdata, _) -> translatePsi(pdata, context) } + ) = platforms.flatMap { (pdata, _) -> translateSources(pdata, context) } fun transformDocumentationModelBeforeMerge( modulesFromPlatforms: List<DModule>, @@ -129,40 +128,10 @@ class DokkaGenerator( EnvironmentAndFacade(environment, facade) } - private fun translateDescriptors(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 context.single(CoreExtensions.descriptorToDocumentableTranslator) - .invoke(platformData.name, packageFragments, platformData) - } - - private fun translatePsi(platformData: PlatformData, context: DokkaContext): DModule { - val (environment, _) = context.platforms.getValue(platformData) - - val sourceRoots = environment.configuration.get(CLIConfigurationKeys.CONTENT_ROOTS) - ?.filterIsInstance<JavaSourceRoot>() - ?.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() - - return context.single(CoreExtensions.psiToDocumentableTranslator) - .invoke(platformData.name, psiFiles, platformData, context) - - } + private fun translateSources(platformData: PlatformData, context: DokkaContext) = + context[CoreExtensions.sourceToDocumentableTranslator].map { + it.invoke(platformData, context) + } class DokkaMessageCollector(private val logger: DokkaLogger) : MessageCollector { override fun clear() { diff --git a/core/src/main/kotlin/model/Documentable.kt b/core/src/main/kotlin/model/Documentable.kt index f91383de..2155b00d 100644 --- a/core/src/main/kotlin/model/Documentable.kt +++ b/core/src/main/kotlin/model/Documentable.kt @@ -7,6 +7,7 @@ import org.jetbrains.dokka.model.properties.PropertyContainer import org.jetbrains.dokka.model.properties.WithExtraProperties import org.jetbrains.dokka.pages.PlatformData import org.jetbrains.kotlin.descriptors.DeclarationDescriptor +import org.jetbrains.kotlin.descriptors.PackageFragmentDescriptor import org.jetbrains.kotlin.load.kotlin.toSourceElement abstract class Documentable { @@ -418,9 +419,14 @@ sealed class JavaVisibility(name: String) : Visibility(name) { fun <T> PlatformDependent<T>?.orEmpty(): PlatformDependent<T> = this ?: PlatformDependent.empty() -sealed class DocumentableSource(val path: String) +interface DocumentableSource { + val path: String +} -class DescriptorDocumentableSource(val descriptor: DeclarationDescriptor) : - DocumentableSource(descriptor.toSourceElement.containingFile.toString()) +class DescriptorDocumentableSource(source: DeclarationDescriptor) : DocumentableSource { + override val path = source.toSourceElement.containingFile.toString() +} -class PsiDocumentableSource(val psi: PsiNamedElement) : DocumentableSource(psi.containingFile.virtualFile.path) +class PsiDocumentableSource(source: PsiNamedElement) : DocumentableSource { + override val path = source.containingFile.virtualFile.path +} diff --git a/core/src/main/kotlin/transformers/descriptors/DescriptorToDocumentableTranslator.kt b/core/src/main/kotlin/transformers/descriptors/DescriptorToDocumentableTranslator.kt deleted file mode 100644 index ca66b90a..00000000 --- a/core/src/main/kotlin/transformers/descriptors/DescriptorToDocumentableTranslator.kt +++ /dev/null @@ -1,13 +0,0 @@ -package org.jetbrains.dokka.transformers.descriptors - -import org.jetbrains.dokka.model.DModule -import org.jetbrains.dokka.pages.PlatformData -import org.jetbrains.kotlin.descriptors.PackageFragmentDescriptor - -interface DescriptorToDocumentableTranslator { - fun invoke( - moduleName: String, - packageFragments: Iterable<PackageFragmentDescriptor>, - platformData: PlatformData - ): DModule -}
\ No newline at end of file diff --git a/core/src/main/kotlin/transformers/psi/PsiToDocumentableTranslator.kt b/core/src/main/kotlin/transformers/psi/PsiToDocumentableTranslator.kt deleted file mode 100644 index 6f5025bd..00000000 --- a/core/src/main/kotlin/transformers/psi/PsiToDocumentableTranslator.kt +++ /dev/null @@ -1,15 +0,0 @@ -package org.jetbrains.dokka.transformers.psi - -import com.intellij.psi.PsiJavaFile -import org.jetbrains.dokka.model.DModule -import org.jetbrains.dokka.pages.PlatformData -import org.jetbrains.dokka.plugability.DokkaContext - -interface PsiToDocumentableTranslator { - fun invoke( - moduleName: String, - psiFiles: List<PsiJavaFile>, - platformData: PlatformData, - context: DokkaContext - ): DModule -} diff --git a/core/src/main/kotlin/transformers/sources/SourceToDocumentableTranslator.kt b/core/src/main/kotlin/transformers/sources/SourceToDocumentableTranslator.kt new file mode 100644 index 00000000..a138b3e2 --- /dev/null +++ b/core/src/main/kotlin/transformers/sources/SourceToDocumentableTranslator.kt @@ -0,0 +1,9 @@ +package org.jetbrains.dokka.transformers.sources + +import org.jetbrains.dokka.model.DModule +import org.jetbrains.dokka.pages.PlatformData +import org.jetbrains.dokka.plugability.DokkaContext + +interface SourceToDocumentableTranslator { + fun invoke(platformData: PlatformData, context: DokkaContext): DModule +}
\ No newline at end of file |