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