-
Notifications
You must be signed in to change notification settings - Fork 380
/
RsDocumentationProvider.kt
596 lines (549 loc) · 23.3 KB
/
RsDocumentationProvider.kt
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
/*
* Use of this source code is governed by the MIT license that can be
* found in the LICENSE file.
*/
package org.rust.ide.docs
import com.intellij.codeInsight.documentation.DocumentationManagerUtil
import com.intellij.lang.documentation.AbstractDocumentationProvider
import com.intellij.lang.documentation.DocumentationMarkup
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.project.Project
import com.intellij.psi.*
import org.rust.cargo.project.workspace.PackageOrigin.*
import org.rust.cargo.util.AutoInjectedCrates.STD
import org.rust.ide.presentation.presentableQualifiedName
import org.rust.ide.presentation.presentationInfo
import org.rust.ide.presentation.render
import org.rust.lang.core.crate.crateGraph
import org.rust.lang.core.psi.*
import org.rust.lang.core.psi.ext.*
import org.rust.lang.core.types.ty.TyPrimitive
import org.rust.lang.core.types.type
import org.rust.lang.doc.RsDocRenderMode
import org.rust.lang.doc.documentationAsHtml
import org.rust.lang.doc.psi.RsDocComment
import org.rust.openapiext.Testmark
import org.rust.openapiext.escaped
import org.rust.openapiext.hitOnFalse
import org.rust.stdext.joinToWithBuffer
import java.util.function.Consumer
@Suppress("UnstableApiUsage")
class RsDocumentationProvider : AbstractDocumentationProvider() {
override fun generateDoc(element: PsiElement, originalElement: PsiElement?): String? {
val buffer = StringBuilder()
when (element) {
is RsTypeParameter -> definition(buffer) { generateDoc(element, it) }
is RsDocAndAttributeOwner -> generateDoc(element, buffer)
is RsPatBinding -> definition(buffer) { generateDoc(element, it) }
is RsPath -> generateDoc(element, buffer)
else -> generateCustomDoc(element, buffer)
}
return if (buffer.isEmpty()) null else buffer.toString()
}
override fun getQuickNavigateInfo(element: PsiElement, originalElement: PsiElement?): String? = buildString {
when (element) {
is RsPatBinding -> generateDoc(element, this)
is RsTypeParameter -> generateDoc(element, this)
is RsConstant -> this += element.presentationInfo?.quickDocumentationText
is RsMod -> this += element.presentationInfo?.quickDocumentationText
is RsItemElement,
is RsMacro -> {
(element as RsDocAndAttributeOwner).header(this)
element.signature(this)
}
is RsNamedElement -> this += element.presentationInfo?.quickDocumentationText
else -> return null
}
}
override fun collectDocComments(file: PsiFile, sink: Consumer<in PsiDocCommentBase>) {
if (file !is RsFile) return
for (element in SyntaxTraverser.psiTraverser(file)) {
if (element is RsDocComment) {
sink.accept(element)
}
}
}
private fun generateDoc(element: RsDocAndAttributeOwner, buffer: StringBuilder) {
definition(buffer) {
element.header(it)
element.signature(it)
}
var text = element.documentationAsHtml()
if (text.isNullOrEmpty() && element is RsAbstractable && element.owner.isTraitImpl) {
// Show documentation of the corresponding trait item if own documentation is empty
val superElement = element.superItem as? RsDocAndAttributeOwner ?: return
text = superElement.documentationAsHtml()
}
if (text.isNullOrEmpty()) return
buffer += "\n" // Just for more pretty html text representation
content(buffer) { it += text }
}
private fun generateDoc(element: RsPatBinding, buffer: StringBuilder) {
val presentationInfo = element.presentationInfo ?: return
val type = element.type.render().escaped
buffer += presentationInfo.type
buffer += " "
buffer.b { it += presentationInfo.name }
buffer += ": "
buffer += type
}
private fun generateDoc(element: RsTypeParameter, buffer: StringBuilder) {
val name = element.name ?: return
buffer += "type parameter "
buffer.b { it += name }
val typeBounds = element.bounds
if (typeBounds.isNotEmpty()) {
typeBounds.joinToWithBuffer(buffer, " + ", ": ") { generateDocumentation(it) }
}
element.typeReference?.generateDocumentation(buffer, " = ")
}
private fun generateDoc(element: RsPath, buffer: StringBuilder) {
val primitive = TyPrimitive.fromPath(element) ?: return
val primitiveDocs = element.project.findFileInStdCrate("primitive_docs.rs") ?: return
val mod = primitiveDocs.childrenOfType<RsModItem>().find {
it.queryAttributes.hasAttributeWithKeyValue("doc", "primitive", primitive.name)
} ?: return
definition(buffer) { builder ->
builder += STD
builder += "\n"
builder += "primitive type "
builder.b { it += primitive.name }
}
content(buffer) { it += mod.documentationAsHtml(element) }
}
private fun generateCustomDoc(element: PsiElement, buffer: StringBuilder) {
if (element.isKeywordLike()) {
val keywordDocs = element.project.findFileInStdCrate("keyword_docs.rs") ?: return
val keywordName = element.text
val mod = keywordDocs.childrenOfType<RsModItem>().find {
it.queryAttributes.hasAttributeWithKeyValue("doc", "keyword", keywordName)
} ?: return
definition(buffer) { builder ->
builder += STD
builder += "\n"
builder += "keyword "
builder.b { it += keywordName }
}
content(buffer) { it += mod.documentationAsHtml(element) }
}
}
override fun getDocumentationElementForLink(psiManager: PsiManager, link: String, context: PsiElement): PsiElement? {
val element = context as? RsElement ?: context.parent as? RsElement ?: return null
val qualifiedName = RsQualifiedName.from(link)
return if (qualifiedName == null) {
RsCodeFragmentFactory(context.project)
.createPath(link, element)
?.reference
?.resolve()
} else {
qualifiedName.findPsiElement(psiManager, element)
}
}
override fun getUrlFor(element: PsiElement, originalElement: PsiElement?): List<String> {
val (qualifiedName, origin) = when {
element is RsDocAndAttributeOwner && element is RsQualifiedNamedElement && element.hasExternalDocumentation -> {
val origin = element.containingCrate?.origin
RsQualifiedName.from(element) to origin
}
else -> {
val qualifiedName = RsQualifiedName.from(element) ?: return emptyList()
qualifiedName to STDLIB
}
}
val pagePrefix = when (origin) {
STDLIB -> STD_DOC_HOST
DEPENDENCY, STDLIB_DEPENDENCY -> {
val pkg = (element as? RsElement)?.containingCargoPackage ?: return emptyList()
// Packages without source don't have documentation at docs.rs
if (pkg.source == null) {
Testmarks.PkgWithoutSource.hit()
return emptyList()
}
"$DOCS_RS_HOST/${pkg.name}/${pkg.version}"
}
else -> {
Testmarks.NonDependency.hit()
return emptyList()
}
}
val pagePath = qualifiedName?.toUrlPath() ?: return emptyList()
return listOf("$pagePrefix/$pagePath")
}
override fun getCustomDocumentationElement(
editor: Editor,
file: PsiFile,
contextElement: PsiElement?,
targetOffset: Int
): PsiElement? {
// Don't show documentation for keywords like `self`, `super`, etc. when they are part of path.
// We want to show documentation for the corresponding item that path references to
if (contextElement?.isKeywordLike() == true && contextElement.parent !is RsPath) return contextElement
return null
}
@Suppress("UnstableApiUsage")
override fun generateRenderedDoc(comment: PsiDocCommentBase): String? {
return (comment as? RsDocComment)?.documentationAsHtml(renderMode = RsDocRenderMode.INLINE_DOC_COMMENT)
}
private val RsDocAndAttributeOwner.hasExternalDocumentation: Boolean
get() {
// items with #[doc(hidden)] attribute don't have external documentation
if (queryAttributes.isDocHidden) {
Testmarks.DocHidden.hit()
return false
}
// private items don't have external documentation
if (this is RsVisible) {
if (this is RsAbstractable) {
when (val owner = owner) {
is RsAbstractableOwner.Trait -> return owner.trait.hasExternalDocumentation
is RsAbstractableOwner.Impl -> {
return if (owner.isInherent) {
visibility == RsVisibility.Public
} else {
owner.impl.traitRef?.resolveToTrait()?.hasExternalDocumentation == true
}
}
else -> Unit
}
} else {
if (visibility != RsVisibility.Public) return false
}
}
// macros without #[macro_export] are not public and don't have external documentation
if (this is RsMacro) {
return Testmarks.NotExportedMacro.hitOnFalse(hasMacroExport)
}
// TODO: we should take into account real path of item for user, i.e. take into account reexports
// instead of already resolved item path
return containingMod.superMods.all { it.isPublic }
}
private fun Project.findFileInStdCrate(name: String): RsFile? {
return crateGraph.topSortedCrates
.find { it.origin == STDLIB && it.normName == STD }
?.rootMod
?.parent
?.findFile(name)
?.rustFile
}
companion object {
const val STD_DOC_HOST = "https://doc.rust-lang.org"
const val DOCS_RS_HOST = "https://docs.rs"
}
object Testmarks {
object DocHidden : Testmark()
object NotExportedMacro : Testmark()
object PkgWithoutSource : Testmark()
object NonDependency : Testmark()
}
}
private fun RsDocAndAttributeOwner.header(buffer: StringBuilder) {
val rawLines = when (this) {
is RsNamedFieldDecl -> listOfNotNull((parent?.parent as? RsDocAndAttributeOwner)?.presentableQualifiedName)
is RsStructOrEnumItemElement,
is RsTraitItem,
is RsMacroDefinitionBase -> listOfNotNull(presentableQualifiedModName)
is RsAbstractable -> when (val owner = owner) {
is RsAbstractableOwner.Foreign,
is RsAbstractableOwner.Free -> listOfNotNull(presentableQualifiedModName)
is RsAbstractableOwner.Impl -> listOfNotNull(presentableQualifiedModName) + owner.impl.declarationText
is RsAbstractableOwner.Trait -> owner.trait.declarationText
}
else -> listOfNotNull(presentableQualifiedName)
}
rawLines.joinTo(buffer, "<br>")
if (rawLines.isNotEmpty()) {
buffer += "\n"
}
}
fun RsDocAndAttributeOwner.signature(builder: StringBuilder) {
val rawLines = when (this) {
is RsNamedFieldDecl -> listOfNotNull(presentationInfo?.signatureText)
is RsFunction -> {
val buffer = StringBuilder()
declarationModifiers.joinTo(buffer, separator = " ", postfix = " ")
buffer.b { it += name }
typeParameterList?.generateDocumentation(buffer)
valueParameterList?.generateDocumentation(buffer)
retType?.generateDocumentation(buffer)
listOf(buffer.toString()) + whereClause?.documentationText.orEmpty()
}
is RsConstant -> {
val buffer = StringBuilder()
declarationModifiers.joinTo(buffer, separator = " ", postfix = " ")
buffer.b { it += name }
typeReference?.generateDocumentation(buffer, ": ")
expr?.generateDocumentation(buffer, " = ")
listOf(buffer.toString())
}
// All these types extend RsItemElement and RsGenericDeclaration interfaces so all casts are safe
is RsStructOrEnumItemElement, is RsTraitItem, is RsTypeAlias -> {
val name = name
if (name != null) {
val buffer = StringBuilder()
(this as RsItemElement).declarationModifiers.joinTo(buffer, separator = " ", postfix = " ")
buffer.b { it += name }
(this as RsGenericDeclaration).typeParameterList?.generateDocumentation(buffer)
(this as? RsTypeAlias)?.typeReference?.generateDocumentation(buffer, " = ")
listOf(buffer.toString()) + whereClause?.documentationText.orEmpty()
} else emptyList()
}
is RsMacro -> listOf("macro <b>$name</b>")
is RsMacro2 -> {
val buffer = StringBuilder()
declarationModifiers.joinTo(buffer, separator = " ", postfix = " ")
buffer.b { it += name }
listOf(buffer.toString())
}
is RsImplItem -> declarationText
else -> emptyList()
}
rawLines.joinTo(builder, "<br>")
}
private val RsImplItem.declarationText: List<String>
get() {
val typeRef = typeReference ?: return emptyList()
val buffer = StringBuilder("impl")
typeParameterList?.generateDocumentation(buffer)
buffer += " "
val traitRef = traitRef
if (traitRef != null) {
traitRef.generateDocumentation(buffer)
buffer += " for "
}
typeRef.generateDocumentation(buffer)
return listOf(buffer.toString()) + whereClause?.documentationText.orEmpty()
}
private val RsTraitItem.declarationText: List<String>
get() {
val name = presentableQualifiedName ?: return emptyList()
val buffer = StringBuilder(name)
typeParameterList?.generateDocumentation(buffer)
return listOf(buffer.toString()) + whereClause?.documentationText.orEmpty()
}
private val RsItemElement.declarationModifiers: List<String>
get() {
val modifiers = mutableListOf<String>()
vis?.text?.let { modifiers += it }
when (this) {
is RsFunction -> {
if (isAsync) {
modifiers += "async"
}
if (isConst) {
modifiers += "const"
}
if (isUnsafe) {
modifiers += "unsafe"
}
if (isActuallyExtern) {
modifiers += "extern"
abiName?.let { modifiers += "\"$it\"" }
}
modifiers += "fn"
}
is RsStructItem -> modifiers += "struct"
is RsEnumItem -> modifiers += "enum"
is RsConstant -> modifiers += if (isConst) "const" else "static"
is RsTypeAlias -> modifiers += "type"
is RsTraitItem -> {
if (isUnsafe) {
modifiers += "unsafe"
}
modifiers += "trait"
}
is RsMacro2 -> modifiers += "macro"
else -> error("unexpected type $javaClass")
}
return modifiers
}
private val RsWhereClause.documentationText: List<String>
get() {
return listOf("where") + wherePredList.mapNotNull {
val buffer = StringBuilder()
val lifetime = it.lifetime
val typeReference = it.typeReference
when {
lifetime != null -> {
lifetime.generateDocumentation(buffer)
it.lifetimeParamBounds?.generateDocumentation(buffer)
}
typeReference != null -> {
typeReference.generateDocumentation(buffer)
it.typeParamBounds?.generateDocumentation(buffer)
}
else -> return@mapNotNull null
}
" $buffer,"
}
}
private val RsDocAndAttributeOwner.presentableQualifiedModName: String?
get() = presentableQualifiedName?.removeSuffix("::$name")
private fun PsiElement.generateDocumentation(buffer: StringBuilder, prefix: String = "", suffix: String = "") {
buffer += prefix
when (this) {
is RsPath -> generatePathDocumentation(this, buffer)
is RsAssocTypeBinding -> {
path.generateDocumentation(buffer)
typeReference?.generateDocumentation(buffer, " = ")
}
is RsTraitRef -> path.generateDocumentation(buffer)
is RsLifetimeParamBounds -> lifetimeList.joinToWithBuffer(buffer, " + ", ": ") { generateDocumentation(it) }
is RsTypeParamBounds -> {
if (polyboundList.isNotEmpty()) {
polyboundList.joinToWithBuffer(buffer, " + ", ": ") { generateDocumentation(it) }
}
}
// TODO: support 'for lifetimes'
is RsPolybound -> {
if (q != null) {
buffer += "?"
}
(bound.lifetime ?: bound.traitRef)?.generateDocumentation(buffer)
}
is RsTypeArgumentList -> (lifetimeList + typeReferenceList + assocTypeBindingList)
.joinToWithBuffer(buffer, ", ", "<", ">") { generateDocumentation(it) }
is RsTypeParameterList -> getGenericParameters()
.joinToWithBuffer(buffer, ", ", "<", ">") { generateDocumentation(it) }
is RsValueParameterList -> (listOfNotNull(selfParameter) + valueParameterList + listOfNotNull(variadic))
.joinToWithBuffer(buffer, ", ", "(", ")") { generateDocumentation(it) }
is RsLifetimeParameter -> {
buffer += quoteIdentifier.text.escaped
lifetimeParamBounds?.generateDocumentation(buffer)
}
is RsTypeParameter -> {
buffer += name
typeParamBounds?.generateDocumentation(buffer)
typeReference?.generateDocumentation(buffer, " = ")
}
is RsConstParameter -> {
buffer += "const "
buffer += name
typeReference?.generateDocumentation(buffer, ": ")
}
is RsValueParameter -> {
pat?.generateDocumentation(buffer, suffix = ": ")
typeReference?.generateDocumentation(buffer)
}
is RsVariadic -> {
pat?.generateDocumentation(buffer, suffix = ": ")
buffer += dotdotdot.text
}
is RsTypeReference -> generateTypeReferenceDocumentation(this, buffer)
is RsRetType -> typeReference?.generateDocumentation(buffer, " -> ")
is RsTypeQual -> {
buffer += "<"
typeReference.generateDocumentation(buffer)
traitRef?.generateDocumentation(buffer, " as ")
buffer += ">::"
}
else -> buffer += text.escaped
}
buffer += suffix
}
private fun generatePathDocumentation(element: RsPath, buffer: StringBuilder) {
val path = element.path
if (path != null) {
buffer += path.text.escaped
buffer += "::"
}
element.typeQual?.generateDocumentation(buffer)
val name = element.referenceName.orEmpty()
if (element.isLinkNeeded()) {
createLink(buffer, element.link(), name)
} else {
buffer += name
}
val typeArgumentList = element.typeArgumentList
val valueParameterList = element.valueParameterList
when {
typeArgumentList != null -> typeArgumentList.generateDocumentation(buffer)
valueParameterList != null -> {
valueParameterList.generateDocumentation(buffer)
element.retType?.generateDocumentation(buffer)
}
}
}
private fun generateTypeReferenceDocumentation(element: RsTypeReference, buffer: StringBuilder) {
when (val typeElement = element.skipParens()) {
is RsBaseType -> when (val kind = typeElement.kind) {
RsBaseTypeKind.Unit -> buffer += "()"
RsBaseTypeKind.Never -> buffer += "!"
RsBaseTypeKind.Underscore -> buffer += "_"
is RsBaseTypeKind.Path -> {
val path = kind.path
if (path.hasCself) {
buffer += "Self"
} else {
path.generateDocumentation(buffer)
}
}
}
is RsTupleType -> typeElement.typeReferenceList.joinToWithBuffer(buffer, ", ", "(", ")") { generateDocumentation(it) }
is RsArrayType -> {
buffer += "["
typeElement.typeReference?.generateDocumentation(buffer)
if (!typeElement.isSlice) {
buffer += "; "
// Try to render raw text of expression when array size cannot be inferred.
// It may be useful when array size is defined with const generic
buffer.append(typeElement.arraySize ?: typeElement.expr?.text?.escaped ?: "<unknown>")
}
buffer += "]"
}
is RsRefLikeType -> {
if (typeElement.isRef) {
buffer += "&"
typeElement.lifetime?.generateDocumentation(buffer, suffix = " ")
if (typeElement.mutability.isMut) {
buffer += "mut "
}
} else {
buffer += "*"
buffer += if (typeElement.mutability.isMut) "mut " else "const "
}
typeElement.typeReference?.generateDocumentation(buffer)
}
is RsFnPointerType -> {
// TODO: handle abi
buffer += "fn"
typeElement.valueParameterList?.generateDocumentation(buffer)
typeElement.retType?.generateDocumentation(buffer)
}
else -> buffer += element.text.escaped
}
}
private fun RsPath.isLinkNeeded(): Boolean {
val element = reference?.resolve()
// If it'll find out that links for type parameters are useful
// just check element for null
return !(element == null || element is RsTypeParameter)
}
// TODO: use RsQualifiedName scheme
private fun RsPath.link(): String {
val path = path
val prefix = if (path != null) "${path.text.escaped}::" else typeQual?.text?.escaped
return if (prefix != null) "$prefix${referenceName.orEmpty()}" else referenceName.orEmpty()
}
private fun createLink(buffer: StringBuilder, refText: String, text: String) {
DocumentationManagerUtil.createHyperlink(buffer, refText, text, true)
}
private inline fun definition(buffer: StringBuilder, block: (StringBuilder) -> Unit) {
buffer += DocumentationMarkup.DEFINITION_START
block(buffer)
buffer += DocumentationMarkup.DEFINITION_END
}
private inline fun content(buffer: StringBuilder, block: (StringBuilder) -> Unit) {
buffer += DocumentationMarkup.CONTENT_START
block(buffer)
buffer += DocumentationMarkup.CONTENT_END
}
private operator fun StringBuilder.plusAssign(value: String?) {
if (value != null) {
append(value)
}
}
private inline fun StringBuilder.b(action: (StringBuilder) -> Unit) {
append("<b>")
action(this)
append("</b>")
}