src/Pure/Thy/thy_load.ML
author wenzelm
Fri Jul 08 11:50:58 2011 +0200 (2011-07-08 ago)
changeset 43700 e4ece46a9ca7
parent 42003 6e45dc518ebb
child 43702 24fb44c1086a
permissions -rw-r--r--
clarified Thy_Load.digest_file -- read ML files only once;
wenzelm@6168
     1
(*  Title:      Pure/Thy/thy_load.ML
wenzelm@42002
     2
    Author:     Makarius
wenzelm@6168
     3
wenzelm@42002
     4
Loading files that contribute to a theory.  Global master path.
wenzelm@6168
     5
*)
wenzelm@6168
     6
wenzelm@6168
     7
signature THY_LOAD =
wenzelm@6168
     8
sig
wenzelm@37949
     9
  val master_directory: theory -> Path.T
wenzelm@41548
    10
  val imports_of: theory -> string list
wenzelm@41955
    11
  val provide: Path.T * (Path.T * SHA1.digest) -> theory -> theory
wenzelm@42003
    12
  val check_file: Path.T -> Path.T -> Path.T
wenzelm@42003
    13
  val check_thy: Path.T -> string ->
wenzelm@42003
    14
    {master: Path.T * SHA1.digest, text: string, imports: string list, uses: (Path.T * bool) list}
wenzelm@37949
    15
  val loaded_files: theory -> Path.T list
wenzelm@37949
    16
  val all_current: theory -> bool
wenzelm@37949
    17
  val provide_file: Path.T -> theory -> theory
wenzelm@37949
    18
  val use_ml: Path.T -> unit
wenzelm@37949
    19
  val exec_ml: Path.T -> generic_theory -> generic_theory
wenzelm@41548
    20
  val begin_theory: Path.T -> string -> string list -> theory list -> (Path.T * bool) list -> theory
wenzelm@42002
    21
  val set_master_path: Path.T -> unit
wenzelm@42002
    22
  val get_master_path: unit -> Path.T
wenzelm@6168
    23
end;
wenzelm@6168
    24
wenzelm@37216
    25
structure Thy_Load: THY_LOAD =
wenzelm@6168
    26
struct
wenzelm@6168
    27
wenzelm@37949
    28
(* manage source files *)
wenzelm@37949
    29
wenzelm@37949
    30
type files =
wenzelm@40741
    31
 {master_dir: Path.T,  (*master directory of theory source*)
wenzelm@41548
    32
  imports: string list,  (*source specification of imports*)
wenzelm@40741
    33
  required: Path.T list,  (*source path*)
wenzelm@41955
    34
  provided: (Path.T * (Path.T * SHA1.digest)) list};  (*source path, physical path, digest*)
wenzelm@37949
    35
wenzelm@41548
    36
fun make_files (master_dir, imports, required, provided): files =
wenzelm@41548
    37
 {master_dir = master_dir, imports = imports, required = required, provided = provided};
wenzelm@37949
    38
wenzelm@37949
    39
structure Files = Theory_Data
wenzelm@37949
    40
(
wenzelm@37949
    41
  type T = files;
wenzelm@41548
    42
  val empty = make_files (Path.current, [], [], []);
wenzelm@37949
    43
  fun extend _ = empty;
wenzelm@37949
    44
  fun merge _ = empty;
wenzelm@37949
    45
);
wenzelm@37949
    46
wenzelm@37949
    47
fun map_files f =
wenzelm@41548
    48
  Files.map (fn {master_dir, imports, required, provided} =>
wenzelm@41548
    49
    make_files (f (master_dir, imports, required, provided)));
wenzelm@37949
    50
wenzelm@37949
    51
wenzelm@37949
    52
val master_directory = #master_dir o Files.get;
wenzelm@41548
    53
val imports_of = #imports o Files.get;
wenzelm@37949
    54
wenzelm@41548
    55
fun put_deps dir imports = map_files (fn _ => (dir, imports, [], []));
wenzelm@37949
    56
wenzelm@37949
    57
fun require src_path =
wenzelm@41548
    58
  map_files (fn (master_dir, imports, required, provided) =>
wenzelm@37949
    59
    if member (op =) required src_path then
wenzelm@41944
    60
      error ("Duplicate source file dependency: " ^ Path.print src_path)
wenzelm@41548
    61
    else (master_dir, imports, src_path :: required, provided));
wenzelm@37949
    62
wenzelm@37978
    63
fun provide (src_path, path_id) =
wenzelm@41548
    64
  map_files (fn (master_dir, imports, required, provided) =>
wenzelm@37949
    65
    if AList.defined (op =) provided src_path then
wenzelm@41944
    66
      error ("Duplicate resolution of source file dependency: " ^ Path.print src_path)
wenzelm@41548
    67
    else (master_dir, imports, required, (src_path, path_id) :: provided));
wenzelm@37949
    68
wenzelm@37949
    69
wenzelm@23872
    70
(* check files *)
wenzelm@6232
    71
wenzelm@42003
    72
fun check_file dir file = File.check_file (File.full_path dir file);
wenzelm@42003
    73
wenzelm@42003
    74
fun digest_file dir file =
wenzelm@6232
    75
  let
wenzelm@42003
    76
    val full_path = check_file dir file;
wenzelm@43700
    77
    val text = File.read full_path;
wenzelm@43700
    78
    val id = SHA1.digest text;
wenzelm@43700
    79
  in (text, (full_path, id)) end;
wenzelm@37939
    80
wenzelm@41886
    81
fun check_thy dir name =
wenzelm@23872
    82
  let
wenzelm@42003
    83
    val master_file = check_file dir (Thy_Header.thy_path name);
wenzelm@42003
    84
    val text = File.read master_file;
wenzelm@42003
    85
    val (name', imports, uses) =
wenzelm@42003
    86
      if name = Context.PureN then (Context.PureN, [], [])
wenzelm@42003
    87
      else Thy_Header.read (Path.position master_file) text;
wenzelm@37950
    88
    val _ = Thy_Header.consistent_name name name';
wenzelm@42003
    89
  in {master = (master_file, SHA1.digest text), text = text, imports = imports, uses = uses} end;
wenzelm@6168
    90
wenzelm@37949
    91
wenzelm@37949
    92
(* loaded files *)
wenzelm@37949
    93
wenzelm@37949
    94
val loaded_files = map (#1 o #2) o #provided o Files.get;
wenzelm@6168
    95
wenzelm@37949
    96
fun check_loaded thy =
wenzelm@37949
    97
  let
wenzelm@37949
    98
    val {required, provided, ...} = Files.get thy;
wenzelm@37949
    99
    val provided_paths = map #1 provided;
wenzelm@37949
   100
    val _ =
wenzelm@37949
   101
      (case subtract (op =) provided_paths required of
wenzelm@37949
   102
        [] => NONE
wenzelm@41944
   103
      | bad => error ("Pending source file dependencies: " ^ commas (map Path.print (rev bad))));
wenzelm@37949
   104
    val _ =
wenzelm@37949
   105
      (case subtract (op =) required provided_paths of
wenzelm@37949
   106
        [] => NONE
wenzelm@41944
   107
      | bad => error ("Undeclared source file dependencies: " ^ commas (map Path.print (rev bad))));
wenzelm@37949
   108
  in () end;
wenzelm@37949
   109
wenzelm@37949
   110
fun all_current thy =
wenzelm@37939
   111
  let
wenzelm@37949
   112
    val {master_dir, provided, ...} = Files.get thy;
wenzelm@37978
   113
    fun current (src_path, (_, id)) =
wenzelm@42003
   114
      (case try (digest_file master_dir) src_path of
wenzelm@37949
   115
        NONE => false
wenzelm@43700
   116
      | SOME (_, (_, id')) => id = id');
wenzelm@37949
   117
  in can check_loaded thy andalso forall current provided end;
wenzelm@37949
   118
wenzelm@37952
   119
val _ = Context.>> (Context.map_theory (Theory.at_end (fn thy => (check_loaded thy; NONE))));
wenzelm@37952
   120
wenzelm@37949
   121
wenzelm@37949
   122
(* provide files *)
wenzelm@37949
   123
wenzelm@37949
   124
fun provide_file src_path thy =
wenzelm@43700
   125
  provide (src_path, #2 (digest_file (master_directory thy) src_path)) thy;
wenzelm@43700
   126
wenzelm@43700
   127
fun eval_file path text = ML_Context.eval_text true (Path.position path) text;
wenzelm@37949
   128
wenzelm@37949
   129
fun use_ml src_path =
wenzelm@37949
   130
  if is_none (Context.thread_data ()) then
wenzelm@43700
   131
    let val path = check_file Path.current src_path
wenzelm@43700
   132
    in eval_file path (File.read path) end
wenzelm@37949
   133
  else
wenzelm@37949
   134
    let
wenzelm@37949
   135
      val thy = ML_Context.the_global_context ();
wenzelm@37949
   136
wenzelm@43700
   137
      val (text, (path, id)) = digest_file (master_directory thy) src_path;
wenzelm@43700
   138
      val _ = eval_file path text;
wenzelm@37949
   139
      val _ = Context.>> Local_Theory.propagate_ml_env;
wenzelm@37949
   140
wenzelm@37978
   141
      val provide = provide (src_path, (path, id));
wenzelm@38757
   142
      val _ = Context.>> (Context.mapping provide (Local_Theory.background_theory provide));
wenzelm@37978
   143
    in () end;
wenzelm@37949
   144
wenzelm@37949
   145
fun exec_ml src_path = ML_Context.exec (fn () => use_ml src_path);
wenzelm@6168
   146
wenzelm@37977
   147
wenzelm@37977
   148
(* begin theory *)
wenzelm@37977
   149
wenzelm@41548
   150
fun begin_theory dir name imports parents uses =
wenzelm@37977
   151
  Theory.begin_theory name parents
wenzelm@41548
   152
  |> put_deps dir imports
wenzelm@37977
   153
  |> fold (require o fst) uses
wenzelm@37977
   154
  |> fold (fn (path, true) => Context.theory_map (exec_ml path) o Theory.checkpoint | _ => I) uses
wenzelm@37977
   155
  |> Theory.checkpoint;
wenzelm@37977
   156
wenzelm@42002
   157
wenzelm@42002
   158
(* global master path *)
wenzelm@42002
   159
wenzelm@42002
   160
local
wenzelm@42002
   161
  val master_path = Unsynchronized.ref Path.current;
wenzelm@42002
   162
in
wenzelm@42002
   163
wenzelm@42002
   164
fun set_master_path path = master_path := path;
wenzelm@42002
   165
fun get_master_path () = ! master_path;
wenzelm@42002
   166
wenzelm@6168
   167
end;
wenzelm@6168
   168
wenzelm@42002
   169
end;