src/Pure/Thy/present.ML
author wenzelm
Fri Feb 15 20:43:09 2002 +0100 (2002-02-15)
changeset 12895 d9dd528ecea6
parent 12849 b5824b740d05
child 12898 c78872ea3320
permissions -rw-r--r--
clarified copy_all;
generated second copy of document sources first (more robust);
wenzelm@6203
     1
(*  Title:      Pure/Thy/present.ML
wenzelm@6203
     2
    ID:         $Id$
wenzelm@9416
     3
    Author:     Markus Wenzel and Stefan Berghofer, TU Muenchen
wenzelm@8808
     4
    License:    GPL (GNU GENERAL PUBLIC LICENSE)
wenzelm@6203
     5
wenzelm@9416
     6
Theory presentation: HTML, graph files, (PDF)LaTeX documents.
wenzelm@6203
     7
*)
wenzelm@6203
     8
wenzelm@6203
     9
signature BASIC_PRESENT =
wenzelm@6203
    10
sig
wenzelm@11057
    11
  val no_document: ('a -> 'b) -> 'a -> 'b
wenzelm@7727
    12
  val section: string -> unit
wenzelm@6203
    13
end;
wenzelm@6203
    14
wenzelm@6203
    15
signature PRESENT =
wenzelm@6203
    16
sig
wenzelm@7727
    17
  include BASIC_PRESENT
wenzelm@9452
    18
  val write_graph: {name: string, ID: string, dir: string, unfold: bool,
wenzelm@9452
    19
   path: string, parents: string list} list -> Path.T -> unit
wenzelm@11911
    20
  val init: bool -> bool -> string -> bool -> string list -> string -> Path.T option
wenzelm@11580
    21
    -> Url.T option * bool -> bool -> unit
wenzelm@7727
    22
  val finish: unit -> unit
wenzelm@7727
    23
  val init_theory: string -> unit
wenzelm@8192
    24
  val verbatim_source: string -> (unit -> Symbol.symbol list) -> unit
wenzelm@8192
    25
  val old_symbol_source: string -> (unit -> Symbol.symbol list) -> unit
wenzelm@9136
    26
  val theory_output: string -> string -> unit
wenzelm@7727
    27
  val begin_theory: string -> string list -> (Path.T * bool) list -> theory -> theory
wenzelm@12151
    28
  val multi_result: string * (string * thm list) list -> unit
wenzelm@7727
    29
  val results: string -> string -> thm list -> unit
wenzelm@7727
    30
  val theorem: string -> thm -> unit
wenzelm@7727
    31
  val theorems: string -> thm list -> unit
wenzelm@8088
    32
  val chapter: string -> unit
wenzelm@7727
    33
  val subsection: string -> unit
wenzelm@7727
    34
  val subsubsection: string -> unit
wenzelm@7727
    35
  val setup: (theory -> theory) list
wenzelm@9416
    36
  val get_info: theory -> {name: string, session: string list, is_local: bool}
wenzelm@6203
    37
end;
wenzelm@6203
    38
wenzelm@7685
    39
structure Present: PRESENT =
wenzelm@7685
    40
struct
wenzelm@7685
    41
wenzelm@7727
    42
wenzelm@7727
    43
(** paths **)
wenzelm@7727
    44
wenzelm@7727
    45
val output_path = Path.variable "ISABELLE_BROWSER_INFO";
wenzelm@7727
    46
wenzelm@7727
    47
val tex_ext = Path.ext "tex";
wenzelm@7727
    48
val tex_path = tex_ext o Path.basic;
wenzelm@7727
    49
val html_ext = Path.ext "html";
wenzelm@7727
    50
val html_path = html_ext o Path.basic;
wenzelm@7727
    51
val index_path = Path.basic "index.html";
wenzelm@11856
    52
val readme_html_path = Path.basic "README.html";
wenzelm@11856
    53
val readme_path = Path.basic "README";
wenzelm@7727
    54
val doc_path = Path.basic "document";
wenzelm@8196
    55
val doc_indexN = "session";
wenzelm@11856
    56
val graph_path = Path.basic "session.graph";
wenzelm@11856
    57
val graph_pdf_path = Path.basic "session_graph.pdf";
wenzelm@11856
    58
val graph_eps_path = Path.basic "session_graph.eps";
wenzelm@7727
    59
wenzelm@7727
    60
val session_path = Path.basic ".session";
wenzelm@7727
    61
val session_entries_path = Path.unpack ".session/entries";
wenzelm@7727
    62
val pre_index_path = Path.unpack ".session/pre-index";
wenzelm@7727
    63
berghofe@9044
    64
fun mk_rel_path [] ys = Path.make ys
berghofe@9044
    65
  | mk_rel_path xs [] = Path.appends (replicate (length xs) Path.parent)
wenzelm@9416
    66
  | mk_rel_path (ps as x :: xs) (qs as y :: ys) = if x = y then mk_rel_path xs ys else
berghofe@9044
    67
      Path.appends (replicate (length ps) Path.parent @ [Path.make qs]);
wenzelm@7727
    68
wenzelm@11856
    69
fun show_path path = Path.pack (Path.append (File.pwd ()) path);
wenzelm@11856
    70
wenzelm@7727
    71
wenzelm@7727
    72
(** additional theory data **)
wenzelm@7727
    73
wenzelm@7727
    74
structure BrowserInfoArgs =
wenzelm@7727
    75
struct
wenzelm@7727
    76
  val name = "Pure/browser_info";
wenzelm@9416
    77
  type T = {name: string, session: string list, is_local: bool};
wenzelm@7727
    78
wenzelm@9416
    79
  val empty = {name = "Pure", session = [], is_local = false};
wenzelm@7727
    80
  val copy = I;
wenzelm@9452
    81
  fun prep_ext _ = {name = "", session = [], is_local = false};
wenzelm@7727
    82
  fun merge _ = empty;
wenzelm@7727
    83
  fun print _ _ = ();
wenzelm@7727
    84
end;
wenzelm@7727
    85
wenzelm@7727
    86
structure BrowserInfoData = TheoryDataFun(BrowserInfoArgs);
wenzelm@7727
    87
wenzelm@7727
    88
fun get_info thy =
wenzelm@7727
    89
  if Theory.eq_thy (thy, ProtoPure.thy) then BrowserInfoArgs.empty
wenzelm@7727
    90
  else BrowserInfoData.get thy;
wenzelm@7727
    91
wenzelm@7727
    92
wenzelm@7727
    93
wenzelm@7727
    94
(** graphs **)
wenzelm@7727
    95
wenzelm@7727
    96
type graph_node =
wenzelm@7727
    97
  {name: string, ID: string, dir: string, unfold: bool,
wenzelm@7727
    98
   path: string, parents: string list};
wenzelm@7727
    99
wenzelm@9416
   100
fun write_graph gr path =
wenzelm@9416
   101
  File.write path (cat_lines (map (fn {name, ID, dir, unfold, path, parents} =>
wenzelm@9416
   102
    "\"" ^ name ^ "\" \"" ^ ID ^ "\" \"" ^ dir ^ (if unfold then "\" + \"" else "\" \"") ^
wenzelm@9416
   103
    path ^ "\" > " ^ space_implode " " (map quote parents) ^ " ;") gr));
wenzelm@7727
   104
wenzelm@9416
   105
fun ID_of sess s = space_implode "/" (sess @ [s]);
wenzelm@7727
   106
wenzelm@9416
   107
(*retrieve graph data from initial theory loader database*)
wenzelm@9416
   108
fun init_graph remote_path curr_sess = map (fn name =>
wenzelm@7727
   109
  let
wenzelm@9416
   110
    val {name = sess_name, session, is_local} = get_info (ThyInfo.theory name);
wenzelm@9416
   111
    val path' = Path.append (Path.make session) (html_path name);
wenzelm@7727
   112
  in
wenzelm@9416
   113
   {name = name, ID = ID_of session name, dir = sess_name,
wenzelm@9416
   114
    path =
wenzelm@9416
   115
      if null session then "" else
wenzelm@9416
   116
      if is_some remote_path andalso not is_local then
wenzelm@9416
   117
        Url.pack (Url.append (the remote_path) (Url.file
wenzelm@9416
   118
          (Path.append (Path.make session) (html_path name))))
wenzelm@9416
   119
      else Path.pack (Path.append (mk_rel_path curr_sess session) (html_path name)),
wenzelm@9416
   120
    unfold = false,
wenzelm@9416
   121
    parents =
wenzelm@9416
   122
      map (fn s => ID_of (#session (get_info (ThyInfo.theory s))) s) (ThyInfo.get_preds name)}
wenzelm@7727
   123
  end) (ThyInfo.names ());
wenzelm@7727
   124
wenzelm@9416
   125
fun ins_graph_entry (entry as {ID, ...}) (gr: graph_node list) =
wenzelm@7727
   126
  filter_out (fn entry' => #ID entry' = ID) gr @ [entry];
wenzelm@7727
   127
wenzelm@7727
   128
wenzelm@7727
   129
wenzelm@7727
   130
(** global browser info state **)
wenzelm@7727
   131
wenzelm@7727
   132
(* type theory_info *)
wenzelm@7727
   133
wenzelm@7727
   134
type theory_info = {tex_source: Buffer.T, html_source: Buffer.T, html: Buffer.T};
wenzelm@7727
   135
wenzelm@7727
   136
fun make_theory_info (tex_source, html_source, html) =
wenzelm@7727
   137
  {tex_source = tex_source, html_source = html_source, html = html}: theory_info;
wenzelm@7727
   138
wenzelm@7727
   139
val empty_theory_info = make_theory_info (Buffer.empty, Buffer.empty, Buffer.empty);
wenzelm@7727
   140
wenzelm@7727
   141
fun map_theory_info f {tex_source, html_source, html} =
wenzelm@7727
   142
  make_theory_info (f (tex_source, html_source, html));
wenzelm@7727
   143
wenzelm@7727
   144
wenzelm@7727
   145
(* type browser_info *)
wenzelm@7727
   146
wenzelm@11856
   147
type browser_info = {theories: theory_info Symtab.table, files: (Path.T * string) list,
wenzelm@11856
   148
  tex_index: Buffer.T, html_index: Buffer.T, graph: graph_node list};
wenzelm@7727
   149
wenzelm@11856
   150
fun make_browser_info (theories, files, tex_index, html_index, graph) =
wenzelm@11856
   151
  {theories = theories, files = files, tex_index = tex_index, html_index = html_index,
wenzelm@9416
   152
    graph = graph}: browser_info;
wenzelm@7727
   153
wenzelm@11856
   154
val empty_browser_info = make_browser_info (Symtab.empty, [], Buffer.empty, Buffer.empty, []);
wenzelm@7727
   155
wenzelm@9416
   156
fun init_browser_info remote_path curr_sess = make_browser_info
wenzelm@11856
   157
  (Symtab.empty, [], Buffer.empty, Buffer.empty, init_graph remote_path curr_sess);
wenzelm@7727
   158
wenzelm@11856
   159
fun map_browser_info f {theories, files, tex_index, html_index, graph} =
wenzelm@11856
   160
  make_browser_info (f (theories, files, tex_index, html_index, graph));
wenzelm@7727
   161
wenzelm@7727
   162
wenzelm@7727
   163
(* state *)
wenzelm@7727
   164
wenzelm@7727
   165
val browser_info = ref empty_browser_info;
wenzelm@11057
   166
fun change_browser_info f = browser_info := map_browser_info f (! browser_info);
wenzelm@7727
   167
wenzelm@11057
   168
val suppress_tex_source = ref false;
wenzelm@11057
   169
fun no_document f x = Library.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@11856
   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@11856
   176
  change_browser_info (fn (info as (theories, files, tex_index, html_index, graph)) =>
wenzelm@7727
   177
    (case Symtab.lookup (theories, name) of
wenzelm@7727
   178
      None => (warning ("Browser info: cannot access theory document " ^ quote name); info)
wenzelm@11856
   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@11856
   189
    (theories, files, Buffer.add 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@11856
   193
    (theories, files, tex_index, Buffer.add txt html_index, graph));
wenzelm@7727
   194
wenzelm@7727
   195
fun add_graph_entry e =
wenzelm@11856
   196
  change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
wenzelm@11856
   197
    (theories, files, tex_index, html_index, ins_graph_entry e 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
fun add_html name txt = change_theory_info name (fn (tex_source, html_source, html) =>
wenzelm@7727
   208
  (tex_source, html_source, Buffer.add txt html));
wenzelm@7727
   209
wenzelm@7727
   210
wenzelm@7727
   211
wenzelm@7727
   212
(** global session state **)
wenzelm@7727
   213
wenzelm@7727
   214
(* session_info *)
wenzelm@7727
   215
wenzelm@7727
   216
type session_info =
wenzelm@7727
   217
  {name: string, parent: string, session: string, path: string list, html_prefix: Path.T,
wenzelm@11856
   218
    info: bool, doc_format: string, doc_graph: bool, doc_prefix1: Path.T option,
wenzelm@11856
   219
    doc_prefix2: Path.T option, remote_path: Url.T option, verbose: bool, readme: Path.T option};
wenzelm@7727
   220
wenzelm@9416
   221
fun make_session_info
wenzelm@11856
   222
  (name, parent, session, path, html_prefix, info, doc_format, doc_graph, doc_prefix1,
wenzelm@11856
   223
    doc_prefix2, remote_path, verbose, readme) =
wenzelm@7802
   224
  {name = name, parent = parent, session = session, path = path, html_prefix = html_prefix,
wenzelm@11856
   225
    info = info, doc_format = doc_format, doc_graph = doc_graph, doc_prefix1 = doc_prefix1,
wenzelm@11856
   226
    doc_prefix2 = doc_prefix2, remote_path = remote_path, verbose = verbose,
wenzelm@11856
   227
    readme = readme}: session_info;
wenzelm@7685
   228
wenzelm@7685
   229
wenzelm@7727
   230
(* state *)
wenzelm@7727
   231
wenzelm@7727
   232
val session_info = ref (None: session_info option);
wenzelm@7727
   233
wenzelm@7727
   234
fun with_session x f = (case ! session_info of None => x | Some info => f info);
wenzelm@7727
   235
fun with_context f = f (PureThy.get_name (Context.the_context ()));
wenzelm@7727
   236
wenzelm@7727
   237
wenzelm@7727
   238
wenzelm@7727
   239
(** HTML output **)
wenzelm@7727
   240
wenzelm@7727
   241
(* maintain index *)
wenzelm@7727
   242
wenzelm@7727
   243
val session_entries =
wenzelm@7727
   244
  HTML.session_entries o
wenzelm@7727
   245
    map (fn name => (Url.file (Path.append (Path.basic name) index_path), name));
wenzelm@7727
   246
wenzelm@7727
   247
fun get_entries dir =
wenzelm@7727
   248
  split_lines (File.read (Path.append dir session_entries_path));
wenzelm@7727
   249
wenzelm@7727
   250
fun put_entries entries dir =
wenzelm@7727
   251
  File.write (Path.append dir session_entries_path) (cat_lines entries);
wenzelm@7727
   252
wenzelm@7727
   253
wenzelm@7727
   254
fun create_index dir =
wenzelm@7727
   255
  File.read (Path.append dir pre_index_path) ^
wenzelm@7727
   256
    session_entries (get_entries dir) ^ HTML.end_index
wenzelm@7727
   257
  |> File.write (Path.append dir index_path);
wenzelm@7727
   258
wenzelm@7727
   259
fun update_index dir name =
wenzelm@7727
   260
  (case try get_entries dir of
wenzelm@7727
   261
    None => warning ("Browser info: cannot access session index of " ^ quote (Path.pack dir))
wenzelm@7727
   262
  | Some es => (put_entries ((es \ name) @ [name]) dir; create_index dir));
wenzelm@7727
   263
wenzelm@7727
   264
wenzelm@7727
   265
(* init session *)
wenzelm@7727
   266
wenzelm@12895
   267
fun copy_files path1 path2 =
wenzelm@12895
   268
 (File.mkdir path2;
wenzelm@12895
   269
  system ("cp " ^ File.sysify_path path1 ^ " " ^ File.sysify_path path2));  (*FIXME: quote!?*)
wenzelm@7727
   270
wenzelm@12895
   271
fun copy_all path1 path2 =
wenzelm@12895
   272
 (File.mkdir path2;
wenzelm@12895
   273
  system ("cp -r " ^ File.quote_sysify_path path1 ^ " " ^
wenzelm@12895
   274
    File.quote_sysify_path (Path.append path2 Path.parent)));
berghofe@9044
   275
wenzelm@9416
   276
wenzelm@12895
   277
fun name_of_session elems = space_implode "/" ("Isabelle" :: elems);
wenzelm@12895
   278
wenzelm@11911
   279
fun init build info doc doc_graph path name doc_prefix2 (remote_path, first_time) verbose =
wenzelm@11911
   280
  if not build andalso not info andalso doc = "" andalso is_none doc_prefix2 then
wenzelm@11856
   281
    (browser_info := empty_browser_info; session_info := None)
wenzelm@11856
   282
  else
wenzelm@11856
   283
    let
wenzelm@11856
   284
      val parent_name = name_of_session (Library.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@11856
   289
      val (doc_prefix1, document_path) =
wenzelm@11856
   290
        if doc = "" then (None, None)
wenzelm@11856
   291
        else if not (File.exists doc_path) then (conditional verbose (fn () =>
wenzelm@11856
   292
          std_error "Warning: missing document directory\n"); (None, None))
wenzelm@11856
   293
        else (Some (Path.append html_prefix doc_path), Some (Path.ext doc doc_path));
wenzelm@7727
   294
wenzelm@11856
   295
      val parent_index_path = Path.append Path.parent index_path;
wenzelm@11856
   296
      val index_up_lnk = if first_time then
wenzelm@11856
   297
          Url.append (the remote_path) (Url.file (Path.append sess_prefix parent_index_path))
wenzelm@11856
   298
        else Url.file parent_index_path;
wenzelm@11856
   299
      val readme =
wenzelm@11856
   300
        if File.exists readme_html_path then Some readme_html_path
wenzelm@11856
   301
        else if File.exists readme_path then Some readme_path
wenzelm@11856
   302
        else None;
wenzelm@7727
   303
wenzelm@11856
   304
      val index_text = HTML.begin_index (index_up_lnk, parent_name)
wenzelm@11856
   305
        (Url.file index_path, session_name) (apsome Url.file readme)
wenzelm@11856
   306
          (apsome Url.file document_path) (Url.unpack "medium.html");
wenzelm@11856
   307
    in
wenzelm@11856
   308
      session_info := Some (make_session_info (name, parent_name, session_name, path, html_prefix,
wenzelm@11856
   309
      info, doc, doc_graph, doc_prefix1, doc_prefix2, remote_path, verbose, readme));
wenzelm@11856
   310
      browser_info := init_browser_info remote_path path;
wenzelm@11856
   311
      add_html_index index_text
wenzelm@11856
   312
    end;
wenzelm@7727
   313
wenzelm@7727
   314
wenzelm@11856
   315
(* finish session -- output all generated text *)
wenzelm@11856
   316
wenzelm@11856
   317
fun write_tex src name path = Buffer.write (Path.append path (tex_path name)) src;
wenzelm@7685
   318
wenzelm@11856
   319
fun isatool_document doc_format path =
wenzelm@12632
   320
  let val s = "\"$ISATOOL\" document -c -o '" ^ doc_format ^ "' " ^
wenzelm@12632
   321
    File.quote_sysify_path path ^ " 2>&1"
wenzelm@12632
   322
  in
wenzelm@11856
   323
    writeln s;
wenzelm@11856
   324
    if system s <> 0 orelse not (File.exists (Path.ext doc_format path)) then
wenzelm@8646
   325
      error "Failed to build document"
wenzelm@8646
   326
    else ()
wenzelm@8646
   327
  end;
wenzelm@7802
   328
wenzelm@11856
   329
fun isatool_browser graph =
wenzelm@11856
   330
  let
wenzelm@11856
   331
    val pdfpath = File.tmp_path graph_pdf_path;
wenzelm@11856
   332
    val epspath = File.tmp_path graph_eps_path;
wenzelm@11856
   333
    val gpath = File.tmp_path graph_path;
wenzelm@11856
   334
    val s = "\"$ISATOOL\" browser -o " ^ File.quote_sysify_path pdfpath ^ " " ^
wenzelm@11856
   335
      File.quote_sysify_path gpath;
wenzelm@11856
   336
  in
wenzelm@11856
   337
    write_graph graph gpath;
wenzelm@11856
   338
    if system s <> 0 orelse not (File.exists epspath) orelse not (File.exists pdfpath) then
wenzelm@11856
   339
      error "Failed to prepare dependency graph"
wenzelm@11856
   340
    else
wenzelm@11856
   341
      let val pdf = File.read pdfpath and eps = File.read epspath
wenzelm@11856
   342
      in File.rm pdfpath; File.rm epspath; File.rm gpath; (pdf, eps) end
wenzelm@11856
   343
  end;
wenzelm@8196
   344
wenzelm@11856
   345
fun finish () = with_session () (fn {name, info, html_prefix, doc_format, doc_graph,
wenzelm@11856
   346
    doc_prefix1, doc_prefix2, path, verbose, readme, ...} =>
wenzelm@7727
   347
  let
wenzelm@11856
   348
    val {theories, files, tex_index, html_index, graph} = ! browser_info;
wenzelm@11856
   349
    val thys = Symtab.dest theories;
wenzelm@9416
   350
    val parent_html_prefix = Path.append html_prefix Path.parent;
wenzelm@7727
   351
wenzelm@11856
   352
    fun finish_tex path (a, {tex_source, ...}: theory_info) = write_tex tex_source a path;
wenzelm@11856
   353
    fun finish_html (a, {html, ...}: theory_info) =
wenzelm@11856
   354
      Buffer.write (Path.append html_prefix (html_path a)) (Buffer.add HTML.end_theory html);
wenzelm@11856
   355
wenzelm@11856
   356
    val opt_graphs =
wenzelm@11856
   357
      if doc_graph andalso (is_some doc_prefix1 orelse is_some doc_prefix2) then
wenzelm@11856
   358
        Some (isatool_browser graph)
wenzelm@11856
   359
      else None;
wenzelm@11856
   360
wenzelm@12895
   361
    fun prepare_sources path =
wenzelm@12895
   362
     (copy_all doc_path path;
wenzelm@12895
   363
      copy_files (Path.unpack "~~/lib/texinputs/*.sty") path;
wenzelm@12849
   364
      (case opt_graphs of None => () | Some (pdf, eps) =>
wenzelm@11856
   365
        (File.write (Path.append path graph_pdf_path) pdf;
wenzelm@11856
   366
          File.write (Path.append path graph_eps_path) eps));
wenzelm@11856
   367
      write_tex (Buffer.add Latex.tex_trailer tex_index) doc_indexN path;
wenzelm@11856
   368
      seq (finish_tex path) thys);
wenzelm@7727
   369
  in
wenzelm@11856
   370
    conditional info (fn () =>
wenzelm@11856
   371
     (File.mkdir (Path.append html_prefix session_path);
wenzelm@11856
   372
      Buffer.write (Path.append html_prefix pre_index_path) html_index;
wenzelm@11856
   373
      File.write (Path.append html_prefix session_entries_path) "";
wenzelm@11856
   374
      create_index html_prefix;
wenzelm@11856
   375
      if length path > 1 then update_index parent_html_prefix name else ();
wenzelm@11856
   376
      (case readme of None => () | Some path => File.copy path (Path.append html_prefix path));
wenzelm@11856
   377
      write_graph graph (Path.append html_prefix graph_path);
wenzelm@11856
   378
      copy_files (Path.unpack "~~/lib/browser/awtUtilities/*.class")
wenzelm@11856
   379
        (Path.append html_prefix (Path.basic "awtUtilities"));
wenzelm@11856
   380
      copy_files (Path.unpack "~~/lib/browser/GraphBrowser/*.class")
wenzelm@11856
   381
        (Path.append html_prefix (Path.basic "GraphBrowser"));
wenzelm@11856
   382
      seq (fn (a, txt) => File.write (Path.append html_prefix (Path.basic a)) txt)
wenzelm@11856
   383
        (HTML.applet_pages name (Url.file index_path, name));
wenzelm@11856
   384
      seq finish_html thys;
wenzelm@11856
   385
      seq (uncurry File.write) files;
wenzelm@11856
   386
      conditional verbose (fn () =>
wenzelm@11856
   387
        std_error ("Browser info at " ^ show_path html_prefix ^ "\n"))));
wenzelm@11856
   388
wenzelm@12895
   389
    (case doc_prefix2 of None => () | Some path =>
wenzelm@12895
   390
     (prepare_sources path;
wenzelm@12895
   391
      conditional verbose (fn () => std_error ("Document sources at " ^ show_path path ^ "\n"))));
wenzelm@12895
   392
wenzelm@11856
   393
    (case doc_prefix1 of None => () | Some path =>
wenzelm@12895
   394
     (prepare_sources path;
wenzelm@11856
   395
      isatool_document doc_format path;
wenzelm@11856
   396
      conditional verbose (fn () =>
wenzelm@11856
   397
        std_error ("Document at " ^ show_path (Path.ext doc_format path) ^ "\n"))));
wenzelm@11856
   398
wenzelm@7727
   399
    browser_info := empty_browser_info;
wenzelm@7727
   400
    session_info := None
wenzelm@7727
   401
  end);
wenzelm@7727
   402
wenzelm@7727
   403
wenzelm@7727
   404
(* theory elements *)
wenzelm@7727
   405
wenzelm@7727
   406
fun init_theory name = with_session () (fn _ => init_theory_info name empty_theory_info);
wenzelm@7727
   407
wenzelm@7727
   408
fun verbatim_source name mk_text =
wenzelm@7727
   409
  with_session () (fn _ => add_html_source name (HTML.verbatim_source (mk_text ())));
wenzelm@7727
   410
wenzelm@8192
   411
fun old_symbol_source name mk_text =
wenzelm@8499
   412
  with_session () (fn _ => add_tex_source name (Latex.old_symbol_source name (mk_text ())));
wenzelm@8192
   413
wenzelm@9136
   414
fun theory_output name s =
wenzelm@9917
   415
  with_session () (fn _ => add_tex_source name (Latex.isabelle_file name s));
wenzelm@7727
   416
wenzelm@7727
   417
wenzelm@7727
   418
fun parent_link remote_path curr_session name =
wenzelm@9416
   419
  let val {name = _, session, is_local} = get_info (ThyInfo.theory name)
wenzelm@7727
   420
  in (if null session then None else
wenzelm@7727
   421
     Some (if is_some remote_path andalso not is_local then
berghofe@9044
   422
       Url.append (the remote_path) (Url.file
berghofe@9044
   423
         (Path.append (Path.make session) (html_path name)))
berghofe@9044
   424
     else Url.file (Path.append (mk_rel_path curr_session session)
berghofe@9044
   425
       (html_path name))), name)
wenzelm@7727
   426
  end;
wenzelm@7727
   427
wenzelm@7727
   428
fun begin_theory name raw_parents orig_files thy =
wenzelm@9416
   429
    with_session thy (fn {name = sess_name, session, path, html_prefix, remote_path, ...} =>
wenzelm@7727
   430
  let
wenzelm@7727
   431
    val parents = map (parent_link remote_path path) raw_parents;
wenzelm@7727
   432
    val ml_path = ThyLoad.ml_path name;
wenzelm@7727
   433
    val files = map (apsnd Some) orig_files @
wenzelm@7727
   434
      (if is_some (ThyLoad.check_file ml_path) then [(ml_path, None)] else []);
wenzelm@7727
   435
wenzelm@7727
   436
    fun prep_file (raw_path, loadit) =
wenzelm@7727
   437
      (case ThyLoad.check_file raw_path of
wenzelm@7727
   438
        Some (path, _) =>
wenzelm@7727
   439
          let
wenzelm@7727
   440
            val base = Path.base path;
wenzelm@7727
   441
            val base_html = html_ext base;
wenzelm@7727
   442
          in
wenzelm@11856
   443
            add_file (Path.append html_prefix base_html,
wenzelm@11856
   444
              HTML.ml_file (Url.file base) (File.read path));
wenzelm@7727
   445
            (Some (Url.file base_html), Url.file raw_path, loadit)
wenzelm@7727
   446
          end
wenzelm@7727
   447
      | None => (warning ("Browser info: expected to find ML file" ^ quote (Path.pack raw_path));
wenzelm@7727
   448
          (None, Url.file raw_path, loadit)));
wenzelm@7727
   449
wenzelm@7727
   450
    val files_html = map prep_file files;
wenzelm@7727
   451
wenzelm@7727
   452
    fun prep_html_source (tex_source, html_source, html) =
wenzelm@7727
   453
      let
wenzelm@7727
   454
        val txt = HTML.begin_theory (Url.file index_path, session)
wenzelm@7727
   455
          name parents files_html (Buffer.content html_source)
wenzelm@7727
   456
      in (tex_source, Buffer.empty, Buffer.add txt html) end;
wenzelm@7727
   457
wenzelm@9416
   458
    val entry =
wenzelm@9416
   459
     {name = name, ID = ID_of path name, dir = sess_name, unfold = true,
wenzelm@9416
   460
      path = Path.pack (html_path name),
wenzelm@9416
   461
      parents = map (fn s => ID_of (#session (get_info (ThyInfo.theory s))) s) raw_parents};
wenzelm@7727
   462
wenzelm@7727
   463
  in
wenzelm@7727
   464
    change_theory_info name prep_html_source;
wenzelm@9416
   465
    add_graph_entry entry;
wenzelm@7727
   466
    add_html_index (HTML.theory_entry (Url.file (html_path name), name));
wenzelm@7727
   467
    add_tex_index (Latex.theory_entry name);
wenzelm@9416
   468
    BrowserInfoData.put {name = sess_name, session = path, is_local = is_some remote_path} thy
wenzelm@7727
   469
  end);
wenzelm@7727
   470
wenzelm@7727
   471
wenzelm@12151
   472
fun multi_result res = with_session () (fn _ => with_context add_html (HTML.multi_result res));
wenzelm@7727
   473
fun results k a thms = with_session () (fn _ => with_context add_html (HTML.results k a thms));
wenzelm@7727
   474
fun theorem a thm = with_session () (fn _ => with_context add_html (HTML.theorem a thm));
wenzelm@7727
   475
fun theorems a thms = with_session () (fn _ => with_context add_html (HTML.theorems a thms));
wenzelm@8088
   476
fun chapter s = with_session () (fn _ => with_context add_html (HTML.chapter s));
wenzelm@7727
   477
fun section s = with_session () (fn _ => with_context add_html (HTML.section s));
wenzelm@7727
   478
fun subsection s = with_session () (fn _ => with_context add_html (HTML.subsection s));
wenzelm@7727
   479
fun subsubsection s = with_session () (fn _ => with_context add_html (HTML.subsubsection s));
wenzelm@7727
   480
wenzelm@7727
   481
wenzelm@7727
   482
wenzelm@7727
   483
(** theory setup **)
wenzelm@7727
   484
wenzelm@7727
   485
val setup = [BrowserInfoData.init];
wenzelm@7685
   486
wenzelm@7685
   487
wenzelm@7685
   488
end;
wenzelm@7685
   489
wenzelm@6203
   490
wenzelm@6203
   491
structure BasicPresent: BASIC_PRESENT = Present;
wenzelm@6203
   492
open BasicPresent;