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