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