-
Notifications
You must be signed in to change notification settings - Fork 419
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #111 from Kotlin/website-samples
Tweaked output for kotlin-website samples feature
- Loading branch information
Showing
17 changed files
with
311 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
core/src/main/kotlin/Samples/DefaultSampleProcessingService.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| package org.jetbrains.dokka.Samples | ||
|
|
||
| import com.google.inject.Inject | ||
| import com.intellij.psi.PsiElement | ||
| import org.jetbrains.dokka.* | ||
| import org.jetbrains.kotlin.descriptors.ClassDescriptor | ||
| import org.jetbrains.kotlin.descriptors.DeclarationDescriptor | ||
| import org.jetbrains.kotlin.descriptors.PackageViewDescriptor | ||
| import org.jetbrains.kotlin.idea.kdoc.getKDocLinkResolutionScope | ||
| import org.jetbrains.kotlin.name.FqName | ||
| import org.jetbrains.kotlin.name.Name | ||
| import org.jetbrains.kotlin.psi.KtBlockExpression | ||
| import org.jetbrains.kotlin.psi.KtDeclarationWithBody | ||
| import org.jetbrains.kotlin.psi.KtFile | ||
| import org.jetbrains.kotlin.resolve.DescriptorToSourceUtils | ||
| import org.jetbrains.kotlin.resolve.scopes.DescriptorKindFilter | ||
| import org.jetbrains.kotlin.resolve.scopes.ResolutionScope | ||
|
|
||
|
|
||
| open class DefaultSampleProcessingService | ||
| @Inject constructor(val options: DocumentationOptions, | ||
| val logger: DokkaLogger, | ||
| val resolutionFacade: DokkaResolutionFacade) | ||
| : SampleProcessingService { | ||
|
|
||
| override fun resolveSample(descriptor: DeclarationDescriptor, functionName: String?): ContentNode { | ||
| if (functionName == null) { | ||
| logger.warn("Missing function name in @sample in ${descriptor.signature()}") | ||
| return ContentBlockSampleCode().apply { append(ContentText("//Missing function name in @sample")) } | ||
| } | ||
| val scope = getKDocLinkResolutionScope(resolutionFacade, descriptor) | ||
| val rootPackage = resolutionFacade.moduleDescriptor.getPackage(FqName.ROOT) | ||
| val rootScope = rootPackage.memberScope | ||
| val symbol = resolveInScope(functionName, scope) ?: resolveInScope(functionName, rootScope) | ||
| if (symbol == null) { | ||
| logger.warn("Unresolved function $functionName in @sample in ${descriptor.signature()}") | ||
| return ContentBlockSampleCode().apply { append(ContentText("//Unresolved: $functionName")) } | ||
| } | ||
| val psiElement = DescriptorToSourceUtils.descriptorToDeclaration(symbol) | ||
| if (psiElement == null) { | ||
| logger.warn("Can't find source for function $functionName in @sample in ${descriptor.signature()}") | ||
| return ContentBlockSampleCode().apply { append(ContentText("//Source not found: $functionName")) } | ||
| } | ||
|
|
||
| val text = processSampleBody(psiElement) | ||
|
|
||
| val lines = text.trimEnd().split("\n".toRegex()).toTypedArray().filterNot(String::isEmpty) | ||
| val indent = lines.map { it.takeWhile(Char::isWhitespace).count() }.min() ?: 0 | ||
| val finalText = lines.map { it.drop(indent) }.joinToString("\n") | ||
|
|
||
| return ContentBlockSampleCode(importsBlock = processImports(psiElement)).apply { append(ContentText(finalText)) } | ||
| } | ||
|
|
||
| protected open fun processSampleBody(psiElement: PsiElement): String = when (psiElement) { | ||
| is KtDeclarationWithBody -> { | ||
| val bodyExpression = psiElement.bodyExpression | ||
| when (bodyExpression) { | ||
| is KtBlockExpression -> bodyExpression.text.removeSurrounding("{", "}") | ||
| else -> bodyExpression!!.text | ||
| } | ||
| } | ||
| else -> psiElement.text | ||
| } | ||
|
|
||
| protected open fun processImports(psiElement: PsiElement): ContentBlockCode { | ||
| val psiFile = psiElement.containingFile | ||
| if (psiFile is KtFile) { | ||
| return ContentBlockCode("kotlin").apply { | ||
| append(ContentText(psiFile.importList?.text ?: "")) | ||
| } | ||
| } else { | ||
| return ContentBlockCode("") | ||
| } | ||
| } | ||
|
|
||
| private fun resolveInScope(functionName: String, scope: ResolutionScope): DeclarationDescriptor? { | ||
| var currentScope = scope | ||
| val parts = functionName.split('.') | ||
|
|
||
| var symbol: DeclarationDescriptor? = null | ||
|
|
||
| for (part in parts) { | ||
| // short name | ||
| val symbolName = Name.identifier(part) | ||
| val partSymbol = currentScope.getContributedDescriptors(DescriptorKindFilter.ALL, { it == symbolName }) | ||
| .filter { it.name == symbolName } | ||
| .firstOrNull() | ||
|
|
||
| if (partSymbol == null) { | ||
| symbol = null | ||
| break | ||
| } | ||
| @Suppress("IfThenToElvis") | ||
| currentScope = if (partSymbol is ClassDescriptor) | ||
| partSymbol.defaultType.memberScope | ||
| else if (partSymbol is PackageViewDescriptor) | ||
| partSymbol.memberScope | ||
| else | ||
| getKDocLinkResolutionScope(resolutionFacade, partSymbol) | ||
| symbol = partSymbol | ||
| } | ||
|
|
||
| return symbol | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.