author | wenzelm |
Wed, 03 Nov 2021 22:55:22 +0100 | |
changeset 74679 | 0efa6a8b6e20 |
parent 74678 | e04806c89b10 |
child 74682 | ce4adcc85f6c |
permissions | -rw-r--r-- |
73718 | 1 |
/* Title: Pure/Thy/presentation.scala |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
2 |
Author: Makarius |
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
3 |
|
73718 | 4 |
HTML presentation of PIDE document content. |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
5 |
*/ |
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
6 |
|
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
7 |
package isabelle |
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
8 |
|
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
9 |
|
74677 | 10 |
import scala.annotation.tailrec |
51402 | 11 |
import scala.collection.immutable.SortedMap |
74677 | 12 |
import scala.collection.mutable |
51402 | 13 |
|
14 |
||
72652 | 15 |
object Presentation |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
16 |
{ |
72957 | 17 |
/** HTML documents **/ |
18 |
||
73718 | 19 |
/* HTML context */ |
20 |
||
72962 | 21 |
val fonts_path = Path.explode("fonts") |
22 |
||
72957 | 23 |
sealed case class HTML_Document(title: String, content: String) |
24 |
||
72959 | 25 |
def html_context(fonts_url: String => String = HTML.fonts_url()): HTML_Context = |
26 |
new HTML_Context(fonts_url) |
|
27 |
||
28 |
final class HTML_Context private[Presentation](fonts_url: String => String) |
|
29 |
{ |
|
73340 | 30 |
def init_fonts(dir: Path): Unit = |
72962 | 31 |
{ |
32 |
val fonts_dir = Isabelle_System.make_directory(dir + fonts_path) |
|
33 |
for (entry <- Isabelle_Fonts.fonts(hidden = true)) |
|
73317 | 34 |
Isabelle_System.copy_file(entry.path, fonts_dir) |
72962 | 35 |
} |
36 |
||
37 |
def head(title: String, rest: XML.Body = Nil): XML.Tree = |
|
38 |
HTML.div("head", HTML.chapter(title) :: rest) |
|
39 |
||
40 |
def source(body: XML.Body): XML.Tree = HTML.pre("source", body) |
|
41 |
||
74677 | 42 |
def offset_ref(offset: Text.Range): String = |
43 |
"offset/" + offset.start + ".." + offset.stop |
|
44 |
||
45 |
def export_ref(entity: Entity): String = |
|
46 |
Export_Theory.export_kind(entity.kind) + "/" + entity.name |
|
47 |
||
72962 | 48 |
def contents(heading: String, items: List[XML.Body], css_class: String = "contents") |
49 |
: List[XML.Elem] = |
|
50 |
{ |
|
51 |
if (items.isEmpty) Nil |
|
52 |
else List(HTML.div(css_class, List(HTML.section(heading), HTML.itemize(items)))) |
|
53 |
} |
|
54 |
||
72959 | 55 |
def output_document(title: String, body: XML.Body): String = |
56 |
HTML.output_document( |
|
57 |
List( |
|
58 |
HTML.style(HTML.fonts_css(fonts_url) + "\n\n" + File.read(HTML.isabelle_css)), |
|
59 |
HTML.title(title)), |
|
60 |
List(HTML.source(body)), css = "", structural = false) |
|
61 |
||
62 |
def html_document(title: String, body: XML.Body): HTML_Document = |
|
63 |
HTML_Document(title, output_document(title, body)) |
|
64 |
} |
|
65 |
||
72957 | 66 |
|
73055 | 67 |
/* presentation elements */ |
68 |
||
69 |
sealed case class Elements( |
|
70 |
html: Markup.Elements = Markup.Elements.empty, |
|
73056 | 71 |
entity: Markup.Elements = Markup.Elements.empty, |
73055 | 72 |
language: Markup.Elements = Markup.Elements.empty) |
72957 | 73 |
|
73055 | 74 |
val elements1: Elements = |
75 |
Elements( |
|
74677 | 76 |
html = Rendering.foreground_elements ++ Rendering.text_color_elements + |
73056 | 77 |
Markup.NUMERAL + Markup.COMMENT + Markup.ENTITY + Markup.LANGUAGE, |
74677 | 78 |
entity = Markup.Elements(Markup.THEORY, Markup.TYPE_NAME, Markup.CONSTANT, Markup.FACT, |
79 |
Markup.CLASS, Markup.LOCALE, Markup.FREE)) |
|
73036 | 80 |
|
73055 | 81 |
val elements2: Elements = |
82 |
Elements( |
|
83 |
html = elements1.html ++ Rendering.markdown_elements, |
|
73056 | 84 |
language = Markup.Elements(Markup.Language.DOCUMENT)) |
73055 | 85 |
|
74678 | 86 |
|
87 |
/* formal entities */ |
|
74677 | 88 |
|
89 |
type Entity = Export_Theory.Entity[Export_Theory.No_Content] |
|
90 |
||
91 |
case class Entity_Context(node: Document.Node.Name) |
|
92 |
{ |
|
93 |
val seen_ranges: mutable.Set[Symbol.Range] = mutable.Set.empty |
|
94 |
} |
|
73055 | 95 |
|
74678 | 96 |
|
73718 | 97 |
/* HTML output */ |
73036 | 98 |
|
72957 | 99 |
private val div_elements = |
100 |
Set(HTML.div.name, HTML.pre.name, HTML.par.name, HTML.list.name, HTML.enum.name, |
|
101 |
HTML.descr.name) |
|
102 |
||
73056 | 103 |
def make_html( |
74677 | 104 |
name: Document.Node.Name, |
73056 | 105 |
elements: Elements, |
74677 | 106 |
entity_anchor: (Entity_Context, Symbol.Range, XML.Body) => Option[XML.Tree], |
107 |
entity_link: (Entity_Context, Properties.T, XML.Body) => Option[XML.Tree], |
|
73056 | 108 |
xml: XML.Body): XML.Body = |
73054 | 109 |
{ |
74677 | 110 |
val context = Entity_Context(name) |
111 |
||
73054 | 112 |
def html_div(html: XML.Body): Boolean = |
113 |
html exists { |
|
114 |
case XML.Elem(markup, body) => div_elements.contains(markup.name) || html_div(body) |
|
115 |
case XML.Text(_) => false |
|
116 |
} |
|
72957 | 117 |
|
73055 | 118 |
def html_class(c: String, html: XML.Body): XML.Body = |
119 |
if (c == "") html |
|
120 |
else if (html_div(html)) List(HTML.div(c, html)) |
|
121 |
else List(HTML.span(c, html)) |
|
72957 | 122 |
|
74677 | 123 |
def html_body(xml_body: XML.Body, end_offset: Symbol.Offset): (XML.Body, Symbol.Offset) = |
124 |
xml_body.foldRight((List.empty[XML.Tree], end_offset)) { case (tree, (res, end_offset1)) => |
|
125 |
val (res1, offset) = html_body_single(tree, end_offset1) |
|
126 |
(res1 ++ res, offset) |
|
127 |
} |
|
128 |
||
129 |
@tailrec |
|
130 |
def html_body_single(xml_tree: XML.Tree, end_offset: Symbol.Offset): (XML.Body, Symbol.Offset) = |
|
131 |
xml_tree match { |
|
132 |
case XML.Wrapped_Elem(markup, _, body) => html_body_single(XML.Elem(markup, body), end_offset) |
|
73056 | 133 |
case XML.Elem(Markup(Markup.ENTITY, props @ Markup.Kind(kind)), body) => |
74677 | 134 |
val (body1, offset) = html_body(body, end_offset) |
73056 | 135 |
if (elements.entity(kind)) { |
74677 | 136 |
entity_link(context, props, body1) match { |
137 |
case Some(link) => (List(link), offset) |
|
138 |
case None => (body1, offset) |
|
73056 | 139 |
} |
140 |
} |
|
74677 | 141 |
else (body1, offset) |
73055 | 142 |
case XML.Elem(Markup(Markup.LANGUAGE, Markup.Name(name)), body) => |
74677 | 143 |
val (body1, offset) = html_body(body, end_offset) |
144 |
(html_class(if (elements.language(name)) name else "", body1), offset) |
|
73055 | 145 |
case XML.Elem(Markup(Markup.MARKDOWN_PARAGRAPH, _), body) => |
74677 | 146 |
val (body1, offset) = html_body(body, end_offset) |
147 |
(List(HTML.par(body1)), offset) |
|
73055 | 148 |
case XML.Elem(Markup(Markup.MARKDOWN_ITEM, _), body) => |
74677 | 149 |
val (body1, offset) = html_body(body, end_offset) |
150 |
(List(HTML.item(body1)), offset) |
|
151 |
case XML.Elem(Markup(Markup.Markdown_Bullet.name, _), text) => |
|
152 |
(Nil, end_offset - Symbol.length(Symbol.decode(XML.content(text)))) |
|
73054 | 153 |
case XML.Elem(Markup.Markdown_List(kind), body) => |
74677 | 154 |
val (body1, offset) = html_body(body, end_offset) |
155 |
if (kind == Markup.ENUMERATE) (List(HTML.enum(body1)), offset) |
|
156 |
else (List(HTML.list(body1)), offset) |
|
73054 | 157 |
case XML.Elem(markup, body) => |
158 |
val name = markup.name |
|
74677 | 159 |
val (body1, offset) = html_body(body, end_offset) |
73054 | 160 |
val html = |
161 |
markup.properties match { |
|
162 |
case Markup.Kind(kind) if kind == Markup.COMMAND || kind == Markup.KEYWORD => |
|
74677 | 163 |
html_class(kind, body1) |
73054 | 164 |
case _ => |
74677 | 165 |
body1 |
73054 | 166 |
} |
167 |
Rendering.foreground.get(name) orElse Rendering.text_color.get(name) match { |
|
74677 | 168 |
case Some(c) => (html_class(c.toString, html), offset) |
169 |
case None => (html_class(name, html), offset) |
|
72957 | 170 |
} |
73054 | 171 |
case XML.Text(text) => |
74677 | 172 |
val decoded = Symbol.decode(text) |
173 |
val offset = end_offset - Symbol.length(decoded) |
|
174 |
val body = HTML.text(decoded) |
|
175 |
entity_anchor(context, Text.Range(offset, end_offset), body) match { |
|
176 |
case Some(body1) => (List(body1), offset) |
|
177 |
case None => (body, offset) |
|
178 |
} |
|
73054 | 179 |
} |
180 |
||
74677 | 181 |
html_body(xml, Symbol.length(Symbol.decode(XML.content(xml))) + 1)._1 |
73054 | 182 |
} |
72957 | 183 |
|
184 |
||
185 |
/* PIDE HTML document */ |
|
186 |
||
187 |
def html_document( |
|
188 |
resources: Resources, |
|
189 |
snapshot: Document.Snapshot, |
|
72962 | 190 |
html_context: HTML_Context, |
73055 | 191 |
elements: Elements, |
72959 | 192 |
plain_text: Boolean = false): HTML_Document = |
72957 | 193 |
{ |
73120
c3589f2dff31
more informative errors: simplify diagnosis of spurious failures reported by users;
wenzelm
parents:
73059
diff
changeset
|
194 |
require(!snapshot.is_outdated, "document snapshot outdated") |
72957 | 195 |
|
196 |
val name = snapshot.node_name |
|
197 |
if (plain_text) { |
|
72962 | 198 |
val title = "File " + Symbol.cartouche_decoded(name.path.file_name) |
72959 | 199 |
val body = HTML.text(snapshot.node.source) |
72962 | 200 |
html_context.html_document(title, body) |
72957 | 201 |
} |
202 |
else { |
|
72962 | 203 |
resources.html_document(snapshot) getOrElse { |
204 |
val title = |
|
205 |
if (name.is_theory) "Theory " + quote(name.theory_base_name) |
|
206 |
else "File " + Symbol.cartouche_decoded(name.path.file_name) |
|
74677 | 207 |
val xml = snapshot.xml_markup(elements = elements.html) |
208 |
val body = make_html(name, elements, (_, _, _) => None, (_, _, _) => None, xml) |
|
72962 | 209 |
html_context.html_document(title, body) |
72957 | 210 |
} |
211 |
} |
|
212 |
} |
|
213 |
||
214 |
||
215 |
||
73718 | 216 |
/** HTML presentation **/ |
72649 | 217 |
|
72648 | 218 |
/* presentation context */ |
219 |
||
220 |
object Context |
|
221 |
{ |
|
222 |
val none: Context = new Context { def enabled: Boolean = false } |
|
223 |
val standard: Context = new Context { def enabled: Boolean = true } |
|
224 |
||
225 |
def dir(path: Path): Context = |
|
226 |
new Context { |
|
227 |
def enabled: Boolean = true |
|
228 |
override def dir(store: Sessions.Store): Path = path |
|
229 |
} |
|
230 |
||
231 |
def make(s: String): Context = |
|
232 |
if (s == ":") standard else dir(Path.explode(s)) |
|
233 |
} |
|
234 |
||
235 |
abstract class Context private |
|
236 |
{ |
|
237 |
def enabled: Boolean |
|
238 |
def enabled(info: Sessions.Info): Boolean = enabled || info.browser_info |
|
239 |
def dir(store: Sessions.Store): Path = store.presentation_dir |
|
240 |
def dir(store: Sessions.Store, info: Sessions.Info): Path = |
|
72670 | 241 |
dir(store) + Path.explode(info.chapter_session) |
72648 | 242 |
} |
243 |
||
244 |
||
72955
942bf91545fa
clarified comments: file-system access is always unsynchronized;
wenzelm
parents:
72882
diff
changeset
|
245 |
/* maintain chapter index */ |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
246 |
|
51399
6ac3c29a300e
discontinued "isabelle usedir" option -r (reset session path);
wenzelm
parents:
50707
diff
changeset
|
247 |
private val sessions_path = Path.basic(".sessions") |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
248 |
|
51402 | 249 |
private def read_sessions(dir: Path): List[(String, String)] = |
250 |
{ |
|
51416 | 251 |
val path = dir + sessions_path |
252 |
if (path.is_file) { |
|
253 |
import XML.Decode._ |
|
65344
b99283eed13c
clarified YXML vs. symbol encoding: operate on whole message;
wenzelm
parents:
65089
diff
changeset
|
254 |
list(pair(string, string))(Symbol.decode_yxml(File.read(path))) |
51416 | 255 |
} |
256 |
else Nil |
|
51402 | 257 |
} |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
258 |
|
73340 | 259 |
private def write_sessions(dir: Path, sessions: List[(String, String)]): Unit = |
51402 | 260 |
{ |
261 |
import XML.Encode._ |
|
262 |
File.write(dir + sessions_path, YXML.string_of_body(list(pair(string, string))(sessions))) |
|
263 |
} |
|
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
264 |
|
73340 | 265 |
def update_chapter_index( |
266 |
browser_info: Path, chapter: String, new_sessions: List[(String, String)]): Unit = |
|
51399
6ac3c29a300e
discontinued "isabelle usedir" option -r (reset session path);
wenzelm
parents:
50707
diff
changeset
|
267 |
{ |
72376 | 268 |
val dir = Isabelle_System.make_directory(browser_info + Path.basic(chapter)) |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
269 |
|
51399
6ac3c29a300e
discontinued "isabelle usedir" option -r (reset session path);
wenzelm
parents:
50707
diff
changeset
|
270 |
val sessions0 = |
51406
950b897f95bb
proper path -- I/O was hidden due to permissiveness;
wenzelm
parents:
51402
diff
changeset
|
271 |
try { read_sessions(dir) } |
51987 | 272 |
catch { case _: XML.Error => Nil } |
51399
6ac3c29a300e
discontinued "isabelle usedir" option -r (reset session path);
wenzelm
parents:
50707
diff
changeset
|
273 |
|
51402 | 274 |
val sessions = (SortedMap.empty[String, String] ++ sessions0 ++ new_sessions).toList |
65988 | 275 |
write_sessions(dir, sessions) |
51402 | 276 |
|
65988 | 277 |
val title = "Isabelle/" + chapter + " sessions" |
278 |
HTML.write_document(dir, "index.html", |
|
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73474
diff
changeset
|
279 |
List(HTML.title(title + Isabelle_System.isabelle_heading())), |
65988 | 280 |
HTML.chapter(title) :: |
281 |
(if (sessions.isEmpty) Nil |
|
282 |
else |
|
65992 | 283 |
List(HTML.div("sessions", |
284 |
List(HTML.description( |
|
65988 | 285 |
sessions.map({ case (name, description) => |
69318 | 286 |
val descr = Symbol.trim_blank_lines(description) |
65989 | 287 |
(List(HTML.link(name + "/index.html", HTML.text(name))), |
69318 | 288 |
if (descr == "") Nil |
289 |
else HTML.break ::: List(HTML.pre(HTML.text(descr)))) }))))))) |
|
51399
6ac3c29a300e
discontinued "isabelle usedir" option -r (reset session path);
wenzelm
parents:
50707
diff
changeset
|
290 |
} |
61372 | 291 |
|
73340 | 292 |
def make_global_index(browser_info: Path): Unit = |
61372 | 293 |
{ |
294 |
if (!(browser_info + Path.explode("index.html")).is_file) { |
|
72375 | 295 |
Isabelle_System.make_directory(browser_info) |
73317 | 296 |
Isabelle_System.copy_file(Path.explode("~~/lib/logo/isabelle.gif"), |
61372 | 297 |
browser_info + Path.explode("isabelle.gif")) |
73528
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
298 |
val title = "The " + XML.text(Isabelle_System.isabelle_name()) + " Library" |
61372 | 299 |
File.write(browser_info + Path.explode("index.html"), |
73529 | 300 |
HTML.header + |
301 |
""" |
|
73528
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
302 |
<head> |
73529 | 303 |
""" + HTML.head_meta + """ |
73528
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
304 |
<title>""" + title + """</title> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
305 |
</head> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
306 |
|
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
307 |
<body text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#000099" alink="#404040"> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
308 |
<center> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
309 |
<table width="100%" border="0" cellspacing="10" cellpadding="0"> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
310 |
<tr> |
74676 | 311 |
<td width="20%" valign="middle" align="center"><a href="https://isabelle.in.tum.de/"><img align="bottom" src="isabelle.gif" width="100" height="86" alt="[Isabelle]" border="0" /></a></td> |
73528
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
312 |
|
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
313 |
<td width="80%" valign="middle" align="center"> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
314 |
<table width="90%" border="0" cellspacing="0" cellpadding="20"> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
315 |
<tr> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
316 |
<td valign="middle" align="center" bgcolor="#AACCCC"><font face="Helvetica,Arial" size="+2">""" + title + """</font></td> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
317 |
</tr> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
318 |
</table> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
319 |
</td> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
320 |
</tr> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
321 |
</table> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
322 |
</center> |
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
323 |
<hr /> |
74670
b2604cd4d131
recover library_index_content.template from c337c798f64c: required for website/build/main;
wenzelm
parents:
73718
diff
changeset
|
324 |
""" + File.read(Path.explode("~~/lib/html/library_index_content.template")) + |
b2604cd4d131
recover library_index_content.template from c337c798f64c: required for website/build/main;
wenzelm
parents:
73718
diff
changeset
|
325 |
""" |
73528
c337c798f64c
clarified HTML template (see also 04cb7e02ca38): avoid odd patching of sources;
wenzelm
parents:
73523
diff
changeset
|
326 |
</body> |
73529 | 327 |
""" + HTML.footer) |
61372 | 328 |
} |
329 |
} |
|
330 |
||
331 |
||
74677 | 332 |
/* cache */ |
333 |
||
334 |
class Entity_Cache private(cache: mutable.Map[Document.Node.Name, Seq[Entity]]) |
|
335 |
{ |
|
336 |
def get_or_update(node: Document.Node.Name, e: => Seq[Entity]): Seq[Entity] = |
|
337 |
cache.getOrElseUpdate(node, e) |
|
338 |
} |
|
339 |
object Entity_Cache |
|
340 |
{ |
|
341 |
def empty: Entity_Cache = new Entity_Cache(mutable.Map.empty) |
|
342 |
} |
|
343 |
||
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
344 |
/* present session */ |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
345 |
|
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
346 |
val session_graph_path = Path.explode("session_graph.pdf") |
72959 | 347 |
val readme_path = Path.explode("README.html") |
348 |
val files_path = Path.explode("files") |
|
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
349 |
|
74677 | 350 |
def html_name(name: Document.Node.Name): String = Path.explode(name.theory_base_name).html.implode |
351 |
def html_path(path: Path): String = (files_path + path.squash.html).implode |
|
352 |
||
353 |
def session_relative(deps: Sessions.Deps, session0: String, session1: String): Option[String] = |
|
354 |
{ |
|
355 |
for { |
|
356 |
info0 <- deps.sessions_structure.get(session0) |
|
357 |
info1 <- deps.sessions_structure.get(session1) |
|
358 |
} yield info0.relative_path(info1) |
|
359 |
} |
|
360 |
||
361 |
def node_relative( |
|
362 |
deps: Sessions.Deps, |
|
363 |
session0: String, |
|
364 |
node_name: Document.Node.Name): Option[String] = |
|
365 |
{ |
|
366 |
val session1 = deps(session0).theory_qualifier(node_name) |
|
367 |
session_relative(deps, session0, session1) |
|
368 |
} |
|
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
369 |
|
73042 | 370 |
def theory_link(deps: Sessions.Deps, session0: String, |
74677 | 371 |
name: Document.Node.Name, body: XML.Body, anchor: Option[String] = None): Option[XML.Tree] = |
73042 | 372 |
{ |
373 |
val session1 = deps(session0).theory_qualifier(name) |
|
73057 | 374 |
val info0 = deps.sessions_structure.get(session0) |
375 |
val info1 = deps.sessions_structure.get(session1) |
|
74677 | 376 |
val fragment = if (anchor.isDefined) "#" + anchor.get else "" |
73057 | 377 |
if (info0.isDefined && info1.isDefined) { |
74677 | 378 |
Some(HTML.link(info0.get.relative_path(info1.get) + html_name(name) + fragment, body)) |
73057 | 379 |
} |
380 |
else None |
|
73042 | 381 |
} |
382 |
||
72648 | 383 |
def session_html( |
72962 | 384 |
resources: Resources, |
72648 | 385 |
session: String, |
386 |
deps: Sessions.Deps, |
|
72683 | 387 |
db_context: Sessions.Database_Context, |
72992 | 388 |
progress: Progress = new Progress, |
73022
38528017e4c8
more verbosity for potentially bulky presentation;
wenzelm
parents:
72992
diff
changeset
|
389 |
verbose: Boolean = false, |
72962 | 390 |
html_context: HTML_Context, |
73055 | 391 |
elements: Elements, |
74677 | 392 |
presentation: Context, |
393 |
seen_nodes_cache: Entity_Cache = Entity_Cache.empty): Unit = |
|
61372 | 394 |
{ |
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
395 |
val info = deps.sessions_structure(session) |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
396 |
val options = info.options |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
397 |
val base = deps(session) |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
398 |
|
72683 | 399 |
val session_dir = presentation.dir(db_context.store, info) |
72962 | 400 |
|
401 |
html_context.init_fonts(session_dir) |
|
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
402 |
|
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
403 |
Bytes.write(session_dir + session_graph_path, |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
404 |
graphview.Graph_File.make_pdf(options, base.session_graph_display)) |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
405 |
|
72673
8ff7a0e394f9
clarified PDF/HTML presentation, based on pdf blobs from session database (e.g. from earlier builds);
wenzelm
parents:
72670
diff
changeset
|
406 |
val documents = |
72683 | 407 |
for { |
408 |
doc <- info.document_variants |
|
73718 | 409 |
document <- db_context.input_database(session)(Document_Build.read_document(_, _, doc.name)) |
73022
38528017e4c8
more verbosity for potentially bulky presentation;
wenzelm
parents:
72992
diff
changeset
|
410 |
} yield { |
38528017e4c8
more verbosity for potentially bulky presentation;
wenzelm
parents:
72992
diff
changeset
|
411 |
if (verbose) progress.echo("Presenting document " + session + "/" + doc.name) |
38528017e4c8
more verbosity for potentially bulky presentation;
wenzelm
parents:
72992
diff
changeset
|
412 |
Bytes.write(session_dir + doc.path.pdf, document.pdf) |
38528017e4c8
more verbosity for potentially bulky presentation;
wenzelm
parents:
72992
diff
changeset
|
413 |
doc |
38528017e4c8
more verbosity for potentially bulky presentation;
wenzelm
parents:
72992
diff
changeset
|
414 |
} |
72673
8ff7a0e394f9
clarified PDF/HTML presentation, based on pdf blobs from session database (e.g. from earlier builds);
wenzelm
parents:
72670
diff
changeset
|
415 |
|
73041 | 416 |
val view_links = |
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
417 |
{ |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
418 |
val deps_link = |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
419 |
HTML.link(session_graph_path, HTML.text("theory dependencies")) |
61372 | 420 |
|
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
421 |
val readme_links = |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
422 |
if ((info.dir + readme_path).is_file) { |
73317 | 423 |
Isabelle_System.copy_file(info.dir + readme_path, session_dir + readme_path) |
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
424 |
List(HTML.link(readme_path, HTML.text("README"))) |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
425 |
} |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
426 |
else Nil |
62971
087e36ce0593
back to exact copy of non-text file (amending dcc8e1d34b18);
wenzelm
parents:
62631
diff
changeset
|
427 |
|
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
428 |
val document_links = |
72673
8ff7a0e394f9
clarified PDF/HTML presentation, based on pdf blobs from session database (e.g. from earlier builds);
wenzelm
parents:
72670
diff
changeset
|
429 |
documents.map(doc => HTML.link(doc.path.pdf, HTML.text(doc.name))) |
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
430 |
|
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
431 |
Library.separate(HTML.break ::: HTML.nl, |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
432 |
(deps_link :: readme_links ::: document_links). |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
433 |
map(link => HTML.text("View ") ::: List(link))).flatten |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
434 |
} |
62971
087e36ce0593
back to exact copy of non-text file (amending dcc8e1d34b18);
wenzelm
parents:
62631
diff
changeset
|
435 |
|
74678 | 436 |
def read_exports(name: Document.Node.Name): Seq[Entity] = |
74677 | 437 |
{ |
438 |
seen_nodes_cache.get_or_update(name, { |
|
74678 | 439 |
if (Sessions.is_pure(name.theory_base_name)) Vector.empty |
440 |
else { |
|
74677 | 441 |
val session1 = deps(session).theory_qualifier(name) |
442 |
val provider = Export.Provider.database_context(db_context, List(session1), name.theory) |
|
443 |
provider(Export.THEORY_PREFIX + "parents") match { |
|
444 |
case Some(_) => |
|
445 |
val theory = Export_Theory.read_theory(provider, session1, name.theory) |
|
446 |
theory.entity_iterator.toVector |
|
447 |
case None => |
|
448 |
progress.echo_error_message("No exports for: " + name) |
|
449 |
Vector.empty |
|
450 |
} |
|
451 |
} |
|
452 |
}) |
|
453 |
} |
|
454 |
||
455 |
val exports = base.known_theories.map(_._2.name).map(node => node -> read_exports(node)).toMap |
|
74678 | 456 |
val export_ranges = |
457 |
exports.view.mapValues(_.groupBy(entity => |
|
458 |
Text.Range(Position.Offset.get(entity.pos), Position.End_Offset.get(entity.pos)))).toMap |
|
459 |
val export_names = |
|
460 |
exports.map { |
|
461 |
case (node, entities) => node.theory -> entities.map(entity => entity.name -> entity).toMap |
|
462 |
} |
|
74677 | 463 |
|
72989 | 464 |
val theories: List[XML.Body] = |
72962 | 465 |
{ |
466 |
var seen_files = List.empty[(Path, String, Document.Node.Name)] |
|
73056 | 467 |
|
74678 | 468 |
def node_file(node: Document.Node.Name): String = |
74677 | 469 |
if (node.node.endsWith(".thy")) html_name(node) else html_path(Path.explode(node.node)) |
470 |
||
74678 | 471 |
def entity_anchor( |
472 |
context: Entity_Context, range: Symbol.Range, body: XML.Body): Option[XML.Elem] = |
|
74677 | 473 |
{ |
474 |
body match { |
|
475 |
case List(XML.Elem(Markup("span", List("id" -> _)), _)) => None |
|
476 |
case _ => |
|
477 |
Some { |
|
74678 | 478 |
val body1 = |
479 |
if (context.seen_ranges.contains(range)) { |
|
74679 | 480 |
HTML.entity_def(HTML.span(HTML.id(html_context.offset_ref(range)), body)) |
74678 | 481 |
} |
482 |
else HTML.span(body) |
|
74677 | 483 |
export_ranges.get(context.node).flatMap(_.get(range)) match { |
484 |
case Some(entities) => |
|
485 |
entities.map(html_context.export_ref).foldLeft(body1) { |
|
74679 | 486 |
case (elem, id) => |
487 |
HTML.entity_def(HTML.span(HTML.id(id), List(elem))) |
|
74677 | 488 |
} |
489 |
case None => body1 |
|
490 |
} |
|
491 |
} |
|
492 |
} |
|
493 |
} |
|
494 |
||
74678 | 495 |
def entity_ref(theory: String, name: String): Option[String] = |
74677 | 496 |
export_names.get(theory).flatMap(_.get(name)).map(html_context.export_ref) |
497 |
||
74678 | 498 |
def offset_ref(context: Entity_Context, theory: String, props: Properties.T): Option[String] = |
499 |
{ |
|
74677 | 500 |
if (theory == context.node.theory) { |
501 |
for { |
|
502 |
offset <- Position.Def_Offset.unapply(props) |
|
503 |
end_offset <- Position.Def_End_Offset.unapply(props) |
|
504 |
range = Text.Range(offset, end_offset) |
|
505 |
} yield { |
|
506 |
context.seen_ranges += range |
|
507 |
html_context.offset_ref(range) |
|
508 |
} |
|
509 |
} else None |
|
510 |
} |
|
511 |
||
74678 | 512 |
def entity_link( |
513 |
context: Entity_Context, props: Properties.T, body: XML.Body): Option[XML.Elem] = |
|
74677 | 514 |
{ |
515 |
(props, props, props, props) match { |
|
516 |
case (Markup.Kind(Markup.THEORY), Markup.Name(theory), Position.Def_File(thy_file), _) => |
|
73057 | 517 |
val node_name = resources.file_node(Path.explode(thy_file), theory = theory) |
74678 | 518 |
node_relative(deps, session, node_name).map(html_dir => |
519 |
HTML.link(html_dir + html_name(node_name), body)) |
|
74677 | 520 |
case (Markup.Ref(_), Position.Def_File(thy_file), Position.Def_Theory(def_theory), |
521 |
Markup.Name(name)) => |
|
522 |
val theory = if (def_theory.nonEmpty) def_theory else context.node.theory |
|
523 |
val node_name = resources.file_node(Path.explode(thy_file), theory = theory) |
|
524 |
for { |
|
525 |
html_dir <- node_relative(deps, session, node_name) |
|
526 |
html_file = node_file(node_name) |
|
527 |
html_ref <- entity_ref(theory, name).orElse(offset_ref(context, theory, props)) |
|
528 |
} yield { |
|
74679 | 529 |
HTML.entity_ref(HTML.link(html_dir + html_file + "#" + html_ref, body)) |
74677 | 530 |
} |
73056 | 531 |
case _ => None |
532 |
} |
|
74677 | 533 |
} |
73056 | 534 |
|
73215 | 535 |
sealed case class Theory( |
536 |
name: Document.Node.Name, |
|
537 |
command: Command, |
|
538 |
files_html: List[(Path, XML.Tree)], |
|
539 |
html: XML.Tree) |
|
540 |
||
541 |
def read_theory(name: Document.Node.Name): Option[Theory] = |
|
542 |
{ |
|
543 |
progress.expose_interrupt() |
|
73216 | 544 |
if (verbose) progress.echo("Presenting theory " + name) |
73215 | 545 |
|
546 |
for (command <- Build_Job.read_theory(db_context, resources, session, name.theory)) |
|
547 |
yield { |
|
548 |
val snapshot = Document.State.init.snippet(command) |
|
73214 | 549 |
|
73215 | 550 |
val files_html = |
551 |
for { |
|
552 |
(src_path, xml) <- snapshot.xml_markup_blobs(elements = elements.html) |
|
553 |
if xml.nonEmpty |
|
554 |
} |
|
555 |
yield { |
|
556 |
progress.expose_interrupt() |
|
73216 | 557 |
if (verbose) progress.echo("Presenting file " + src_path) |
558 |
||
74677 | 559 |
(src_path, html_context.source( |
560 |
make_html(name, elements, entity_anchor, entity_link, xml))) |
|
73215 | 561 |
} |
562 |
||
563 |
val html = |
|
564 |
html_context.source( |
|
74677 | 565 |
make_html(name, elements, entity_anchor, entity_link, |
566 |
snapshot.xml_markup(elements = elements.html))) |
|
73215 | 567 |
|
568 |
Theory(name, command, files_html, html) |
|
569 |
} |
|
570 |
} |
|
571 |
||
572 |
for (thy <- Par_List.map(read_theory, base.session_theories).flatten) |
|
72669 | 573 |
yield { |
72989 | 574 |
val files = |
73215 | 575 |
for { (src_path, file_html) <- thy.files_html } |
73043 | 576 |
yield { |
74677 | 577 |
val file_name = html_path(src_path) |
72989 | 578 |
|
579 |
seen_files.find(p => p._1 == src_path || p._2 == file_name) match { |
|
73215 | 580 |
case None => seen_files ::= (src_path, file_name, thy.name) |
72989 | 581 |
case Some((_, _, thy_name1)) => |
582 |
error("Incoherent use of file name " + src_path + " as " + quote(file_name) + |
|
73215 | 583 |
" in theory " + thy_name1 + " vs. " + thy.name) |
72989 | 584 |
} |
72669 | 585 |
|
72989 | 586 |
val file_path = session_dir + Path.explode(file_name) |
587 |
html_context.init_fonts(file_path.dir) |
|
588 |
||
589 |
val file_title = "File " + Symbol.cartouche_decoded(src_path.implode_short) |
|
590 |
HTML.write_document(file_path.dir, file_path.file_name, |
|
73215 | 591 |
List(HTML.title(file_title)), List(html_context.head(file_title), file_html)) |
72989 | 592 |
|
593 |
List(HTML.link(file_name, HTML.text(file_title))) |
|
73043 | 594 |
} |
72989 | 595 |
|
73215 | 596 |
val thy_title = "Theory " + thy.name.theory_base_name |
72989 | 597 |
|
73215 | 598 |
HTML.write_document(session_dir, html_name(thy.name), |
599 |
List(HTML.title(thy_title)), List(html_context.head(thy_title), thy.html)) |
|
600 |
||
601 |
List(HTML.link(html_name(thy.name), |
|
602 |
HTML.text(thy.name.theory_base_name) ::: |
|
72989 | 603 |
(if (files.isEmpty) Nil else List(HTML.itemize(files))))) |
72669 | 604 |
} |
72989 | 605 |
} |
61500 | 606 |
|
72622
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
607 |
val title = "Session " + session |
830222403681
HTML presentation in Isabelle/Scala, based on theory html exports from Isabelle/ML;
wenzelm
parents:
72600
diff
changeset
|
608 |
HTML.write_document(session_dir, "index.html", |
73523
2cd23d587db9
further clarification of Isabelle distribution identification -- avoid odd patching of sources;
wenzelm
parents:
73474
diff
changeset
|
609 |
List(HTML.title(title + Isabelle_System.isabelle_heading())), |
73041 | 610 |
html_context.head(title, List(HTML.par(view_links))) :: |
72989 | 611 |
html_context.contents("Theories", theories)) |
61372 | 612 |
} |
50707
5b2bf7611662
maintain session index on Scala side, for more determistic results;
wenzelm
parents:
diff
changeset
|
613 |
} |