author | wenzelm |
Mon, 23 Jun 2008 20:00:58 +0200 | |
changeset 27329 | 91c0c894e1b4 |
parent 27327 | efd626efcb04 |
child 27491 | c8178a6a6480 |
permissions | -rw-r--r-- |
6203 | 1 |
(* Title: Pure/Thy/present.ML |
2 |
ID: $Id$ |
|
9416 | 3 |
Author: Markus Wenzel and Stefan Berghofer, TU Muenchen |
6203 | 4 |
|
9416 | 5 |
Theory presentation: HTML, graph files, (PDF)LaTeX documents. |
6203 | 6 |
*) |
7 |
||
8 |
signature BASIC_PRESENT = |
|
9 |
sig |
|
11057 | 10 |
val no_document: ('a -> 'b) -> 'a -> 'b |
7727 | 11 |
val section: string -> unit |
6203 | 12 |
end; |
13 |
||
14 |
signature PRESENT = |
|
15 |
sig |
|
7727 | 16 |
include BASIC_PRESENT |
24561 | 17 |
val session_name: theory -> string |
9452 | 18 |
val write_graph: {name: string, ID: string, dir: string, unfold: bool, |
19 |
path: string, parents: string list} list -> Path.T -> unit |
|
20577 | 20 |
val display_graph: {name: string, ID: string, dir: string, unfold: bool, |
21 |
path: string, parents: string list} list -> unit |
|
17082 | 22 |
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
|
23 |
string -> (bool * Path.T) option -> Url.T option * bool -> bool -> theory list -> unit |
7727 | 24 |
val finish: unit -> unit |
25 |
val init_theory: string -> unit |
|
8192 | 26 |
val verbatim_source: string -> (unit -> Symbol.symbol list) -> unit |
9136 | 27 |
val theory_output: string -> string -> unit |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
28 |
val begin_theory: int -> Path.T -> (Path.T * bool) list -> theory -> theory |
13532 | 29 |
val add_hook: (string -> (string * thm list) list -> unit) -> unit |
30 |
val results: string -> (string * thm list) list -> unit |
|
7727 | 31 |
val theorem: string -> thm -> unit |
32 |
val theorems: string -> thm list -> unit |
|
8088 | 33 |
val chapter: string -> unit |
7727 | 34 |
val subsection: string -> unit |
35 |
val subsubsection: string -> unit |
|
14922 | 36 |
val drafts: string -> Path.T list -> Path.T |
6203 | 37 |
end; |
38 |
||
7685 | 39 |
structure Present: PRESENT = |
40 |
struct |
|
41 |
||
7727 | 42 |
|
43 |
(** paths **) |
|
44 |
||
45 |
val output_path = Path.variable "ISABELLE_BROWSER_INFO"; |
|
46 |
||
47 |
val tex_ext = Path.ext "tex"; |
|
48 |
val tex_path = tex_ext o Path.basic; |
|
49 |
val html_ext = Path.ext "html"; |
|
50 |
val html_path = html_ext o Path.basic; |
|
51 |
val index_path = Path.basic "index.html"; |
|
11856 | 52 |
val readme_html_path = Path.basic "README.html"; |
53 |
val readme_path = Path.basic "README"; |
|
17082 | 54 |
val documentN = "document"; |
55 |
val document_path = Path.basic documentN; |
|
8196 | 56 |
val doc_indexN = "session"; |
11856 | 57 |
val graph_path = Path.basic "session.graph"; |
58 |
val graph_pdf_path = Path.basic "session_graph.pdf"; |
|
59 |
val graph_eps_path = Path.basic "session_graph.eps"; |
|
7727 | 60 |
|
61 |
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
|
62 |
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
|
63 |
val pre_index_path = Path.explode ".session/pre-index"; |
7727 | 64 |
|
9044 | 65 |
fun mk_rel_path [] ys = Path.make ys |
66 |
| mk_rel_path xs [] = Path.appends (replicate (length xs) Path.parent) |
|
9416 | 67 |
| mk_rel_path (ps as x :: xs) (qs as y :: ys) = if x = y then mk_rel_path xs ys else |
9044 | 68 |
Path.appends (replicate (length ps) Path.parent @ [Path.make qs]); |
7727 | 69 |
|
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
70 |
fun show_path path = Path.implode (Path.append (File.pwd ()) path); |
11856 | 71 |
|
7727 | 72 |
|
14922 | 73 |
|
7727 | 74 |
(** additional theory data **) |
75 |
||
16426 | 76 |
structure BrowserInfoData = TheoryDataFun |
22846 | 77 |
( |
9416 | 78 |
type T = {name: string, session: string list, is_local: bool}; |
27329 | 79 |
val empty = {name = "", session = [], is_local = false}: T; |
7727 | 80 |
val copy = I; |
16503 | 81 |
fun extend _ = empty; |
16426 | 82 |
fun merge _ _ = empty; |
22846 | 83 |
); |
7727 | 84 |
|
27327 | 85 |
val put_info = BrowserInfoData.put; |
26957 | 86 |
val get_info = BrowserInfoData.get; |
24561 | 87 |
val session_name = #name o get_info; |
88 |
||
7727 | 89 |
|
90 |
||
91 |
(** graphs **) |
|
92 |
||
93 |
type graph_node = |
|
94 |
{name: string, ID: string, dir: string, unfold: bool, |
|
95 |
path: string, parents: string list}; |
|
96 |
||
9416 | 97 |
fun write_graph gr path = |
98 |
File.write path (cat_lines (map (fn {name, ID, dir, unfold, path, parents} => |
|
99 |
"\"" ^ name ^ "\" \"" ^ ID ^ "\" \"" ^ dir ^ (if unfold then "\" + \"" else "\" \"") ^ |
|
14598
7009f59711e3
Replaced quote by Library.quote, since quote now refers to Symbol.quote
berghofe
parents:
14540
diff
changeset
|
100 |
path ^ "\" > " ^ space_implode " " (map Library.quote parents) ^ " ;") gr)); |
7727 | 101 |
|
20577 | 102 |
fun display_graph gr = |
103 |
let |
|
24561 | 104 |
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
|
105 |
val path = File.tmp_path (Path.explode "tmp.graph"); |
20577 | 106 |
val _ = write_graph gr path; |
107 |
val _ = File.isatool ("browser -c " ^ File.shell_path path ^ " &"); |
|
108 |
in () end; |
|
109 |
||
110 |
||
9416 | 111 |
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
|
112 |
fun ID_of_thy thy = ID_of (#session (get_info thy)) (Context.theory_name thy); |
7727 | 113 |
|
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
114 |
|
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
115 |
(*retrieve graph data from initial collection of theories*) |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
116 |
fun init_graph remote_path curr_sess = rev o map (fn thy => |
7727 | 117 |
let |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
118 |
val name = Context.theory_name thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
119 |
val {name = sess_name, session, is_local} = get_info thy; |
9416 | 120 |
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
|
121 |
val entry = |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
122 |
{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
|
123 |
path = |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
124 |
if null session then "" else |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
125 |
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
|
126 |
Url.implode (Url.append (the remote_path) (Url.File |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
127 |
(Path.append (Path.make session) (html_path name)))) |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
128 |
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
|
129 |
unfold = false, |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
130 |
parents = map ID_of_thy (Theory.parents_of thy)}; |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
131 |
in (0, entry) end); |
7727 | 132 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
133 |
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
|
134 |
(i, entry) :: filter_out (fn (_, entry') => #ID entry' = ID) gr; |
7727 | 135 |
|
136 |
||
137 |
||
138 |
(** global browser info state **) |
|
139 |
||
140 |
(* type theory_info *) |
|
141 |
||
142 |
type theory_info = {tex_source: Buffer.T, html_source: Buffer.T, html: Buffer.T}; |
|
143 |
||
144 |
fun make_theory_info (tex_source, html_source, html) = |
|
145 |
{tex_source = tex_source, html_source = html_source, html = html}: theory_info; |
|
146 |
||
147 |
val empty_theory_info = make_theory_info (Buffer.empty, Buffer.empty, Buffer.empty); |
|
148 |
||
149 |
fun map_theory_info f {tex_source, html_source, html} = |
|
150 |
make_theory_info (f (tex_source, html_source, html)); |
|
151 |
||
152 |
||
153 |
(* type browser_info *) |
|
154 |
||
11856 | 155 |
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
|
156 |
tex_index: (int * string) list, html_index: (int * string) list, graph: (int * graph_node) list}; |
7727 | 157 |
|
11856 | 158 |
fun make_browser_info (theories, files, tex_index, html_index, graph) = |
159 |
{theories = theories, files = files, tex_index = tex_index, html_index = html_index, |
|
9416 | 160 |
graph = graph}: browser_info; |
7727 | 161 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
162 |
val empty_browser_info = make_browser_info (Symtab.empty, [], [], [], []); |
7727 | 163 |
|
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
164 |
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
|
165 |
(Symtab.empty, [], [], [], init_graph remote_path curr_sess thys); |
7727 | 166 |
|
11856 | 167 |
fun map_browser_info f {theories, files, tex_index, html_index, graph} = |
168 |
make_browser_info (f (theories, files, tex_index, html_index, graph)); |
|
7727 | 169 |
|
170 |
||
171 |
(* state *) |
|
172 |
||
173 |
val browser_info = ref empty_browser_info; |
|
23944 | 174 |
fun change_browser_info f = CRITICAL (fn () => change browser_info (map_browser_info f)); |
7727 | 175 |
|
11057 | 176 |
val suppress_tex_source = ref false; |
24102 | 177 |
fun no_document f x = setmp_noncritical suppress_tex_source true f x; |
7727 | 178 |
|
179 |
fun init_theory_info name info = |
|
11856 | 180 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
17412 | 181 |
(Symtab.update (name, info) theories, files, tex_index, html_index, graph)); |
7727 | 182 |
|
183 |
fun change_theory_info name f = |
|
11856 | 184 |
change_browser_info (fn (info as (theories, files, tex_index, html_index, graph)) => |
17412 | 185 |
(case Symtab.lookup theories name of |
15531 | 186 |
NONE => (warning ("Browser info: cannot access theory document " ^ quote name); info) |
17412 | 187 |
| SOME info => (Symtab.update (name, map_theory_info f info) theories, files, |
9416 | 188 |
tex_index, html_index, graph))); |
7727 | 189 |
|
190 |
||
11856 | 191 |
fun add_file file = |
192 |
change_browser_info (fn (theories, files, tex_index, html_index, graph) => |
|
193 |
(theories, file :: files, tex_index, html_index, graph)); |
|
194 |
||
7727 | 195 |
fun add_tex_index txt = |
11856 | 196 |
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
|
197 |
(theories, files, txt :: tex_index, html_index, graph)); |
7727 | 198 |
|
199 |
fun add_html_index txt = |
|
11856 | 200 |
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
|
201 |
(theories, files, tex_index, txt :: html_index, graph)); |
7727 | 202 |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
203 |
fun add_graph_entry entry = |
11856 | 204 |
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
|
205 |
(theories, files, tex_index, html_index, ins_graph_entry entry graph)); |
7727 | 206 |
|
11057 | 207 |
fun add_tex_source name txt = |
208 |
if ! suppress_tex_source then () |
|
209 |
else change_theory_info name (fn (tex_source, html_source, html) => |
|
210 |
(Buffer.add txt tex_source, html_source, html)); |
|
7727 | 211 |
|
212 |
fun add_html_source name txt = change_theory_info name (fn (tex_source, html_source, html) => |
|
213 |
(tex_source, Buffer.add txt html_source, html)); |
|
214 |
||
215 |
fun add_html name txt = change_theory_info name (fn (tex_source, html_source, html) => |
|
216 |
(tex_source, html_source, Buffer.add txt html)); |
|
217 |
||
218 |
||
219 |
||
220 |
(** global session state **) |
|
221 |
||
222 |
(* session_info *) |
|
223 |
||
224 |
type session_info = |
|
225 |
{name: string, parent: string, session: string, path: string list, html_prefix: Path.T, |
|
17082 | 226 |
info: bool, doc_format: string, doc_graph: bool, documents: (string * string) list, |
17210 | 227 |
doc_prefix1: (Path.T * Path.T) option, doc_prefix2: (bool * Path.T) option, |
228 |
remote_path: Url.T option, verbose: bool, readme: Path.T option}; |
|
7727 | 229 |
|
9416 | 230 |
fun make_session_info |
17082 | 231 |
(name, parent, session, path, html_prefix, info, doc_format, doc_graph, documents, |
232 |
doc_prefix1, doc_prefix2, remote_path, verbose, readme) = |
|
7802 | 233 |
{name = name, parent = parent, session = session, path = path, html_prefix = html_prefix, |
17082 | 234 |
info = info, doc_format = doc_format, doc_graph = doc_graph, documents = documents, |
235 |
doc_prefix1 = doc_prefix1, doc_prefix2 = doc_prefix2, remote_path = remote_path, |
|
236 |
verbose = verbose, readme = readme}: session_info; |
|
7685 | 237 |
|
238 |
||
7727 | 239 |
(* state *) |
240 |
||
15531 | 241 |
val session_info = ref (NONE: session_info option); |
7727 | 242 |
|
15531 | 243 |
fun with_session x f = (case ! session_info of NONE => x | SOME info => f info); |
26433 | 244 |
fun with_context f = f (Context.theory_name (ML_Context.the_global_context ())); |
7727 | 245 |
|
246 |
||
247 |
||
14922 | 248 |
(** document preparation **) |
7727 | 249 |
|
250 |
(* maintain index *) |
|
251 |
||
252 |
val session_entries = |
|
253 |
HTML.session_entries o |
|
14898 | 254 |
map (fn name => (Url.File (Path.append (Path.basic name) index_path), name)); |
7727 | 255 |
|
256 |
fun get_entries dir = |
|
257 |
split_lines (File.read (Path.append dir session_entries_path)); |
|
258 |
||
259 |
fun put_entries entries dir = |
|
260 |
File.write (Path.append dir session_entries_path) (cat_lines entries); |
|
261 |
||
262 |
||
263 |
fun create_index dir = |
|
264 |
File.read (Path.append dir pre_index_path) ^ |
|
265 |
session_entries (get_entries dir) ^ HTML.end_index |
|
266 |
|> File.write (Path.append dir index_path); |
|
267 |
||
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
268 |
fun update_index dir name = CRITICAL (fn () => |
7727 | 269 |
(case try get_entries dir of |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
270 |
NONE => warning ("Browser info: cannot access session index of " ^ quote (Path.implode dir)) |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
271 |
| SOME es => (put_entries ((remove (op =) name es) @ [name]) dir; create_index dir))); |
7727 | 272 |
|
273 |
||
17082 | 274 |
(* document versions *) |
275 |
||
276 |
fun read_version str = |
|
277 |
(case space_explode "=" str of |
|
278 |
[name] => (name, "") |
|
279 |
| [name, tags] => (name, tags) |
|
280 |
| _ => error ("Malformed document version specification: " ^ quote str)); |
|
281 |
||
282 |
fun read_versions strs = |
|
19046
bc5c6c9b114e
removed distinct, renamed gen_distinct to distinct;
wenzelm
parents:
18708
diff
changeset
|
283 |
rev (distinct (eq_fst (op =)) (rev ((documentN, "") :: map read_version strs))) |
17082 | 284 |
|> filter_out (equal "-" o #2); |
285 |
||
286 |
||
7727 | 287 |
(* init session *) |
288 |
||
12895 | 289 |
fun name_of_session elems = space_implode "/" ("Isabelle" :: elems); |
290 |
||
17082 | 291 |
fun init build info doc doc_graph doc_versions path name doc_prefix2 |
23944 | 292 |
(remote_path, first_time) verbose thys = CRITICAL (fn () => |
11911
6533ceee4cd7
build option enables most basic browser info (for proper recording of session);
wenzelm
parents:
11856
diff
changeset
|
293 |
if not build andalso not info andalso doc = "" andalso is_none doc_prefix2 then |
15531 | 294 |
(browser_info := empty_browser_info; session_info := NONE) |
11856 | 295 |
else |
296 |
let |
|
297 |
val parent_name = name_of_session (Library.take (length path - 1, path)); |
|
298 |
val session_name = name_of_session path; |
|
299 |
val sess_prefix = Path.make path; |
|
300 |
val html_prefix = Path.append (Path.expand output_path) sess_prefix; |
|
7727 | 301 |
|
17082 | 302 |
val (doc_prefix1, documents) = |
303 |
if doc = "" then (NONE, []) |
|
21962 | 304 |
else if not (File.exists document_path) then |
22580 | 305 |
(if verbose then Output.std_error "Warning: missing document directory\n" else (); |
306 |
(NONE, [])) |
|
17082 | 307 |
else (SOME (Path.append html_prefix document_path, html_prefix), |
308 |
read_versions doc_versions); |
|
7727 | 309 |
|
11856 | 310 |
val parent_index_path = Path.append Path.parent index_path; |
311 |
val index_up_lnk = if first_time then |
|
16263
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
312 |
Url.append (the remote_path) (Url.File (Path.append sess_prefix parent_index_path)) |
14898 | 313 |
else Url.File parent_index_path; |
11856 | 314 |
val readme = |
15531 | 315 |
if File.exists readme_html_path then SOME readme_html_path |
316 |
else if File.exists readme_path then SOME readme_path |
|
317 |
else NONE; |
|
7727 | 318 |
|
17082 | 319 |
val docs = |
320 |
(case readme of NONE => [] | SOME p => [(Url.File p, "README")]) @ |
|
321 |
map (fn (name, _) => (Url.File (Path.ext doc (Path.basic name)), name)) documents; |
|
11856 | 322 |
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
|
323 |
(Url.File index_path, session_name) docs (Url.explode "medium.html"); |
11856 | 324 |
in |
15531 | 325 |
session_info := SOME (make_session_info (name, parent_name, session_name, path, html_prefix, |
17082 | 326 |
info, doc, doc_graph, documents, doc_prefix1, doc_prefix2, remote_path, verbose, readme)); |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
327 |
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
|
328 |
add_html_index (0, index_text) |
23944 | 329 |
end); |
7727 | 330 |
|
331 |
||
17082 | 332 |
(* isatool wrappers *) |
333 |
||
334 |
fun isatool_document verbose format name tags path result_path = |
|
335 |
let |
|
336 |
val s = "\"$ISATOOL\" document -c -o '" ^ format ^ "' \ |
|
337 |
\-n '" ^ name ^ "' -t '" ^ tags ^ "' " ^ File.shell_path path ^ |
|
338 |
" 2>&1" ^ (if verbose then "" else " >/dev/null"); |
|
339 |
val doc_path = Path.append result_path (Path.ext format (Path.basic name)); |
|
340 |
in |
|
21962 | 341 |
if verbose then writeln s else (); |
17082 | 342 |
system s; |
21962 | 343 |
File.exists doc_path orelse |
344 |
error ("No document: " ^ quote (show_path doc_path)); |
|
17082 | 345 |
doc_path |
346 |
end; |
|
347 |
||
348 |
fun isatool_browser graph = |
|
349 |
let |
|
350 |
val pdf_path = File.tmp_path graph_pdf_path; |
|
351 |
val eps_path = File.tmp_path graph_eps_path; |
|
352 |
val gr_path = File.tmp_path graph_path; |
|
353 |
val s = "browser -o " ^ File.shell_path pdf_path ^ " " ^ File.shell_path gr_path; |
|
354 |
in |
|
355 |
write_graph graph gr_path; |
|
356 |
if File.isatool s <> 0 orelse not (File.exists eps_path) orelse not (File.exists pdf_path) |
|
357 |
then error "Failed to prepare dependency graph" |
|
358 |
else |
|
359 |
let val pdf = File.read pdf_path and eps = File.read eps_path |
|
360 |
in File.rm pdf_path; File.rm eps_path; File.rm gr_path; (pdf, eps) end |
|
361 |
end; |
|
362 |
||
363 |
||
11856 | 364 |
(* finish session -- output all generated text *) |
365 |
||
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
366 |
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
|
367 |
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
|
368 |
|
14922 | 369 |
fun write_tex src name path = |
370 |
Buffer.write (Path.append path (tex_path name)) src; |
|
371 |
||
372 |
fun write_tex_index tex_index path = |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
373 |
write_tex (index_buffer tex_index |> Buffer.add Latex.tex_trailer) doc_indexN path; |
14922 | 374 |
|
7685 | 375 |
|
23944 | 376 |
fun finish () = CRITICAL (fn () => |
377 |
with_session () (fn {name, info, html_prefix, doc_format, doc_graph, |
|
378 |
documents, doc_prefix1, doc_prefix2, path, verbose, readme, ...} => |
|
7727 | 379 |
let |
11856 | 380 |
val {theories, files, tex_index, html_index, graph} = ! browser_info; |
381 |
val thys = Symtab.dest theories; |
|
9416 | 382 |
val parent_html_prefix = Path.append html_prefix Path.parent; |
7727 | 383 |
|
11856 | 384 |
fun finish_tex path (a, {tex_source, ...}: theory_info) = write_tex tex_source a path; |
385 |
fun finish_html (a, {html, ...}: theory_info) = |
|
386 |
Buffer.write (Path.append html_prefix (html_path a)) (Buffer.add HTML.end_theory html); |
|
387 |
||
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
388 |
val sorted_graph = sorted_index graph; |
11856 | 389 |
val opt_graphs = |
16263
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
390 |
if doc_graph andalso (is_some doc_prefix1 orelse is_some doc_prefix2) then |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
391 |
SOME (isatool_browser sorted_graph) |
15531 | 392 |
else NONE; |
11856 | 393 |
|
17210 | 394 |
fun prepare_sources cp path = |
16263
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
395 |
(File.mkdir path; |
17210 | 396 |
if cp then File.copy_dir document_path path else (); |
17177 | 397 |
File.isatool ("latex -o sty " ^ File.shell_path (Path.append path (Path.basic "root.tex"))); |
15531 | 398 |
(case opt_graphs of NONE => () | SOME (pdf, eps) => |
11856 | 399 |
(File.write (Path.append path graph_pdf_path) pdf; |
400 |
File.write (Path.append path graph_eps_path) eps)); |
|
14922 | 401 |
write_tex_index tex_index path; |
15570 | 402 |
List.app (finish_tex path) thys); |
7727 | 403 |
in |
21962 | 404 |
if info then |
11856 | 405 |
(File.mkdir (Path.append html_prefix session_path); |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
406 |
Buffer.write (Path.append html_prefix pre_index_path) (index_buffer html_index); |
11856 | 407 |
File.write (Path.append html_prefix session_entries_path) ""; |
408 |
create_index html_prefix; |
|
409 |
if length path > 1 then update_index parent_html_prefix name else (); |
|
16263
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
410 |
(case readme of NONE => () | SOME path => File.copy path html_prefix); |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
411 |
write_graph sorted_graph (Path.append html_prefix graph_path); |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
412 |
File.copy (Path.explode "~~/lib/browser/GraphBrowser.jar") html_prefix; |
15570 | 413 |
List.app (fn (a, txt) => File.write (Path.append html_prefix (Path.basic a)) txt) |
14898 | 414 |
(HTML.applet_pages name (Url.File index_path, name)); |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
415 |
File.copy (Path.explode "~~/lib/html/isabelle.css") html_prefix; |
15570 | 416 |
List.app finish_html thys; |
417 |
List.app (uncurry File.write) files; |
|
22580 | 418 |
if verbose then Output.std_error ("Browser info at " ^ show_path html_prefix ^ "\n") else ()) |
21962 | 419 |
else (); |
11856 | 420 |
|
17210 | 421 |
(case doc_prefix2 of NONE => () | SOME (cp, path) => |
422 |
(prepare_sources cp path; |
|
22580 | 423 |
if verbose then Output.std_error ("Document sources at " ^ show_path path ^ "\n") else ())); |
12895 | 424 |
|
17082 | 425 |
(case doc_prefix1 of NONE => () | SOME (path, result_path) => |
426 |
documents |> List.app (fn (name, tags) => |
|
427 |
let |
|
17210 | 428 |
val _ = prepare_sources true path; |
17082 | 429 |
val doc_path = isatool_document true doc_format name tags path result_path; |
430 |
in |
|
22580 | 431 |
if verbose then Output.std_error ("Document at " ^ show_path doc_path ^ "\n") else () |
17082 | 432 |
end)); |
11856 | 433 |
|
7727 | 434 |
browser_info := empty_browser_info; |
15531 | 435 |
session_info := NONE |
23944 | 436 |
end)); |
7727 | 437 |
|
438 |
||
439 |
(* theory elements *) |
|
440 |
||
441 |
fun init_theory name = with_session () (fn _ => init_theory_info name empty_theory_info); |
|
442 |
||
443 |
fun verbatim_source name mk_text = |
|
444 |
with_session () (fn _ => add_html_source name (HTML.verbatim_source (mk_text ()))); |
|
445 |
||
9136 | 446 |
fun theory_output name s = |
9917 | 447 |
with_session () (fn _ => add_tex_source name (Latex.isabelle_file name s)); |
7727 | 448 |
|
449 |
||
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
450 |
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
|
451 |
let |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
452 |
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
|
453 |
val name = Context.theory_name thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
454 |
val link = |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
455 |
if null session then NONE |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
456 |
else SOME |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
457 |
(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
|
458 |
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
|
459 |
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
|
460 |
in (link, name) end; |
7727 | 461 |
|
26323
73efc70edeef
theory loader: discontinued *attached* ML scripts;
wenzelm
parents:
24829
diff
changeset
|
462 |
fun begin_theory update_time dir files thy = |
9416 | 463 |
with_session thy (fn {name = sess_name, session, path, html_prefix, remote_path, ...} => |
7727 | 464 |
let |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
465 |
val name = Context.theory_name thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
466 |
val parents = Theory.parents_of thy; |
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
467 |
val parent_specs = map (parent_link remote_path path) parents; |
7727 | 468 |
|
469 |
fun prep_file (raw_path, loadit) = |
|
23884
1d39ec4fe73f
simplified ThyLoad interfaces: only one additional directory;
wenzelm
parents:
23870
diff
changeset
|
470 |
(case ThyLoad.check_ml dir raw_path of |
15531 | 471 |
SOME (path, _) => |
7727 | 472 |
let |
473 |
val base = Path.base path; |
|
474 |
val base_html = html_ext base; |
|
26323
73efc70edeef
theory loader: discontinued *attached* ML scripts;
wenzelm
parents:
24829
diff
changeset
|
475 |
val _ = add_file (Path.append html_prefix base_html, |
14898 | 476 |
HTML.ml_file (Url.File base) (File.read path)); |
26323
73efc70edeef
theory loader: discontinued *attached* ML scripts;
wenzelm
parents:
24829
diff
changeset
|
477 |
in (SOME (Url.File base_html), Url.File raw_path, loadit) end |
23884
1d39ec4fe73f
simplified ThyLoad interfaces: only one additional directory;
wenzelm
parents:
23870
diff
changeset
|
478 |
| NONE => |
1d39ec4fe73f
simplified ThyLoad interfaces: only one additional directory;
wenzelm
parents:
23870
diff
changeset
|
479 |
(warning ("Browser info: expected to find ML file" ^ quote (Path.implode raw_path)); |
1d39ec4fe73f
simplified ThyLoad interfaces: only one additional directory;
wenzelm
parents:
23870
diff
changeset
|
480 |
(NONE, Url.File raw_path, loadit))); |
7727 | 481 |
|
482 |
fun prep_html_source (tex_source, html_source, html) = |
|
483 |
let |
|
14898 | 484 |
val txt = HTML.begin_theory (Url.File index_path, session) |
26323
73efc70edeef
theory loader: discontinued *attached* ML scripts;
wenzelm
parents:
24829
diff
changeset
|
485 |
name parent_specs (map prep_file files) (Buffer.content html_source) |
7727 | 486 |
in (tex_source, Buffer.empty, Buffer.add txt html) end; |
487 |
||
9416 | 488 |
val entry = |
489 |
{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
|
490 |
path = Path.implode (html_path name), |
23899
ab37b1f690c7
clarified init/begin_theory: no longer depend on thy_info.ML;
wenzelm
parents:
23884
diff
changeset
|
491 |
parents = map ID_of_thy parents}; |
7727 | 492 |
in |
493 |
change_theory_info name prep_html_source; |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
494 |
add_graph_entry (update_time, entry); |
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
495 |
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
|
496 |
add_tex_index (update_time, Latex.theory_entry name); |
27327 | 497 |
put_info {name = sess_name, session = path, is_local = is_some remote_path} thy |
7727 | 498 |
end); |
499 |
||
500 |
||
13532 | 501 |
val hooks = ref ([]: (string -> (string * thm list) list -> unit) list); |
23944 | 502 |
fun add_hook f = CRITICAL (fn () => change hooks (cons f)); |
13532 | 503 |
|
504 |
fun results k xs = |
|
15570 | 505 |
(List.app (fn f => (try (fn () => f k xs) (); ())) (! hooks); |
22123
15ddfafc04a9
moved ML context stuff to from Context to ML_Context;
wenzelm
parents:
21962
diff
changeset
|
506 |
with_session () (fn _ => with_context add_html |
15ddfafc04a9
moved ML context stuff to from Context to ML_Context;
wenzelm
parents:
21962
diff
changeset
|
507 |
(HTML.results (ML_Context.the_local_context ()) k xs))); |
13532 | 508 |
|
22123
15ddfafc04a9
moved ML context stuff to from Context to ML_Context;
wenzelm
parents:
21962
diff
changeset
|
509 |
fun theorem a th = results Thm.theoremK [(a, [th])]; |
15ddfafc04a9
moved ML context stuff to from Context to ML_Context;
wenzelm
parents:
21962
diff
changeset
|
510 |
fun theorems a ths = results Thm.theoremK [(a, ths)]; |
8088 | 511 |
fun chapter s = with_session () (fn _ => with_context add_html (HTML.chapter s)); |
7727 | 512 |
fun section s = with_session () (fn _ => with_context add_html (HTML.section s)); |
513 |
fun subsection s = with_session () (fn _ => with_context add_html (HTML.subsection s)); |
|
514 |
fun subsubsection s = with_session () (fn _ => with_context add_html (HTML.subsubsection s)); |
|
515 |
||
516 |
||
517 |
||
14922 | 518 |
(** draft document output **) |
519 |
||
520 |
fun drafts doc_format src_paths = |
|
521 |
let |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
522 |
fun prep_draft path i = |
14935 | 523 |
let |
524 |
val base = Path.base path; |
|
14972 | 525 |
val name = |
24829 | 526 |
(case Path.implode (#1 (Path.split_ext base)) of |
527 |
"" => "DUMMY" ^ serial_string () |
|
528 |
| s => s); |
|
14935 | 529 |
in |
530 |
if File.exists path then |
|
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
531 |
(((name, base, File.read path), (i, Latex.theory_entry name)), i + 1) |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
532 |
else error ("Bad file: " ^ quote (Path.implode path)) |
14935 | 533 |
end; |
24150
ed724867099a
sort indexes according to symbolic update_time (multithreading-safe);
wenzelm
parents:
24102
diff
changeset
|
534 |
val (srcs, tex_index) = split_list (fst (fold_map prep_draft src_paths 0)); |
14935 | 535 |
|
17082 | 536 |
val doc_path = File.tmp_path document_path; |
537 |
val result_path = Path.append doc_path Path.parent; |
|
14922 | 538 |
val _ = File.mkdir doc_path; |
539 |
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
|
540 |
val _ = File.copy (Path.explode "~~/lib/texinputs/draft.tex") root_path; |
16263
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
541 |
val _ = File.isatool ("latex -o sty " ^ File.shell_path root_path); |
0609fb8df4a7
removed copy, copy_all (superceded by File.copy, File.copy_dir);
wenzelm
parents:
15801
diff
changeset
|
542 |
val _ = File.isatool ("latex -o syms " ^ File.shell_path root_path); |
14922 | 543 |
|
544 |
fun known name = |
|
545 |
let val ss = split_lines (File.read (Path.append doc_path (Path.basic name))) |
|
20664 | 546 |
in member (op =) ss end; |
14922 | 547 |
val known_syms = known "syms.lst"; |
548 |
val known_ctrls = known "ctrls.lst"; |
|
549 |
||
15570 | 550 |
val _ = srcs |> List.app (fn (name, base, txt) => |
14935 | 551 |
Symbol.explode txt |
21858
05f57309170c
avoid conflict with Alice keywords: renamed pack -> implode, unpack -> explode, any -> many, avoided assert;
wenzelm
parents:
20664
diff
changeset
|
552 |
|> Latex.symbol_source (known_syms, known_ctrls) (Path.implode base) |
14935 | 553 |
|> File.write (Path.append doc_path (tex_path name))); |
14922 | 554 |
val _ = write_tex_index tex_index doc_path; |
17082 | 555 |
in isatool_document false doc_format documentN "" doc_path result_path end; |
14922 | 556 |
|
557 |
||
7685 | 558 |
end; |
559 |
||
6203 | 560 |
structure BasicPresent: BASIC_PRESENT = Present; |
561 |
open BasicPresent; |