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