aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src
diff options
context:
space:
mode:
authorVadim Mishenev <vad-mishenev@yandex.ru>2022-02-09 15:59:40 +0300
committerGitHub <noreply@github.com>2022-02-09 15:59:40 +0300
commit019cef47f1bf993a7a25ec73e88b1d9da25528eb (patch)
treed10defa35533f16221c7a3befba000475449d977 /plugins/base/src
parent39f6b38bfbfb01d8ce6ae23705b09f65ab72fa64 (diff)
downloaddokka-019cef47f1bf993a7a25ec73e88b1d9da25528eb.tar.gz
dokka-019cef47f1bf993a7a25ec73e88b1d9da25528eb.tar.bz2
dokka-019cef47f1bf993a7a25ec73e88b1d9da25528eb.zip
Add KotlinWebSite plugin to transform samples (#2349)
Diffstat (limited to 'plugins/base/src')
-rw-r--r--plugins/base/src/main/kotlin/transformers/pages/samples/KotlinWebsiteSamplesTransformer.kt196
1 files changed, 0 insertions, 196 deletions
diff --git a/plugins/base/src/main/kotlin/transformers/pages/samples/KotlinWebsiteSamplesTransformer.kt b/plugins/base/src/main/kotlin/transformers/pages/samples/KotlinWebsiteSamplesTransformer.kt
deleted file mode 100644
index 5babc289..00000000
--- a/plugins/base/src/main/kotlin/transformers/pages/samples/KotlinWebsiteSamplesTransformer.kt
+++ /dev/null
@@ -1,196 +0,0 @@
-package org.jetbrains.dokka.base.transformers.pages.samples
-
-import com.intellij.psi.PsiDocumentManager
-import com.intellij.psi.PsiElement
-import com.intellij.psi.PsiElementVisitor
-import com.intellij.psi.PsiWhiteSpace
-import com.intellij.psi.impl.source.tree.LeafPsiElement
-import com.intellij.psi.util.PsiTreeUtil
-import org.jetbrains.dokka.plugability.DokkaContext
-import org.jetbrains.kotlin.psi.*
-import org.jetbrains.kotlin.psi.psiUtil.allChildren
-import org.jetbrains.kotlin.psi.psiUtil.prevLeaf
-import org.jetbrains.kotlin.psi.psiUtil.startOffset
-import org.jetbrains.kotlin.resolve.ImportPath
-import org.jetbrains.kotlin.utils.addToStdlib.safeAs
-import java.io.PrintWriter
-import java.io.StringWriter
-
-// TODO Inspect below class for any bugs. Big chunk of was ripped from 0.10.1
-class KotlinWebsiteSamplesTransformer(context: DokkaContext): SamplesTransformer(context) {
-
- private class SampleBuilder : KtTreeVisitorVoid() {
- val builder = StringBuilder()
- val text: String
- get() = builder.toString()
-
- val errors = mutableListOf<ConvertError>()
-
- data class ConvertError(val e: Exception, val text: String, val loc: String)
-
- fun KtValueArgument.extractStringArgumentValue() =
- (getArgumentExpression() as KtStringTemplateExpression)
- .entries.joinToString("") { it.text }
-
-
- fun convertAssertPrints(expression: KtCallExpression) {
- val (argument, commentArgument) = expression.valueArguments
- builder.apply {
- append("println(")
- append(argument.text)
- append(") // ")
- append(commentArgument.extractStringArgumentValue())
- }
- }
-
- fun convertAssertTrueFalse(expression: KtCallExpression, expectedResult: Boolean) {
- val (argument) = expression.valueArguments
- builder.apply {
- expression.valueArguments.getOrNull(1)?.let {
- append("// ${it.extractStringArgumentValue()}")
- val ws = expression.prevLeaf { it is PsiWhiteSpace }
- append(ws?.text ?: "\n")
- }
- append("println(\"")
- append(argument.text)
- append(" is \${")
- append(argument.text)
- append("}\") // $expectedResult")
- }
- }
-
- fun convertAssertFails(expression: KtCallExpression) {
- val valueArguments = expression.valueArguments
-
- val funcArgument: KtValueArgument
- val message: KtValueArgument?
-
- if (valueArguments.size == 1) {
- message = null
- funcArgument = valueArguments.first()
- } else {
- message = valueArguments.first()
- funcArgument = valueArguments.last()
- }
-
- builder.apply {
- val argument = funcArgument.extractFunctionalArgumentText()
- append(argument.lines().joinToString(separator = "\n") { "// $it" })
- append(" // ")
- if (message != null) {
- append(message.extractStringArgumentValue())
- }
- append(" will fail")
- }
- }
-
- private fun KtValueArgument.extractFunctionalArgumentText(): String {
- return if (getArgumentExpression() is KtLambdaExpression)
- PsiTreeUtil.findChildOfType(this, KtBlockExpression::class.java)?.text ?: ""
- else
- text
- }
-
- fun convertAssertFailsWith(expression: KtCallExpression) {
- val (funcArgument) = expression.valueArguments
- val (exceptionType) = expression.typeArguments
- builder.apply {
- val argument = funcArgument.extractFunctionalArgumentText()
- append(argument.lines().joinToString(separator = "\n") { "// $it" })
- append(" // will fail with ")
- append(exceptionType.text)
- }
- }
-
- override fun visitCallExpression(expression: KtCallExpression) {
- when (expression.calleeExpression?.text) {
- "assertPrints" -> convertAssertPrints(expression)
- "assertTrue" -> convertAssertTrueFalse(expression, expectedResult = true)
- "assertFalse" -> convertAssertTrueFalse(expression, expectedResult = false)
- "assertFails" -> convertAssertFails(expression)
- "assertFailsWith" -> convertAssertFailsWith(expression)
- else -> super.visitCallExpression(expression)
- }
- }
-
- private fun reportProblemConvertingElement(element: PsiElement, e: Exception) {
- val text = element.text
- val document = PsiDocumentManager.getInstance(element.project).getDocument(element.containingFile)
-
- val lineInfo = if (document != null) {
- val lineNumber = document.getLineNumber(element.startOffset)
- "$lineNumber, ${element.startOffset - document.getLineStartOffset(lineNumber)}"
- } else {
- "offset: ${element.startOffset}"
- }
- errors += ConvertError(e, text, lineInfo)
- }
-
- override fun visitElement(element: PsiElement) {
- if (element is LeafPsiElement)
- builder.append(element.text)
-
- element.acceptChildren(object : PsiElementVisitor() {
- override fun visitElement(element: PsiElement) {
- try {
- element.accept(this@SampleBuilder)
- } catch (e: Exception) {
- try {
- reportProblemConvertingElement(element, e)
- } finally {
- builder.append(element.text) //recover
- }
- }
- }
- })
- }
-
- }
-
- private fun PsiElement.buildSampleText(): String {
- val sampleBuilder = SampleBuilder()
- this.accept(sampleBuilder)
-
- sampleBuilder.errors.forEach {
- val sw = StringWriter()
- val pw = PrintWriter(sw)
- it.e.printStackTrace(pw)
-
- this@KotlinWebsiteSamplesTransformer.context.logger.error("${containingFile.name}: (${it.loc}): Exception thrown while converting \n```\n${it.text}\n```\n$sw")
- }
- return sampleBuilder.text
- }
-
- val importsToIgnore = arrayOf("samples.*", "samples.Sample").map { ImportPath.fromString(it) }
-
- override fun processImports(psiElement: PsiElement): String {
- val psiFile = psiElement.containingFile
- return when(val text = psiFile.safeAs<KtFile>()?.importList) {
- is KtImportList -> text.let {
- it.allChildren.filter {
- it !is KtImportDirective || it.importPath !in importsToIgnore
- }.joinToString(separator = "\n") { it.text }
- }
- else -> ""
- }
- }
-
- override fun processBody(psiElement: PsiElement): String {
- val text = processSampleBody(psiElement).trim { it == '\n' || it == '\r' }.trimEnd()
- val lines = text.split("\n")
- val indent = lines.filter(String::isNotBlank).map { it.takeWhile(Char::isWhitespace).count() }.minOrNull() ?: 0
- return lines.joinToString("\n") { it.drop(indent) }
- }
-
- private fun processSampleBody(psiElement: PsiElement) = when (psiElement) {
- is KtDeclarationWithBody -> {
- val bodyExpression = psiElement.bodyExpression
- val bodyExpressionText = bodyExpression!!.buildSampleText()
- when (bodyExpression) {
- is KtBlockExpression -> bodyExpressionText.removeSurrounding("{", "}")
- else -> bodyExpressionText
- }
- }
- else -> psiElement.buildSampleText()
- }
-} \ No newline at end of file