1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
package org.jetbrains.dokka
import java.util.ArrayDeque
import org.jetbrains.kotlin.descriptors.*
import org.jetbrains.kotlin.resolve.*
import org.jetbrains.kotlin.resolve.scopes.*
import org.jetbrains.kotlin.name.*
import org.jetbrains.kotlin.idea.kdoc.getResolutionScope
import org.intellij.markdown.*
import org.jetbrains.kotlin.psi.JetDeclarationWithBody
import org.jetbrains.kotlin.psi.JetBlockExpression
public fun DocumentationBuilder.buildContent(tree: MarkdownNode): Content {
val result = Content()
buildContentTo(tree, result)
return result
}
public fun DocumentationBuilder.buildContentTo(tree: MarkdownNode, target: ContentBlock) {
// println(tree.toTestString())
val nodeStack = ArrayDeque<ContentBlock>()
nodeStack.push(target)
tree.visit {(node, processChildren) ->
val parent = nodeStack.peek()!!
when (node.type) {
MarkdownElementTypes.UNORDERED_LIST -> {
nodeStack.push(ContentList())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.ORDERED_LIST -> {
nodeStack.push(ContentList()) // TODO: add list kind
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.LIST_ITEM -> {
nodeStack.push(ContentListItem())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.EMPH -> {
nodeStack.push(ContentEmphasis())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.STRONG -> {
nodeStack.push(ContentStrong())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.CODE_SPAN -> {
nodeStack.push(ContentCode())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.CODE_BLOCK -> {
nodeStack.push(ContentBlockCode())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownElementTypes.INLINE_LINK -> {
val label = node.child(MarkdownElementTypes.LINK_TEXT)?.child(MarkdownTokenTypes.TEXT)
val destination = node.child(MarkdownElementTypes.LINK_DESTINATION)
if (label != null) {
if (destination != null) {
val link = ContentExternalLink(destination.text)
link.append(ContentText(label.text))
parent.append(link)
} else {
val link = ContentExternalLink(label.text)
link.append(ContentText(label.text))
parent.append(link)
}
}
}
MarkdownElementTypes.SHORT_REFERENCE_LINK -> {
val label = node.child(MarkdownElementTypes.LINK_LABEL)?.child(MarkdownTokenTypes.TEXT)
if (label != null) {
val link = ContentExternalLink(label.text)
link.append(ContentText(label.text))
parent.append(link)
}
}
MarkdownTokenTypes.WHITE_SPACE,
MarkdownTokenTypes.EOL -> {
if (keepWhitespace(nodeStack.peek()) && node.parent?.children?.last() != node) {
parent.append(ContentText(node.text))
}
}
MarkdownTokenTypes.TEXT ->
parent.append(ContentText(node.text))
MarkdownTokenTypes.CODE -> {
val block = ContentBlockCode()
block.append(ContentText(node.text))
parent.append(block)
}
MarkdownElementTypes.PARAGRAPH -> {
nodeStack.push(ContentParagraph())
processChildren()
parent.append(nodeStack.pop())
}
MarkdownTokenTypes.COLON -> {
parent.append(ContentText(node.text))
}
MarkdownTokenTypes.DOUBLE_QUOTE,
MarkdownTokenTypes.LT,
MarkdownTokenTypes.GT,
MarkdownTokenTypes.LPAREN,
MarkdownTokenTypes.RPAREN,
MarkdownTokenTypes.LBRACKET,
MarkdownTokenTypes.RBRACKET -> {
parent.append(ContentText(node.text))
}
else -> {
processChildren()
}
}
}
}
private fun keepWhitespace(node: ContentNode) = node is ContentParagraph || node is ContentSection
public fun DocumentationBuilder.buildInlineContentTo(tree: MarkdownNode, target: ContentBlock) {
val inlineContent = tree.children.singleOrNull { it.type == MarkdownElementTypes.PARAGRAPH }?.children ?: listOf(tree)
inlineContent.forEach {
buildContentTo(it, target)
}
}
fun DocumentationBuilder.functionBody(descriptor: DeclarationDescriptor, functionName: String?): ContentNode {
if (functionName == null)
return ContentBlockCode().let() { it.append(ContentText("Missing function name in @sample")); it }
val scope = getResolutionScope(session, descriptor)
val rootPackage = session.getModuleDescriptor().getPackage(FqName.ROOT)!!
val rootScope = rootPackage.getMemberScope()
val symbol = resolveInScope(functionName, scope) ?: resolveInScope(functionName, rootScope)
if (symbol == null)
return ContentBlockCode().let() { it.append(ContentText("Unresolved: $functionName")); it }
val psiElement = DescriptorToSourceUtils.descriptorToDeclaration(symbol)
if (psiElement == null)
return ContentBlockCode().let() { it.append(ContentText("Source not found: $functionName")); it }
val text = when (psiElement) {
is JetDeclarationWithBody -> ContentBlockCode().let() {
val bodyExpression = psiElement.getBodyExpression()
when (bodyExpression) {
is JetBlockExpression -> bodyExpression.getText().trim("{", "}")
else -> bodyExpression.getText()
}
}
else -> psiElement.getText()
}
val lines = text.trimTrailing().split("\n").filterNot { it.length() == 0 }
val indent = lines.map { it.takeWhile { it.isWhitespace() }.count() }.min() ?: 0
val finalText = lines.map { it.drop(indent) }.join("\n")
return ContentBlockCode().let() { it.append(ContentText(finalText)); it }
}
private fun DocumentationBuilder.resolveInScope(functionName: String, scope: JetScope): DeclarationDescriptor? {
var currentScope = scope
val parts = functionName.split('.')
var symbol: DeclarationDescriptor? = null
for (part in parts) {
// short name
val symbolName = Name.guess(part)
val partSymbol = currentScope.getAllDescriptors().filter { it.getName() == symbolName }.firstOrNull()
if (partSymbol == null) {
symbol = null
break
}
currentScope = getResolutionScope(session, partSymbol)
symbol = partSymbol
}
return symbol
}
|
