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 list_mapi_acc f a l =
152 let rec aux k a res = function
153 | [] -> a, List.rev res
154 | h::tl -> let a,h = f h k a in aux (k+1) a (h::res) tl
163 | he::_ when p he -> Some (n,he)
164 | _::tl -> aux (n + 1) tl
169 let rec list_iter_default2 f l1 def l2 =
172 | a::ta, b::tb -> f a b; list_iter_default2 f ta def tb
173 | a::ta, [] -> f a def; list_iter_default2 f ta def []
176 let rec list_forall_default3 f l1 l2 def l3 =
180 | _, [], _ -> raise (Invalid_argument "list_forall_default3")
181 | a::ta, b::tb, c::tc -> f a b c && list_forall_default3 f ta tb def tc
182 | a::ta, b::tb, [] -> f a b def && list_forall_default3 f ta tb def []
185 exception FailureAt of int;;
187 let list_forall_default3_var f l1 l2 def l3 =
188 let rec aux f l1 l2 def l3 i =
192 | _, [], _ -> raise (Invalid_argument "list_forall_default3")
193 | a::ta, b::tb, c::tc ->
194 if f a b c then aux f ta tb def tc (i+1)
195 else raise (FailureAt i)
196 | a::ta, b::tb, [] ->
197 if f a b def then aux f ta tb def [] (i+1)
198 else raise (FailureAt i)
199 in aux f l1 l2 def l3 0
202 let sharing_map f l =
203 let unchanged = ref true in
204 let rec aux b = function
205 | [] as t -> unchanged := b; t
208 he1 :: aux (b && he1 == he) tl
210 let l1 = aux true l in
211 if !unchanged then l else l1
214 let sharing_map_acc f acc l =
215 let unchanged = ref true in
216 let final_acc = ref acc in
217 let rec aux b acc = function
218 | [] as t -> unchanged := b; final_acc := acc; t
220 let acc, he1 = f acc he in
221 he1 :: aux (b && he1 == he) acc tl
223 let l1 = aux true acc l in
224 !final_acc, if !unchanged then l else l1
227 let rec list_uniq ?(eq=(=)) = function
230 | h1::h2::tl when eq h1 h2 -> list_uniq ~eq (h2 :: tl)
231 | h1::tl (* when h1 <> h2 *) -> h1 :: list_uniq ~eq tl
233 let rec filter_map f =
238 | None -> filter_map f tl
239 | Some v -> v :: filter_map f tl)
241 let filter_map_acc f acc l =
247 | Some (acc, x) -> acc, x::res)
253 let filter_map_monad f acc l =
258 | acc, None -> acc, res
259 | acc, Some x -> acc, x::res)
265 let list_rev_map_filter f l =
266 let rec aux a = function
269 begin match f hd with
271 | Some b -> aux (b :: a) tl
276 let list_rev_map_filter_fold f v l =
277 let rec aux v a = function
280 begin match f v hd with
281 | v, None -> aux v a tl
282 | v, Some b -> aux v (b :: a) tl
287 let list_concat ?(sep = []) =
291 | [ last ] -> List.flatten (List.rev (last :: acc))
292 | hd :: tl -> aux ([sep; hd] @ acc) tl
296 let list_iter_sep ~sep f =
301 | hd :: tl -> f hd; sep (); aux tl
305 let rec list_findopt f l =
306 let rec aux k = function
310 | None -> aux (succ k) tl
311 | Some _ as rc -> rc)
316 let rec aux acc n l =
318 | 0, _ -> List.rev acc, l
319 | n, [] -> raise (Failure "HExtlib.split_nth")
320 | n, hd :: tl -> aux (hd :: acc) (n - 1) tl in
324 let l = List.rev l in
325 try List.hd l with exn -> raise (Failure "HExtlib.list_last")
328 let rec list_assoc_all a = function
330 | (x, y) :: tl when x = a -> y :: list_assoc_all a tl
331 | _ :: tl -> list_assoc_all a tl
334 (** {2 File predicates} *)
338 (Unix.stat fname).Unix.st_kind = Unix.S_DIR
339 with Unix.Unix_error _ -> false
341 let writable_dir path =
343 let file = path ^ "/prova_matita" in
344 let oc = open_out file in
348 with Sys_error _ -> false
351 let is_regular fname =
353 (Unix.stat fname).Unix.st_kind = Unix.S_REG
354 with Unix.Unix_error _ -> false
356 let is_executable fname =
358 let stat = (Unix.stat fname) in
359 stat.Unix.st_kind = Unix.S_REG &&
360 (stat.Unix.st_perm land 0o001 > 0)
361 with Unix.Unix_error _ -> false
363 let chmod mode filename =
364 Unix.chmod filename mode
367 let components = split ~sep:'/' path in
368 let rec aux where = function
372 if where = "" then piece else where ^ "/" ^ piece in
374 Unix.mkdir path 0o755; chmod 0o2775 path
376 | Unix.Unix_error (Unix.EEXIST,_,_) -> ()
377 | Unix.Unix_error (e,_,_) ->
380 ("Unix.mkdir " ^ path ^ " 0o2775 :" ^ (Unix.error_message e))));
383 let where = if path.[0] = '/' then "/" else "" in
386 (** {2 Filesystem} *)
388 let input_file fname =
389 let size = (Unix.stat fname).Unix.st_size in
390 let buf = Buffer.create size in
391 let ic = open_in fname in
392 Buffer.add_channel buf ic size;
398 let buf = Buffer.create size in
399 let s = String.create size in
402 let bytes = input ic s 0 size in
403 if bytes = 0 then raise End_of_file
404 else Buffer.add_substring buf s 0 bytes
406 with End_of_file -> ());
409 let output_file ~filename ~text =
410 let oc = open_out filename in
411 output_string oc text;
416 let len = String.length s in
417 let buf = Buffer.create 0 in
421 if Buffer.length buf > 0
422 then List.rev (Buffer.contents buf :: acc)
425 if is_blank s.[i] then
426 if Buffer.length buf > 0 then begin
427 let s = Buffer.contents buf in
429 aux (s :: acc) (i + 1)
433 Buffer.add_char buf s.[i];
440 (* Rules: * "~name" -> home dir of "name"
441 * "~" -> value of $HOME if defined, home dir of the current user otherwise *)
443 let get_home login = (Unix.getpwnam login).Unix.pw_dir in
445 let len = String.length s in
446 if len > 0 && s.[0] = '~' then begin
447 let login_len = ref 1 in
448 while !login_len < len && is_alphanum (s.[!login_len]) do
451 let login = String.sub s 1 (!login_len - 1) in
455 try Sys.getenv "HOME" with Not_found -> get_home (Unix.getlogin ())
459 home ^ String.sub s !login_len (len - !login_len)
460 with Not_found | Invalid_argument _ -> s
464 String.concat " " (List.map expand_one (blank_split s))
466 let find ?(test = fun _ -> true) path =
467 let rec aux acc todo =
472 let handle = Unix.opendir path in
474 let matching_files = ref [] in
477 match Unix.readdir handle with
480 let qentry = path ^ "/" ^ entry in
482 if is_dir qentry then
483 dirs := qentry :: !dirs
484 else if test qentry then
485 matching_files := qentry :: !matching_files;
486 with Unix.Unix_error _ -> ())
488 with End_of_file -> Unix.closedir handle);
489 aux (!matching_files @ acc) (!dirs @ tl)
490 with Unix.Unix_error _ -> aux acc tl
494 let safe_remove fname = if Sys.file_exists fname then Sys.remove fname
498 let od = Unix.opendir d in
500 let name = Unix.readdir od in
501 if name <> "." && name <> ".." then false else aux () in
502 let res = try aux () with End_of_file -> true in
506 Unix.Unix_error _ -> true (* raised by Unix.opendir, we hope :-) *)
508 let safe_rmdir d = try Unix.rmdir d with Unix.Unix_error _ -> ()
510 let rec rmdir_descend d =
511 if is_dir_empty d then
514 rmdir_descend (Filename.dirname d)
518 (** {2 Exception handling} *)
520 let finally at_end f arg =
523 with exn -> at_end (); raise exn
528 (** {2 Localized exceptions } *)
530 exception Localized of Stdpp.location * exn
532 let loc_of_floc floc = Stdpp.first_pos floc, Stdpp.last_pos floc;;
534 let floc_of_loc (loc_begin, loc_end) =
535 Stdpp.make_loc (loc_begin, loc_end)
537 let dummy_floc = floc_of_loc (0, 0)
539 let raise_localized_exception ~offset floc exn =
540 let x, y = loc_of_floc floc in
541 let x = offset + x in
542 let y = offset + y in
543 let floc = floc_of_loc (x,y) in
544 raise (Localized (floc, exn))
546 let estimate_size x =
547 4 * (String.length (Marshal.to_string x [])) / 1024
549 let normalize_path s =
550 let s = Str.global_replace (Str.regexp "//") "/" s in
551 let l = Str.split (Str.regexp "/") s in
552 let rec aux acc = function
554 | he::"."::tl -> aux acc (he::tl)
555 | he::".."::tl when he <> ".." -> aux [] (acc @ tl)
556 | he::tl -> aux (acc@[he]) tl
558 (if Str.string_match (Str.regexp "^/") s 0 then "/" else "") ^
559 String.concat "/" (aux [] l)
560 ^ (if Str.string_match (Str.regexp "/$") s 0 then "/" else "")
563 let find_in paths path =
564 let rec aux = function
565 | [] -> raise (Failure "find_in")
567 let path = normalize_path (p ^ "/" ^ path) in
569 if (Unix.stat path).Unix.st_kind = Unix.S_REG then path
571 with Unix.Unix_error _ ->
576 with Unix.Unix_error _ | Failure _ ->
581 let is_prefix_of_aux d1 d2 =
582 let len1 = String.length d1 in
583 let len2 = String.length d2 in
587 let pref = String.sub d2 0 len1 in
588 pref = d1 && (len1 = len2 || d1.[len1-1] = '/' || d2.[len1] = '/'), len1, len2
590 let is_prefix_of d1 d2 =
591 let b,_,_ = is_prefix_of_aux d1 d2 in b
594 let chop_prefix prefix s =
595 let b,lp,ls = is_prefix_of_aux prefix s in
597 String.sub s lp (ls - lp)
603 try close_out(open_out s) with Sys_error _ -> ()
606 let rec mk_list x = function
608 | n -> x :: mk_list x (n-1)
611 let list_seq start stop =
612 if start > stop then [] else
614 if pos = stop then []
615 else pos :: (aux (pos+1))
620 let rec list_skip n l =
623 | n,_::l -> list_skip (n-1) l
624 | _, [] -> assert false