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