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
|
package dotty.tools
package dottydoc
package model
package comment
import dotty.tools.dottydoc.util.syntax._
import dotty.tools.dotc.core.Contexts.Context
import dotty.tools.dotc.util.Positions._
import dotty.tools.dotc.config.Printers.dottydoc
import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
import HtmlParsers._
import util.MemberLookup
case class Comment (
body: String,
short: String,
authors: List[String],
see: List[String],
result: Option[String],
throws: Map[String, String],
valueParams: Map[String, String],
typeParams: Map[String, String],
version: Option[String],
since: Option[String],
todo: List[String],
deprecated: Option[String],
note: List[String],
example: List[String],
constructor: Option[String],
group: Option[String],
groupDesc: Map[String, String],
groupNames: Map[String, String],
groupPrio: Map[String, String],
/** List of conversions to hide - containing e.g: `scala.Predef.FloatArrayOps` */
hideImplicitConversions: List[String]
)
private[comment] case class ParsedComment (
body: String,
authors: List[String],
see: List[String],
result: List[String],
throws: Map[String, String],
valueParams: Map[String, String],
typeParams: Map[String, String],
version: List[String],
since: List[String],
todo: List[String],
deprecated: List[String],
note: List[String],
example: List[String],
constructor: List[String],
group: List[String],
groupDesc: Map[String, String],
groupNames: Map[String, String],
groupPrio: Map[String, String],
hideImplicitConversions: List[String],
shortDescription: List[String]
)
trait MarkupConversion[T] extends MemberLookup {
def ent: Entity
def pos: Position
def parsed: ParsedComment
protected def linkedExceptions(m: Map[String, String])(implicit ctx: Context): Map[String, String]
protected def stringToMarkup(str: String)(implicit ctx: Context): T
protected def markupToHtml(t: T)(implicit ctx: Context): String
protected def stringToShortHtml(str: String)(implicit ctx: Context): String
protected def filterEmpty(xs: List[String])(implicit ctx: Context): List[T]
protected def filterEmpty(xs: Map[String, String])(implicit ctx: Context): Map[String, T]
private def single(annot: String, xs: List[String], filter: Boolean = true)(implicit ctx: Context): Option[T] =
(if (filter) filterEmpty(xs) else xs.map(stringToMarkup)) match {
case x :: xs =>
if (xs.nonEmpty) dottydoc.println(s"Only allowed to have a single annotation for $annot")
Some(x)
case _ => None
}
final def comment(implicit ctx: Context): Comment = Comment(
body = markupToHtml(stringToMarkup(parsed.body)),
short = stringToShortHtml(parsed.body),
authors = filterEmpty(parsed.authors).map(markupToHtml),
see = filterEmpty(parsed.see).map(markupToHtml),
result = single("@result", parsed.result).map(markupToHtml),
throws = linkedExceptions(parsed.throws),
valueParams = filterEmpty(parsed.valueParams).mapValues(markupToHtml),
typeParams = filterEmpty(parsed.typeParams).mapValues(markupToHtml),
version = single("@version", parsed.version).map(markupToHtml),
since = single("@since", parsed.since).map(markupToHtml),
todo = filterEmpty(parsed.todo).map(markupToHtml),
deprecated = single("@deprecated", parsed.deprecated, filter = false).map(markupToHtml),
note = filterEmpty(parsed.note).map(markupToHtml),
example = filterEmpty(parsed.example).map(markupToHtml),
constructor = single("@constructor", parsed.constructor).map(markupToHtml),
group = single("@group", parsed.group).map(markupToHtml),
groupDesc = filterEmpty(parsed.groupDesc).mapValues(markupToHtml),
groupNames = filterEmpty(parsed.groupNames).mapValues(markupToHtml),
groupPrio = filterEmpty(parsed.groupPrio).mapValues(markupToHtml),
hideImplicitConversions = filterEmpty(parsed.hideImplicitConversions).map(markupToHtml)
)
}
case class MarkdownComment(ent: Entity, parsed: ParsedComment, pos: Position)
extends MarkupConversion[MarkdownNode] {
def stringToMarkup(str: String)(implicit ctx: Context) =
str.toMarkdown(ent)
def stringToShortHtml(str: String)(implicit ctx: Context) =
str.toMarkdown(ent).shortenAndShow
def markupToHtml(md: MarkdownNode)(implicit ctx: Context) =
md.show
def linkedExceptions(m: Map[String, String])(implicit ctx: Context) = {
val inlineToHtml = InlineToHtml(ent)
m.map { case (targetStr, body) =>
val link = makeEntityLink(ent, ctx.docbase.packages, Monospace(Text(targetStr)), targetStr)
(targetStr, inlineToHtml(link))
}
}
def filterEmpty(xs: List[String])(implicit ctx: Context) =
xs.map(_.trim)
.filterNot(_.isEmpty)
.map(stringToMarkup)
def filterEmpty(xs: Map[String, String])(implicit ctx: Context) =
xs.mapValues(_.trim)
.filterNot { case (_, v) => v.isEmpty }
.mapValues(stringToMarkup)
}
case class WikiComment(ent: Entity, parsed: ParsedComment, pos: Position)
extends MarkupConversion[Body] {
def filterEmpty(xs: Map[String,String])(implicit ctx: Context) =
xs.mapValues(_.toWiki(ent, ctx.docbase.packages, pos))
.filterNot { case (_, v) => v.blocks.isEmpty }
def filterEmpty(xs: List[String])(implicit ctx: Context) =
xs.map(_.toWiki(ent, ctx.docbase.packages, pos))
def markupToHtml(t: Body)(implicit ctx: Context) =
t.show(ent)
def stringToMarkup(str: String)(implicit ctx: Context) =
str.toWiki(ent, ctx.docbase.packages, pos)
def stringToShortHtml(str: String)(implicit ctx: Context) = {
val parsed = stringToMarkup(str)
parsed.summary.getOrElse(parsed).show(ent)
}
def linkedExceptions(m: Map[String, String])(implicit ctx: Context) = {
m.mapValues(_.toWiki(ent, ctx.docbase.packages, pos)).map { case (targetStr, body) =>
val link = lookup(ent, ctx.docbase.packages, targetStr)
val newBody = body match {
case Body(List(Paragraph(Chain(content)))) =>
val descr = Text(" ") +: content
val link = makeEntityLink(ent, ctx.docbase.packages, Monospace(Text(targetStr)), targetStr)
Body(List(Paragraph(Chain(link +: descr))))
case _ => body
}
(targetStr, newBody.show(ent))
}
}
}
|
