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
|
/* NSC -- new Scala compiler
* Copyright 2007-2013 LAMP/EPFL
* @author David Bernard, Manohar Jonnalagedda
*/
package scala.tools.nsc
package doc
package html
import model._
import java.io.{ File => JFile }
import io.{ Streamable, Directory }
import scala.collection._
import page.diagram._
import scala.reflect.internal.Reporter
/** A class that can generate Scaladoc sites to some fixed root folder.
* @author David Bernard
* @author Gilles Dubochet */
class HtmlFactory(val universe: doc.Universe, val reporter: Reporter) {
import page.{IndexScript, EntityPage}
/** The character encoding to be used for generated Scaladoc sites.
* This value is currently always UTF-8. */
def encoding: String = "UTF-8"
def siteRoot: JFile = new JFile(universe.settings.outdir.value)
def libResources = List(
"class.svg",
"object.svg",
"trait.svg",
"package.svg",
"class_comp.svg",
"object_comp.svg",
"trait_comp.svg",
"object_comp_trait.svg",
"abstract_type.svg",
"lato-v11-latin-100.eot",
"lato-v11-latin-100.ttf",
"lato-v11-latin-100.woff",
"lato-v11-latin-regular.eot",
"lato-v11-latin-regular.ttf",
"lato-v11-latin-regular.woff",
"open-sans-v13-latin-regular.eot",
"open-sans-v13-latin-regular.ttf",
"open-sans-v13-latin-regular.woff",
"source-code-pro-v6-latin-700.eot",
"source-code-pro-v6-latin-700.ttf",
"source-code-pro-v6-latin-700.woff",
"source-code-pro-v6-latin-regular.eot",
"source-code-pro-v6-latin-regular.ttf",
"source-code-pro-v6-latin-regular.woff",
"MaterialIcons-Regular.eot",
"MaterialIcons-Regular.ttf",
"MaterialIcons-Regular.woff",
"index.js",
"jquery.js",
"jquery.mousewheel.min.js",
"jquery.panzoom.min.js",
"scheduler.js",
"diagrams.js",
"template.js",
"tools.tooltip.js",
"modernizr.custom.js",
"index.css",
"ref-index.css",
"template.css",
"diagrams.css",
"class_diagram.png",
"object_diagram.png",
"trait_diagram.png",
"type_diagram.png",
"ownderbg2.gif",
"ownerbg.gif",
"ownerbg2.gif"
)
/** Generates the Scaladoc site for a model into the site root.
* A scaladoc site is a set of HTML and related files
* that document a model extracted from a compiler run.
*/
def generate() {
def copyResource(subPath: String) {
val bytes = new Streamable.Bytes {
val p = "/scala/tools/nsc/doc/html/resource/" + subPath
val inputStream = getClass.getResourceAsStream(p)
assert(inputStream != null, p)
}.toByteArray()
val dest = Directory(siteRoot) / subPath
dest.parent.createDirectory()
val out = dest.toFile.bufferedOutput()
try out.write(bytes, 0, bytes.length)
finally out.close()
}
libResources foreach (s => copyResource("lib/" + s))
IndexScript(universe) writeFor this
try {
writeTemplates(_ writeFor this)
} finally {
DiagramStats.printStats(universe.settings)
universe.dotRunner.cleanup()
}
}
def writeTemplates(writeForThis: HtmlPage => Unit) {
val written = mutable.HashSet.empty[DocTemplateEntity]
def writeTemplate(tpl: DocTemplateEntity) {
if (!(written contains tpl)) {
val diagramGenerator: DiagramGenerator = new DotDiagramGenerator(universe.settings, universe.dotRunner)
writeForThis(page.EntityPage(universe, diagramGenerator, tpl, reporter))
written += tpl
tpl.templates collect { case d: DocTemplateEntity => d } map writeTemplate
}
}
writeTemplate(universe.rootPackage)
}
}
|
