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