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