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 iter_option: ('a -> unit) -> 'a option -> unit
30 val unopt: 'a option -> 'a (** @raise Failure *)
34 val is_dir: string -> bool (** @return true if file is a directory *)
35 val is_regular: string -> bool (** @return true if file is a regular file *)
36 val mkdir: string -> unit (** create dir and parents. @raise Failure *)
37 val tilde_expand: string -> string (** bash-like (head) tilde expansion *)
39 (** find all _files_ matching test under a filesystem root *)
40 val find: ?test:(string -> bool) -> string -> string list
44 val input_file: string -> string (** read all the contents of file to string *)
45 val input_all: in_channel -> string (** read all the contents of a channel *)
46 val output_file: filename:string -> text:string -> unit (** other way round *)
48 (** {2 Exception handling} *)
50 val finally: (unit -> unit) -> ('a -> 'b) -> 'a -> 'b
52 (** {2 Char processing} *)
54 val is_alpha: char -> bool
55 val is_blank: char -> bool
56 val is_digit: char -> bool
57 val is_alphanum: char -> bool (** is_alpha || is_digit *)
59 (** {2 String processing} *)
61 val split: ?sep:char -> string -> string list (** @param sep defaults to ' ' *)
62 val trim_blanks: string -> string (** strip heading and trailing blanks *)
64 (** {2 List processing} *)
67 ?eq:('a->'a->bool) -> 'a list -> 'a list (** uniq unix filter on lists *)
68 val filter_map: ('a -> 'b option) -> 'a list -> 'b list (** filter + map *)
69 val list_concat: ?sep:'a list -> 'a list list -> 'a list (**String.concat-like*)
71 (** {2 Debugging & Profiling} *)
73 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
75 (** @return a profiling function; [s] is used for labelling the total time at
76 * the end of the execution *)
77 val profile : ?enable:bool -> string -> profiler
78 val set_profiling_printings : (unit -> bool) -> unit
80 (** {2 Localized exceptions } *)
82 exception Localized of Token.flocation * exn
84 val loc_of_floc: Token.flocation -> int * int
86 val raise_localized_exception: offset:int -> Token.flocation -> exn -> 'a