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
|
package dotty.tools
package dottydoc
package core
/** Dotty and Dottydoc imports */
import dotc.ast.Trees._
import dotc.CompilationUnit
import dotc.config.Printers.dottydoc
import dotc.core.Contexts.Context
import dotc.core.Phases.Phase
import dotc.core.Symbols.Symbol
object Phases {
class DocPhase extends Phase {
import model.CommentParsers.WikiParser
import model._
import model.factories._
import model.internal._
import model.comment.Comment
import dotty.tools.dotc.core.Flags
import dotty.tools.dotc.ast.tpd._
import util.traversing._
import util.internal.setters._
def phaseName = "docphase"
private[this] val commentParser = new WikiParser
/** Saves the commentParser function for later evaluation, for when the AST has been filled */
def track(symbol: Symbol, ctx: Context)(op: => Entity) = {
val entity = op
if (entity != NonEntity)
commentParser += (entity, symbol, ctx)
entity
}
/** Build documentation hierarchy from existing tree */
def collect(tree: Tree, prev: List[String] = Nil)(implicit ctx: Context): Entity = track(tree.symbol, ctx) {
def collectList(xs: List[Tree], ps: List[String])(implicit ctx: Context): List[Entity] =
xs.map(collect(_, ps)).filter(_ != NonEntity)
def collectEntityMembers(xs: List[Tree], ps: List[String])(implicit ctx: Context) =
collectList(xs, ps).asInstanceOf[List[Entity with Members]]
def collectMembers(tree: Tree, ps: List[String] = prev)(implicit ctx: Context): List[Entity] = tree match {
case t: Template => collectList(t.body, ps)
case _ => Nil
}
tree match {
/** package */
case pd @ PackageDef(pid, st) =>
val newPath = prev :+ pid.name.toString
addEntity(PackageImpl(newPath.mkString("."), collectEntityMembers(st, newPath), newPath))
/** trait */
case t @ TypeDef(n, rhs) if t.symbol.is(Flags.Trait) =>
val name = filteredName(n.toString)
val newPath = prev :+ name
TraitImpl(name, collectMembers(rhs), flags(t), newPath)
/** objects, on the format "Object$" so drop the last letter */
case o @ TypeDef(n, rhs) if o.symbol.is(Flags.Module) =>
val name = filteredName(n.toString.dropRight(1))
ObjectImpl(name, collectMembers(rhs, prev :+ name), flags(o), prev :+ (name + "$"))
/** class / case class */
case c @ TypeDef(n, rhs) if c.symbol.isClass =>
val name = filteredName(n.toString)
val newPath = prev :+ name
(name, collectMembers(rhs), flags(c), newPath, None) match {
case x if c.symbol.is(Flags.CaseClass) => CaseClassImpl.tupled(x)
case x => ClassImpl.tupled(x)
}
/** def */
case d: DefDef =>
DefImpl(filteredName(d.name.toString), flags(d), path(d), returnType(d.tpt))
/** val */
case v: ValDef if !v.symbol.is(Flags.ModuleVal) =>
ValImpl(filteredName(v.name.toString), flags(v), path(v), returnType(v.tpt))
case x => {
//dottydoc.println(s"Found unwanted entity: $x (${x.pos},\n${x.show}")
NonEntity
}
}
}
var packages: Map[String, Package] = Map.empty
def addEntity(p: Package): Package = {
def mergedChildren(x1s: List[Entity], x2s: List[Entity]): List[Entity] = {
val (packs1, others1) = x1s.partition(_.kind == "package")
val (packs2, others2) = x2s.partition(_.kind == "package")
val others = others1 ::: others2
val packs = (packs1 ::: packs2).groupBy(_.path).map(_._2.head)
(others ++ packs).sortBy(_.name)
}
val path = p.path.mkString(".")
val newPack = packages.get(path).map {
case ex: PackageImpl =>
if (!ex.comment.isDefined) ex.comment = p.comment
ex.members = mergedChildren(ex.members, p.members)
ex
}.getOrElse(p)
packages = packages + (path -> newPack)
newPack
}
private[this] var totalRuns = 0
private[this] var currentRun = 0
override def run(implicit ctx: Context): Unit = {
currentRun += 1
println(s"Compiling ($currentRun/$totalRuns): ${ctx.compilationUnit.source.file.name}")
collect(ctx.compilationUnit.tpdTree) // Will put packages in `packages` var
}
override def runOn(units: List[CompilationUnit])(implicit ctx: Context): List[CompilationUnit] = {
// (1) Create package structure for all `units`, this will give us a complete structure
totalRuns = units.length
val compUnits = super.runOn(units)
// (2) Set parents of entities, needed for linking
for {
parent <- packages.values
child <- parent.children
} setParent(child, to = parent)
// (3) Create documentation template from docstrings, with internal links
println("Generating documentation, this might take a while...")
commentParser.parse(packages)
// (4) Write the finished model to JSON
val outputDir = {
val out = ctx.settings.DocOutput.value
if (out.last == '/') out.dropRight(1)
else out
}
if (!ctx.settings.YDocNoWrite.value) (new util.OutputWriter).write(packages, outputDir)
// (5) Clear caches
commentParser.clear()
// Return super's result
compUnits
}
}
}
|
