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