author | wenzelm |
Sun, 20 Mar 2011 19:34:18 +0100 | |
changeset 42007 | 2142883ec29f |
parent 42006 | 7eecd020e367 |
child 42008 | 7423e833a880 |
permissions | -rw-r--r-- |
6203 | 1 |
(* Title: Pure/Thy/present.ML |
9416 | 2 |
Author: Markus Wenzel and Stefan Berghofer, TU Muenchen |
6203 | 3 |
|
9416 | 4 |
Theory presentation: HTML, graph files, (PDF)LaTeX documents. |
6203 | 5 |
*) |
6 |
||
7 |
signature BASIC_PRESENT = |
|
8 |
sig |
|
11057 | 9 |
val no_document: ('a -> 'b) -> 'a -> 'b |
6203 | 10 |
end; |
11 |
||
12 |
signature PRESENT = |
|
13 |
sig |
|
7727 | 14 |
include BASIC_PRESENT |
24561 | 15 |
val session_name: theory -> string |
9452 | 16 |
val write_graph: {name: string, ID: string, dir: string, unfold: bool, |
17 |
path: string, parents: string list} list -> Path.T -> unit |
|
20577 | 18 |
val display_graph: {name: string, ID: string, dir: string, unfold: bool, |
19 |
path: string, parents: string list} list -> unit |
|
17082 | 20 |
val init: bool -> bool -> string -> bool -> string list -> string list -> |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
21 |
string -> (bool * Path.T) option -> Url.T option * bool -> bool -> theory list -> unit |
7727 | 22 |
val finish: unit -> unit |
23 |
val init_theory: string -> unit |
|
27862
8f727f7c8c1d
removed obsolete verbatim_source, results, chapter, section etc.;
wenzelm
parents:
27491
diff
changeset
|
24 |
val theory_source: string -> (unit -> HTML.text) -> unit |
9136 | 25 |
val theory_output: string -> string -> unit |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
26 |
val begin_theory: int -> Path.T -> (Path.T * bool) list -> theory -> theory |
14922 | 27 |
val drafts: string -> Path.T list -> Path.T |
6203 | 28 |
end; |
29 |
||
7685 | 30 |
structure Present: PRESENT = |
31 |
struct |
|
32 |
||
7727 | 33 |
|
34 |
(** paths **) |
|
35 |
||
36 |
val output_path = Path.variable "ISABELLE_BROWSER_INFO"; |
|
37 |
||
38 |
val tex_ext = Path.ext "tex"; |
|
39 |
val tex_path = tex_ext o Path.basic; |
|
40 |
val html_ext = Path.ext "html"; |
|
41 |
val html_path = html_ext o Path.basic; |
|
42 |
val index_path = Path.basic "index.html"; |
|
11856 | 43 |
val readme_html_path = Path.basic "README.html"; |
44 |
val readme_path = Path.basic "README"; |
|
17082 | 45 |
val documentN = "document"; |
46 |
val document_path = Path.basic documentN; |
|
8196 | 47 |
val doc_indexN = "session"; |
11856 | 48 |
val graph_path = Path.basic "session.graph"; |
49 |
val graph_pdf_path = Path.basic "session_graph.pdf"; |
|
50 |
val graph_eps_path = Path.basic "session_graph.eps"; |
|
7727 | 51 |
|
52 |
val session_path = Path.basic ".session"; |
|
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
53 |
val session_entries_path = Path.explode ".session/entries"; |
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
54 |
val pre_index_path = Path.explode ".session/pre-index"; |
7727 | 55 |
|
9044 | 56 |
fun mk_rel_path [] ys = Path.make ys |
57 |
| mk_rel_path xs [] = Path.appends (replicate (length xs) Path.parent) |
|
9416 | 58 |
| mk_rel_path (ps as x :: xs) (qs as y :: ys) = if x = y then mk_rel_path xs ys else |
9044 | 59 |
Path.appends (replicate (length ps) Path.parent @ [Path.make qs]); |
7727 | 60 |
|
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
61 |
fun show_path path = Path.implode (Path.append (File.pwd ()) path); |
11856 | 62 |
|
7727 | 63 |
|
14922 | 64 |
|
7727 | 65 |
(** additional theory data **) |
66 |
||
33522 | 67 |
structure BrowserInfoData = Theory_Data |
22846 | 68 |
( |
9416 | 69 |
type T = {name: string, session: string list, is_local: bool}; |
27329 | 70 |
val empty = {name = "", session = [], is_local = false}: T; |
16503 | 71 |
fun extend _ = empty; |
33522 | 72 |
fun merge _ = empty; |
22846 | 73 |
); |
7727 | 74 |
|
27327 | 75 |
val put_info = BrowserInfoData.put; |
26957 | 76 |
val get_info = BrowserInfoData.get; |
24561 | 77 |
val session_name = #name o get_info; |
78 |
||
7727 | 79 |
|
80 |
||
81 |
(** graphs **) |
|
82 |
||
83 |
type graph_node = |
|
84 |
{name: string, ID: string, dir: string, unfold: bool, |
|
85 |
path: string, parents: string list}; |
|
86 |
||
9416 | 87 |
fun write_graph gr path = |
88 |
File.write path (cat_lines (map (fn {name, ID, dir, unfold, path, parents} => |
|
89 |
"\"" ^ name ^ "\" \"" ^ ID ^ "\" \"" ^ dir ^ (if unfold then "\" + \"" else "\" \"") ^ |
|
28840 | 90 |
path ^ "\" > " ^ space_implode " " (map quote parents) ^ " ;") gr)); |
7727 | 91 |
|
20577 | 92 |
fun display_graph gr = |
93 |
let |
|
24561 | 94 |
val _ = writeln "Displaying graph ..."; |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
95 |
val path = File.tmp_path (Path.explode "tmp.graph"); |
20577 | 96 |
val _ = write_graph gr path; |
40743 | 97 |
val _ = Isabelle_System.isabelle_tool "browser" ("-c " ^ File.shell_path path ^ " &"); |
20577 | 98 |
in () end; |
99 |
||
100 |
||
9416 | 101 |
fun ID_of sess s = space_implode "/" (sess @ [s]); |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
102 |
fun ID_of_thy thy = ID_of (#session (get_info thy)) (Context.theory_name thy); |
7727 | 103 |
|
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
104 |
|
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
105 |
(*retrieve graph data from initial collection of theories*) |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
106 |
fun init_graph remote_path curr_sess = rev o map (fn thy => |
7727 | 107 |
let |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
108 |
val name = Context.theory_name thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
109 |
val {name = sess_name, session, is_local} = get_info thy; |
9416 | 110 |
val path' = Path.append (Path.make session) (html_path name); |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
111 |
val entry = |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
112 |
{name = name, ID = ID_of session name, dir = sess_name, |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
113 |
path = |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
114 |
if null session then "" else |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
115 |
if is_some remote_path andalso not is_local then |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
116 |
Url.implode (Url.append (the remote_path) (Url.File |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
117 |
(Path.append (Path.make session) (html_path name)))) |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
118 |
else Path.implode (Path.append (mk_rel_path curr_sess session) (html_path name)), |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
119 |
unfold = false, |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
120 |
parents = map ID_of_thy (Theory.parents_of thy)}; |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
121 |
in (0, entry) end); |
7727 | 122 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
123 |
fun ins_graph_entry (i, entry as {ID, ...}) (gr: (int * graph_node) list) = |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
124 |
(i, entry) :: filter_out (fn (_, entry') => #ID entry' = ID) gr; |
7727 | 125 |
|
126 |
||
127 |
||
128 |
(** global browser info state **) |
|
129 |
||
130 |
(* type theory_info *) |
|
131 |
||
132 |
type theory_info = {tex_source: Buffer.T, html_source: Buffer.T, html: Buffer.T}; |
|
133 |
||
134 |
fun make_theory_info (tex_source, html_source, html) = |
|
135 |
{tex_source = tex_source, html_source = html_source, html = html}: theory_info; |
|
136 |
||
137 |
val empty_theory_info = make_theory_info (Buffer.empty, Buffer.empty, Buffer.empty); |
|
138 |
||
139 |
fun map_theory_info f {tex_source, html_source, html} = |
|
140 |
make_theory_info (f (tex_source, html_source, html)); |
|
141 |
||
142 |
||
143 |
(* type browser_info *) |
|
144 |
||
11856 | 145 |
type browser_info = {theories: theory_info Symtab.table, files: (Path.T * string) list, |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
146 |
tex_index: (int * string) list, html_index: (int * string) list, graph: (int * graph_node) list}; |
7727 | 147 |
|
11856 | 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, |
|
9416 | 150 |
graph = graph}: browser_info; |
7727 | 151 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
152 |
val empty_browser_info = make_browser_info (Symtab.empty, [], [], [], []); |
7727 | 153 |
|
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
154 |
fun init_browser_info remote_path curr_sess thys = make_browser_info |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
155 |
(Symtab.empty, [], [], [], init_graph remote_path curr_sess thys); |
7727 | 156 |
|
11856 | 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)); |
|
7727 | 159 |
|
160 |
||
161 |
(* state *) |
|
162 |
||
32738 | 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)); |
|
7727 | 166 |
|
32738 | 167 |
val suppress_tex_source = Unsynchronized.ref false; |
39616
8052101883c3
renamed setmp_noncritical to Unsynchronized.setmp to emphasize its meaning;
wenzelm
parents:
38133
diff
changeset
|
168 |
fun no_document f x = Unsynchronized.setmp suppress_tex_source true f x; (* FIXME unreliable *) |
7727 | 169 |
|
170 |
fun init_theory_info name info = |
|
11856 | 171 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
17412 | 172 |
(Symtab.update (name, info) theories, files, tex_index, html_index, graph)); |
7727 | 173 |
|
174 |
fun change_theory_info name f = |
|
11856 | 175 |
change_browser_info (fn (info as (theories, files, tex_index, html_index, graph)) => |
17412 | 176 |
(case Symtab.lookup theories name of |
27491
c8178a6a6480
begin_theory: files_html needs to be produced outside of prep_html_source to make ML files appear!
wenzelm
parents:
27329
diff
changeset
|
177 |
NONE => error ("Browser info: cannot access theory document " ^ quote name) |
17412 | 178 |
| SOME info => (Symtab.update (name, map_theory_info f info) theories, files, |
9416 | 179 |
tex_index, html_index, graph))); |
7727 | 180 |
|
181 |
||
11856 | 182 |
fun add_file file = |
183 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
|
184 |
(theories, file :: files, tex_index, html_index, graph)); |
|
185 |
||
7727 | 186 |
fun add_tex_index txt = |
11856 | 187 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
188 |
(theories, files, txt :: tex_index, html_index, graph)); |
7727 | 189 |
|
190 |
fun add_html_index txt = |
|
11856 | 191 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
192 |
(theories, files, tex_index, txt :: html_index, graph)); |
7727 | 193 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
194 |
fun add_graph_entry entry = |
11856 | 195 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
196 |
(theories, files, tex_index, html_index, ins_graph_entry entry graph)); |
7727 | 197 |
|
11057 | 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)); |
|
7727 | 202 |
|
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)); |
|
205 |
||
206 |
fun add_html name txt = change_theory_info name (fn (tex_source, html_source, html) => |
|
207 |
(tex_source, html_source, Buffer.add txt html)); |
|
208 |
||
209 |
||
210 |
||
211 |
(** global session state **) |
|
212 |
||
213 |
(* session_info *) |
|
214 |
||
215 |
type session_info = |
|
216 |
{name: string, parent: string, session: string, path: string list, html_prefix: Path.T, |
|
17082 | 217 |
info: bool, doc_format: string, doc_graph: bool, documents: (string * string) list, |
42007 | 218 |
dump_prefix: (bool * Path.T) option, remote_path: Url.T option, verbose: bool, |
219 |
readme: Path.T option}; |
|
7727 | 220 |
|
9416 | 221 |
fun make_session_info |
17082 | 222 |
(name, parent, session, path, html_prefix, info, doc_format, doc_graph, documents, |
42007 | 223 |
dump_prefix, remote_path, verbose, readme) = |
7802 | 224 |
{name = name, parent = parent, session = session, path = path, html_prefix = html_prefix, |
17082 | 225 |
info = info, doc_format = doc_format, doc_graph = doc_graph, documents = documents, |
42007 | 226 |
dump_prefix = dump_prefix, remote_path = remote_path, verbose = verbose, |
227 |
readme = readme}: session_info; |
|
7685 | 228 |
|
229 |
||
7727 | 230 |
(* state *) |
231 |
||
32738 | 232 |
val session_info = Unsynchronized.ref (NONE: session_info option); |
7727 | 233 |
|
15531 | 234 |
fun with_session x f = (case ! session_info of NONE => x | SOME info => f info); |
26433 | 235 |
fun with_context f = f (Context.theory_name (ML_Context.the_global_context ())); |
7727 | 236 |
|
237 |
||
238 |
||
14922 | 239 |
(** document preparation **) |
7727 | 240 |
|
241 |
(* maintain index *) |
|
242 |
||
243 |
val session_entries = |
|
244 |
HTML.session_entries o |
|
14898 | 245 |
map (fn name => (Url.File (Path.append (Path.basic name) index_path), name)); |
7727 | 246 |
|
247 |
fun get_entries dir = |
|
248 |
split_lines (File.read (Path.append dir session_entries_path)); |
|
249 |
||
250 |
fun put_entries entries dir = |
|
251 |
File.write (Path.append dir session_entries_path) (cat_lines entries); |
|
252 |
||
253 |
||
254 |
fun create_index dir = |
|
255 |
File.read (Path.append dir pre_index_path) ^ |
|
27862
8f727f7c8c1d
removed obsolete verbatim_source, results, chapter, section etc.;
wenzelm
parents:
27491
diff
changeset
|
256 |
session_entries (get_entries dir) ^ HTML.end_document |
7727 | 257 |
|> File.write (Path.append dir index_path); |
258 |
||
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
259 |
fun update_index dir name = CRITICAL (fn () => |
7727 | 260 |
(case try get_entries dir of |
41944
b97091ae583a
Path.print is the official way to show file-system paths to users -- note that Path.implode often indicates violation of the abstract datatype;
wenzelm
parents:
41886
diff
changeset
|
261 |
NONE => warning ("Browser info: cannot access session index of " ^ Path.print dir) |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
262 |
| SOME es => (put_entries ((remove (op =) name es) @ [name]) dir; create_index dir))); |
7727 | 263 |
|
264 |
||
42004 | 265 |
(* document variants *) |
17082 | 266 |
|
42004 | 267 |
fun read_variant str = |
17082 | 268 |
(case space_explode "=" str of |
269 |
[name] => (name, "") |
|
270 |
| [name, tags] => (name, tags) |
|
42004 | 271 |
| _ => error ("Malformed document variant specification: " ^ quote str)); |
17082 | 272 |
|
42004 | 273 |
fun read_variants strs = |
274 |
rev (distinct (eq_fst (op =)) (rev ((documentN, "") :: map read_variant strs))) |
|
28375 | 275 |
|> filter_out (fn (_, s) => s = "-"); |
17082 | 276 |
|
277 |
||
7727 | 278 |
(* init session *) |
279 |
||
12895 | 280 |
fun name_of_session elems = space_implode "/" ("Isabelle" :: elems); |
281 |
||
42006 | 282 |
fun init build info doc doc_graph doc_variants path name dump_prefix |
23944 | 283 |
(remote_path, first_time) verbose thys = CRITICAL (fn () => |
42006 | 284 |
if not build andalso not info andalso doc = "" andalso is_none dump_prefix then |
15531 | 285 |
(browser_info := empty_browser_info; session_info := NONE) |
11856 | 286 |
else |
287 |
let |
|
33957 | 288 |
val parent_name = name_of_session (take (length path - 1) path); |
11856 | 289 |
val session_name = name_of_session path; |
290 |
val sess_prefix = Path.make path; |
|
291 |
val html_prefix = Path.append (Path.expand output_path) sess_prefix; |
|
7727 | 292 |
|
42007 | 293 |
val documents = |
294 |
if doc = "" then [] |
|
42005 | 295 |
else if not (can File.check_dir document_path) then |
42007 | 296 |
(if verbose then Output.raw_stderr "Warning: missing document directory\n" else (); []) |
297 |
else read_variants doc_variants; |
|
7727 | 298 |
|
11856 | 299 |
val parent_index_path = Path.append Path.parent index_path; |
42007 | 300 |
val index_up_lnk = |
301 |
if first_time then |
|
16263
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
302 |
Url.append (the remote_path) (Url.File (Path.append sess_prefix parent_index_path)) |
14898 | 303 |
else Url.File parent_index_path; |
11856 | 304 |
val readme = |
15531 | 305 |
if File.exists readme_html_path then SOME readme_html_path |
306 |
else if File.exists readme_path then SOME readme_path |
|
307 |
else NONE; |
|
7727 | 308 |
|
17082 | 309 |
val docs = |
310 |
(case readme of NONE => [] | SOME p => [(Url.File p, "README")]) @ |
|
42007 | 311 |
map (fn (name, _) => (Url.File (Path.ext doc (Path.basic name)), name)) documents; |
11856 | 312 |
val index_text = HTML.begin_index (index_up_lnk, parent_name) |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
313 |
(Url.File index_path, session_name) docs (Url.explode "medium.html"); |
11856 | 314 |
in |
42007 | 315 |
session_info := |
316 |
SOME (make_session_info (name, parent_name, session_name, path, html_prefix, |
|
317 |
info, doc, doc_graph, documents, dump_prefix, remote_path, verbose, readme)); |
|
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
318 |
browser_info := init_browser_info remote_path path thys; |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
319 |
add_html_index (0, index_text) |
23944 | 320 |
end); |
7727 | 321 |
|
322 |
||
28496
4cff10648928
renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents:
28375
diff
changeset
|
323 |
(* isabelle tool wrappers *) |
17082 | 324 |
|
28496
4cff10648928
renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents:
28375
diff
changeset
|
325 |
fun isabelle_document verbose format name tags path result_path = |
17082 | 326 |
let |
28500 | 327 |
val s = "\"$ISABELLE_TOOL\" document -c -o '" ^ format ^ "' \ |
33682
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
328 |
\-n '" ^ name ^ "' -t '" ^ tags ^ "' " ^ File.shell_path path ^ " 2>&1"; |
17082 | 329 |
val doc_path = Path.append result_path (Path.ext format (Path.basic name)); |
33682
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
330 |
val _ = if verbose then writeln s else (); |
35010
d6e492cea6e4
renamed system/system_out to bash/bash_output -- to emphasized that this is really GNU bash, not some undefined POSIX sh;
wenzelm
parents:
33957
diff
changeset
|
331 |
val (out, rc) = bash_output s; |
33682
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
332 |
val _ = |
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
333 |
if not (File.exists doc_path) orelse rc <> 0 then |
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
334 |
cat_error out ("Failed to build document " ^ quote (show_path doc_path)) |
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
335 |
else if verbose then writeln out |
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
336 |
else (); |
0c5d1485dea7
isabelle_document: more explicit error output, notably for drafts;
wenzelm
parents:
33522
diff
changeset
|
337 |
in doc_path end; |
17082 | 338 |
|
28496
4cff10648928
renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents:
28375
diff
changeset
|
339 |
fun isabelle_browser graph = |
17082 | 340 |
let |
341 |
val pdf_path = File.tmp_path graph_pdf_path; |
|
342 |
val eps_path = File.tmp_path graph_eps_path; |
|
343 |
val gr_path = File.tmp_path graph_path; |
|
31819 | 344 |
val args = "-o " ^ File.shell_path pdf_path ^ " " ^ File.shell_path gr_path; |
17082 | 345 |
in |
346 |
write_graph graph gr_path; |
|
40743 | 347 |
if Isabelle_System.isabelle_tool "browser" args <> 0 orelse |
31819 | 348 |
not (File.exists eps_path) orelse not (File.exists pdf_path) |
17082 | 349 |
then error "Failed to prepare dependency graph" |
350 |
else |
|
351 |
let val pdf = File.read pdf_path and eps = File.read eps_path |
|
352 |
in File.rm pdf_path; File.rm eps_path; File.rm gr_path; (pdf, eps) end |
|
353 |
end; |
|
354 |
||
355 |
||
11856 | 356 |
(* finish session -- output all generated text *) |
357 |
||
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
358 |
fun sorted_index index = map snd (sort (int_ord o pairself fst) (rev index)); |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
359 |
fun index_buffer index = Buffer.add (implode (sorted_index index)) Buffer.empty; |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
360 |
|
14922 | 361 |
fun write_tex src name path = |
28027 | 362 |
File.write_buffer (Path.append path (tex_path name)) src; |
14922 | 363 |
|
364 |
fun write_tex_index tex_index path = |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
365 |
write_tex (index_buffer tex_index |> Buffer.add Latex.tex_trailer) doc_indexN path; |
14922 | 366 |
|
7685 | 367 |
|
23944 | 368 |
fun finish () = CRITICAL (fn () => |
42007 | 369 |
with_session () (fn {name, info, html_prefix, doc_format, doc_graph, documents, |
370 |
dump_prefix, path, verbose, readme, ...} => |
|
7727 | 371 |
let |
11856 | 372 |
val {theories, files, tex_index, html_index, graph} = ! browser_info; |
373 |
val thys = Symtab.dest theories; |
|
9416 | 374 |
val parent_html_prefix = Path.append html_prefix Path.parent; |
7727 | 375 |
|
11856 | 376 |
fun finish_tex path (a, {tex_source, ...}: theory_info) = write_tex tex_source a path; |
377 |
fun finish_html (a, {html, ...}: theory_info) = |
|
28027 | 378 |
File.write_buffer (Path.append html_prefix (html_path a)) (Buffer.add HTML.end_document html); |
11856 | 379 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
380 |
val sorted_graph = sorted_index graph; |
11856 | 381 |
val opt_graphs = |
42007 | 382 |
if doc_graph andalso (not (null documents) orelse is_some dump_prefix) then |
28496
4cff10648928
renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents:
28375
diff
changeset
|
383 |
SOME (isabelle_browser sorted_graph) |
15531 | 384 |
else NONE; |
11856 | 385 |
|
17210 | 386 |
fun prepare_sources cp path = |
40743 | 387 |
(Isabelle_System.mkdirs path; |
388 |
if cp then Isabelle_System.copy_dir document_path path else (); |
|
389 |
Isabelle_System.isabelle_tool "latex" |
|
31819 | 390 |
("-o sty " ^ File.shell_path (Path.append path (Path.basic "root.tex"))); |
15531 | 391 |
(case opt_graphs of NONE => () | SOME (pdf, eps) => |
11856 | 392 |
(File.write (Path.append path graph_pdf_path) pdf; |
393 |
File.write (Path.append path graph_eps_path) eps)); |
|
14922 | 394 |
write_tex_index tex_index path; |
15570 | 395 |
List.app (finish_tex path) thys); |
42007 | 396 |
val _ = |
397 |
if info then |
|
398 |
(Isabelle_System.mkdirs (Path.append html_prefix session_path); |
|
399 |
File.write_buffer (Path.append html_prefix pre_index_path) (index_buffer html_index); |
|
400 |
File.write (Path.append html_prefix session_entries_path) ""; |
|
401 |
create_index html_prefix; |
|
402 |
if length path > 1 then update_index parent_html_prefix name else (); |
|
403 |
(case readme of NONE => () | SOME path => File.copy path html_prefix); |
|
404 |
write_graph sorted_graph (Path.append html_prefix graph_path); |
|
405 |
Isabelle_System.isabelle_tool "browser" "-b"; |
|
406 |
File.copy (Path.explode "~~/lib/browser/GraphBrowser.jar") html_prefix; |
|
407 |
List.app (fn (a, txt) => File.write (Path.append html_prefix (Path.basic a)) txt) |
|
408 |
(HTML.applet_pages name (Url.File index_path, name)); |
|
409 |
File.copy (Path.explode "~~/lib/html/isabelle.css") html_prefix; |
|
410 |
List.app finish_html thys; |
|
411 |
List.app (uncurry File.write) files; |
|
412 |
if verbose then Output.raw_stderr ("Browser info at " ^ show_path html_prefix ^ "\n") |
|
413 |
else ()) |
|
414 |
else (); |
|
415 |
||
416 |
val _ = |
|
417 |
(case dump_prefix of NONE => () | SOME (cp, path) => |
|
418 |
(prepare_sources cp path; |
|
419 |
if verbose then Output.raw_stderr ("Document sources at " ^ show_path path ^ "\n") |
|
420 |
else ())); |
|
421 |
||
422 |
val doc_paths = |
|
423 |
documents |> map (fn (name, tags) => |
|
424 |
let |
|
425 |
val path = Path.append html_prefix document_path; |
|
426 |
val _ = prepare_sources true path; |
|
427 |
in isabelle_document true doc_format name tags path html_prefix end); |
|
428 |
val _ = |
|
429 |
if verbose then |
|
430 |
doc_paths |> List.app (fn doc => Output.raw_stderr ("Document at " ^ show_path doc ^ "\n")) |
|
431 |
else (); |
|
7727 | 432 |
in |
433 |
browser_info := empty_browser_info; |
|
15531 | 434 |
session_info := NONE |
23944 | 435 |
end)); |
7727 | 436 |
|
437 |
||
438 |
(* theory elements *) |
|
439 |
||
440 |
fun init_theory name = with_session () (fn _ => init_theory_info name empty_theory_info); |
|
441 |
||
27862
8f727f7c8c1d
removed obsolete verbatim_source, results, chapter, section etc.;
wenzelm
parents:
27491
diff
changeset
|
442 |
fun theory_source name mk_text = |
8f727f7c8c1d
removed obsolete verbatim_source, results, chapter, section etc.;
wenzelm
parents:
27491
diff
changeset
|
443 |
with_session () (fn _ => add_html_source name (HTML.theory_source (mk_text ()))); |
7727 | 444 |
|
9136 | 445 |
fun theory_output name s = |
9917 | 446 |
with_session () (fn _ => add_tex_source name (Latex.isabelle_file name s)); |
7727 | 447 |
|
448 |
||
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
449 |
fun parent_link remote_path curr_session thy = |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
450 |
let |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
451 |
val {name = _, session, is_local} = get_info thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
452 |
val name = Context.theory_name thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
453 |
val link = |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
454 |
if null session then NONE |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
455 |
else SOME |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
456 |
(if is_some remote_path andalso not is_local then |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
457 |
Url.append (the remote_path) (Url.File (Path.append (Path.make session) (html_path name))) |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
458 |
else Url.File (Path.append (mk_rel_path curr_session session) (html_path name))); |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
459 |
in (link, name) end; |
7727 | 460 |
|
26323
73efc70edeef
theory loader: discontinued *attached* ML scripts;
wenzelm
parents:
24829
diff
changeset
|
461 |
fun begin_theory update_time dir files thy = |
9416 | 462 |
with_session thy (fn {name = sess_name, session, path, html_prefix, remote_path, ...} => |
7727 | 463 |
let |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
464 |
val name = Context.theory_name thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
465 |
val parents = Theory.parents_of thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
466 |
val parent_specs = map (parent_link remote_path path) parents; |
7727 | 467 |
|
37939
965537d86fcc
discontinued special treatment of ML files -- no longer complete extensions on demand;
wenzelm
parents:
37216
diff
changeset
|
468 |
val files_html = files |> map (fn (raw_path, loadit) => |
965537d86fcc
discontinued special treatment of ML files -- no longer complete extensions on demand;
wenzelm
parents:
37216
diff
changeset
|
469 |
let |
42003
6e45dc518ebb
replaced File.check by specific File.check_file, File.check_dir;
wenzelm
parents:
41944
diff
changeset
|
470 |
val path = Thy_Load.check_file dir raw_path; |
37939
965537d86fcc
discontinued special treatment of ML files -- no longer complete extensions on demand;
wenzelm
parents:
37216
diff
changeset
|
471 |
val base = Path.base path; |
965537d86fcc
discontinued special treatment of ML files -- no longer complete extensions on demand;
wenzelm
parents:
37216
diff
changeset
|
472 |
val base_html = html_ext base; |
965537d86fcc
discontinued special treatment of ML files -- no longer complete extensions on demand;
wenzelm
parents:
37216
diff
changeset
|
473 |
val _ = add_file (Path.append html_prefix base_html, |
37940
4857eab31298
generic external source files -- nothing special about ML here;
wenzelm
parents:
37939
diff
changeset
|
474 |
HTML.external_file (Url.File base) (File.read path)); |
37939
965537d86fcc
discontinued special treatment of ML files -- no longer complete extensions on demand;
wenzelm
parents:
37216
diff
changeset
|
475 |
in (Url.File base_html, Url.File raw_path, loadit) end); |
7727 | 476 |
|
477 |
fun prep_html_source (tex_source, html_source, html) = |
|
478 |
let |
|
14898 | 479 |
val txt = HTML.begin_theory (Url.File index_path, session) |
27491
c8178a6a6480
begin_theory: files_html needs to be produced outside of prep_html_source to make ML files appear!
wenzelm
parents:
27329
diff
changeset
|
480 |
name parent_specs files_html (Buffer.content html_source) |
7727 | 481 |
in (tex_source, Buffer.empty, Buffer.add txt html) end; |
482 |
||
9416 | 483 |
val entry = |
484 |
{name = name, ID = ID_of path name, dir = sess_name, unfold = true, |
|
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
485 |
path = Path.implode (html_path name), |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
486 |
parents = map ID_of_thy parents}; |
7727 | 487 |
in |
488 |
change_theory_info name prep_html_source; |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
489 |
add_graph_entry (update_time, entry); |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
490 |
add_html_index (update_time, HTML.theory_entry (Url.File (html_path name), name)); |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
491 |
add_tex_index (update_time, Latex.theory_entry name); |
27327 | 492 |
put_info {name = sess_name, session = path, is_local = is_some remote_path} thy |
7727 | 493 |
end); |
494 |
||
495 |
||
496 |
||
40943 | 497 |
(** draft document output **) (* FIXME doc_path etc. not thread-safe *) |
14922 | 498 |
|
499 |
fun drafts doc_format src_paths = |
|
500 |
let |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
501 |
fun prep_draft path i = |
14935 | 502 |
let |
503 |
val base = Path.base path; |
|
14972 | 504 |
val name = |
24829 | 505 |
(case Path.implode (#1 (Path.split_ext base)) of |
506 |
"" => "DUMMY" ^ serial_string () |
|
507 |
| s => s); |
|
14935 | 508 |
in |
509 |
if File.exists path then |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
510 |
(((name, base, File.read path), (i, Latex.theory_entry name)), i + 1) |
41944
b97091ae583a
Path.print is the official way to show file-system paths to users -- note that Path.implode often indicates violation of the abstract datatype;
wenzelm
parents:
41886
diff
changeset
|
511 |
else error ("Bad file: " ^ Path.print path) |
14935 | 512 |
end; |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
513 |
val (srcs, tex_index) = split_list (fst (fold_map prep_draft src_paths 0)); |
14935 | 514 |
|
17082 | 515 |
val doc_path = File.tmp_path document_path; |
516 |
val result_path = Path.append doc_path Path.parent; |
|
40743 | 517 |
val _ = Isabelle_System.mkdirs doc_path; |
14922 | 518 |
val root_path = Path.append doc_path (Path.basic "root.tex"); |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
519 |
val _ = File.copy (Path.explode "~~/lib/texinputs/draft.tex") root_path; |
40743 | 520 |
val _ = Isabelle_System.isabelle_tool "latex" ("-o sty " ^ File.shell_path root_path); |
521 |
val _ = Isabelle_System.isabelle_tool "latex" ("-o syms " ^ File.shell_path root_path); |
|
14922 | 522 |
|
523 |
fun known name = |
|
524 |
let val ss = split_lines (File.read (Path.append doc_path (Path.basic name))) |
|
20664 | 525 |
in member (op =) ss end; |
14922 | 526 |
val known_syms = known "syms.lst"; |
527 |
val known_ctrls = known "ctrls.lst"; |
|
528 |
||
15570 | 529 |
val _ = srcs |> List.app (fn (name, base, txt) => |
14935 | 530 |
Symbol.explode txt |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
531 |
|> Latex.symbol_source (known_syms, known_ctrls) (Path.implode base) |
14935 | 532 |
|> File.write (Path.append doc_path (tex_path name))); |
14922 | 533 |
val _ = write_tex_index tex_index doc_path; |
28496
4cff10648928
renamed isatool to isabelle_tool in programming interfaces;
wenzelm
parents:
28375
diff
changeset
|
534 |
in isabelle_document false doc_format documentN "" doc_path result_path end; |
14922 | 535 |
|
536 |
||
7685 | 537 |
end; |
538 |
||
32738 | 539 |
structure Basic_Present: BASIC_PRESENT = Present; |
540 |
open Basic_Present; |