src/Pure/Thy/thy_load.ML
author wenzelm
Wed Aug 22 11:56:13 2012 +0200 (2012-08-22 ago)
changeset 48878 5e850e6fa3c3
parent 48877 51659a3819a7
child 48880 03232f0bb5c4
permissions -rw-r--r--
tuned errors;
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@46737
    13
  val thy_path: Path.T -> Path.T
wenzelm@48876
    14
  val check_thy: Thy_Header.keywords -> Path.T -> string ->
wenzelm@48874
    15
   {master: Path.T * SHA1.digest, text: string, imports: string list,
wenzelm@48876
    16
    uses: (Path.T * bool) list, keywords: Thy_Header.keywords}
wenzelm@43702
    17
  val load_file: theory -> Path.T -> (Path.T * SHA1.digest) * string
wenzelm@43702
    18
  val use_file: Path.T -> theory -> string * theory
wenzelm@37949
    19
  val loaded_files: theory -> Path.T list
wenzelm@37949
    20
  val all_current: theory -> bool
wenzelm@37949
    21
  val use_ml: Path.T -> unit
wenzelm@37949
    22
  val exec_ml: Path.T -> generic_theory -> generic_theory
wenzelm@46938
    23
  val begin_theory: Path.T -> Thy_Header.header -> theory list -> theory
wenzelm@46938
    24
  val load_thy: int -> Path.T -> Thy_Header.header -> Position.T -> string ->
wenzelm@46938
    25
    theory list -> theory * unit future
wenzelm@48867
    26
  val resolve_files: Path.T -> Thy_Syntax.span -> Thy_Syntax.span
wenzelm@48867
    27
  val parse_files: string -> (theory -> Token.files) parser
wenzelm@42002
    28
  val set_master_path: Path.T -> unit
wenzelm@42002
    29
  val get_master_path: unit -> Path.T
wenzelm@6168
    30
end;
wenzelm@6168
    31
wenzelm@37216
    32
structure Thy_Load: THY_LOAD =
wenzelm@6168
    33
struct
wenzelm@6168
    34
wenzelm@37949
    35
(* manage source files *)
wenzelm@37949
    36
wenzelm@37949
    37
type files =
wenzelm@40741
    38
 {master_dir: Path.T,  (*master directory of theory source*)
wenzelm@41548
    39
  imports: string list,  (*source specification of imports*)
wenzelm@40741
    40
  required: Path.T list,  (*source path*)
wenzelm@41955
    41
  provided: (Path.T * (Path.T * SHA1.digest)) list};  (*source path, physical path, digest*)
wenzelm@37949
    42
wenzelm@41548
    43
fun make_files (master_dir, imports, required, provided): files =
wenzelm@41548
    44
 {master_dir = master_dir, imports = imports, required = required, provided = provided};
wenzelm@37949
    45
wenzelm@37949
    46
structure Files = Theory_Data
wenzelm@37949
    47
(
wenzelm@37949
    48
  type T = files;
wenzelm@41548
    49
  val empty = make_files (Path.current, [], [], []);
wenzelm@37949
    50
  fun extend _ = empty;
wenzelm@37949
    51
  fun merge _ = empty;
wenzelm@37949
    52
);
wenzelm@37949
    53
wenzelm@37949
    54
fun map_files f =
wenzelm@41548
    55
  Files.map (fn {master_dir, imports, required, provided} =>
wenzelm@41548
    56
    make_files (f (master_dir, imports, required, provided)));
wenzelm@37949
    57
wenzelm@37949
    58
wenzelm@37949
    59
val master_directory = #master_dir o Files.get;
wenzelm@41548
    60
val imports_of = #imports o Files.get;
wenzelm@37949
    61
wenzelm@41548
    62
fun put_deps dir imports = map_files (fn _ => (dir, imports, [], []));
wenzelm@37949
    63
wenzelm@37949
    64
fun require src_path =
wenzelm@41548
    65
  map_files (fn (master_dir, imports, required, provided) =>
wenzelm@37949
    66
    if member (op =) required src_path then
wenzelm@41944
    67
      error ("Duplicate source file dependency: " ^ Path.print src_path)
wenzelm@41548
    68
    else (master_dir, imports, src_path :: required, provided));
wenzelm@37949
    69
wenzelm@37978
    70
fun provide (src_path, path_id) =
wenzelm@41548
    71
  map_files (fn (master_dir, imports, required, provided) =>
wenzelm@37949
    72
    if AList.defined (op =) provided src_path then
wenzelm@41944
    73
      error ("Duplicate resolution of source file dependency: " ^ Path.print src_path)
wenzelm@41548
    74
    else (master_dir, imports, required, (src_path, path_id) :: provided));
wenzelm@37949
    75
wenzelm@37949
    76
wenzelm@48869
    77
(* inlined files *)
wenzelm@48869
    78
wenzelm@48878
    79
fun check_file dir file = File.check_file (File.full_path dir file);
wenzelm@48878
    80
wenzelm@48874
    81
local
wenzelm@48874
    82
wenzelm@48874
    83
fun clean ((i1, t1) :: (i2, t2) :: toks) =
wenzelm@48874
    84
      if Token.keyword_with (fn s => s = "%" orelse s = "--") t1 then clean toks
wenzelm@48874
    85
      else (i1, t1) :: clean ((i2, t2) :: toks)
wenzelm@48874
    86
  | clean toks = toks;
wenzelm@48874
    87
wenzelm@48874
    88
fun clean_tokens toks =
wenzelm@48874
    89
  ((0 upto length toks - 1) ~~ toks)
wenzelm@48874
    90
  |> filter (fn (_, tok) => Token.is_proper tok)
wenzelm@48874
    91
  |> clean;
wenzelm@48874
    92
wenzelm@48874
    93
fun find_file toks =
wenzelm@48874
    94
  rev (clean_tokens toks) |> get_first (fn (i, tok) =>
wenzelm@48874
    95
    if Token.is_name tok then SOME (i, Path.explode (Token.content_of tok))
wenzelm@48874
    96
    else NONE);
wenzelm@48874
    97
wenzelm@48874
    98
fun command_files path exts =
wenzelm@48874
    99
  if null exts then [path]
wenzelm@48874
   100
  else map (fn ext => Path.ext ext path) exts;
wenzelm@48874
   101
wenzelm@48874
   102
in
wenzelm@48874
   103
wenzelm@48874
   104
fun find_files syntax text =
wenzelm@48874
   105
  let val thy_load_commands = Keyword.thy_load_commands syntax in
wenzelm@48874
   106
    if exists (fn (cmd, _) => String.isSubstring cmd text) thy_load_commands then
wenzelm@48874
   107
      Thy_Syntax.parse_tokens (Keyword.lexicons_of syntax) Position.none text
wenzelm@48874
   108
      |> Thy_Syntax.parse_spans
wenzelm@48874
   109
      |> maps
wenzelm@48878
   110
        (fn Thy_Syntax.Span (Thy_Syntax.Command (cmd, _), toks) =>
wenzelm@48874
   111
              (case AList.lookup (op =) thy_load_commands cmd of
wenzelm@48874
   112
                SOME exts =>
wenzelm@48874
   113
                  (case find_file toks of
wenzelm@48874
   114
                    SOME (_, path) => command_files path exts
wenzelm@48874
   115
                  | NONE => [])
wenzelm@48874
   116
              | NONE => [])
wenzelm@48874
   117
          | _ => [])
wenzelm@48874
   118
    else []
wenzelm@48874
   119
  end;
wenzelm@48869
   120
wenzelm@48869
   121
fun read_files cmd dir tok =
wenzelm@48869
   122
  let
wenzelm@48869
   123
    val path = Path.explode (Token.content_of tok);
wenzelm@48869
   124
    val files =
wenzelm@48874
   125
      command_files path (Keyword.command_files cmd)
wenzelm@48878
   126
      |> map (check_file dir #> (fn path => (File.read path, Path.position path)));
wenzelm@48869
   127
  in (dir, files) end;
wenzelm@48869
   128
wenzelm@48869
   129
fun parse_files cmd =
wenzelm@48869
   130
  Scan.ahead Parse.not_eof -- Parse.group (fn () => "file name/path specification") Parse.name
wenzelm@48869
   131
    >> (fn (tok, name) => fn thy =>
wenzelm@48869
   132
      (case Token.get_files tok of
wenzelm@48869
   133
        SOME files => files
wenzelm@48869
   134
      | NONE =>
wenzelm@48869
   135
          (warning ("Dynamic loading of files: " ^ quote name ^ Token.pos_of tok);
wenzelm@48869
   136
            read_files cmd (master_directory thy) tok)));
wenzelm@48869
   137
wenzelm@48874
   138
fun resolve_files dir span =
wenzelm@48874
   139
  (case span of
wenzelm@48878
   140
    Thy_Syntax.Span (Thy_Syntax.Command (cmd, pos), toks) =>
wenzelm@48869
   141
      if Keyword.is_theory_load cmd then
wenzelm@48869
   142
        (case find_first (Token.is_name o #2) (rev (clean_tokens toks)) of
wenzelm@48878
   143
          NONE =>
wenzelm@48878
   144
            error ("Cannot resolve file argument of command " ^ quote cmd ^ Position.str_of pos)
wenzelm@48874
   145
        | SOME (i, path) =>
wenzelm@48869
   146
            let
wenzelm@48869
   147
              val toks' = toks |> map_index (fn (j, tok) =>
wenzelm@48874
   148
                if i = j then Token.put_files (read_files cmd dir path) tok
wenzelm@48869
   149
                else tok);
wenzelm@48878
   150
            in Thy_Syntax.Span (Thy_Syntax.Command (cmd, pos), toks') end)
wenzelm@48869
   151
      else span
wenzelm@48874
   152
  | span => span);
wenzelm@48869
   153
wenzelm@48869
   154
end;
wenzelm@48869
   155
wenzelm@48869
   156
wenzelm@23872
   157
(* check files *)
wenzelm@6232
   158
wenzelm@46737
   159
val thy_path = Path.ext "thy";
wenzelm@46737
   160
wenzelm@48876
   161
fun check_thy base_keywords dir thy_name =
wenzelm@23872
   162
  let
wenzelm@48876
   163
    val path = thy_path (Path.basic thy_name);
wenzelm@46737
   164
    val master_file = check_file dir path;
wenzelm@42003
   165
    val text = File.read master_file;
wenzelm@48876
   166
wenzelm@48876
   167
    val {name, imports, uses, keywords} = Thy_Header.read (Path.position master_file) text;
wenzelm@48876
   168
    val _ = thy_name <> name andalso
wenzelm@48876
   169
      error ("Bad file name " ^ Path.print path ^ " for theory " ^ quote name);
wenzelm@48876
   170
wenzelm@48876
   171
    val syntax =
wenzelm@48876
   172
      fold (Keyword.define_keywords o apsnd (Option.map Keyword.spec))
wenzelm@48876
   173
        (keywords @ base_keywords) (Keyword.get_keywords ());
wenzelm@48876
   174
    val more_uses = map (rpair false) (find_files syntax text);
wenzelm@48874
   175
  in
wenzelm@48874
   176
   {master = (master_file, SHA1.digest text), text = text,
wenzelm@48876
   177
    imports = imports, uses = uses @ more_uses, keywords = keywords}
wenzelm@48874
   178
  end;
wenzelm@6168
   179
wenzelm@37949
   180
wenzelm@43702
   181
(* load files *)
wenzelm@43702
   182
wenzelm@43702
   183
fun load_file thy src_path =
wenzelm@43702
   184
  let
wenzelm@43702
   185
    val full_path = check_file (master_directory thy) src_path;
wenzelm@43702
   186
    val text = File.read full_path;
wenzelm@43702
   187
    val id = SHA1.digest text;
wenzelm@43702
   188
  in ((full_path, id), text) end;
wenzelm@43702
   189
wenzelm@43702
   190
fun use_file src_path thy =
wenzelm@43702
   191
  let
wenzelm@43702
   192
    val (path_id, text) = load_file thy src_path;
wenzelm@43702
   193
    val thy' = provide (src_path, path_id) thy;
wenzelm@43702
   194
  in (text, thy') end;
wenzelm@37949
   195
wenzelm@37949
   196
val loaded_files = map (#1 o #2) o #provided o Files.get;
wenzelm@6168
   197
wenzelm@37949
   198
fun check_loaded thy =
wenzelm@37949
   199
  let
wenzelm@37949
   200
    val {required, provided, ...} = Files.get thy;
wenzelm@37949
   201
    val provided_paths = map #1 provided;
wenzelm@37949
   202
    val _ =
wenzelm@37949
   203
      (case subtract (op =) provided_paths required of
wenzelm@37949
   204
        [] => NONE
wenzelm@41944
   205
      | bad => error ("Pending source file dependencies: " ^ commas (map Path.print (rev bad))));
wenzelm@37949
   206
    val _ =
wenzelm@37949
   207
      (case subtract (op =) required provided_paths of
wenzelm@37949
   208
        [] => NONE
wenzelm@41944
   209
      | bad => error ("Undeclared source file dependencies: " ^ commas (map Path.print (rev bad))));
wenzelm@37949
   210
  in () end;
wenzelm@37949
   211
wenzelm@37949
   212
fun all_current thy =
wenzelm@37939
   213
  let
wenzelm@43702
   214
    val {provided, ...} = Files.get thy;
wenzelm@37978
   215
    fun current (src_path, (_, id)) =
wenzelm@43702
   216
      (case try (load_file thy) src_path of
wenzelm@37949
   217
        NONE => false
wenzelm@43702
   218
      | SOME ((_, id'), _) => id = id');
wenzelm@37949
   219
  in can check_loaded thy andalso forall current provided end;
wenzelm@37949
   220
wenzelm@37952
   221
val _ = Context.>> (Context.map_theory (Theory.at_end (fn thy => (check_loaded thy; NONE))));
wenzelm@37952
   222
wenzelm@37949
   223
wenzelm@37949
   224
(* provide files *)
wenzelm@37949
   225
wenzelm@43700
   226
fun eval_file path text = ML_Context.eval_text true (Path.position path) text;
wenzelm@37949
   227
wenzelm@37949
   228
fun use_ml src_path =
wenzelm@37949
   229
  if is_none (Context.thread_data ()) then
wenzelm@43700
   230
    let val path = check_file Path.current src_path
wenzelm@43700
   231
    in eval_file path (File.read path) end
wenzelm@37949
   232
  else
wenzelm@37949
   233
    let
wenzelm@37949
   234
      val thy = ML_Context.the_global_context ();
wenzelm@37949
   235
wenzelm@43702
   236
      val ((path, id), text) = load_file thy src_path;
wenzelm@43700
   237
      val _ = eval_file path text;
wenzelm@37949
   238
      val _ = Context.>> Local_Theory.propagate_ml_env;
wenzelm@37949
   239
wenzelm@37978
   240
      val provide = provide (src_path, (path, id));
wenzelm@38757
   241
      val _ = Context.>> (Context.mapping provide (Local_Theory.background_theory provide));
wenzelm@37978
   242
    in () end;
wenzelm@37949
   243
wenzelm@37949
   244
fun exec_ml src_path = ML_Context.exec (fn () => use_ml src_path);
wenzelm@6168
   245
wenzelm@37977
   246
wenzelm@43712
   247
(* load_thy *)
wenzelm@37977
   248
wenzelm@46938
   249
fun begin_theory dir {name, imports, keywords, uses} parents =
wenzelm@37977
   250
  Theory.begin_theory name parents
wenzelm@41548
   251
  |> put_deps dir imports
wenzelm@46938
   252
  |> fold Thy_Header.declare_keyword keywords
wenzelm@37977
   253
  |> fold (require o fst) uses
wenzelm@37977
   254
  |> fold (fn (path, true) => Context.theory_map (exec_ml path) o Theory.checkpoint | _ => I) uses
wenzelm@37977
   255
  |> Theory.checkpoint;
wenzelm@37977
   256
wenzelm@46959
   257
fun excursion init elements =
wenzelm@46959
   258
  let
wenzelm@46959
   259
    val immediate = not (Goal.future_enabled ());
wenzelm@46959
   260
wenzelm@46959
   261
    fun proof_result (tr, trs) (st, _) =
wenzelm@46959
   262
      let
wenzelm@46959
   263
        val (result, st') = Toplevel.proof_result immediate (tr, trs) st;
wenzelm@46959
   264
        val pos' = Toplevel.pos_of (List.last (tr :: trs));
wenzelm@46959
   265
      in (result, (st', pos')) end;
wenzelm@46959
   266
wenzelm@46959
   267
    fun element_result elem x =
wenzelm@46959
   268
      fold_map proof_result
wenzelm@46959
   269
        (Outer_Syntax.read_element (#2 (Outer_Syntax.get_syntax ())) init elem) x;
wenzelm@46959
   270
wenzelm@46959
   271
    val (results, (end_state, end_pos)) =
wenzelm@46959
   272
      fold_map element_result elements (Toplevel.toplevel, Position.none);
wenzelm@46959
   273
wenzelm@46959
   274
    val thy = Toplevel.end_theory end_pos end_state;
wenzelm@46959
   275
  in (flat results, thy) end;
wenzelm@46959
   276
wenzelm@46938
   277
fun load_thy update_time dir header pos text parents =
wenzelm@43712
   278
  let
wenzelm@43712
   279
    val time = ! Toplevel.timing;
wenzelm@43712
   280
wenzelm@48867
   281
    val {name, uses, ...} = header;
wenzelm@46958
   282
    val _ = Thy_Header.define_keywords header;
wenzelm@43712
   283
    val _ = Present.init_theory name;
wenzelm@44186
   284
    fun init () =
wenzelm@46938
   285
      begin_theory dir header parents
wenzelm@43712
   286
      |> Present.begin_theory update_time dir uses;
wenzelm@43712
   287
wenzelm@46959
   288
    val lexs = Keyword.get_lexicons ();
wenzelm@46958
   289
wenzelm@46811
   290
    val toks = Thy_Syntax.parse_tokens lexs pos text;
wenzelm@48867
   291
    val spans = map (resolve_files dir) (Thy_Syntax.parse_spans toks);
wenzelm@46959
   292
    val elements = Thy_Syntax.parse_elements spans;
wenzelm@43712
   293
wenzelm@43712
   294
    val _ = Present.theory_source name
wenzelm@43712
   295
      (fn () => HTML.html_mode (implode o map Thy_Syntax.present_span) spans);
wenzelm@43712
   296
wenzelm@43712
   297
    val _ = if time then writeln ("\n**** Starting theory " ^ quote name ^ " ****") else ();
wenzelm@46959
   298
    val (results, thy) = cond_timeit time "" (fn () => excursion init elements);
wenzelm@43712
   299
    val _ = if time then writeln ("**** Finished theory " ^ quote name ^ " ****\n") else ();
wenzelm@43712
   300
wenzelm@43712
   301
    val present =
wenzelm@43712
   302
      singleton (Future.cond_forks {name = "Outer_Syntax.present:" ^ name, group = NONE,
wenzelm@44113
   303
        deps = map Future.task_of results, pri = 0, interrupts = true})
wenzelm@43712
   304
      (fn () =>
wenzelm@46959
   305
        let val ((minor, _), outer_syntax) = Outer_Syntax.get_syntax () in
wenzelm@46959
   306
          Thy_Output.present_thy minor Keyword.command_tags
wenzelm@46959
   307
            (Outer_Syntax.is_markup outer_syntax)
wenzelm@46959
   308
            (maps Future.join results) toks
wenzelm@46959
   309
          |> Buffer.content
wenzelm@46959
   310
          |> Present.theory_output name
wenzelm@46959
   311
        end);
wenzelm@43712
   312
wenzelm@43712
   313
  in (thy, present) end;
wenzelm@43712
   314
wenzelm@42002
   315
wenzelm@42002
   316
(* global master path *)
wenzelm@42002
   317
wenzelm@42002
   318
local
wenzelm@42002
   319
  val master_path = Unsynchronized.ref Path.current;
wenzelm@42002
   320
in
wenzelm@42002
   321
wenzelm@42002
   322
fun set_master_path path = master_path := path;
wenzelm@42002
   323
fun get_master_path () = ! master_path;
wenzelm@42002
   324
wenzelm@6168
   325
end;
wenzelm@6168
   326
wenzelm@42002
   327
end;