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