src/Pure/Thy/present.ML
author wenzelm
Tue Jul 08 16:19:24 2008 +0200 (2008-07-08)
changeset 27491 c8178a6a6480
parent 27329 91c0c894e1b4
child 27862 8f727f7c8c1d
permissions -rw-r--r--
begin_theory: files_html needs to be produced outside of prep_html_source to make ML files appear!
replaced warning by error for non-existant theory/ML info;
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@6203
     4
wenzelm@9416
     5
Theory presentation: HTML, graph files, (PDF)LaTeX documents.
wenzelm@6203
     6
*)
wenzelm@6203
     7
wenzelm@6203
     8
signature BASIC_PRESENT =
wenzelm@6203
     9
sig
wenzelm@11057
    10
  val no_document: ('a -> 'b) -> 'a -> 'b
wenzelm@7727
    11
  val section: string -> unit
wenzelm@6203
    12
end;
wenzelm@6203
    13
wenzelm@6203
    14
signature PRESENT =
wenzelm@6203
    15
sig
wenzelm@7727
    16
  include BASIC_PRESENT
wenzelm@24561
    17
  val session_name: theory -> string
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@20577
    20
  val display_graph: {name: string, ID: string, dir: string, unfold: bool,
wenzelm@20577
    21
   path: string, parents: string list} list -> unit
wenzelm@17082
    22
  val init: bool -> bool -> string -> bool -> string list -> string list ->
wenzelm@23899
    23
    string -> (bool * Path.T) option -> Url.T option * bool -> bool -> theory list -> unit
wenzelm@7727
    24
  val finish: unit -> unit
wenzelm@7727
    25
  val init_theory: string -> unit
wenzelm@8192
    26
  val verbatim_source: string -> (unit -> Symbol.symbol list) -> unit
wenzelm@9136
    27
  val theory_output: string -> string -> unit
wenzelm@24150
    28
  val begin_theory: int -> Path.T -> (Path.T * bool) list -> theory -> theory
wenzelm@13532
    29
  val add_hook: (string -> (string * thm list) list -> unit) -> unit
wenzelm@13532
    30
  val results: string -> (string * thm list) list -> unit
wenzelm@7727
    31
  val theorem: string -> thm -> unit
wenzelm@7727
    32
  val theorems: string -> thm list -> unit
wenzelm@8088
    33
  val chapter: string -> unit
wenzelm@7727
    34
  val subsection: string -> unit
wenzelm@7727
    35
  val subsubsection: string -> unit
wenzelm@14922
    36
  val drafts: string -> Path.T list -> Path.T
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@17082
    54
val documentN = "document";
wenzelm@17082
    55
val document_path = Path.basic documentN;
wenzelm@8196
    56
val doc_indexN = "session";
wenzelm@11856
    57
val graph_path = Path.basic "session.graph";
wenzelm@11856
    58
val graph_pdf_path = Path.basic "session_graph.pdf";
wenzelm@11856
    59
val graph_eps_path = Path.basic "session_graph.eps";
wenzelm@7727
    60
wenzelm@7727
    61
val session_path = Path.basic ".session";
wenzelm@21858
    62
val session_entries_path = Path.explode ".session/entries";
wenzelm@21858
    63
val pre_index_path = Path.explode ".session/pre-index";
wenzelm@7727
    64
berghofe@9044
    65
fun mk_rel_path [] ys = Path.make ys
berghofe@9044
    66
  | mk_rel_path xs [] = Path.appends (replicate (length xs) Path.parent)
wenzelm@9416
    67
  | mk_rel_path (ps as x :: xs) (qs as y :: ys) = if x = y then mk_rel_path xs ys else
berghofe@9044
    68
      Path.appends (replicate (length ps) Path.parent @ [Path.make qs]);
wenzelm@7727
    69
wenzelm@21858
    70
fun show_path path = Path.implode (Path.append (File.pwd ()) path);
wenzelm@11856
    71
wenzelm@7727
    72
wenzelm@14922
    73
wenzelm@7727
    74
(** additional theory data **)
wenzelm@7727
    75
wenzelm@16426
    76
structure BrowserInfoData = TheoryDataFun
wenzelm@22846
    77
(
wenzelm@9416
    78
  type T = {name: string, session: string list, is_local: bool};
wenzelm@27329
    79
  val empty = {name = "", session = [], is_local = false}: T;
wenzelm@7727
    80
  val copy = I;
wenzelm@16503
    81
  fun extend _ = empty;
wenzelm@16426
    82
  fun merge _ _ = empty;
wenzelm@22846
    83
);
wenzelm@7727
    84
wenzelm@27327
    85
val put_info = BrowserInfoData.put;
wenzelm@26957
    86
val get_info = BrowserInfoData.get;
wenzelm@24561
    87
val session_name = #name o get_info;
wenzelm@24561
    88
wenzelm@7727
    89
wenzelm@7727
    90
wenzelm@7727
    91
(** graphs **)
wenzelm@7727
    92
wenzelm@7727
    93
type graph_node =
wenzelm@7727
    94
  {name: string, ID: string, dir: string, unfold: bool,
wenzelm@7727
    95
   path: string, parents: string list};
wenzelm@7727
    96
wenzelm@9416
    97
fun write_graph gr path =
wenzelm@9416
    98
  File.write path (cat_lines (map (fn {name, ID, dir, unfold, path, parents} =>
wenzelm@9416
    99
    "\"" ^ name ^ "\" \"" ^ ID ^ "\" \"" ^ dir ^ (if unfold then "\" + \"" else "\" \"") ^
berghofe@14598
   100
    path ^ "\" > " ^ space_implode " " (map Library.quote parents) ^ " ;") gr));
wenzelm@7727
   101
wenzelm@20577
   102
fun display_graph gr =
wenzelm@20577
   103
  let
wenzelm@24561
   104
    val _ = writeln "Displaying graph ...";
wenzelm@21858
   105
    val path = File.tmp_path (Path.explode "tmp.graph");
wenzelm@20577
   106
    val _ = write_graph gr path;
wenzelm@20577
   107
    val _ = File.isatool ("browser -c " ^ File.shell_path path ^ " &");
wenzelm@20577
   108
  in () end;
wenzelm@20577
   109
wenzelm@20577
   110
wenzelm@9416
   111
fun ID_of sess s = space_implode "/" (sess @ [s]);
wenzelm@23899
   112
fun ID_of_thy thy = ID_of (#session (get_info thy)) (Context.theory_name thy);
wenzelm@7727
   113
wenzelm@23899
   114
wenzelm@23899
   115
(*retrieve graph data from initial collection of theories*)
wenzelm@24150
   116
fun init_graph remote_path curr_sess = rev o map (fn thy =>
wenzelm@7727
   117
  let
wenzelm@23899
   118
    val name = Context.theory_name thy;
wenzelm@23899
   119
    val {name = sess_name, session, is_local} = get_info thy;
wenzelm@9416
   120
    val path' = Path.append (Path.make session) (html_path name);
wenzelm@24150
   121
    val entry =
wenzelm@24150
   122
     {name = name, ID = ID_of session name, dir = sess_name,
wenzelm@24150
   123
      path =
wenzelm@24150
   124
        if null session then "" else
wenzelm@24150
   125
        if is_some remote_path andalso not is_local then
wenzelm@24150
   126
          Url.implode (Url.append (the remote_path) (Url.File
wenzelm@24150
   127
            (Path.append (Path.make session) (html_path name))))
wenzelm@24150
   128
        else Path.implode (Path.append (mk_rel_path curr_sess session) (html_path name)),
wenzelm@24150
   129
      unfold = false,
wenzelm@24150
   130
      parents = map ID_of_thy (Theory.parents_of thy)};
wenzelm@24150
   131
  in (0, entry) end);
wenzelm@7727
   132
wenzelm@24150
   133
fun ins_graph_entry (i, entry as {ID, ...}) (gr: (int * graph_node) list) =
wenzelm@24150
   134
  (i, entry) :: filter_out (fn (_, entry') => #ID entry' = ID) gr;
wenzelm@7727
   135
wenzelm@7727
   136
wenzelm@7727
   137
wenzelm@7727
   138
(** global browser info state **)
wenzelm@7727
   139
wenzelm@7727
   140
(* type theory_info *)
wenzelm@7727
   141
wenzelm@7727
   142
type theory_info = {tex_source: Buffer.T, html_source: Buffer.T, html: Buffer.T};
wenzelm@7727
   143
wenzelm@7727
   144
fun make_theory_info (tex_source, html_source, html) =
wenzelm@7727
   145
  {tex_source = tex_source, html_source = html_source, html = html}: theory_info;
wenzelm@7727
   146
wenzelm@7727
   147
val empty_theory_info = make_theory_info (Buffer.empty, Buffer.empty, Buffer.empty);
wenzelm@7727
   148
wenzelm@7727
   149
fun map_theory_info f {tex_source, html_source, html} =
wenzelm@7727
   150
  make_theory_info (f (tex_source, html_source, html));
wenzelm@7727
   151
wenzelm@7727
   152
wenzelm@7727
   153
(* type browser_info *)
wenzelm@7727
   154
wenzelm@11856
   155
type browser_info = {theories: theory_info Symtab.table, files: (Path.T * string) list,
wenzelm@24150
   156
  tex_index: (int * string) list, html_index: (int * string) list, graph: (int * graph_node) list};
wenzelm@7727
   157
wenzelm@11856
   158
fun make_browser_info (theories, files, tex_index, html_index, graph) =
wenzelm@11856
   159
  {theories = theories, files = files, tex_index = tex_index, html_index = html_index,
wenzelm@9416
   160
    graph = graph}: browser_info;
wenzelm@7727
   161
wenzelm@24150
   162
val empty_browser_info = make_browser_info (Symtab.empty, [], [], [], []);
wenzelm@7727
   163
wenzelm@23899
   164
fun init_browser_info remote_path curr_sess thys = make_browser_info
wenzelm@24150
   165
  (Symtab.empty, [], [], [], init_graph remote_path curr_sess thys);
wenzelm@7727
   166
wenzelm@11856
   167
fun map_browser_info f {theories, files, tex_index, html_index, graph} =
wenzelm@11856
   168
  make_browser_info (f (theories, files, tex_index, html_index, graph));
wenzelm@7727
   169
wenzelm@7727
   170
wenzelm@7727
   171
(* state *)
wenzelm@7727
   172
wenzelm@7727
   173
val browser_info = ref empty_browser_info;
wenzelm@23944
   174
fun change_browser_info f = CRITICAL (fn () => change browser_info (map_browser_info f));
wenzelm@7727
   175
wenzelm@11057
   176
val suppress_tex_source = ref false;
wenzelm@24102
   177
fun no_document f x = setmp_noncritical suppress_tex_source true f x;
wenzelm@7727
   178
wenzelm@7727
   179
fun init_theory_info name info =
wenzelm@11856
   180
  change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
wenzelm@17412
   181
    (Symtab.update (name, info) theories, files, tex_index, html_index, graph));
wenzelm@7727
   182
wenzelm@7727
   183
fun change_theory_info name f =
wenzelm@11856
   184
  change_browser_info (fn (info as (theories, files, tex_index, html_index, graph)) =>
wenzelm@17412
   185
    (case Symtab.lookup theories name of
wenzelm@27491
   186
      NONE => error ("Browser info: cannot access theory document " ^ quote name)
wenzelm@17412
   187
    | SOME info => (Symtab.update (name, map_theory_info f info) theories, files,
wenzelm@9416
   188
        tex_index, html_index, graph)));
wenzelm@7727
   189
wenzelm@7727
   190
wenzelm@11856
   191
fun add_file file =
wenzelm@11856
   192
  change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
wenzelm@11856
   193
    (theories, file :: files, tex_index, html_index, graph));
wenzelm@11856
   194
wenzelm@7727
   195
fun add_tex_index txt =
wenzelm@11856
   196
  change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
wenzelm@24150
   197
    (theories, files, txt :: tex_index, html_index, graph));
wenzelm@7727
   198
wenzelm@7727
   199
fun add_html_index txt =
wenzelm@11856
   200
  change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
wenzelm@24150
   201
    (theories, files, tex_index, txt :: html_index, graph));
wenzelm@7727
   202
wenzelm@24150
   203
fun add_graph_entry entry =
wenzelm@11856
   204
  change_browser_info (fn (theories, files, tex_index, html_index, graph) =>
wenzelm@24150
   205
    (theories, files, tex_index, html_index, ins_graph_entry entry graph));
wenzelm@7727
   206
wenzelm@11057
   207
fun add_tex_source name txt =
wenzelm@11057
   208
  if ! suppress_tex_source then ()
wenzelm@11057
   209
  else change_theory_info name (fn (tex_source, html_source, html) =>
wenzelm@11057
   210
    (Buffer.add txt tex_source, html_source, html));
wenzelm@7727
   211
wenzelm@7727
   212
fun add_html_source name txt = change_theory_info name (fn (tex_source, html_source, html) =>
wenzelm@7727
   213
  (tex_source, Buffer.add txt html_source, html));
wenzelm@7727
   214
wenzelm@7727
   215
fun add_html name txt = change_theory_info name (fn (tex_source, html_source, html) =>
wenzelm@7727
   216
  (tex_source, html_source, Buffer.add txt html));
wenzelm@7727
   217
wenzelm@7727
   218
wenzelm@7727
   219
wenzelm@7727
   220
(** global session state **)
wenzelm@7727
   221
wenzelm@7727
   222
(* session_info *)
wenzelm@7727
   223
wenzelm@7727
   224
type session_info =
wenzelm@7727
   225
  {name: string, parent: string, session: string, path: string list, html_prefix: Path.T,
wenzelm@17082
   226
    info: bool, doc_format: string, doc_graph: bool, documents: (string * string) list,
wenzelm@17210
   227
    doc_prefix1: (Path.T * Path.T) option, doc_prefix2: (bool * Path.T) option,
wenzelm@17210
   228
    remote_path: Url.T option, verbose: bool, readme: Path.T option};
wenzelm@7727
   229
wenzelm@9416
   230
fun make_session_info
wenzelm@17082
   231
  (name, parent, session, path, html_prefix, info, doc_format, doc_graph, documents,
wenzelm@17082
   232
    doc_prefix1, doc_prefix2, remote_path, verbose, readme) =
wenzelm@7802
   233
  {name = name, parent = parent, session = session, path = path, html_prefix = html_prefix,
wenzelm@17082
   234
    info = info, doc_format = doc_format, doc_graph = doc_graph, documents = documents,
wenzelm@17082
   235
    doc_prefix1 = doc_prefix1, doc_prefix2 = doc_prefix2, remote_path = remote_path,
wenzelm@17082
   236
    verbose = verbose, readme = readme}: session_info;
wenzelm@7685
   237
wenzelm@7685
   238
wenzelm@7727
   239
(* state *)
wenzelm@7727
   240
skalberg@15531
   241
val session_info = ref (NONE: session_info option);
wenzelm@7727
   242
skalberg@15531
   243
fun with_session x f = (case ! session_info of NONE => x | SOME info => f info);
wenzelm@26433
   244
fun with_context f = f (Context.theory_name (ML_Context.the_global_context ()));
wenzelm@7727
   245
wenzelm@7727
   246
wenzelm@7727
   247
wenzelm@14922
   248
(** document preparation **)
wenzelm@7727
   249
wenzelm@7727
   250
(* maintain index *)
wenzelm@7727
   251
wenzelm@7727
   252
val session_entries =
wenzelm@7727
   253
  HTML.session_entries o
wenzelm@14898
   254
    map (fn name => (Url.File (Path.append (Path.basic name) index_path), name));
wenzelm@7727
   255
wenzelm@7727
   256
fun get_entries dir =
wenzelm@7727
   257
  split_lines (File.read (Path.append dir session_entries_path));
wenzelm@7727
   258
wenzelm@7727
   259
fun put_entries entries dir =
wenzelm@7727
   260
  File.write (Path.append dir session_entries_path) (cat_lines entries);
wenzelm@7727
   261
wenzelm@7727
   262
wenzelm@7727
   263
fun create_index dir =
wenzelm@7727
   264
  File.read (Path.append dir pre_index_path) ^
wenzelm@7727
   265
    session_entries (get_entries dir) ^ HTML.end_index
wenzelm@7727
   266
  |> File.write (Path.append dir index_path);
wenzelm@7727
   267
wenzelm@24150
   268
fun update_index dir name = CRITICAL (fn () =>
wenzelm@7727
   269
  (case try get_entries dir of
wenzelm@21858
   270
    NONE => warning ("Browser info: cannot access session index of " ^ quote (Path.implode dir))
wenzelm@24150
   271
  | SOME es => (put_entries ((remove (op =) name es) @ [name]) dir; create_index dir)));
wenzelm@7727
   272
wenzelm@7727
   273
wenzelm@17082
   274
(* document versions *)
wenzelm@17082
   275
wenzelm@17082
   276
fun read_version str =
wenzelm@17082
   277
  (case space_explode "=" str of
wenzelm@17082
   278
    [name] => (name, "")
wenzelm@17082
   279
  | [name, tags] => (name, tags)
wenzelm@17082
   280
  | _ => error ("Malformed document version specification: " ^ quote str));
wenzelm@17082
   281
wenzelm@17082
   282
fun read_versions strs =
wenzelm@19046
   283
  rev (distinct (eq_fst (op =)) (rev ((documentN, "") :: map read_version strs)))
wenzelm@17082
   284
  |> filter_out (equal "-" o #2);
wenzelm@17082
   285
wenzelm@17082
   286
wenzelm@7727
   287
(* init session *)
wenzelm@7727
   288
wenzelm@12895
   289
fun name_of_session elems = space_implode "/" ("Isabelle" :: elems);
wenzelm@12895
   290
wenzelm@17082
   291
fun init build info doc doc_graph doc_versions path name doc_prefix2
wenzelm@23944
   292
    (remote_path, first_time) verbose thys = CRITICAL (fn () =>
wenzelm@11911
   293
  if not build andalso not info andalso doc = "" andalso is_none doc_prefix2 then
skalberg@15531
   294
    (browser_info := empty_browser_info; session_info := NONE)
wenzelm@11856
   295
  else
wenzelm@11856
   296
    let
wenzelm@11856
   297
      val parent_name = name_of_session (Library.take (length path - 1, path));
wenzelm@11856
   298
      val session_name = name_of_session path;
wenzelm@11856
   299
      val sess_prefix = Path.make path;
wenzelm@11856
   300
      val html_prefix = Path.append (Path.expand output_path) sess_prefix;
wenzelm@7727
   301
wenzelm@17082
   302
      val (doc_prefix1, documents) =
wenzelm@17082
   303
        if doc = "" then (NONE, [])
wenzelm@21962
   304
        else if not (File.exists document_path) then
wenzelm@22580
   305
          (if verbose then Output.std_error "Warning: missing document directory\n" else ();
wenzelm@22580
   306
            (NONE, []))
wenzelm@17082
   307
        else (SOME (Path.append html_prefix document_path, html_prefix),
wenzelm@17082
   308
          read_versions doc_versions);
wenzelm@7727
   309
wenzelm@11856
   310
      val parent_index_path = Path.append Path.parent index_path;
wenzelm@11856
   311
      val index_up_lnk = if first_time then
wenzelm@16263
   312
          Url.append (the remote_path) (Url.File (Path.append sess_prefix parent_index_path))
wenzelm@14898
   313
        else Url.File parent_index_path;
wenzelm@11856
   314
      val readme =
skalberg@15531
   315
        if File.exists readme_html_path then SOME readme_html_path
skalberg@15531
   316
        else if File.exists readme_path then SOME readme_path
skalberg@15531
   317
        else NONE;
wenzelm@7727
   318
wenzelm@17082
   319
      val docs =
wenzelm@17082
   320
        (case readme of NONE => [] | SOME p => [(Url.File p, "README")]) @
wenzelm@17082
   321
        map (fn (name, _) => (Url.File (Path.ext doc (Path.basic name)), name)) documents;
wenzelm@11856
   322
      val index_text = HTML.begin_index (index_up_lnk, parent_name)
wenzelm@21858
   323
        (Url.File index_path, session_name) docs (Url.explode "medium.html");
wenzelm@11856
   324
    in
skalberg@15531
   325
      session_info := SOME (make_session_info (name, parent_name, session_name, path, html_prefix,
wenzelm@17082
   326
      info, doc, doc_graph, documents, doc_prefix1, doc_prefix2, remote_path, verbose, readme));
wenzelm@23899
   327
      browser_info := init_browser_info remote_path path thys;
wenzelm@24150
   328
      add_html_index (0, index_text)
wenzelm@23944
   329
    end);
wenzelm@7727
   330
wenzelm@7727
   331
wenzelm@17082
   332
(* isatool wrappers *)
wenzelm@17082
   333
wenzelm@17082
   334
fun isatool_document verbose format name tags path result_path =
wenzelm@17082
   335
  let
wenzelm@17082
   336
    val s = "\"$ISATOOL\" document -c -o '" ^ format ^ "' \
wenzelm@17082
   337
      \-n '" ^ name ^ "' -t '" ^ tags ^ "' " ^ File.shell_path path ^
wenzelm@17082
   338
      " 2>&1" ^ (if verbose then "" else " >/dev/null");
wenzelm@17082
   339
    val doc_path = Path.append result_path (Path.ext format (Path.basic name));
wenzelm@17082
   340
  in
wenzelm@21962
   341
    if verbose then writeln s else ();
wenzelm@17082
   342
    system s;
wenzelm@21962
   343
    File.exists doc_path orelse
wenzelm@21962
   344
      error ("No document: " ^ quote (show_path doc_path));
wenzelm@17082
   345
    doc_path
wenzelm@17082
   346
  end;
wenzelm@17082
   347
wenzelm@17082
   348
fun isatool_browser graph =
wenzelm@17082
   349
  let
wenzelm@17082
   350
    val pdf_path = File.tmp_path graph_pdf_path;
wenzelm@17082
   351
    val eps_path = File.tmp_path graph_eps_path;
wenzelm@17082
   352
    val gr_path = File.tmp_path graph_path;
wenzelm@17082
   353
    val s = "browser -o " ^ File.shell_path pdf_path ^ " " ^ File.shell_path gr_path;
wenzelm@17082
   354
  in
wenzelm@17082
   355
    write_graph graph gr_path;
wenzelm@17082
   356
    if File.isatool s <> 0 orelse not (File.exists eps_path) orelse not (File.exists pdf_path)
wenzelm@17082
   357
    then error "Failed to prepare dependency graph"
wenzelm@17082
   358
    else
wenzelm@17082
   359
      let val pdf = File.read pdf_path and eps = File.read eps_path
wenzelm@17082
   360
      in File.rm pdf_path; File.rm eps_path; File.rm gr_path; (pdf, eps) end
wenzelm@17082
   361
  end;
wenzelm@17082
   362
wenzelm@17082
   363
wenzelm@11856
   364
(* finish session -- output all generated text *)
wenzelm@11856
   365
wenzelm@24150
   366
fun sorted_index index = map snd (sort (int_ord o pairself fst) (rev index));
wenzelm@24150
   367
fun index_buffer index = Buffer.add (implode (sorted_index index)) Buffer.empty;
wenzelm@24150
   368
wenzelm@14922
   369
fun write_tex src name path =
wenzelm@14922
   370
  Buffer.write (Path.append path (tex_path name)) src;
wenzelm@14922
   371
wenzelm@14922
   372
fun write_tex_index tex_index path =
wenzelm@24150
   373
  write_tex (index_buffer tex_index |> Buffer.add Latex.tex_trailer) doc_indexN path;
wenzelm@14922
   374
wenzelm@7685
   375
wenzelm@23944
   376
fun finish () = CRITICAL (fn () =>
wenzelm@23944
   377
    with_session () (fn {name, info, html_prefix, doc_format, doc_graph,
wenzelm@23944
   378
      documents, doc_prefix1, doc_prefix2, path, verbose, readme, ...} =>
wenzelm@7727
   379
  let
wenzelm@11856
   380
    val {theories, files, tex_index, html_index, graph} = ! browser_info;
wenzelm@11856
   381
    val thys = Symtab.dest theories;
wenzelm@9416
   382
    val parent_html_prefix = Path.append html_prefix Path.parent;
wenzelm@7727
   383
wenzelm@11856
   384
    fun finish_tex path (a, {tex_source, ...}: theory_info) = write_tex tex_source a path;
wenzelm@11856
   385
    fun finish_html (a, {html, ...}: theory_info) =
wenzelm@11856
   386
      Buffer.write (Path.append html_prefix (html_path a)) (Buffer.add HTML.end_theory html);
wenzelm@11856
   387
wenzelm@24150
   388
    val sorted_graph = sorted_index graph;
wenzelm@11856
   389
    val opt_graphs =
wenzelm@16263
   390
      if doc_graph andalso (is_some doc_prefix1 orelse is_some doc_prefix2) then
wenzelm@24150
   391
        SOME (isatool_browser sorted_graph)
skalberg@15531
   392
      else NONE;
wenzelm@11856
   393
wenzelm@17210
   394
    fun prepare_sources cp path =
wenzelm@16263
   395
     (File.mkdir path;
wenzelm@17210
   396
      if cp then File.copy_dir document_path path else ();
wenzelm@17177
   397
      File.isatool ("latex -o sty " ^ File.shell_path (Path.append path (Path.basic "root.tex")));
skalberg@15531
   398
      (case opt_graphs of NONE => () | SOME (pdf, eps) =>
wenzelm@11856
   399
        (File.write (Path.append path graph_pdf_path) pdf;
wenzelm@11856
   400
          File.write (Path.append path graph_eps_path) eps));
wenzelm@14922
   401
      write_tex_index tex_index path;
skalberg@15570
   402
      List.app (finish_tex path) thys);
wenzelm@7727
   403
  in
wenzelm@21962
   404
    if info then
wenzelm@11856
   405
     (File.mkdir (Path.append html_prefix session_path);
wenzelm@24150
   406
      Buffer.write (Path.append html_prefix pre_index_path) (index_buffer html_index);
wenzelm@11856
   407
      File.write (Path.append html_prefix session_entries_path) "";
wenzelm@11856
   408
      create_index html_prefix;
wenzelm@11856
   409
      if length path > 1 then update_index parent_html_prefix name else ();
wenzelm@16263
   410
      (case readme of NONE => () | SOME path => File.copy path html_prefix);
wenzelm@24150
   411
      write_graph sorted_graph (Path.append html_prefix graph_path);
wenzelm@21858
   412
      File.copy (Path.explode "~~/lib/browser/GraphBrowser.jar") html_prefix;
skalberg@15570
   413
      List.app (fn (a, txt) => File.write (Path.append html_prefix (Path.basic a)) txt)
wenzelm@14898
   414
        (HTML.applet_pages name (Url.File index_path, name));
wenzelm@21858
   415
      File.copy (Path.explode "~~/lib/html/isabelle.css") html_prefix;
skalberg@15570
   416
      List.app finish_html thys;
skalberg@15570
   417
      List.app (uncurry File.write) files;
wenzelm@22580
   418
      if verbose then Output.std_error ("Browser info at " ^ show_path html_prefix ^ "\n") else ())
wenzelm@21962
   419
    else ();
wenzelm@11856
   420
wenzelm@17210
   421
    (case doc_prefix2 of NONE => () | SOME (cp, path) =>
wenzelm@17210
   422
     (prepare_sources cp path;
wenzelm@22580
   423
      if verbose then Output.std_error ("Document sources at " ^ show_path path ^ "\n") else ()));
wenzelm@12895
   424
wenzelm@17082
   425
    (case doc_prefix1 of NONE => () | SOME (path, result_path) =>
wenzelm@17082
   426
      documents |> List.app (fn (name, tags) =>
wenzelm@17082
   427
       let
wenzelm@17210
   428
         val _ = prepare_sources true path;
wenzelm@17082
   429
         val doc_path = isatool_document true doc_format name tags path result_path;
wenzelm@17082
   430
       in
wenzelm@22580
   431
         if verbose then Output.std_error ("Document at " ^ show_path doc_path ^ "\n") else ()
wenzelm@17082
   432
       end));
wenzelm@11856
   433
wenzelm@7727
   434
    browser_info := empty_browser_info;
skalberg@15531
   435
    session_info := NONE
wenzelm@23944
   436
  end));
wenzelm@7727
   437
wenzelm@7727
   438
wenzelm@7727
   439
(* theory elements *)
wenzelm@7727
   440
wenzelm@7727
   441
fun init_theory name = with_session () (fn _ => init_theory_info name empty_theory_info);
wenzelm@7727
   442
wenzelm@7727
   443
fun verbatim_source name mk_text =
wenzelm@7727
   444
  with_session () (fn _ => add_html_source name (HTML.verbatim_source (mk_text ())));
wenzelm@7727
   445
wenzelm@9136
   446
fun theory_output name s =
wenzelm@9917
   447
  with_session () (fn _ => add_tex_source name (Latex.isabelle_file name s));
wenzelm@7727
   448
wenzelm@7727
   449
wenzelm@23899
   450
fun parent_link remote_path curr_session thy =
wenzelm@23899
   451
  let
wenzelm@23899
   452
    val {name = _, session, is_local} = get_info thy;
wenzelm@23899
   453
    val name = Context.theory_name thy;
wenzelm@23899
   454
    val link =
wenzelm@23899
   455
      if null session then NONE
wenzelm@23899
   456
      else SOME
wenzelm@23899
   457
       (if is_some remote_path andalso not is_local then
wenzelm@23899
   458
         Url.append (the remote_path) (Url.File (Path.append (Path.make session) (html_path name)))
wenzelm@23899
   459
        else Url.File (Path.append (mk_rel_path curr_session session) (html_path name)));
wenzelm@23899
   460
  in (link, name) end;
wenzelm@7727
   461
wenzelm@26323
   462
fun begin_theory update_time dir files thy =
wenzelm@9416
   463
    with_session thy (fn {name = sess_name, session, path, html_prefix, remote_path, ...} =>
wenzelm@7727
   464
  let
wenzelm@23899
   465
    val name = Context.theory_name thy;
wenzelm@23899
   466
    val parents = Theory.parents_of thy;
wenzelm@23899
   467
    val parent_specs = map (parent_link remote_path path) parents;
wenzelm@7727
   468
wenzelm@7727
   469
    fun prep_file (raw_path, loadit) =
wenzelm@23884
   470
      (case ThyLoad.check_ml dir raw_path of
skalberg@15531
   471
        SOME (path, _) =>
wenzelm@7727
   472
          let
wenzelm@7727
   473
            val base = Path.base path;
wenzelm@7727
   474
            val base_html = html_ext base;
wenzelm@26323
   475
            val _ = add_file (Path.append html_prefix base_html,
wenzelm@14898
   476
              HTML.ml_file (Url.File base) (File.read path));
wenzelm@27491
   477
            in (Url.File base_html, Url.File raw_path, loadit) end
wenzelm@27491
   478
      | NONE => error ("Browser info: expected to find ML file" ^ quote (Path.implode raw_path)));
wenzelm@27491
   479
wenzelm@27491
   480
    val files_html = map prep_file files;
wenzelm@7727
   481
wenzelm@7727
   482
    fun prep_html_source (tex_source, html_source, html) =
wenzelm@7727
   483
      let
wenzelm@14898
   484
        val txt = HTML.begin_theory (Url.File index_path, session)
wenzelm@27491
   485
          name parent_specs files_html (Buffer.content html_source)
wenzelm@7727
   486
      in (tex_source, Buffer.empty, Buffer.add txt html) end;
wenzelm@7727
   487
wenzelm@9416
   488
    val entry =
wenzelm@9416
   489
     {name = name, ID = ID_of path name, dir = sess_name, unfold = true,
wenzelm@21858
   490
      path = Path.implode (html_path name),
wenzelm@23899
   491
      parents = map ID_of_thy parents};
wenzelm@7727
   492
  in
wenzelm@7727
   493
    change_theory_info name prep_html_source;
wenzelm@24150
   494
    add_graph_entry (update_time, entry);
wenzelm@24150
   495
    add_html_index (update_time, HTML.theory_entry (Url.File (html_path name), name));
wenzelm@24150
   496
    add_tex_index (update_time, Latex.theory_entry name);
wenzelm@27327
   497
    put_info {name = sess_name, session = path, is_local = is_some remote_path} thy
wenzelm@7727
   498
  end);
wenzelm@7727
   499
wenzelm@7727
   500
wenzelm@13532
   501
val hooks = ref ([]: (string -> (string * thm list) list -> unit) list);
wenzelm@23944
   502
fun add_hook f = CRITICAL (fn () => change hooks (cons f));
wenzelm@13532
   503
wenzelm@13532
   504
fun results k xs =
skalberg@15570
   505
 (List.app (fn f => (try (fn () => f k xs) (); ())) (! hooks);
wenzelm@22123
   506
  with_session () (fn _ => with_context add_html
wenzelm@22123
   507
    (HTML.results (ML_Context.the_local_context ()) k xs)));
wenzelm@13532
   508
wenzelm@22123
   509
fun theorem a th = results Thm.theoremK [(a, [th])];
wenzelm@22123
   510
fun theorems a ths = results Thm.theoremK [(a, ths)];
wenzelm@8088
   511
fun chapter s = with_session () (fn _ => with_context add_html (HTML.chapter s));
wenzelm@7727
   512
fun section s = with_session () (fn _ => with_context add_html (HTML.section s));
wenzelm@7727
   513
fun subsection s = with_session () (fn _ => with_context add_html (HTML.subsection s));
wenzelm@7727
   514
fun subsubsection s = with_session () (fn _ => with_context add_html (HTML.subsubsection s));
wenzelm@7727
   515
wenzelm@7727
   516
wenzelm@7727
   517
wenzelm@14922
   518
(** draft document output **)
wenzelm@14922
   519
wenzelm@14922
   520
fun drafts doc_format src_paths =
wenzelm@14922
   521
  let
wenzelm@24150
   522
    fun prep_draft path i =
wenzelm@14935
   523
      let
wenzelm@14935
   524
        val base = Path.base path;
wenzelm@14972
   525
        val name =
wenzelm@24829
   526
          (case Path.implode (#1 (Path.split_ext base)) of
wenzelm@24829
   527
            "" => "DUMMY" ^ serial_string ()
wenzelm@24829
   528
          | s => s);
wenzelm@14935
   529
      in
wenzelm@14935
   530
        if File.exists path then
wenzelm@24150
   531
          (((name, base, File.read path), (i, Latex.theory_entry name)), i + 1)
wenzelm@21858
   532
        else error ("Bad file: " ^ quote (Path.implode path))
wenzelm@14935
   533
      end;
wenzelm@24150
   534
    val (srcs, tex_index) = split_list (fst (fold_map prep_draft src_paths 0));
wenzelm@14935
   535
wenzelm@17082
   536
    val doc_path = File.tmp_path document_path;
wenzelm@17082
   537
    val result_path = Path.append doc_path Path.parent;
wenzelm@14922
   538
    val _ = File.mkdir doc_path;
wenzelm@14922
   539
    val root_path = Path.append doc_path (Path.basic "root.tex");
wenzelm@21858
   540
    val _ = File.copy (Path.explode "~~/lib/texinputs/draft.tex") root_path;
wenzelm@16263
   541
    val _ = File.isatool ("latex -o sty " ^ File.shell_path root_path);
wenzelm@16263
   542
    val _ = File.isatool ("latex -o syms " ^ File.shell_path root_path);
wenzelm@14922
   543
wenzelm@14922
   544
    fun known name =
wenzelm@14922
   545
      let val ss = split_lines (File.read (Path.append doc_path (Path.basic name)))
wenzelm@20664
   546
      in member (op =) ss end;
wenzelm@14922
   547
    val known_syms = known "syms.lst";
wenzelm@14922
   548
    val known_ctrls = known "ctrls.lst";
wenzelm@14922
   549
skalberg@15570
   550
    val _ = srcs |> List.app (fn (name, base, txt) =>
wenzelm@14935
   551
      Symbol.explode txt
wenzelm@21858
   552
      |> Latex.symbol_source (known_syms, known_ctrls) (Path.implode base)
wenzelm@14935
   553
      |> File.write (Path.append doc_path (tex_path name)));
wenzelm@14922
   554
    val _ = write_tex_index tex_index doc_path;
wenzelm@17082
   555
  in isatool_document false doc_format documentN "" doc_path result_path end;
wenzelm@14922
   556
wenzelm@14922
   557
wenzelm@7685
   558
end;
wenzelm@7685
   559
wenzelm@6203
   560
structure BasicPresent: BASIC_PRESENT = Present;
wenzelm@6203
   561
open BasicPresent;