src/Pure/PIDE/resources.ML
author wenzelm
Mon Mar 16 16:26:02 2015 +0100 (2015-03-16 ago)
changeset 59718 5d0c539537c9
parent 59689 7968c57ea240
child 61379 c57820ceead3
permissions -rw-r--r--
tuned message -- include completion;
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@59718
    71
      error ("Bad theory name " ^ quote name ^
wenzelm@59718
    72
        " for file " ^ Path.print path ^ Position.here pos);
wenzelm@54525
    73
  in
wenzelm@54525
    74
   {master = (master_file, SHA1.digest text), text = text, theory_pos = pos,
wenzelm@54525
    75
    imports = imports, keywords = keywords}
wenzelm@54525
    76
  end;
wenzelm@54525
    77
wenzelm@54525
    78
wenzelm@54526
    79
(* load files *)
wenzelm@48898
    80
wenzelm@48898
    81
fun parse_files cmd =
wenzelm@48898
    82
  Scan.ahead Parse.not_eof -- Parse.path >> (fn (tok, name) => fn thy =>
wenzelm@48898
    83
    (case Token.get_files tok of
wenzelm@54526
    84
      [] =>
wenzelm@54526
    85
        let
wenzelm@58928
    86
          val keywords = Thy_Header.get_keywords thy;
wenzelm@54526
    87
          val master_dir = master_directory thy;
wenzelm@55708
    88
          val pos = Token.pos_of tok;
wenzelm@58923
    89
          val src_paths = Keyword.command_files keywords cmd (Path.explode name);
wenzelm@54526
    90
        in map (Command.read_file master_dir pos) src_paths end
wenzelm@54520
    91
    | files => map Exn.release files));
wenzelm@48869
    92
wenzelm@48906
    93
fun provide (src_path, id) =
wenzelm@48906
    94
  map_files (fn (master_dir, imports, provided) =>
wenzelm@48906
    95
    if AList.defined (op =) provided src_path then
wenzelm@48906
    96
      error ("Duplicate use of source file: " ^ Path.print src_path)
wenzelm@48906
    97
    else (master_dir, imports, (src_path, id) :: provided));
wenzelm@48906
    98
wenzelm@48906
    99
fun provide_parse_files cmd =
wenzelm@48906
   100
  parse_files cmd >> (fn files => fn thy =>
wenzelm@48906
   101
    let
wenzelm@48906
   102
      val fs = files thy;
wenzelm@55788
   103
      val thy' = fold (fn {src_path, digest, ...} => provide (src_path, digest)) fs thy;
wenzelm@48906
   104
    in (fs, thy') end);
wenzelm@48906
   105
wenzelm@43702
   106
fun load_file thy src_path =
wenzelm@43702
   107
  let
wenzelm@43702
   108
    val full_path = check_file (master_directory thy) src_path;
wenzelm@43702
   109
    val text = File.read full_path;
wenzelm@43702
   110
    val id = SHA1.digest text;
wenzelm@43702
   111
  in ((full_path, id), text) end;
wenzelm@43702
   112
wenzelm@54446
   113
fun loaded_files_current thy =
wenzelm@48886
   114
  #provided (Files.get thy) |>
wenzelm@48896
   115
    forall (fn (src_path, id) =>
wenzelm@43702
   116
      (case try (load_file thy) src_path of
wenzelm@37949
   117
        NONE => false
wenzelm@48886
   118
      | SOME ((_, id'), _) => id = id'));
wenzelm@37952
   119
wenzelm@37949
   120
wenzelm@54525
   121
(* load theory *)
wenzelm@37977
   122
wenzelm@51294
   123
fun begin_theory master_dir {name, imports, keywords} parents =
wenzelm@37977
   124
  Theory.begin_theory name parents
wenzelm@48888
   125
  |> put_deps master_dir imports
wenzelm@58928
   126
  |> Thy_Header.add_keywords keywords;
wenzelm@37977
   127
wenzelm@58923
   128
fun excursion keywords master_dir last_timing init elements =
wenzelm@46959
   129
  let
wenzelm@58928
   130
    fun prepare_span st span =
wenzelm@57905
   131
      Command_Span.content span
wenzelm@59689
   132
      |> Command.read keywords (Command.read_thy st) master_dir init ([], ~1)
wenzelm@51268
   133
      |> (fn tr => Toplevel.put_timing (last_timing tr) tr);
wenzelm@51217
   134
wenzelm@51268
   135
    fun element_result span_elem (st, _) =
wenzelm@46959
   136
      let
wenzelm@58928
   137
        val elem = Thy_Syntax.map_element (prepare_span st) span_elem;
wenzelm@58923
   138
        val (results, st') = Toplevel.element_result keywords elem st;
wenzelm@51273
   139
        val pos' = Toplevel.pos_of (Thy_Syntax.last_element elem);
wenzelm@51268
   140
      in (results, (st', pos')) end;
wenzelm@46959
   141
wenzelm@46959
   142
    val (results, (end_state, end_pos)) =
wenzelm@46959
   143
      fold_map element_result elements (Toplevel.toplevel, Position.none);
wenzelm@46959
   144
wenzelm@46959
   145
    val thy = Toplevel.end_theory end_pos end_state;
wenzelm@51273
   146
  in (results, thy) end;
wenzelm@46959
   147
wenzelm@54458
   148
fun load_thy document last_timing update_time master_dir header text_pos text parents =
wenzelm@43712
   149
  let
wenzelm@58918
   150
    val (name, _) = #name header;
wenzelm@58928
   151
    val keywords =
wenzelm@58928
   152
      fold (curry Keyword.merge_keywords o Thy_Header.get_keywords) parents
wenzelm@58928
   153
        (Keyword.add_keywords (#keywords header) Keyword.empty_keywords);
wenzelm@43712
   154
wenzelm@59083
   155
    val toks = Token.explode keywords text_pos text;
wenzelm@57905
   156
    val spans = Outer_Syntax.parse_spans toks;
wenzelm@58923
   157
    val elements = Thy_Syntax.parse_elements keywords spans;
wenzelm@43712
   158
wenzelm@54456
   159
    fun init () =
wenzelm@54456
   160
      begin_theory master_dir header parents
wenzelm@54456
   161
      |> Present.begin_theory update_time
wenzelm@59123
   162
          (fn () => HTML.html_mode (implode o map (Thy_Syntax.present_span keywords)) spans);
wenzelm@43712
   163
wenzelm@54526
   164
    val (results, thy) =
wenzelm@58849
   165
      cond_timeit true ("theory " ^ quote name)
wenzelm@58923
   166
        (fn () => excursion keywords master_dir last_timing init elements);
wenzelm@43712
   167
wenzelm@51331
   168
    fun present () =
wenzelm@51331
   169
      let
wenzelm@51332
   170
        val res = filter_out (Toplevel.is_ignored o #1) (maps Toplevel.join_results results);
wenzelm@51331
   171
      in
wenzelm@51556
   172
        if exists (Toplevel.is_skipped_proof o #2) res then
wenzelm@51556
   173
          warning ("Cannot present theory with skipped proofs: " ^ quote name)
wenzelm@51556
   174
        else
wenzelm@58928
   175
          let val tex_source = Thy_Output.present_thy thy res toks |> Buffer.content;
wenzelm@54458
   176
          in if document then Present.theory_output name tex_source else () end
wenzelm@51331
   177
      end;
wenzelm@43712
   178
wenzelm@51331
   179
  in (thy, present, size text) end;
wenzelm@43712
   180
wenzelm@42002
   181
wenzelm@56135
   182
(* antiquotations *)
wenzelm@49244
   183
wenzelm@56135
   184
local
wenzelm@56135
   185
wenzelm@56135
   186
fun check_path strict ctxt dir (name, pos) =
wenzelm@54705
   187
  let
wenzelm@56034
   188
    val _ = Context_Position.report ctxt pos Markup.language_path;
wenzelm@56034
   189
wenzelm@55882
   190
    val path = Path.append dir (Path.explode name)
wenzelm@55882
   191
      handle ERROR msg => error (msg ^ Position.here pos);
wenzelm@55882
   192
wenzelm@56134
   193
    val _ = Context_Position.report ctxt pos (Markup.path (Path.smart_implode path));
wenzelm@54705
   194
    val _ =
wenzelm@55882
   195
      if can Path.expand path andalso File.exists path then ()
wenzelm@55882
   196
      else
wenzelm@55882
   197
        let
wenzelm@55882
   198
          val path' = perhaps (try Path.expand) path;
wenzelm@55882
   199
          val msg = "Bad file: " ^ Path.print path' ^ Position.here pos;
wenzelm@55882
   200
        in
wenzelm@55882
   201
          if strict then error msg
wenzelm@56294
   202
          else if Context_Position.is_visible ctxt then
wenzelm@56294
   203
            Output.report
wenzelm@56333
   204
              [Markup.markup (Markup.bad |> Markup.properties (Position.properties_of pos)) msg]
wenzelm@56294
   205
          else ()
wenzelm@55882
   206
        end;
wenzelm@56135
   207
  in path end;
wenzelm@56135
   208
wenzelm@56135
   209
fun file_antiq strict ctxt (name, pos) =
wenzelm@56135
   210
  let
wenzelm@56135
   211
    val dir = master_directory (Proof_Context.theory_of ctxt);
wenzelm@56135
   212
    val _ = check_path strict ctxt dir (name, pos);
wenzelm@54705
   213
  in
wenzelm@54705
   214
    space_explode "/" name
wenzelm@58716
   215
    |> map Latex.output_ascii
wenzelm@58716
   216
    |> space_implode (Latex.output_ascii "/" ^ "\\discretionary{}{}{}")
wenzelm@58741
   217
    |> enclose "\\isatt{" "}"
wenzelm@54705
   218
  end;
wenzelm@54705
   219
wenzelm@56135
   220
in
wenzelm@56135
   221
wenzelm@53171
   222
val _ = Theory.setup
wenzelm@56204
   223
 (Thy_Output.antiquotation @{binding file} (Scan.lift (Parse.position Parse.path))
wenzelm@54705
   224
    (file_antiq true o #context) #>
wenzelm@56204
   225
  Thy_Output.antiquotation @{binding file_unchecked} (Scan.lift (Parse.position Parse.path))
wenzelm@56135
   226
    (file_antiq false o #context) #>
wenzelm@56204
   227
  ML_Antiquotation.value @{binding path}
wenzelm@56135
   228
    (Args.context -- Scan.lift (Parse.position Parse.path) >> (fn (ctxt, arg) =>
wenzelm@56135
   229
      let val path = check_path true ctxt Path.current arg
wenzelm@56135
   230
      in "Path.explode " ^ ML_Syntax.print_string (Path.implode path) end)));
wenzelm@49244
   231
wenzelm@6168
   232
end;
wenzelm@56135
   233
wenzelm@56135
   234
end;