1 (* Copyright (C) 2005, HELM Team.
3 * This file is part of HELM, an Hypertextual, Electronic
4 * Library of Mathematics, developed at the Computer Science
5 * Department, University of Bologna, Italy.
7 * HELM is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * HELM is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with HELM; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
22 * For details, see the HELM World-Wide-Web page,
23 * http://cs.unibo.it/helm/.
30 (* we should use a key in te registry, but we can't see the registry.. *)
31 let profiling_enabled = true
33 let profiling_printings = ref (fun () -> true)
34 let set_profiling_printings f = profiling_printings := f
36 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
37 let profile ?(enable = true) =
38 if profiling_enabled && enable then
40 let total = ref 0.0 in
42 let before = Unix.gettimeofday () in
45 let after = Unix.gettimeofday () in
46 total := !total +. (after -. before);
50 let after = Unix.gettimeofday () in
51 total := !total +. (after -. before);
56 if !profiling_printings () then
58 ("!! TOTAL TIME SPENT IN " ^ s ^ ": " ^ string_of_float !total));
61 function _ -> { profile = fun f x -> f x }
63 (** {2 Optional values} *)
65 let map_option f = function None -> None | Some v -> Some (f v)
66 let iter_option f = function None -> () | Some v -> f v
67 let unopt = function None -> failwith "unopt: None" | Some v -> v
69 (** {2 String processing} *)
71 let split ?(sep = ' ') s =
72 let pieces = ref [] in
74 match (try Some (String.index_from s idx sep) with Not_found -> None) with
76 pieces := String.sub s idx (pos - idx) :: !pieces;
78 | None -> pieces := String.sub s idx (String.length s - idx) :: !pieces
84 let rec find_left idx =
86 | ' ' | '\t' | '\r' | '\n' -> find_left (idx + 1)
89 let rec find_right idx =
91 | ' ' | '\t' | '\r' | '\n' -> find_right (idx - 1)
94 let s_len = String.length s in
95 let left, right = find_left 0, find_right (s_len - 1) in
96 String.sub s left (right - left + 1)
98 (** {2 Char processing} *)
101 let code = Char.code c in
102 (code >= 65 && code <= 90) || (code >= 97 && code <= 122)
105 let code = Char.code c in
106 code >= 48 && code <= 57
109 let code = Char.code c in
110 code = 9 || code = 10 || code = 13 || code = 32
112 let is_alphanum c = is_alpha c || is_digit c
114 (** {2 List processing} *)
116 let rec list_uniq ?(eq=(=)) = function
119 | h1::h2::tl when eq h1 h2 -> list_uniq ~eq (h2 :: tl)
120 | h1::tl (* when h1 <> h2 *) -> h1 :: list_uniq ~eq tl
122 let rec filter_map f =
127 | None -> filter_map f tl
128 | Some v -> v :: filter_map f tl)
130 let list_concat ?(sep = []) =
134 | [ last ] -> List.flatten (List.rev (last :: acc))
135 | hd :: tl -> aux ([sep; hd] @ acc) tl
139 let rec list_findopt f l =
140 let rec aux = function
145 | Some _ as rc -> rc)
149 (** {2 File predicates} *)
153 (Unix.stat fname).Unix.st_kind = Unix.S_DIR
154 with Unix.Unix_error _ -> false
156 let is_regular fname =
158 (Unix.stat fname).Unix.st_kind = Unix.S_REG
159 with Unix.Unix_error _ -> false
162 let components = split ~sep:'/' path in
163 let rec aux where = function
166 let path = where ^ "/" ^ piece in
168 Unix.mkdir path 0o755
170 | Unix.Unix_error (Unix.EEXIST,_,_) -> ()
171 | Unix.Unix_error (e,_,_) ->
174 ("Unix.mkdir " ^ path ^ " 0o755 :" ^ (Unix.error_message e))));
179 (** {2 Filesystem} *)
181 let input_file fname =
182 let size = (Unix.stat fname).Unix.st_size in
183 let buf = Buffer.create size in
184 let ic = open_in fname in
185 Buffer.add_channel buf ic size;
191 let buf = Buffer.create size in
192 let s = String.create size in
195 let bytes = input ic s 0 size in
196 if bytes = 0 then raise End_of_file
197 else Buffer.add_substring buf s 0 bytes
199 with End_of_file -> ());
202 let output_file ~filename ~text =
203 let oc = open_out filename in
204 output_string oc text;
208 let len = String.length s in
209 let buf = Buffer.create 0 in
213 if Buffer.length buf > 0
214 then List.rev (Buffer.contents buf :: acc)
217 if is_blank s.[i] then
218 if Buffer.length buf > 0 then begin
219 let s = Buffer.contents buf in
221 aux (s :: acc) (i + 1)
225 Buffer.add_char buf s.[i];
232 (* Rules: * "~name" -> home dir of "name"
233 * "~" -> value of $HOME if defined, home dir of the current user otherwise *)
235 let get_home login = (Unix.getpwnam login).Unix.pw_dir in
237 let len = String.length s in
238 if len > 0 && s.[0] = '~' then begin
239 let login_len = ref 1 in
240 while !login_len < len && is_alphanum (s.[!login_len]) do
243 let login = String.sub s 1 (!login_len - 1) in
247 try Sys.getenv "HOME" with Not_found -> get_home (Unix.getlogin ())
251 home ^ String.sub s !login_len (len - !login_len)
252 with Not_found | Invalid_argument _ -> s
256 String.concat " " (List.map expand_one (blank_split s))
258 let find ?(test = fun _ -> true) path =
259 let rec aux acc todo =
264 let handle = Unix.opendir path in
266 let matching_files = ref [] in
269 match Unix.readdir handle with
272 let qentry = path ^ "/" ^ entry in
274 if is_dir qentry then
275 dirs := qentry :: !dirs
276 else if test qentry then
277 matching_files := qentry :: !matching_files;
278 with Unix.Unix_error _ -> ())
280 with End_of_file -> Unix.closedir handle);
281 aux (!matching_files @ acc) (!dirs @ tl)
282 with Unix.Unix_error _ -> aux acc tl
286 let safe_remove fname = if Sys.file_exists fname then Sys.remove fname
289 let od = Unix.opendir d in
291 let name = Unix.readdir od in
292 if name <> "." && name <> ".." then false else aux () in
293 let res = try aux () with End_of_file -> true in
297 let safe_rmdir d = try Unix.rmdir d with Unix.Unix_error _ -> ()
299 let rec rmdir_descend d =
300 if is_dir_empty d then
303 rmdir_descend (Filename.dirname d)
307 (** {2 Exception handling} *)
309 let finally at_end f arg =
312 with exn -> at_end (); raise exn
317 (** {2 Localized exceptions } *)
319 exception Localized of Token.flocation * exn
321 let loc_of_floc = function
322 | { Lexing.pos_cnum = loc_begin }, { Lexing.pos_cnum = loc_end } ->
325 let floc_of_loc (loc_begin, loc_end) =
327 { Lexing.pos_fname = ""; Lexing.pos_lnum = -1; Lexing.pos_bol = -1;
328 Lexing.pos_cnum = loc_begin }
330 let floc_end = { floc_begin with Lexing.pos_cnum = loc_end } in
331 (floc_begin, floc_end)
333 let dummy_floc = floc_of_loc (-1, -1)
335 let raise_localized_exception ~offset floc exn =
336 let (x, y) = loc_of_floc floc in
337 let x = offset + x in
338 let y = offset + y in
339 let flocb,floce = floc in
341 { flocb with Lexing.pos_cnum = x }, { floce with Lexing.pos_cnum = y }
343 raise (Localized (floc, exn))