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