src/Pure/Thy/thy_load.ML
author wenzelm
Tue Sep 29 11:49:22 2009 +0200 (2009-09-29)
changeset 32738 15bb09ca0378
parent 32466 a393b7e2a2f8
child 32811 a692298ecbe0
permissions -rw-r--r--
explicit indication of Unsynchronized.ref;
wenzelm@6168
     1
(*  Title:      Pure/Thy/thy_load.ML
wenzelm@6168
     2
    Author:     Markus Wenzel, TU Muenchen
wenzelm@6168
     3
wenzelm@15801
     4
Theory loader primitives, including load path.
wenzelm@6168
     5
*)
wenzelm@6168
     6
wenzelm@6168
     7
signature BASIC_THY_LOAD =
wenzelm@6168
     8
sig
wenzelm@6168
     9
  val show_path: unit -> string list
wenzelm@6168
    10
  val add_path: string -> unit
wenzelm@10252
    11
  val path_add: string -> unit
wenzelm@6168
    12
  val del_path: string -> unit
wenzelm@7438
    13
  val with_path: string -> ('a -> 'b) -> 'a -> 'b
wenzelm@9103
    14
  val with_paths: string list -> ('a -> 'b) -> 'a -> 'b
wenzelm@6205
    15
  val reset_path: unit -> unit
wenzelm@6168
    16
end;
wenzelm@6168
    17
wenzelm@6168
    18
signature THY_LOAD =
wenzelm@6168
    19
sig
wenzelm@6168
    20
  include BASIC_THY_LOAD
wenzelm@17366
    21
  val ml_exts: string list
wenzelm@6205
    22
  val ml_path: string -> Path.T
wenzelm@7901
    23
  val thy_path: string -> Path.T
wenzelm@29418
    24
  val split_thy_path: Path.T -> Path.T * string
wenzelm@23885
    25
  val check_file: Path.T -> Path.T -> (Path.T * File.ident) option
wenzelm@23885
    26
  val check_ml: Path.T -> Path.T -> (Path.T * File.ident) option
wenzelm@24189
    27
  val check_thy: Path.T -> string -> Path.T * File.ident
wenzelm@29515
    28
  val check_name: string -> string -> unit
wenzelm@24189
    29
  val deps_thy: Path.T -> string ->
wenzelm@24189
    30
   {master: Path.T * File.ident, text: string list, imports: string list, uses: Path.T list}
wenzelm@23885
    31
  val load_ml: Path.T -> Path.T -> Path.T * File.ident
wenzelm@6168
    32
end;
wenzelm@6168
    33
wenzelm@26616
    34
structure ThyLoad: THY_LOAD =
wenzelm@6168
    35
struct
wenzelm@6168
    36
wenzelm@6168
    37
wenzelm@6232
    38
(* maintain load path *)
wenzelm@6168
    39
wenzelm@32738
    40
local val load_path = Unsynchronized.ref [Path.current] in
wenzelm@6168
    41
wenzelm@21858
    42
fun show_path () = map Path.implode (! load_path);
wenzelm@23944
    43
wenzelm@32738
    44
fun del_path s = CRITICAL (fn () =>
wenzelm@32738
    45
    Unsynchronized.change load_path (remove (op =) (Path.explode s)));
wenzelm@32738
    46
fun add_path s = CRITICAL (fn () =>
wenzelm@32738
    47
    (del_path s; Unsynchronized.change load_path (cons (Path.explode s))));
wenzelm@32738
    48
fun path_add s = CRITICAL (fn () =>
wenzelm@32738
    49
    (del_path s; Unsynchronized.change load_path (fn path => path @ [Path.explode s])));
wenzelm@6205
    50
fun reset_path () = load_path := [Path.current];
wenzelm@23944
    51
wenzelm@23944
    52
fun with_paths ss f x =
wenzelm@23944
    53
  CRITICAL (fn () => Library.setmp load_path (! load_path @ map Path.explode ss) f x);
wenzelm@9655
    54
fun with_path s f x = with_paths [s] f x;
wenzelm@6168
    55
wenzelm@23944
    56
fun search_path dir path =
wenzelm@23944
    57
  distinct (op =) (dir :: (if Path.is_basic path then (! load_path) else [Path.current]));
wenzelm@23944
    58
wenzelm@23944
    59
end;
wenzelm@23944
    60
wenzelm@6168
    61
wenzelm@6232
    62
(* file formats *)
wenzelm@6168
    63
wenzelm@23872
    64
val ml_exts = ["ML", "sml"];
wenzelm@6232
    65
val ml_path = Path.ext "ML" o Path.basic;
wenzelm@6232
    66
val thy_path = Path.ext "thy" o Path.basic;
wenzelm@6168
    67
wenzelm@29418
    68
fun split_thy_path path =
wenzelm@29418
    69
  (case Path.split_ext path of
wenzelm@29418
    70
    (path', "thy") => (Path.dir path', Path.implode (Path.base path'))
wenzelm@29418
    71
  | _ => error ("Bad theory file specification " ^ Path.implode path));
wenzelm@29418
    72
wenzelm@6168
    73
wenzelm@23872
    74
(* check files *)
wenzelm@6232
    75
wenzelm@23944
    76
fun check_ext exts paths dir src_path =
wenzelm@6232
    77
  let
wenzelm@6232
    78
    val path = Path.expand src_path;
wenzelm@23872
    79
    val _ = Path.is_current path andalso error "Bad file specification";
wenzelm@6168
    80
wenzelm@23885
    81
    fun try_ext rel_path ext =
wenzelm@8750
    82
      let val ext_path = Path.expand (Path.ext ext rel_path)
wenzelm@23872
    83
      in Option.map (fn id => (File.full_path ext_path, id)) (File.ident ext_path) end;
wenzelm@23885
    84
    fun try_prfx prfx = get_first (try_ext (Path.append prfx path)) ("" :: exts);
wenzelm@23944
    85
  in get_first try_prfx paths end;
wenzelm@6232
    86
wenzelm@23944
    87
fun check_file dir path = check_ext [] (search_path dir path) dir path;
wenzelm@23944
    88
fun check_ml dir path = check_ext ml_exts (search_path dir path) dir path;
wenzelm@6168
    89
wenzelm@24189
    90
fun check_thy dir name =
wenzelm@23944
    91
  let
wenzelm@23944
    92
    val thy_file = thy_path name;
wenzelm@23944
    93
    val paths = search_path dir thy_file;
wenzelm@23944
    94
  in
wenzelm@23944
    95
    (case check_ext [] paths dir thy_file of
wenzelm@23872
    96
      NONE => error ("Could not find theory file " ^ quote (Path.implode thy_file) ^
wenzelm@23944
    97
        " in " ^ commas_quote (map Path.implode paths))
wenzelm@24189
    98
    | SOME thy_id => thy_id)
wenzelm@23872
    99
  end;
wenzelm@6232
   100
wenzelm@29515
   101
fun check_name name name' =
wenzelm@29515
   102
  if name = name' then ()
wenzelm@29515
   103
  else error ("Filename " ^ quote (Path.implode (thy_path name)) ^
wenzelm@29515
   104
    " does not agree with theory name " ^ quote name');
wenzelm@29515
   105
wenzelm@6232
   106
wenzelm@23872
   107
(* theory deps *)
wenzelm@7940
   108
wenzelm@24189
   109
fun deps_thy dir name =
wenzelm@23872
   110
  let
wenzelm@24189
   111
    val master as (path, _) = check_thy dir name;
wenzelm@24065
   112
    val text = explode (File.read path);
wenzelm@23872
   113
    val (name', imports, uses) =
wenzelm@32466
   114
      Thy_Header.read (Path.position path) (Source.of_list_limited 8000 text);
wenzelm@29515
   115
    val _ = check_name name name';
wenzelm@24189
   116
    val uses = map (Path.explode o #1) uses;
wenzelm@24065
   117
  in {master = master, text = text, imports = imports, uses = uses} end;
wenzelm@6484
   118
wenzelm@6168
   119
wenzelm@23872
   120
(* load files *)
wenzelm@6168
   121
wenzelm@23885
   122
fun load_ml dir raw_path =
wenzelm@23885
   123
  (case check_ml dir raw_path of
wenzelm@23872
   124
    NONE => error ("Could not find ML file " ^ quote (Path.implode raw_path))
wenzelm@26455
   125
  | SOME (path, id) => (ML_Context.eval_file path; (path, id)));
wenzelm@6168
   126
wenzelm@6168
   127
end;
wenzelm@6168
   128
wenzelm@32738
   129
structure Basic_Thy_Load: BASIC_THY_LOAD = ThyLoad;
wenzelm@32738
   130
open Basic_Thy_Load;