src/Pure/Thy/present.ML
author wenzelm
Thu Mar 28 14:01:56 2013 +0100 (2013-03-28)
changeset 51567 a86c5e02ba58
parent 51419 5313abe76bd4
child 52549 802576856527
permissions -rw-r--r--
proper default browser info for interactive mode, notably thy_deps;
     1 (*  Title:      Pure/Thy/present.ML
     2     Author:     Markus Wenzel and Stefan Berghofer, TU Muenchen
     3 
     4 Theory presentation: HTML, graph files, (PDF)LaTeX documents.
     5 *)
     6 
     7 signature BASIC_PRESENT =
     8 sig
     9   val no_document: ('a -> 'b) -> 'a -> 'b  (*not thread-safe!*)
    10 end;
    11 
    12 signature PRESENT =
    13 sig
    14   include BASIC_PRESENT
    15   val session_name: theory -> string
    16   val read_variant: string -> string * string
    17   val init: bool -> bool -> Path.T -> string -> bool -> string -> (string * string) list ->
    18     string * string -> bool * string -> bool -> theory list -> unit  (*not thread-safe!*)
    19   val finish: unit -> unit  (*not thread-safe!*)
    20   val init_theory: string -> unit
    21   val theory_source: string -> (unit -> HTML.text) -> unit
    22   val theory_output: string -> string -> unit
    23   val begin_theory: int -> Path.T -> theory -> theory
    24   val drafts: string -> Path.T list -> Path.T
    25 end;
    26 
    27 structure Present: PRESENT =
    28 struct
    29 
    30 
    31 (** paths **)
    32 
    33 val tex_ext = Path.ext "tex";
    34 val tex_path = tex_ext o Path.basic;
    35 val html_ext = Path.ext "html";
    36 val html_path = html_ext o Path.basic;
    37 val index_path = Path.basic "index.html";
    38 val readme_html_path = Path.basic "README.html";
    39 val documentN = "document";
    40 val document_path = Path.basic documentN;
    41 val doc_indexN = "session";
    42 val graph_path = Path.basic "session.graph";
    43 val graph_pdf_path = Path.basic "session_graph.pdf";
    44 val graph_eps_path = Path.basic "session_graph.eps";
    45 
    46 fun show_path path = Path.implode (Path.expand (Path.append (File.pwd ()) path));
    47 
    48 
    49 
    50 (** additional theory data **)
    51 
    52 structure Browser_Info = Theory_Data
    53 (
    54   type T = {chapter: string, name: string};
    55   val empty = {chapter = "Unsorted", name = "Unknown"}: T;
    56   fun extend _ = empty;
    57   fun merge _ = empty;
    58 );
    59 
    60 val _ = Context.>> (Context.map_theory
    61   (Browser_Info.put {chapter = Context.PureN, name = Context.PureN}));
    62 
    63 val session_name = #name o Browser_Info.get;
    64 val session_chapter_name = (fn {chapter, name} => [chapter, name]) o Browser_Info.get;
    65 
    66 
    67 
    68 (** graphs **)
    69 
    70 fun ID_of sess s = space_implode "/" (sess @ [s]);
    71 fun ID_of_thy thy = ID_of (session_chapter_name thy) (Context.theory_name thy);
    72 
    73 fun theory_link (curr_chapter, curr_session) thy =
    74   let
    75     val {chapter, name = session} = Browser_Info.get thy;
    76     val link = html_path (Context.theory_name thy);
    77   in
    78     if curr_session = session then SOME link
    79     else if curr_chapter = chapter then
    80       SOME (Path.appends [Path.parent, Path.basic session, link])
    81     else if chapter = Context.PureN then NONE
    82     else SOME (Path.appends [Path.parent, Path.parent, Path.basic chapter, Path.basic session, link])
    83   end;
    84 
    85 (*retrieve graph data from initial collection of theories*)
    86 fun init_graph (curr_chapter, curr_session) = rev o map (fn thy =>
    87   let
    88     val {chapter, name = session_name} = Browser_Info.get thy;
    89     val thy_name = Context.theory_name thy;
    90     val path =
    91       (case theory_link (curr_chapter, curr_session) thy of
    92         NONE => ""
    93       | SOME p => Path.implode p);
    94     val entry =
    95      {name = thy_name,
    96       ID = ID_of [chapter, session_name] thy_name,
    97       dir = session_name,
    98       path = path,
    99       unfold = false,
   100       parents = map ID_of_thy (Theory.parents_of thy),
   101       content = []};
   102   in (0, entry) end);
   103 
   104 fun ins_graph_entry (i, entry as {ID, ...}) (gr: (int * Graph_Display.node) list) =
   105   (i, entry) :: filter_out (fn (_, entry') => #ID entry' = ID) gr;
   106 
   107 
   108 
   109 (** global browser info state **)
   110 
   111 (* type theory_info *)
   112 
   113 type theory_info = {tex_source: Buffer.T, html_source: Buffer.T, html: Buffer.T};
   114 
   115 fun make_theory_info (tex_source, html_source, html) =
   116   {tex_source = tex_source, html_source = html_source, html = html}: theory_info;
   117 
   118 val empty_theory_info = make_theory_info (Buffer.empty, Buffer.empty, Buffer.empty);
   119 
   120 fun map_theory_info f {tex_source, html_source, html} =
   121   make_theory_info (f (tex_source, html_source, html));
   122 
   123 
   124 (* type browser_info *)
   125 
   126 type browser_info = {theories: theory_info Symtab.table, files: (Path.T * string) list,
   127   tex_index: (int * string) list, html_index: (int * string) list,
   128   graph: (int * Graph_Display.node) list};
   129 
   130 fun make_browser_info (theories, files, tex_index, html_index, graph) =
   131   {theories = theories, files = files, tex_index = tex_index, html_index = html_index,
   132     graph = graph}: browser_info;
   133 
   134 val empty_browser_info = make_browser_info (Symtab.empty, [], [], [], []);
   135 
   136 fun init_browser_info session thys =
   137   make_browser_info (Symtab.empty, [], [], [], init_graph session thys);
   138 
   139 fun map_browser_info f {theories, files, tex_index, html_index, graph} =
   140   make_browser_info (f (theories, files, tex_index, html_index, graph));
   141 
   142 
   143 (* state *)
   144 
   145 val browser_info = Unsynchronized.ref empty_browser_info;
   146 fun change_browser_info f =
   147   CRITICAL (fn () => Unsynchronized.change browser_info (map_browser_info f));
   148 
   149 val suppress_tex_source = Unsynchronized.ref false;
   150 fun no_document f x = Unsynchronized.setmp suppress_tex_source true f x;
   151 
   152 fun init_theory_info name info =
   153   change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
   154     (Symtab.update (name, info) theories, files, tex_index, html_index, graph));
   155 
   156 fun change_theory_info name f =
   157   change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
   158     (case Symtab.lookup theories name of
   159       NONE => error ("Browser info: cannot access theory document " ^ quote name)
   160     | SOME info => (Symtab.update (name, map_theory_info f info) theories, files,
   161         tex_index, html_index, graph)));
   162 
   163 
   164 fun add_file file =
   165   change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
   166     (theories, file :: files, tex_index, html_index, graph));
   167 
   168 fun add_tex_index txt =
   169   change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
   170     (theories, files, txt :: tex_index, html_index, graph));
   171 
   172 fun add_html_index txt =
   173   change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
   174     (theories, files, tex_index, txt :: html_index, graph));
   175 
   176 fun add_graph_entry entry =
   177   change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
   178     (theories, files, tex_index, html_index, ins_graph_entry entry graph));
   179 
   180 fun add_tex_source name txt =
   181   if ! suppress_tex_source then ()
   182   else change_theory_info name (fn (tex_source, html_source, html) =>
   183     (Buffer.add txt tex_source, html_source, html));
   184 
   185 fun add_html_source name txt = change_theory_info name (fn (tex_source, html_source, html) =>
   186   (tex_source, Buffer.add txt html_source, html));
   187 
   188 
   189 
   190 (** global session state **)
   191 
   192 (* session_info *)
   193 
   194 type session_info =
   195   {name: string, chapter: string, info_path: Path.T,
   196     info: bool, doc_format: string, doc_graph: bool, doc_output: Path.T option,
   197     documents: (string * string) list, doc_dump: (bool * string), verbose: bool,
   198     readme: Path.T option};
   199 
   200 fun make_session_info
   201   (name, chapter, info_path, info, doc_format, doc_graph, doc_output,
   202     documents, doc_dump, verbose, readme) =
   203   {name = name, chapter = chapter, info_path = info_path, info = info,
   204     doc_format = doc_format, doc_graph = doc_graph, doc_output = doc_output,
   205     documents = documents, doc_dump = doc_dump, verbose = verbose,
   206     readme = readme}: session_info;
   207 
   208 
   209 (* state *)
   210 
   211 val session_info = Unsynchronized.ref (NONE: session_info option);
   212 
   213 fun with_session_info x f = (case ! session_info of NONE => x | SOME info => f info);
   214 
   215 
   216 
   217 (** document preparation **)
   218 
   219 (* document variants *)
   220 
   221 fun read_variant str =
   222   (case space_explode "=" str of
   223     [name] => (name, "")
   224   | [name, tags] => (name, tags)
   225   | _ => error ("Malformed document variant specification: " ^ quote str));
   226 
   227 
   228 (* init session *)
   229 
   230 fun init build info info_path doc doc_graph document_output doc_variants
   231     (chapter, name) (doc_dump as (_, dump_prefix)) verbose thys =
   232   if not build andalso not info andalso doc = "" andalso dump_prefix = "" then
   233     (browser_info := empty_browser_info; session_info := NONE)
   234   else
   235     let
   236       val doc_output =
   237         if document_output = "" then NONE else SOME (Path.explode document_output);
   238 
   239       val documents =
   240         if doc = "" then []
   241         else if not (can File.check_dir document_path) then
   242           (if verbose then Output.physical_stderr "Warning: missing document directory\n"
   243            else (); [])
   244         else doc_variants;
   245 
   246       val readme = if File.exists readme_html_path then SOME readme_html_path else NONE;
   247 
   248       val docs =
   249         (case readme of NONE => [] | SOME p => [(Url.File p, "README")]) @
   250           map (fn (name, _) => (Url.File (Path.ext doc (Path.basic name)), name)) documents;
   251     in
   252       session_info :=
   253         SOME (make_session_info (name, chapter, info_path, info, doc,
   254           doc_graph, doc_output, documents, doc_dump, verbose, readme));
   255       browser_info := init_browser_info (chapter, name) thys;
   256       add_html_index (0, HTML.begin_session_index name docs (Url.explode "medium.html"))
   257     end;
   258 
   259 
   260 (* isabelle tool wrappers *)
   261 
   262 fun isabelle_document {verbose, purge} format name tags dir =
   263   let
   264     val s = "\"$ISABELLE_TOOL\" document" ^ (if purge then " -c" else "") ^ " -o '" ^ format ^ "' \
   265       \-n '" ^ name ^ "' -t '" ^ tags ^ "' " ^ File.shell_path dir ^ " 2>&1";
   266     val doc_path = Path.appends [dir, Path.parent, Path.basic name |> Path.ext format];
   267     val _ = if verbose then writeln s else ();
   268     val (out, rc) = Isabelle_System.bash_output s;
   269     val _ =
   270       if not (File.exists doc_path) orelse rc <> 0 then
   271         cat_error out ("Failed to build document " ^ quote (show_path doc_path))
   272       else if verbose then writeln out
   273       else ();
   274   in doc_path end;
   275 
   276 fun isabelle_browser graph = Isabelle_System.with_tmp_dir "browser" (fn dir =>
   277   let
   278     val pdf_path = Path.append dir graph_pdf_path;
   279     val eps_path = Path.append dir graph_eps_path;
   280     val graph_path = Path.append dir graph_path;
   281     val _ = Graph_Display.write_graph_browser graph_path graph;
   282     val args = "-o " ^ File.shell_path pdf_path ^ " " ^ File.shell_path graph_path;
   283   in
   284     if Isabelle_System.isabelle_tool "browser" args = 0 andalso
   285       File.exists pdf_path andalso File.exists eps_path
   286     then (File.read pdf_path, File.read eps_path)
   287     else error "Failed to prepare dependency graph"
   288   end);
   289 
   290 
   291 (* finish session -- output all generated text *)
   292 
   293 fun sorted_index index = map snd (sort (int_ord o pairself fst) (rev index));
   294 fun index_buffer index = Buffer.add (implode (sorted_index index)) Buffer.empty;
   295 
   296 fun write_tex src name path =
   297   File.write_buffer (Path.append path (tex_path name)) src;
   298 
   299 fun write_tex_index tex_index path =
   300   write_tex (index_buffer tex_index |> Buffer.add Latex.tex_trailer) doc_indexN path;
   301 
   302 
   303 fun finish () =
   304   with_session_info () (fn {name, chapter, info, info_path, doc_format, doc_graph, doc_output,
   305     documents, doc_dump = (dump_copy, dump_prefix), verbose, readme, ...} =>
   306   let
   307     val {theories, files, tex_index, html_index, graph} = ! browser_info;
   308     val thys = Symtab.dest theories;
   309 
   310     val chapter_prefix = Path.append info_path (Path.basic chapter);
   311     val session_prefix = Path.append chapter_prefix (Path.basic name);
   312 
   313     fun finish_html (a, {html, ...}: theory_info) =
   314       File.write_buffer (Path.append session_prefix (html_path a))
   315         (Buffer.add HTML.end_document html);
   316 
   317     val sorted_graph = sorted_index graph;
   318     val opt_graphs =
   319       if doc_graph andalso (not (null documents) orelse dump_prefix <> "") then
   320         SOME (isabelle_browser sorted_graph)
   321       else NONE;
   322 
   323     val _ =
   324       if info then
   325        (Isabelle_System.mkdirs session_prefix;
   326         File.write_buffer (Path.append session_prefix index_path)
   327           (index_buffer html_index |> Buffer.add HTML.end_document);
   328         (case readme of NONE => () | SOME path => File.copy path session_prefix);
   329         Graph_Display.write_graph_browser (Path.append session_prefix graph_path) sorted_graph;
   330         Isabelle_System.isabelle_tool "browser" "-b";
   331         File.copy (Path.explode "~~/lib/browser/GraphBrowser.jar") session_prefix;
   332         List.app (fn (a, txt) => File.write (Path.append session_prefix (Path.basic a)) txt)
   333           (HTML.applet_pages name (Url.File index_path, name));
   334         File.copy (Path.explode "~~/etc/isabelle.css") session_prefix;
   335         List.app finish_html thys;
   336         List.app (uncurry File.write) files;
   337         if verbose then Output.physical_stderr ("Browser info at " ^ show_path session_prefix ^ "\n")
   338         else ())
   339       else ();
   340 
   341     fun prepare_sources doc_copy doc_dir =
   342      (Isabelle_System.mkdirs doc_dir;
   343       if doc_copy then Isabelle_System.copy_dir document_path doc_dir else ();
   344       Isabelle_System.isabelle_tool "latex"
   345         ("-o sty " ^ File.shell_path (Path.append doc_dir (Path.basic "root.tex")));
   346       (case opt_graphs of NONE => () | SOME (pdf, eps) =>
   347         (File.write (Path.append doc_dir graph_pdf_path) pdf;
   348           File.write (Path.append doc_dir graph_eps_path) eps));
   349       write_tex_index tex_index doc_dir;
   350       List.app (fn (a, {tex_source, ...}) => write_tex tex_source a doc_dir) thys);
   351 
   352     val _ =
   353       if dump_prefix = "" then ()
   354       else
   355         let
   356           val path = Path.explode dump_prefix;
   357           val _ = prepare_sources dump_copy path;
   358         in
   359           if verbose then
   360             Output.physical_stderr ("Document sources at " ^ show_path path ^ "\n")
   361           else ()
   362         end;
   363 
   364     fun document_job doc_prefix backdrop (name, tags) =
   365       let
   366         val _ =
   367           File.eq (document_path, doc_prefix) andalso
   368             error ("Overlap of document input and output directory " ^ Path.print doc_prefix);
   369         val dir = Path.append doc_prefix (Path.basic name);
   370         val copy = not (File.eq (document_path, dir));
   371         val _ = prepare_sources copy dir;
   372         fun inform doc =
   373           if verbose orelse not backdrop then
   374             Output.physical_stderr ("Document at " ^ show_path doc ^ "\n")
   375           else ();
   376       in
   377         fn () =>
   378           (isabelle_document {verbose = true, purge = backdrop} doc_format name tags dir, inform)
   379       end;
   380 
   381     val jobs =
   382       (if info orelse is_none doc_output then
   383         map (document_job session_prefix true) documents
   384        else []) @
   385       (case doc_output of
   386         NONE => []
   387       | SOME path => map (document_job path false) documents);
   388 
   389     val _ = jobs |> Par_List.map (fn job => job ()) |> List.app (op |>);
   390   in
   391     browser_info := empty_browser_info;
   392     session_info := NONE
   393   end);
   394 
   395 
   396 (* theory elements *)
   397 
   398 fun init_theory name = with_session_info () (fn _ => init_theory_info name empty_theory_info);
   399 
   400 fun theory_source name mk_text =
   401   with_session_info () (fn _ => add_html_source name (HTML.theory_source (mk_text ())));
   402 
   403 fun theory_output name s =
   404   with_session_info () (fn _ => add_tex_source name (Latex.isabelle_file name s));
   405 
   406 
   407 fun begin_theory update_time dir thy =
   408     with_session_info thy (fn {name = session_name, chapter, info_path, ...} =>
   409   let
   410     val name = Context.theory_name thy;
   411     val parents = Theory.parents_of thy;
   412     val parent_specs = parents |> map (fn parent =>
   413       (Option.map Url.File (theory_link (chapter, session_name) parent),
   414         (Context.theory_name parent)));
   415 
   416     val files = [];  (* FIXME *)
   417     val files_html = files |> map (fn (raw_path, loadit) =>
   418       let
   419         val path = File.check_file (File.full_path dir raw_path);
   420         val base = Path.base path;
   421         val base_html = html_ext base;
   422         (* FIXME retain file path!? *)
   423         val session_prefix = Path.appends [info_path, Path.basic chapter, Path.basic name];
   424         val _ =
   425           add_file (Path.append session_prefix base_html,
   426             HTML.external_file (Url.File base) (File.read path));
   427       in (Url.File base_html, Url.File raw_path, loadit) end);
   428 
   429     fun prep_html_source (tex_source, html_source, html) =
   430       let val txt = HTML.begin_theory name parent_specs files_html (Buffer.content html_source)
   431       in (tex_source, Buffer.empty, Buffer.add txt html) end;
   432 
   433     val entry =
   434      {name = name,
   435       ID = ID_of [chapter, session_name] name,
   436       dir = session_name,
   437       unfold = true,
   438       path = Path.implode (html_path name),
   439       parents = map ID_of_thy parents,
   440       content = []};
   441   in
   442     change_theory_info name prep_html_source;
   443     add_graph_entry (update_time, entry);
   444     add_html_index (update_time, HTML.theory_entry (Url.File (html_path name), name));
   445     add_tex_index (update_time, Latex.theory_entry name);
   446     Browser_Info.put {chapter = chapter, name = session_name} thy
   447   end);
   448 
   449 
   450 
   451 (** draft document output **)
   452 
   453 fun drafts doc_format src_paths = Isabelle_System.with_tmp_dir "drafts" (fn dir =>
   454   let
   455     fun prep_draft path i =
   456       let
   457         val base = Path.base path;
   458         val name =
   459           (case Path.implode (#1 (Path.split_ext base)) of
   460             "" => "DUMMY"
   461           | s => s)  ^ serial_string ();
   462       in
   463         if File.exists path then
   464           (((name, base, File.read path), (i, Latex.theory_entry name)), i + 1)
   465         else error ("Bad file: " ^ Path.print path)
   466       end;
   467     val (srcs, tex_index) = split_list (fst (fold_map prep_draft src_paths 0));
   468 
   469     val doc_path = Path.append dir document_path;
   470     val _ = Isabelle_System.mkdirs doc_path;
   471     val root_path = Path.append doc_path (Path.basic "root.tex");
   472     val _ = File.copy (Path.explode "~~/lib/texinputs/draft.tex") root_path;
   473     val _ = Isabelle_System.isabelle_tool "latex" ("-o sty " ^ File.shell_path root_path);
   474     val _ = Isabelle_System.isabelle_tool "latex" ("-o syms " ^ File.shell_path root_path);
   475 
   476     fun known name =
   477       let val ss = split_lines (File.read (Path.append doc_path (Path.basic name)))
   478       in member (op =) ss end;
   479     val known_syms = known "syms.lst";
   480     val known_ctrls = known "ctrls.lst";
   481 
   482     val _ = srcs |> List.app (fn (name, base, txt) =>
   483       Symbol.explode txt
   484       |> Latex.symbol_source (known_syms, known_ctrls) (Path.implode base)
   485       |> File.write (Path.append doc_path (tex_path name)));
   486     val _ = write_tex_index tex_index doc_path;
   487 
   488     val result =
   489       isabelle_document {verbose = false, purge = true} doc_format documentN "" doc_path;
   490     val result' = Isabelle_System.create_tmp_path documentN doc_format;
   491     val _ = File.copy result result';
   492   in result' end);
   493 
   494 end;
   495 
   496 structure Basic_Present: BASIC_PRESENT = Present;
   497 open Basic_Present;