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://helm.cs.unibo.it/
26 (** {2 Optional values} *)
28 val map_option: ('a -> 'b) -> 'a option -> 'b option
29 val unopt: 'a option -> 'a (** @raise Failure *)
33 val is_dir: string -> bool (** @return true if file is a directory *)
34 val is_regular: string -> bool (** @return true if file is a regular file *)
35 val mkdir: string -> unit (** create dir and parents. @raise Failure *)
37 (** find all _files_ matching test under a filesystem root *)
38 val find: ?test:(string -> bool) -> string -> string list
42 val input_file: string -> string (** read all the contents of file to string *)
43 val input_all: in_channel -> string (** read all the contents of a channel *)
44 val output_file: filename:string -> text:string -> unit (** other way round *)
46 (** {2 Exception handling} *)
48 val finally: (unit -> unit) -> ('a -> 'b) -> 'a -> 'b
50 (** {2 String processing} *)
52 val split: ?sep:char -> string -> string list (** @param sep defaults to ' ' *)
53 val trim_blanks: string -> string (** strip heading and trailing blanks *)
55 (** {2 List processing} *)
57 val list_uniq: 'a list -> 'a list (** uniq unix filter on lists *)
58 val filter_map: ('a -> 'b option) -> 'a list -> 'b list (** filter + map *)
59 val list_concat: ?sep:'a list -> 'a list list -> 'a list (**String.concat-like*)
61 (** {2 Debugging & Profiling} *)
63 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
65 (** @return a profiling function; [s] is used for labelling the total time at
66 * the end of the execution *)
67 val profile : string -> profiler