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 let profiling_enabled = ref false ;; (* ComponentsConf.profiling *)
32 let something_profiled = ref false
35 if !something_profiled then
39 (Printf.sprintf "!! %39s ---------- --------- --------- ---------"
40 (String.make 39 '-'));
42 (Printf.sprintf "!! %-39s %10s %9s %9s %9s"
43 "function" "#calls" "total" "max" "average"))
45 let profiling_printings = ref (fun _ -> true)
46 let set_profiling_printings f = profiling_printings := f
48 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
49 let profile ?(enable = true) s =
50 if !profiling_enabled && enable then
51 let total = ref 0.0 in
55 if not !profiling_enabled then f x else
56 let before = Unix.gettimeofday () in
60 let after = Unix.gettimeofday () in
61 let delta = after -. before in
62 total := !total +. delta;
63 if delta > !max then max := delta;
67 let after = Unix.gettimeofday () in
68 let delta = after -. before in
69 total := !total +. delta;
70 if delta > !max then max := delta;
75 if !profiling_printings s && !calls <> 0 then
77 something_profiled := true;
79 (Printf.sprintf "!! %-39s %10d %9.4f %9.4f %9.4f"
80 s !calls !total !max (!total /. (float_of_int !calls)))
84 { profile = fun f x -> f x }
86 (** {2 Optional values} *)
88 let map_option f = function None -> None | Some v -> Some (f v)
89 let iter_option f = function None -> () | Some v -> f v
90 let unopt = function None -> failwith "unopt: None" | Some v -> v
92 (** {2 String processing} *)
94 let split ?(sep = ' ') s =
95 let pieces = ref [] in
97 match (try Some (String.index_from s idx sep) with Not_found -> None) with
99 pieces := String.sub s idx (pos - idx) :: !pieces;
101 | None -> pieces := String.sub s idx (String.length s - idx) :: !pieces
107 let rec find_left idx =
109 | ' ' | '\t' | '\r' | '\n' -> find_left (idx + 1)
112 let rec find_right idx =
114 | ' ' | '\t' | '\r' | '\n' -> find_right (idx - 1)
117 let s_len = String.length s in
118 let left, right = find_left 0, find_right (s_len - 1) in
119 String.sub s left (right - left + 1)
121 (** {2 Char processing} *)
124 let code = Char.code c in
125 (code >= 65 && code <= 90) || (code >= 97 && code <= 122)
128 let code = Char.code c in
129 code >= 48 && code <= 57
132 let code = Char.code c in
133 code = 9 || code = 10 || code = 13 || code = 32
135 let is_alphanum c = is_alpha c || is_digit c
137 (** {2 List processing} *)
139 let flatten_map f l =
140 List.flatten (List.map f l)
144 let rec aux k = function
146 | h::tl -> f h k :: aux (k+1) tl
151 let sharing_map f l =
152 let unchanged = ref true in
153 let rec aux b = function
154 | [] as t -> unchanged := b; t
157 he1 :: aux (b && he1 == he) tl
159 let l1 = aux true l in
160 if !unchanged then l else l1
163 let rec list_uniq ?(eq=(=)) = function
166 | h1::h2::tl when eq h1 h2 -> list_uniq ~eq (h2 :: tl)
167 | h1::tl (* when h1 <> h2 *) -> h1 :: list_uniq ~eq tl
169 let rec filter_map f =
174 | None -> filter_map f tl
175 | Some v -> v :: filter_map f tl)
177 let list_rev_map_filter f l =
178 let rec aux a = function
181 begin match f hd with
183 | Some b -> aux (b :: a) tl
188 let list_rev_map_filter_fold f v l =
189 let rec aux v a = function
192 begin match f v hd with
193 | v, None -> aux v a tl
194 | v, Some b -> aux v (b :: a) tl
199 let list_concat ?(sep = []) =
203 | [ last ] -> List.flatten (List.rev (last :: acc))
204 | hd :: tl -> aux ([sep; hd] @ acc) tl
208 let rec list_findopt f l =
209 let rec aux = function
214 | Some _ as rc -> rc)
219 let rec aux acc n l =
221 | 0, _ -> List.rev acc, l
222 | n, [] -> raise (Failure "HExtlib.split_nth")
223 | n, hd :: tl -> aux (hd :: acc) (n - 1) tl in
227 let l = List.rev l in
228 try List.hd l with exn -> raise (Failure "HExtlib.list_last")
231 (** {2 File predicates} *)
235 (Unix.stat fname).Unix.st_kind = Unix.S_DIR
236 with Unix.Unix_error _ -> false
238 let writable_dir path =
240 let file = path ^ "/prova_matita" in
241 let oc = open_out file in
245 with Sys_error _ -> false
248 let is_regular fname =
250 (Unix.stat fname).Unix.st_kind = Unix.S_REG
251 with Unix.Unix_error _ -> false
253 let is_executable fname =
255 let stat = (Unix.stat fname) in
256 stat.Unix.st_kind = Unix.S_REG &&
257 (stat.Unix.st_perm land 0o001 > 0)
258 with Unix.Unix_error _ -> false
260 let chmod mode filename =
261 Unix.chmod filename mode
264 let components = split ~sep:'/' path in
265 let rec aux where = function
269 if where = "" then piece else where ^ "/" ^ piece in
271 Unix.mkdir path 0o755; chmod 0o2775 path
273 | Unix.Unix_error (Unix.EEXIST,_,_) -> ()
274 | Unix.Unix_error (e,_,_) ->
277 ("Unix.mkdir " ^ path ^ " 0o2775 :" ^ (Unix.error_message e))));
280 let where = if path.[0] = '/' then "/" else "" in
283 (** {2 Filesystem} *)
285 let input_file fname =
286 let size = (Unix.stat fname).Unix.st_size in
287 let buf = Buffer.create size in
288 let ic = open_in fname in
289 Buffer.add_channel buf ic size;
295 let buf = Buffer.create size in
296 let s = String.create size in
299 let bytes = input ic s 0 size in
300 if bytes = 0 then raise End_of_file
301 else Buffer.add_substring buf s 0 bytes
303 with End_of_file -> ());
306 let output_file ~filename ~text =
307 let oc = open_out filename in
308 output_string oc text;
313 let len = String.length s in
314 let buf = Buffer.create 0 in
318 if Buffer.length buf > 0
319 then List.rev (Buffer.contents buf :: acc)
322 if is_blank s.[i] then
323 if Buffer.length buf > 0 then begin
324 let s = Buffer.contents buf in
326 aux (s :: acc) (i + 1)
330 Buffer.add_char buf s.[i];
337 (* Rules: * "~name" -> home dir of "name"
338 * "~" -> value of $HOME if defined, home dir of the current user otherwise *)
340 let get_home login = (Unix.getpwnam login).Unix.pw_dir in
342 let len = String.length s in
343 if len > 0 && s.[0] = '~' then begin
344 let login_len = ref 1 in
345 while !login_len < len && is_alphanum (s.[!login_len]) do
348 let login = String.sub s 1 (!login_len - 1) in
352 try Sys.getenv "HOME" with Not_found -> get_home (Unix.getlogin ())
356 home ^ String.sub s !login_len (len - !login_len)
357 with Not_found | Invalid_argument _ -> s
361 String.concat " " (List.map expand_one (blank_split s))
363 let find ?(test = fun _ -> true) path =
364 let rec aux acc todo =
369 let handle = Unix.opendir path in
371 let matching_files = ref [] in
374 match Unix.readdir handle with
377 let qentry = path ^ "/" ^ entry in
379 if is_dir qentry then
380 dirs := qentry :: !dirs
381 else if test qentry then
382 matching_files := qentry :: !matching_files;
383 with Unix.Unix_error _ -> ())
385 with End_of_file -> Unix.closedir handle);
386 aux (!matching_files @ acc) (!dirs @ tl)
387 with Unix.Unix_error _ -> aux acc tl
391 let safe_remove fname = if Sys.file_exists fname then Sys.remove fname
395 let od = Unix.opendir d in
397 let name = Unix.readdir od in
398 if name <> "." && name <> ".." then false else aux () in
399 let res = try aux () with End_of_file -> true in
403 Unix.Unix_error _ -> true (* raised by Unix.opendir, we hope :-) *)
405 let safe_rmdir d = try Unix.rmdir d with Unix.Unix_error _ -> ()
407 let rec rmdir_descend d =
408 if is_dir_empty d then
411 rmdir_descend (Filename.dirname d)
415 (** {2 Exception handling} *)
417 let finally at_end f arg =
420 with exn -> at_end (); raise exn
425 (** {2 Localized exceptions } *)
427 exception Localized of Stdpp.location * exn
429 let loc_of_floc floc = Stdpp.first_pos floc, Stdpp.last_pos floc;;
431 let floc_of_loc (loc_begin, loc_end) =
432 Stdpp.make_loc (loc_begin, loc_end)
434 let dummy_floc = floc_of_loc (-1, -1)
436 let raise_localized_exception ~offset floc exn =
437 let x, y = loc_of_floc floc in
438 let x = offset + x in
439 let y = offset + y in
440 let floc = floc_of_loc (x,y) in
441 raise (Localized (floc, exn))
443 let estimate_size x =
444 4 * (String.length (Marshal.to_string x [])) / 1024
446 let normalize_path s =
447 let s = Str.global_replace (Str.regexp "//") "/" s in
448 let l = Str.split (Str.regexp "/") s in
449 let rec aux acc = function
451 | he::"."::tl -> aux acc (he::tl)
452 | he::".."::tl when he <> ".." -> aux [] (acc @ tl)
453 | he::tl -> aux (acc@[he]) tl
455 (if Str.string_match (Str.regexp "^/") s 0 then "/" else "") ^
456 String.concat "/" (aux [] l)
457 ^ (if Str.string_match (Str.regexp "/$") s 0 then "/" else "")
460 let find_in paths path =
461 let rec aux = function
462 | [] -> raise (Failure "find_in")
464 let path = normalize_path (p ^ "/" ^ path) in
466 if (Unix.stat path).Unix.st_kind = Unix.S_REG then path
468 with Unix.Unix_error _ ->
473 with Unix.Unix_error _ | Failure _ ->
478 let is_prefix_of_aux d1 d2 =
479 let len1 = String.length d1 in
480 let len2 = String.length d2 in
484 let pref = String.sub d2 0 len1 in
485 pref = d1 && (len1 = len2 || d1.[len1-1] = '/' || d2.[len1] = '/'), len1, len2
487 let is_prefix_of d1 d2 =
488 let b,_,_ = is_prefix_of_aux d1 d2 in b
491 let chop_prefix prefix s =
492 let b,lp,ls = is_prefix_of_aux prefix s in
494 String.sub s lp (ls - lp)
500 try close_out(open_out s) with Sys_error _ -> ()