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