aboutsummaryrefslogtreecommitdiff
path: root/src/Model/DocumentationContent.kt
blob: 5ea745c59778f166a7c8c0d90917c39de696cd36 (plain)
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
package org.jetbrains.dokka

import org.jetbrains.jet.lang.descriptors.*
import org.jetbrains.jet.lang.resolve.BindingContext

class DocumentationContentSection(val label: String, val text: String) {
    override fun toString(): String {
        return "$label = $text"
    }
}

class DocumentationContent(val summary: String, val description: String, val sections: List<DocumentationContentSection>) {

    override fun equals(other: Any?): Boolean {
        if (other !is DocumentationContent)
            return false
        if (summary != other.summary)
            return false
        if (sections.size != other.sections.size)
            return false
        for (index in sections.indices)
            if (sections[index] != other.sections[index])
                return false

        return true
    }

    override fun hashCode(): Int {
        return summary.hashCode() + sections.map { it.hashCode() }.sum()
    }

    override fun toString(): String {
        if (sections.isEmpty())
            return summary
        return "$summary | " + sections.joinToString()
    }

    val hasDescription : Boolean
        get() = !description.isEmpty() || sections.any()

    class object {
        val Empty = DocumentationContent("", "", listOf())
    }
}


fun BindingContext.getDocumentation(descriptor: DeclarationDescriptor): DocumentationContent {
    val docText = getDocumentationElements(descriptor).map { it.extractText() }.join("\n")
    val sections = docText.parseSections()
    val content = sections.first().text
    return DocumentationContent(content.substringBefore('\n'), content.substringAfter('\n'), sections.drop(1))
}

fun String.parseLabel(index: Int): Pair<String, Int> {
    val c = get(index)
    when {
        Character.isJavaIdentifierStart(c) -> {
            for (end in index + 1..length - 1) {
                if (!Character.isJavaIdentifierPart(get(end))) {
                    return substring(index, end) to end
                }
            }
            return substring(index, length) to length
        }
        c == '{' -> {
            val end = indexOf('}', index + 1)
            return substring(index + 1, end) to end + 2
        }
    }
    return "" to -1
}

fun String.parseSections(): List<DocumentationContentSection> {
    val sections = arrayListOf<DocumentationContentSection>()
    var currentLabel = ""
    var currentSectionStart = 0
    var currentIndex = 0

    while (currentIndex < length) {
        if (get(currentIndex) == '$') {
            val (label, index) = parseLabel(currentIndex + 1)
            if (index != -1) {
                // section starts, add previous section
                sections.add(DocumentationContentSection(currentLabel, substring(currentSectionStart, currentIndex).trim()))

                currentLabel = label
                currentIndex = index
                currentSectionStart = currentIndex
                continue
            }
        }
        currentIndex++

    }

    sections.add(DocumentationContentSection(currentLabel, substring(currentSectionStart, currentIndex).trim()))
    return sections
}