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