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
184
185
186
187
188
189
190
191
192
193
194
195
196
|
package org.jetbrains.dokka
import com.intellij.psi.*
import com.intellij.psi.impl.source.tree.JavaDocElementType
import com.intellij.psi.javadoc.PsiDocTag
import com.intellij.psi.javadoc.PsiDocTagValue
import com.intellij.psi.javadoc.PsiDocToken
import com.intellij.psi.javadoc.PsiInlineDocTag
import com.intellij.psi.util.PsiTreeUtil
import org.jsoup.Jsoup
import org.jsoup.nodes.Element
import org.jsoup.nodes.Node
import org.jsoup.nodes.TextNode
data class JavadocParseResult(val content: Content, val deprecatedContent: Content?) {
companion object {
val Empty = JavadocParseResult(Content.Empty, null)
}
}
interface JavaDocumentationParser {
fun parseDocumentation(element: PsiNamedElement): JavadocParseResult
}
class JavadocParser(
private val refGraph: NodeReferenceGraph,
private val logger: DokkaLogger,
private val signatureProvider: ElementSignatureProvider
) : JavaDocumentationParser {
override fun parseDocumentation(element: PsiNamedElement): JavadocParseResult {
val docComment = (element as? PsiDocCommentOwner)?.docComment
if (docComment == null) return JavadocParseResult.Empty
val result = MutableContent()
var deprecatedContent: Content? = null
val firstParagraph = ContentParagraph()
firstParagraph.convertJavadocElements(docComment.descriptionElements.dropWhile { it.text.trim().isEmpty() })
val paragraphs = firstParagraph.children.dropWhile { it !is ContentParagraph }
firstParagraph.children.removeAll(paragraphs)
if (!firstParagraph.isEmpty()) {
result.append(firstParagraph)
}
paragraphs.forEach {
result.append(it)
}
val attrs = mutableListOf<DocumentationNode>()
var since: DocumentationNode? = null
docComment.tags.forEach { tag ->
when (tag.name) {
"see" -> result.convertSeeTag(tag)
"deprecated" -> {
deprecatedContent = Content()
deprecatedContent!!.convertJavadocElements(tag.contentElements())
}
else -> {
val subjectName = tag.getSubjectName()
val section = result.addSection(javadocSectionDisplayName(tag.name), subjectName)
section.convertJavadocElements(tag.contentElements())
}
}
}
return JavadocParseResult(result, deprecatedContent)
}
private fun PsiDocTag.contentElements(): Iterable<PsiElement> {
val tagValueElements = children
.dropWhile { it.node?.elementType == JavaDocTokenType.DOC_TAG_NAME }
.dropWhile { it is PsiWhiteSpace }
.filterNot { it.node?.elementType == JavaDocTokenType.DOC_COMMENT_LEADING_ASTERISKS }
return if (getSubjectName() != null) tagValueElements.dropWhile { it is PsiDocTagValue } else tagValueElements
}
private fun ContentBlock.convertJavadocElements(elements: Iterable<PsiElement>) {
val htmlBuilder = StringBuilder()
elements.forEach {
if (it is PsiInlineDocTag) {
htmlBuilder.append(convertInlineDocTag(it))
} else {
htmlBuilder.append(it.text)
}
}
val doc = Jsoup.parse(htmlBuilder.toString().trim())
doc.body().childNodes().forEach {
convertHtmlNode(it)?.let { append(it) }
}
}
private fun convertHtmlNode(node: Node): ContentNode? {
if (node is TextNode) {
return ContentText(node.text())
} else if (node is Element) {
val childBlock = createBlock(node)
node.childNodes().forEach {
val child = convertHtmlNode(it)
if (child != null) {
childBlock.append(child)
}
}
return (childBlock)
}
return null
}
private fun createBlock(element: Element): ContentBlock = when (element.tagName()) {
"p" -> ContentParagraph()
"b", "strong" -> ContentStrong()
"i", "em" -> ContentEmphasis()
"s", "del" -> ContentStrikethrough()
"code" -> ContentCode()
"pre" -> ContentBlockCode()
"ul" -> ContentUnorderedList()
"ol" -> ContentOrderedList()
"li" -> ContentListItem()
"a" -> createLink(element)
"br" -> ContentBlock().apply { hardLineBreak() }
else -> ContentBlock()
}
private fun createLink(element: Element): ContentBlock {
if (element.hasAttr("docref")) {
val docref = element.attr("docref")
return ContentNodeLazyLink(docref, { -> refGraph.lookupOrWarn(docref, logger) })
}
return if (element.hasAttr("href")) {
val href = element.attr("href")
ContentExternalLink(href)
} else {
ContentBlock()
}
}
private fun MutableContent.convertSeeTag(tag: PsiDocTag) {
val linkElement = tag.linkElement() ?: return
val seeSection = findSectionByTag(ContentTags.SeeAlso) ?: addSection(ContentTags.SeeAlso, null)
val linkSignature = resolveLink(tag.referenceElement())
val text = ContentText(linkElement.text)
if (linkSignature != null) {
val linkNode =
ContentNodeLazyLink((tag.valueElement ?: linkElement).text, { -> refGraph.lookupOrWarn(linkSignature, logger) })
linkNode.append(text)
seeSection.append(linkNode)
} else {
seeSection.append(text)
}
}
private fun convertInlineDocTag(tag: PsiInlineDocTag) = when (tag.name) {
"link", "linkplain" -> {
val valueElement = tag.referenceElement()
val linkSignature = resolveLink(valueElement)
if (linkSignature != null) {
val labelText = tag.dataElements.firstOrNull { it is PsiDocToken }?.text ?: valueElement!!.text
val link = "<a docref=\"$linkSignature\">${labelText.htmlEscape()}</a>"
if (tag.name == "link") "<code>$link</code>" else link
} else if (valueElement != null) {
valueElement.text
} else {
""
}
}
"code", "literal" -> {
val text = StringBuilder()
tag.dataElements.forEach { text.append(it.text) }
val escaped = text.toString().trimStart().htmlEscape()
if (tag.name == "code") "<code>$escaped</code>" else escaped
}
else -> tag.text
}
private fun PsiDocTag.referenceElement(): PsiElement? =
linkElement()?.let {
if (it.node.elementType == JavaDocElementType.DOC_REFERENCE_HOLDER) {
PsiTreeUtil.findChildOfType(it, PsiJavaCodeReferenceElement::class.java)
} else {
it
}
}
private fun PsiDocTag.linkElement(): PsiElement? =
valueElement ?: dataElements.firstOrNull { it !is PsiWhiteSpace }
private fun resolveLink(valueElement: PsiElement?): String? {
val target = valueElement?.reference?.resolve()
if (target != null) {
return signatureProvider.signature(target)
}
return null
}
fun PsiDocTag.getSubjectName(): String? {
if (name == "param" || name == "throws" || name == "exception") {
return valueElement?.text
}
return null
}
}
|
