unique file names via serial numbers, to allow files like "root" or multiple files with same base name;
1 (* Title: Pure/Thy/present.ML
2 Author: Markus Wenzel and Stefan Berghofer, TU Muenchen
4 Theory presentation: HTML, graph files, (PDF)LaTeX documents.
7 signature BASIC_PRESENT =
9 val no_document: ('a -> 'b) -> 'a -> 'b (*not thread-safe!*)
15 val session_name: theory -> string
16 val write_graph: {name: string, ID: string, dir: string, unfold: bool,
17 path: string, parents: string list} list -> Path.T -> unit
18 val display_graph: {name: string, ID: string, dir: string, unfold: bool,
19 path: string, parents: string list} list -> unit
20 val init: bool -> bool -> string -> bool -> string list -> string list ->
21 string -> (bool * Path.T) option -> Url.T option * bool -> bool ->
22 theory list -> unit (*not thread-safe!*)
23 val finish: unit -> unit (*not thread-safe!*)
24 val init_theory: string -> unit
25 val theory_source: string -> (unit -> HTML.text) -> unit
26 val theory_output: string -> string -> unit
27 val begin_theory: int -> Path.T -> (Path.T * bool) list -> theory -> theory
28 val drafts: string -> Path.T list -> Path.T
31 structure Present: PRESENT =
37 val output_path = Path.variable "ISABELLE_BROWSER_INFO";
39 val tex_ext = Path.ext "tex";
40 val tex_path = tex_ext o Path.basic;
41 val html_ext = Path.ext "html";
42 val html_path = html_ext o Path.basic;
43 val index_path = Path.basic "index.html";
44 val readme_html_path = Path.basic "README.html";
45 val readme_path = Path.basic "README";
46 val documentN = "document";
47 val document_path = Path.basic documentN;
48 val doc_indexN = "session";
49 val graph_path = Path.basic "session.graph";
50 val graph_pdf_path = Path.basic "session_graph.pdf";
51 val graph_eps_path = Path.basic "session_graph.eps";
53 val session_path = Path.basic ".session";
54 val session_entries_path = Path.explode ".session/entries";
55 val pre_index_path = Path.explode ".session/pre-index";
57 fun mk_rel_path [] ys = Path.make ys
58 | mk_rel_path xs [] = Path.appends (replicate (length xs) Path.parent)
59 | mk_rel_path (ps as x :: xs) (qs as y :: ys) = if x = y then mk_rel_path xs ys else
60 Path.appends (replicate (length ps) Path.parent @ [Path.make qs]);
62 fun show_path path = Path.implode (Path.append (File.pwd ()) path);
66 (** additional theory data **)
68 structure Browser_Info = Theory_Data
70 type T = {name: string, session: string list, is_local: bool};
71 val empty = {name = "", session = [], is_local = false}: T;
76 val put_info = Browser_Info.put;
77 val get_info = Browser_Info.get;
78 val session_name = #name o get_info;
85 {name: string, ID: string, dir: string, unfold: bool,
86 path: string, parents: string list};
88 fun write_graph gr path =
89 File.write path (cat_lines (map (fn {name, ID, dir, unfold, path, parents} =>
90 "\"" ^ name ^ "\" \"" ^ ID ^ "\" \"" ^ dir ^ (if unfold then "\" + \"" else "\" \"") ^
91 path ^ "\" > " ^ space_implode " " (map quote parents) ^ " ;") gr));
93 fun display_graph gr =
95 val path = Isabelle_System.create_tmp_path "graph" "";
96 val _ = write_graph gr path;
97 val _ = writeln "Displaying graph ...";
98 val _ = Isabelle_System.isabelle_tool "browser" ("-c " ^ File.shell_path path ^ " &");
102 fun ID_of sess s = space_implode "/" (sess @ [s]);
103 fun ID_of_thy thy = ID_of (#session (get_info thy)) (Context.theory_name thy);
106 (*retrieve graph data from initial collection of theories*)
107 fun init_graph remote_path curr_sess = rev o map (fn thy =>
109 val name = Context.theory_name thy;
110 val {name = sess_name, session, is_local} = get_info thy;
112 {name = name, ID = ID_of session name, dir = sess_name,
114 if null session then "" else
115 if is_some remote_path andalso not is_local then
116 Url.implode (Url.append (the remote_path) (Url.File
117 (Path.append (Path.make session) (html_path name))))
118 else Path.implode (Path.append (mk_rel_path curr_sess session) (html_path name)),
120 parents = map ID_of_thy (Theory.parents_of thy)};
123 fun ins_graph_entry (i, entry as {ID, ...}) (gr: (int * graph_node) list) =
124 (i, entry) :: filter_out (fn (_, entry') => #ID entry' = ID) gr;
128 (** global browser info state **)
130 (* type theory_info *)
132 type theory_info = {tex_source: Buffer.T, html_source: Buffer.T, html: Buffer.T};
134 fun make_theory_info (tex_source, html_source, html) =
135 {tex_source = tex_source, html_source = html_source, html = html}: theory_info;
137 val empty_theory_info = make_theory_info (Buffer.empty, Buffer.empty, Buffer.empty);
139 fun map_theory_info f {tex_source, html_source, html} =
140 make_theory_info (f (tex_source, html_source, html));
143 (* type browser_info *)
145 type browser_info = {theories: theory_info Symtab.table, files: (Path.T * string) list,
146 tex_index: (int * string) list, html_index: (int * string) list, graph: (int * graph_node) list};
148 fun make_browser_info (theories, files, tex_index, html_index, graph) =
149 {theories = theories, files = files, tex_index = tex_index, html_index = html_index,
150 graph = graph}: browser_info;
152 val empty_browser_info = make_browser_info (Symtab.empty, [], [], [], []);
154 fun init_browser_info remote_path curr_sess thys = make_browser_info
155 (Symtab.empty, [], [], [], init_graph remote_path curr_sess thys);
157 fun map_browser_info f {theories, files, tex_index, html_index, graph} =
158 make_browser_info (f (theories, files, tex_index, html_index, graph));
163 val browser_info = Unsynchronized.ref empty_browser_info;
164 fun change_browser_info f =
165 CRITICAL (fn () => Unsynchronized.change browser_info (map_browser_info f));
167 val suppress_tex_source = Unsynchronized.ref false;
168 fun no_document f x = Unsynchronized.setmp suppress_tex_source true f x;
170 fun init_theory_info name info =
171 change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
172 (Symtab.update (name, info) theories, files, tex_index, html_index, graph));
174 fun change_theory_info name f =
175 change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
176 (case Symtab.lookup theories name of
177 NONE => error ("Browser info: cannot access theory document " ^ quote name)
178 | SOME info => (Symtab.update (name, map_theory_info f info) theories, files,
179 tex_index, html_index, graph)));
183 change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
184 (theories, file :: files, tex_index, html_index, graph));
186 fun add_tex_index txt =
187 change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
188 (theories, files, txt :: tex_index, html_index, graph));
190 fun add_html_index txt =
191 change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
192 (theories, files, tex_index, txt :: html_index, graph));
194 fun add_graph_entry entry =
195 change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
196 (theories, files, tex_index, html_index, ins_graph_entry entry graph));
198 fun add_tex_source name txt =
199 if ! suppress_tex_source then ()
200 else change_theory_info name (fn (tex_source, html_source, html) =>
201 (Buffer.add txt tex_source, html_source, html));
203 fun add_html_source name txt = change_theory_info name (fn (tex_source, html_source, html) =>
204 (tex_source, Buffer.add txt html_source, html));
208 (** global session state **)
213 {name: string, parent: string, session: string, path: string list, html_prefix: Path.T,
214 info: bool, doc_format: string, doc_graph: bool, documents: (string * string) list,
215 dump_prefix: (bool * Path.T) option, remote_path: Url.T option, verbose: bool,
216 readme: Path.T option};
218 fun make_session_info
219 (name, parent, session, path, html_prefix, info, doc_format, doc_graph, documents,
220 dump_prefix, remote_path, verbose, readme) =
221 {name = name, parent = parent, session = session, path = path, html_prefix = html_prefix,
222 info = info, doc_format = doc_format, doc_graph = doc_graph, documents = documents,
223 dump_prefix = dump_prefix, remote_path = remote_path, verbose = verbose,
224 readme = readme}: session_info;
229 val session_info = Unsynchronized.ref (NONE: session_info option);
231 fun session_default x f = (case ! session_info of NONE => x | SOME info => f info);
235 (** document preparation **)
239 val session_entries =
240 HTML.session_entries o
241 map (fn name => (Url.File (Path.append (Path.basic name) index_path), name));
243 fun get_entries dir =
244 split_lines (File.read (Path.append dir session_entries_path));
246 fun put_entries entries dir =
247 File.write (Path.append dir session_entries_path) (cat_lines entries);
250 fun create_index dir =
251 File.read (Path.append dir pre_index_path) ^
252 session_entries (get_entries dir) ^ HTML.end_document
253 |> File.write (Path.append dir index_path);
255 fun update_index dir name =
256 (case try get_entries dir of
257 NONE => warning ("Browser info: cannot access session index of " ^ Path.print dir)
258 | SOME es => (put_entries ((remove (op =) name es) @ [name]) dir; create_index dir));
261 (* document variants *)
263 fun read_variant str =
264 (case space_explode "=" str of
266 | [name, tags] => (name, tags)
267 | _ => error ("Malformed document variant specification: " ^ quote str));
269 fun read_variants strs =
270 rev (distinct (eq_fst (op =)) (rev ((documentN, "") :: map read_variant strs)))
271 |> filter_out (fn (_, s) => s = "-");
276 fun name_of_session elems = space_implode "/" ("Isabelle" :: elems);
278 fun init build info doc doc_graph doc_variants path name dump_prefix
279 (remote_path, first_time) verbose thys =
280 if not build andalso not info andalso doc = "" andalso is_none dump_prefix then
281 (browser_info := empty_browser_info; session_info := NONE)
284 val parent_name = name_of_session (take (length path - 1) path);
285 val session_name = name_of_session path;
286 val sess_prefix = Path.make path;
287 val html_prefix = Path.append (Path.expand output_path) sess_prefix;
291 else if not (can File.check_dir document_path) then
292 (if verbose then Output.physical_stderr "Warning: missing document directory\n"
294 else read_variants doc_variants;
296 val parent_index_path = Path.append Path.parent index_path;
299 Url.append (the remote_path) (Url.File (Path.append sess_prefix parent_index_path))
300 else Url.File parent_index_path;
302 if File.exists readme_html_path then SOME readme_html_path
303 else if File.exists readme_path then SOME readme_path
307 (case readme of NONE => [] | SOME p => [(Url.File p, "README")]) @
308 map (fn (name, _) => (Url.File (Path.ext doc (Path.basic name)), name)) documents;
309 val index_text = HTML.begin_index (index_up_lnk, parent_name)
310 (Url.File index_path, session_name) docs (Url.explode "medium.html");
313 SOME (make_session_info (name, parent_name, session_name, path, html_prefix,
314 info, doc, doc_graph, documents, dump_prefix, remote_path, verbose, readme));
315 browser_info := init_browser_info remote_path path thys;
316 add_html_index (0, index_text)
320 (* isabelle tool wrappers *)
322 fun isabelle_document verbose format name tags path result_path =
324 val s = "\"$ISABELLE_TOOL\" document -c -o '" ^ format ^ "' \
325 \-n '" ^ name ^ "' -t '" ^ tags ^ "' " ^ File.shell_path path ^ " 2>&1";
326 val doc_path = Path.append result_path (Path.ext format (Path.basic name));
327 val _ = if verbose then writeln s else ();
328 val (out, rc) = Isabelle_System.bash_output s;
330 if not (File.exists doc_path) orelse rc <> 0 then
331 cat_error out ("Failed to build document " ^ quote (show_path doc_path))
332 else if verbose then writeln out
336 fun isabelle_browser graph = Isabelle_System.with_tmp_dir "browser" (fn dir =>
338 val pdf_path = Path.append dir graph_pdf_path;
339 val eps_path = Path.append dir graph_eps_path;
340 val graph_path = Path.append dir graph_path;
341 val _ = write_graph graph graph_path;
342 val args = "-o " ^ File.shell_path pdf_path ^ " " ^ File.shell_path graph_path;
344 if Isabelle_System.isabelle_tool "browser" args = 0 andalso
345 File.exists pdf_path andalso File.exists eps_path
346 then (File.read pdf_path, File.read eps_path)
347 else error "Failed to prepare dependency graph"
351 (* finish session -- output all generated text *)
353 fun sorted_index index = map snd (sort (int_ord o pairself fst) (rev index));
354 fun index_buffer index = Buffer.add (implode (sorted_index index)) Buffer.empty;
356 fun write_tex src name path =
357 File.write_buffer (Path.append path (tex_path name)) src;
359 fun write_tex_index tex_index path =
360 write_tex (index_buffer tex_index |> Buffer.add Latex.tex_trailer) doc_indexN path;
364 session_default () (fn {name, info, html_prefix, doc_format,
365 doc_graph, documents, dump_prefix, path, verbose, readme, ...} =>
367 val {theories, files, tex_index, html_index, graph} = ! browser_info;
368 val thys = Symtab.dest theories;
369 val parent_html_prefix = Path.append html_prefix Path.parent;
371 fun finish_tex path (a, {tex_source, ...}: theory_info) = write_tex tex_source a path;
372 fun finish_html (a, {html, ...}: theory_info) =
373 File.write_buffer (Path.append html_prefix (html_path a)) (Buffer.add HTML.end_document html);
375 val sorted_graph = sorted_index graph;
377 if doc_graph andalso (not (null documents) orelse is_some dump_prefix) then
378 SOME (isabelle_browser sorted_graph)
381 fun prepare_sources cp path =
382 (Isabelle_System.mkdirs path;
383 if cp then Isabelle_System.copy_dir document_path path else ();
384 Isabelle_System.isabelle_tool "latex"
385 ("-o sty " ^ File.shell_path (Path.append path (Path.basic "root.tex")));
386 (case opt_graphs of NONE => () | SOME (pdf, eps) =>
387 (File.write (Path.append path graph_pdf_path) pdf;
388 File.write (Path.append path graph_eps_path) eps));
389 write_tex_index tex_index path;
390 List.app (finish_tex path) thys);
393 (Isabelle_System.mkdirs (Path.append html_prefix session_path);
394 File.write_buffer (Path.append html_prefix pre_index_path) (index_buffer html_index);
395 File.write (Path.append html_prefix session_entries_path) "";
396 create_index html_prefix;
397 if length path > 1 then update_index parent_html_prefix name else ();
398 (case readme of NONE => () | SOME path => File.copy path html_prefix);
399 write_graph sorted_graph (Path.append html_prefix graph_path);
400 Isabelle_System.isabelle_tool "browser" "-b";
401 File.copy (Path.explode "~~/lib/browser/GraphBrowser.jar") html_prefix;
402 List.app (fn (a, txt) => File.write (Path.append html_prefix (Path.basic a)) txt)
403 (HTML.applet_pages name (Url.File index_path, name));
404 File.copy (Path.explode "~~/etc/isabelle.css") html_prefix;
405 List.app finish_html thys;
406 List.app (uncurry File.write) files;
407 if verbose then Output.physical_stderr ("Browser info at " ^ show_path html_prefix ^ "\n")
412 (case dump_prefix of NONE => () | SOME (cp, path) =>
413 (prepare_sources cp path;
414 if verbose then Output.physical_stderr ("Document sources at " ^ show_path path ^ "\n")
418 documents |> Par_List.map (fn (name, tags) =>
420 val path = Path.append html_prefix (Path.basic name);
421 val _ = prepare_sources true path;
422 in isabelle_document true doc_format name tags path html_prefix end);
426 |> List.app (fn doc => Output.physical_stderr ("Document at " ^ show_path doc ^ "\n"))
429 browser_info := empty_browser_info;
434 (* theory elements *)
436 fun init_theory name = session_default () (fn _ => init_theory_info name empty_theory_info);
438 fun theory_source name mk_text =
439 session_default () (fn _ => add_html_source name (HTML.theory_source (mk_text ())));
441 fun theory_output name s =
442 session_default () (fn _ => add_tex_source name (Latex.isabelle_file name s));
445 fun parent_link remote_path curr_session thy =
447 val {name = _, session, is_local} = get_info thy;
448 val name = Context.theory_name thy;
450 if null session then NONE
452 (if is_some remote_path andalso not is_local then
453 Url.append (the remote_path) (Url.File (Path.append (Path.make session) (html_path name)))
454 else Url.File (Path.append (mk_rel_path curr_session session) (html_path name)));
457 fun begin_theory update_time dir files thy =
458 session_default thy (fn {name = sess_name, session, path, html_prefix, remote_path, ...} =>
460 val name = Context.theory_name thy;
461 val parents = Theory.parents_of thy;
462 val parent_specs = map (parent_link remote_path path) parents;
464 val files_html = files |> map (fn (raw_path, loadit) =>
466 val path = File.check_file (File.full_path dir raw_path);
467 val base = Path.base path;
468 val base_html = html_ext base;
469 val _ = add_file (Path.append html_prefix base_html,
470 HTML.external_file (Url.File base) (File.read path));
471 in (Url.File base_html, Url.File raw_path, loadit) end);
473 fun prep_html_source (tex_source, html_source, html) =
475 val txt = HTML.begin_theory (Url.File index_path, session)
476 name parent_specs files_html (Buffer.content html_source)
477 in (tex_source, Buffer.empty, Buffer.add txt html) end;
480 {name = name, ID = ID_of path name, dir = sess_name, unfold = true,
481 path = Path.implode (html_path name),
482 parents = map ID_of_thy parents};
484 change_theory_info name prep_html_source;
485 add_graph_entry (update_time, entry);
486 add_html_index (update_time, HTML.theory_entry (Url.File (html_path name), name));
487 add_tex_index (update_time, Latex.theory_entry name);
488 put_info {name = sess_name, session = path, is_local = is_some remote_path} thy
493 (** draft document output **)
495 fun drafts doc_format src_paths = Isabelle_System.with_tmp_dir "drafts" (fn dir =>
497 fun prep_draft path i =
499 val base = Path.base path;
501 (case Path.implode (#1 (Path.split_ext base)) of
503 | s => s) ^ serial_string ();
505 if File.exists path then
506 (((name, base, File.read path), (i, Latex.theory_entry name)), i + 1)
507 else error ("Bad file: " ^ Path.print path)
509 val (srcs, tex_index) = split_list (fst (fold_map prep_draft src_paths 0));
511 val doc_path = Path.append dir document_path;
512 val _ = Isabelle_System.mkdirs doc_path;
513 val root_path = Path.append doc_path (Path.basic "root.tex");
514 val _ = File.copy (Path.explode "~~/lib/texinputs/draft.tex") root_path;
515 val _ = Isabelle_System.isabelle_tool "latex" ("-o sty " ^ File.shell_path root_path);
516 val _ = Isabelle_System.isabelle_tool "latex" ("-o syms " ^ File.shell_path root_path);
519 let val ss = split_lines (File.read (Path.append doc_path (Path.basic name)))
520 in member (op =) ss end;
521 val known_syms = known "syms.lst";
522 val known_ctrls = known "ctrls.lst";
524 val _ = srcs |> List.app (fn (name, base, txt) =>
526 |> Latex.symbol_source (known_syms, known_ctrls) (Path.implode base)
527 |> File.write (Path.append doc_path (tex_path name)));
528 val _ = write_tex_index tex_index doc_path;
530 val result = isabelle_document false doc_format documentN "" doc_path dir;
531 val result' = Isabelle_System.create_tmp_path documentN doc_format;
532 val _ = File.copy result result';
537 structure Basic_Present: BASIC_PRESENT = Present;