src/Pure/PIDE/resources.ML
author wenzelm
Fri Oct 31 21:20:06 2014 +0100 (2014-10-31 ago)
changeset 58851 897f266c44b3
parent 58849 ef7700ecce83
child 58862 63a16e98cc14
permissions -rw-r--r--
obsolete;
wenzelm@56208
     1
(*  Title:      Pure/PIDE/resources.ML
wenzelm@42002
     2
    Author:     Makarius
wenzelm@6168
     3
wenzelm@56208
     4
Resources for theories and auxiliary files.
wenzelm@6168
     5
*)
wenzelm@6168
     6
wenzelm@56208
     7
signature RESOURCES =
wenzelm@6168
     8
sig
wenzelm@37949
     9
  val master_directory: theory -> Path.T
wenzelm@48927
    10
  val imports_of: theory -> (string * Position.T) list
wenzelm@46737
    11
  val thy_path: Path.T -> Path.T
wenzelm@48898
    12
  val check_thy: Path.T -> string ->
wenzelm@48928
    13
   {master: Path.T * SHA1.digest, text: string, theory_pos: Position.T,
wenzelm@51293
    14
    imports: (string * Position.T) list, keywords: Thy_Header.keywords}
wenzelm@54525
    15
  val parse_files: string -> (theory -> Token.file list) parser
wenzelm@48906
    16
  val provide: Path.T * SHA1.digest -> theory -> theory
wenzelm@48906
    17
  val provide_parse_files: string -> (theory -> Token.file list * theory) parser
wenzelm@54446
    18
  val loaded_files_current: theory -> bool
wenzelm@46938
    19
  val begin_theory: Path.T -> Thy_Header.header -> theory list -> theory
wenzelm@54458
    20
  val load_thy: bool -> (Toplevel.transition -> Time.time option) -> int -> Path.T ->
wenzelm@54458
    21
    Thy_Header.header -> Position.T -> string -> theory list -> theory * (unit -> unit) * int
wenzelm@6168
    22
end;
wenzelm@6168
    23
wenzelm@56208
    24
structure Resources: RESOURCES =
wenzelm@6168
    25
struct
wenzelm@6168
    26
wenzelm@37949
    27
(* manage source files *)
wenzelm@37949
    28
wenzelm@37949
    29
type files =
wenzelm@40741
    30
 {master_dir: Path.T,  (*master directory of theory source*)
wenzelm@48927
    31
  imports: (string * Position.T) list,  (*source specification of imports*)
wenzelm@48896
    32
  provided: (Path.T * SHA1.digest) list};  (*source path, digest*)
wenzelm@37949
    33
wenzelm@48886
    34
fun make_files (master_dir, imports, provided): files =
wenzelm@48886
    35
 {master_dir = master_dir, imports = imports, provided = provided};
wenzelm@37949
    36
wenzelm@37949
    37
structure Files = Theory_Data
wenzelm@37949
    38
(
wenzelm@37949
    39
  type T = files;
wenzelm@48886
    40
  val empty = make_files (Path.current, [], []);
wenzelm@37949
    41
  fun extend _ = empty;
wenzelm@37949
    42
  fun merge _ = empty;
wenzelm@37949
    43
);
wenzelm@37949
    44
wenzelm@37949
    45
fun map_files f =
wenzelm@48886
    46
  Files.map (fn {master_dir, imports, provided} =>
wenzelm@48886
    47
    make_files (f (master_dir, imports, provided)));
wenzelm@37949
    48
wenzelm@37949
    49
wenzelm@37949
    50
val master_directory = #master_dir o Files.get;
wenzelm@41548
    51
val imports_of = #imports o Files.get;
wenzelm@37949
    52
wenzelm@48888
    53
fun put_deps master_dir imports = map_files (fn _ => (master_dir, imports, []));
wenzelm@37949
    54
wenzelm@37949
    55
wenzelm@54525
    56
(* theory files *)
wenzelm@54525
    57
wenzelm@54525
    58
val thy_path = Path.ext "thy";
wenzelm@48869
    59
wenzelm@48878
    60
fun check_file dir file = File.check_file (File.full_path dir file);
wenzelm@48878
    61
wenzelm@54525
    62
fun check_thy dir thy_name =
wenzelm@54525
    63
  let
wenzelm@54525
    64
    val path = thy_path (Path.basic thy_name);
wenzelm@54525
    65
    val master_file = check_file dir path;
wenzelm@54525
    66
    val text = File.read master_file;
wenzelm@54525
    67
wenzelm@54525
    68
    val {name = (name, pos), imports, keywords} =
wenzelm@54525
    69
      Thy_Header.read (Path.position master_file) text;
wenzelm@54525
    70
    val _ = thy_name <> name andalso
wenzelm@54525
    71
      error ("Bad file name " ^ Path.print path ^ " for theory " ^ quote name ^ Position.here pos);
wenzelm@54525
    72
  in
wenzelm@54525
    73
   {master = (master_file, SHA1.digest text), text = text, theory_pos = pos,
wenzelm@54525
    74
    imports = imports, keywords = keywords}
wenzelm@54525
    75
  end;
wenzelm@54525
    76
wenzelm@54525
    77
wenzelm@54526
    78
(* load files *)
wenzelm@48898
    79
wenzelm@48898
    80
fun parse_files cmd =
wenzelm@48898
    81
  Scan.ahead Parse.not_eof -- Parse.path >> (fn (tok, name) => fn thy =>
wenzelm@48898
    82
    (case Token.get_files tok of
wenzelm@54526
    83
      [] =>
wenzelm@54526
    84
        let
wenzelm@54526
    85
          val master_dir = master_directory thy;
wenzelm@55708
    86
          val pos = Token.pos_of tok;
wenzelm@54526
    87
          val src_paths = Keyword.command_files cmd (Path.explode name);
wenzelm@54526
    88
        in map (Command.read_file master_dir pos) src_paths end
wenzelm@54520
    89
    | files => map Exn.release files));
wenzelm@48869
    90
wenzelm@48906
    91
fun provide (src_path, id) =
wenzelm@48906
    92
  map_files (fn (master_dir, imports, provided) =>
wenzelm@48906
    93
    if AList.defined (op =) provided src_path then
wenzelm@48906
    94
      error ("Duplicate use of source file: " ^ Path.print src_path)
wenzelm@48906
    95
    else (master_dir, imports, (src_path, id) :: provided));
wenzelm@48906
    96
wenzelm@48906
    97
fun provide_parse_files cmd =
wenzelm@48906
    98
  parse_files cmd >> (fn files => fn thy =>
wenzelm@48906
    99
    let
wenzelm@48906
   100
      val fs = files thy;
wenzelm@55788
   101
      val thy' = fold (fn {src_path, digest, ...} => provide (src_path, digest)) fs thy;
wenzelm@48906
   102
    in (fs, thy') end);
wenzelm@48906
   103
wenzelm@43702
   104
fun load_file thy src_path =
wenzelm@43702
   105
  let
wenzelm@43702
   106
    val full_path = check_file (master_directory thy) src_path;
wenzelm@43702
   107
    val text = File.read full_path;
wenzelm@43702
   108
    val id = SHA1.digest text;
wenzelm@43702
   109
  in ((full_path, id), text) end;
wenzelm@43702
   110
wenzelm@54446
   111
fun loaded_files_current thy =
wenzelm@48886
   112
  #provided (Files.get thy) |>
wenzelm@48896
   113
    forall (fn (src_path, id) =>
wenzelm@43702
   114
      (case try (load_file thy) src_path of
wenzelm@37949
   115
        NONE => false
wenzelm@48886
   116
      | SOME ((_, id'), _) => id = id'));
wenzelm@37952
   117
wenzelm@37949
   118
wenzelm@54525
   119
(* load theory *)
wenzelm@37977
   120
wenzelm@51294
   121
fun begin_theory master_dir {name, imports, keywords} parents =
wenzelm@37977
   122
  Theory.begin_theory name parents
wenzelm@48888
   123
  |> put_deps master_dir imports
wenzelm@52788
   124
  |> fold Thy_Header.declare_keyword keywords;
wenzelm@37977
   125
wenzelm@54526
   126
fun excursion master_dir last_timing init elements =
wenzelm@46959
   127
  let
wenzelm@51268
   128
    fun prepare_span span =
wenzelm@57905
   129
      Command_Span.content span
wenzelm@54526
   130
      |> Command.read init master_dir []
wenzelm@51268
   131
      |> (fn tr => Toplevel.put_timing (last_timing tr) tr);
wenzelm@51217
   132
wenzelm@51268
   133
    fun element_result span_elem (st, _) =
wenzelm@46959
   134
      let
wenzelm@51273
   135
        val elem = Thy_Syntax.map_element prepare_span span_elem;
wenzelm@51273
   136
        val (results, st') = Toplevel.element_result elem st;
wenzelm@51273
   137
        val pos' = Toplevel.pos_of (Thy_Syntax.last_element elem);
wenzelm@51268
   138
      in (results, (st', pos')) end;
wenzelm@46959
   139
wenzelm@46959
   140
    val (results, (end_state, end_pos)) =
wenzelm@46959
   141
      fold_map element_result elements (Toplevel.toplevel, Position.none);
wenzelm@46959
   142
wenzelm@46959
   143
    val thy = Toplevel.end_theory end_pos end_state;
wenzelm@51273
   144
  in (results, thy) end;
wenzelm@46959
   145
wenzelm@54458
   146
fun load_thy document last_timing update_time master_dir header text_pos text parents =
wenzelm@43712
   147
  let
wenzelm@51294
   148
    val {name = (name, _), ...} = header;
wenzelm@46958
   149
    val _ = Thy_Header.define_keywords header;
wenzelm@43712
   150
wenzelm@46959
   151
    val lexs = Keyword.get_lexicons ();
wenzelm@57918
   152
    val toks = Outer_Syntax.scan lexs text_pos text;
wenzelm@57905
   153
    val spans = Outer_Syntax.parse_spans toks;
wenzelm@46959
   154
    val elements = Thy_Syntax.parse_elements spans;
wenzelm@43712
   155
wenzelm@54456
   156
    fun init () =
wenzelm@54456
   157
      begin_theory master_dir header parents
wenzelm@54456
   158
      |> Present.begin_theory update_time
wenzelm@54456
   159
          (fn () => HTML.html_mode (implode o map Thy_Syntax.present_span) spans);
wenzelm@43712
   160
wenzelm@54526
   161
    val (results, thy) =
wenzelm@58849
   162
      cond_timeit true ("theory " ^ quote name)
wenzelm@58849
   163
        (fn () => excursion master_dir last_timing init elements);
wenzelm@43712
   164
wenzelm@51331
   165
    fun present () =
wenzelm@51331
   166
      let
wenzelm@51332
   167
        val res = filter_out (Toplevel.is_ignored o #1) (maps Toplevel.join_results results);
wenzelm@51331
   168
        val ((minor, _), outer_syntax) = Outer_Syntax.get_syntax ();
wenzelm@51331
   169
      in
wenzelm@51556
   170
        if exists (Toplevel.is_skipped_proof o #2) res then
wenzelm@51556
   171
          warning ("Cannot present theory with skipped proofs: " ^ quote name)
wenzelm@51556
   172
        else
wenzelm@54458
   173
          let val tex_source =
wenzelm@54458
   174
            Thy_Output.present_thy minor Keyword.command_tags
wenzelm@54458
   175
              (Outer_Syntax.is_markup outer_syntax) res toks
wenzelm@54458
   176
            |> Buffer.content;
wenzelm@54458
   177
          in if document then Present.theory_output name tex_source else () end
wenzelm@51331
   178
      end;
wenzelm@43712
   179
wenzelm@51331
   180
  in (thy, present, size text) end;
wenzelm@43712
   181
wenzelm@42002
   182
wenzelm@56135
   183
(* antiquotations *)
wenzelm@49244
   184
wenzelm@56135
   185
local
wenzelm@56135
   186
wenzelm@56135
   187
fun check_path strict ctxt dir (name, pos) =
wenzelm@54705
   188
  let
wenzelm@56034
   189
    val _ = Context_Position.report ctxt pos Markup.language_path;
wenzelm@56034
   190
wenzelm@55882
   191
    val path = Path.append dir (Path.explode name)
wenzelm@55882
   192
      handle ERROR msg => error (msg ^ Position.here pos);
wenzelm@55882
   193
wenzelm@56134
   194
    val _ = Context_Position.report ctxt pos (Markup.path (Path.smart_implode path));
wenzelm@54705
   195
    val _ =
wenzelm@55882
   196
      if can Path.expand path andalso File.exists path then ()
wenzelm@55882
   197
      else
wenzelm@55882
   198
        let
wenzelm@55882
   199
          val path' = perhaps (try Path.expand) path;
wenzelm@55882
   200
          val msg = "Bad file: " ^ Path.print path' ^ Position.here pos;
wenzelm@55882
   201
        in
wenzelm@55882
   202
          if strict then error msg
wenzelm@56294
   203
          else if Context_Position.is_visible ctxt then
wenzelm@56294
   204
            Output.report
wenzelm@56333
   205
              [Markup.markup (Markup.bad |> Markup.properties (Position.properties_of pos)) msg]
wenzelm@56294
   206
          else ()
wenzelm@55882
   207
        end;
wenzelm@56135
   208
  in path end;
wenzelm@56135
   209
wenzelm@56135
   210
fun file_antiq strict ctxt (name, pos) =
wenzelm@56135
   211
  let
wenzelm@56135
   212
    val dir = master_directory (Proof_Context.theory_of ctxt);
wenzelm@56135
   213
    val _ = check_path strict ctxt dir (name, pos);
wenzelm@54705
   214
  in
wenzelm@54705
   215
    space_explode "/" name
wenzelm@58716
   216
    |> map Latex.output_ascii
wenzelm@58716
   217
    |> space_implode (Latex.output_ascii "/" ^ "\\discretionary{}{}{}")
wenzelm@58741
   218
    |> enclose "\\isatt{" "}"
wenzelm@54705
   219
  end;
wenzelm@54705
   220
wenzelm@56135
   221
in
wenzelm@56135
   222
wenzelm@53171
   223
val _ = Theory.setup
wenzelm@56204
   224
 (Thy_Output.antiquotation @{binding file} (Scan.lift (Parse.position Parse.path))
wenzelm@54705
   225
    (file_antiq true o #context) #>
wenzelm@56204
   226
  Thy_Output.antiquotation @{binding file_unchecked} (Scan.lift (Parse.position Parse.path))
wenzelm@56135
   227
    (file_antiq false o #context) #>
wenzelm@56204
   228
  ML_Antiquotation.value @{binding path}
wenzelm@56135
   229
    (Args.context -- Scan.lift (Parse.position Parse.path) >> (fn (ctxt, arg) =>
wenzelm@56135
   230
      let val path = check_path true ctxt Path.current arg
wenzelm@56135
   231
      in "Path.explode " ^ ML_Syntax.print_string (Path.implode path) end)));
wenzelm@49244
   232
wenzelm@6168
   233
end;
wenzelm@56135
   234
wenzelm@56135
   235
end;