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 = ComponentsConf.profiling
32 let profiling_printings = ref (fun () -> true)
33 let set_profiling_printings f = profiling_printings := f
35 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
36 let profile ?(enable = true) =
37 if profiling_enabled && enable then
39 let total = ref 0.0 in
42 let before = Unix.gettimeofday () in
46 let after = Unix.gettimeofday () in
47 total := !total +. (after -. before);
51 let after = Unix.gettimeofday () in
52 total := !total +. (after -. before);
57 if !profiling_printings () && !total <> 0. then
59 ("!! TOTAL TIME SPENT IN " ^ s ^ " ("^string_of_int !calls^"): " ^ string_of_float !total));
62 function _ -> { profile = fun f x -> f x }
64 (** {2 Optional values} *)
66 let map_option f = function None -> None | Some v -> Some (f v)
67 let iter_option f = function None -> () | Some v -> f v
68 let unopt = function None -> failwith "unopt: None" | Some v -> v
70 (** {2 String processing} *)
72 let split ?(sep = ' ') s =
73 let pieces = ref [] in
75 match (try Some (String.index_from s idx sep) with Not_found -> None) with
77 pieces := String.sub s idx (pos - idx) :: !pieces;
79 | None -> pieces := String.sub s idx (String.length s - idx) :: !pieces
85 let rec find_left idx =
87 | ' ' | '\t' | '\r' | '\n' -> find_left (idx + 1)
90 let rec find_right idx =
92 | ' ' | '\t' | '\r' | '\n' -> find_right (idx - 1)
95 let s_len = String.length s in
96 let left, right = find_left 0, find_right (s_len - 1) in
97 String.sub s left (right - left + 1)
99 (** {2 Char processing} *)
102 let code = Char.code c in
103 (code >= 65 && code <= 90) || (code >= 97 && code <= 122)
106 let code = Char.code c in
107 code >= 48 && code <= 57
110 let code = Char.code c in
111 code = 9 || code = 10 || code = 13 || code = 32
113 let is_alphanum c = is_alpha c || is_digit c
115 (** {2 List processing} *)
117 let rec list_uniq ?(eq=(=)) = function
120 | h1::h2::tl when eq h1 h2 -> list_uniq ~eq (h2 :: tl)
121 | h1::tl (* when h1 <> h2 *) -> h1 :: list_uniq ~eq tl
123 let rec filter_map f =
128 | None -> filter_map f tl
129 | Some v -> v :: filter_map f tl)
131 let list_concat ?(sep = []) =
135 | [ last ] -> List.flatten (List.rev (last :: acc))
136 | hd :: tl -> aux ([sep; hd] @ acc) tl
140 let rec list_findopt f l =
141 let rec aux = function
146 | Some _ as rc -> rc)
150 (** {2 File predicates} *)
154 (Unix.stat fname).Unix.st_kind = Unix.S_DIR
155 with Unix.Unix_error _ -> false
157 let is_regular fname =
159 (Unix.stat fname).Unix.st_kind = Unix.S_REG
160 with Unix.Unix_error _ -> false
163 let components = split ~sep:'/' path in
164 let rec aux where = function
168 if where = "" then piece else where ^ "/" ^ piece in
170 Unix.mkdir path 0o755
172 | Unix.Unix_error (Unix.EEXIST,_,_) -> ()
173 | Unix.Unix_error (e,_,_) ->
176 ("Unix.mkdir " ^ path ^ " 0o755 :" ^ (Unix.error_message e))));
179 let where = if path.[0] = '/' then "/" else "" in
182 (** {2 Filesystem} *)
184 let input_file fname =
185 let size = (Unix.stat fname).Unix.st_size in
186 let buf = Buffer.create size in
187 let ic = open_in fname in
188 Buffer.add_channel buf ic size;
194 let buf = Buffer.create size in
195 let s = String.create size in
198 let bytes = input ic s 0 size in
199 if bytes = 0 then raise End_of_file
200 else Buffer.add_substring buf s 0 bytes
202 with End_of_file -> ());
205 let output_file ~filename ~text =
206 let oc = open_out filename in
207 output_string oc text;
211 let len = String.length s in
212 let buf = Buffer.create 0 in
216 if Buffer.length buf > 0
217 then List.rev (Buffer.contents buf :: acc)
220 if is_blank s.[i] then
221 if Buffer.length buf > 0 then begin
222 let s = Buffer.contents buf in
224 aux (s :: acc) (i + 1)
228 Buffer.add_char buf s.[i];
235 (* Rules: * "~name" -> home dir of "name"
236 * "~" -> value of $HOME if defined, home dir of the current user otherwise *)
238 let get_home login = (Unix.getpwnam login).Unix.pw_dir in
240 let len = String.length s in
241 if len > 0 && s.[0] = '~' then begin
242 let login_len = ref 1 in
243 while !login_len < len && is_alphanum (s.[!login_len]) do
246 let login = String.sub s 1 (!login_len - 1) in
250 try Sys.getenv "HOME" with Not_found -> get_home (Unix.getlogin ())
254 home ^ String.sub s !login_len (len - !login_len)
255 with Not_found | Invalid_argument _ -> s
259 String.concat " " (List.map expand_one (blank_split s))
261 let find ?(test = fun _ -> true) path =
262 let rec aux acc todo =
267 let handle = Unix.opendir path in
269 let matching_files = ref [] in
272 match Unix.readdir handle with
275 let qentry = path ^ "/" ^ entry in
277 if is_dir qentry then
278 dirs := qentry :: !dirs
279 else if test qentry then
280 matching_files := qentry :: !matching_files;
281 with Unix.Unix_error _ -> ())
283 with End_of_file -> Unix.closedir handle);
284 aux (!matching_files @ acc) (!dirs @ tl)
285 with Unix.Unix_error _ -> aux acc tl
289 let safe_remove fname = if Sys.file_exists fname then Sys.remove fname
292 let od = Unix.opendir d in
294 let name = Unix.readdir od in
295 if name <> "." && name <> ".." then false else aux () in
296 let res = try aux () with End_of_file -> true in
300 let safe_rmdir d = try Unix.rmdir d with Unix.Unix_error _ -> ()
302 let rec rmdir_descend d =
303 if is_dir_empty d then
306 rmdir_descend (Filename.dirname d)
310 (** {2 Exception handling} *)
312 let finally at_end f arg =
315 with exn -> at_end (); raise exn
320 (** {2 Localized exceptions } *)
322 exception Localized of Token.flocation * exn
324 let loc_of_floc = function
325 | { Lexing.pos_cnum = loc_begin }, { Lexing.pos_cnum = loc_end } ->
328 let floc_of_loc (loc_begin, loc_end) =
330 { Lexing.pos_fname = ""; Lexing.pos_lnum = -1; Lexing.pos_bol = -1;
331 Lexing.pos_cnum = loc_begin }
333 let floc_end = { floc_begin with Lexing.pos_cnum = loc_end } in
334 (floc_begin, floc_end)
336 let dummy_floc = floc_of_loc (-1, -1)
338 let raise_localized_exception ~offset floc exn =
339 let (x, y) = loc_of_floc floc in
340 let x = offset + x in
341 let y = offset + y in
342 let flocb,floce = floc in
344 { flocb with Lexing.pos_cnum = x }, { floce with Lexing.pos_cnum = y }
346 raise (Localized (floc, exn))