]> matita.cs.unibo.it Git - helm.git/blob - helm/software/components/extlib/hExtlib.mli
added an utility function
[helm.git] / helm / software / components / extlib / hExtlib.mli
1 (* Copyright (C) 2005, HELM Team.
2  * 
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.
6  * 
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.
11  * 
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.
16  *
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,
20  * MA  02111-1307, USA.
21  * 
22  * For details, see the HELM World-Wide-Web page,
23  * http://helm.cs.unibo.it/
24  *)
25
26 (** {2 Optional values} *)
27
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 *)
31
32 (** {2 Filesystem} *)
33
34 val is_dir: string -> bool  (** @return true if file is a directory *)
35 val writable_dir: string -> bool  (** @return true if the directory is writable *)
36 val is_regular: string -> bool  (** @return true if file is a regular file *)
37 val is_executable: string -> bool  (** @return true if file is executable *)
38 val mkdir: string -> unit (** create dir and parents. @raise Failure *)
39 val tilde_expand: string -> string  (** bash-like (head) tilde expansion *)
40 val safe_remove: string -> unit (** removes a file if it exists *)
41 val safe_rmdir: string -> unit (** removes a dir if it exists and is empty *)
42 val is_dir_empty: string -> bool (** checks if the dir is empty *)
43 val rmdir_descend: string -> unit (** rmdir -p *)
44
45   (** find all _files_ whose name matches test under a filesystem root.
46    * Test is passed the filename path relative to the given filesystem root *)
47 val find: ?test:(string -> bool) -> string -> string list 
48
49 (** {2 File I/O} *)
50
51 val input_file: string -> string  (** read all the contents of file to string *)
52 val input_all: in_channel -> string (** read all the contents of a channel *)
53 val output_file: filename:string -> text:string -> unit (** other way round *)
54
55 (** {2 Exception handling} *)
56
57   (** @param finalizer finalization function (execution both in case of success
58    * and in case of raised exception
59    * @param f function to be invoked
60    * @param arg argument to be passed to function *)
61 val finally: (unit -> unit) -> ('a -> 'b) -> 'a -> 'b
62
63 (** {2 Char processing} *)
64
65 val is_alpha: char -> bool
66 val is_blank: char -> bool
67 val is_digit: char -> bool
68 val is_alphanum: char -> bool (** is_alpha || is_digit *)
69
70 (** {2 String processing} *)
71
72 val split: ?sep:char -> string -> string list (** @param sep defaults to ' ' *)
73 val trim_blanks: string -> string (** strip heading and trailing blanks *)
74
75 (** {2 List processing} *)
76
77 val list_uniq: 
78   ?eq:('a->'a->bool) -> 'a list -> 'a list (** uniq unix filter on lists *)
79 val filter_map: ('a -> 'b option) -> 'a list -> 'b list (** filter + map *)
80 val list_rev_map_filter: ('a -> 'b option) -> 'a list -> 'b list
81 val list_rev_map_filter_fold: ('c -> 'a -> 'c * 'b option) -> 'c -> 'a list -> 'c * 'b list
82 val list_concat: ?sep:'a list -> 'a list list -> 'a list (**String.concat-like*)
83 val list_findopt: ('a -> 'b option) -> 'a list -> 'b option
84 val flatten_map: ('a -> 'b list) -> 'a list -> 'b list
85 val list_last: 'a list -> 'a
86
87   (** split_nth n l
88    * @returns two list, the first contains at least n elements, the second the
89    * remaining one
90    * @raise Failure when List.length l < n *)
91 val split_nth: int -> 'a list -> 'a list * 'a list
92
93 (** {2 Debugging & Profiling} *)
94
95 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
96
97   (** @return a profiling function; [s] is used for labelling the total time at
98    * the end of the execution *)
99 val profile : ?enable:bool -> string -> profiler
100 val set_profiling_printings : (string -> bool) -> unit
101
102 (** {2 Localized exceptions } *)
103
104 exception Localized of Token.flocation * exn
105
106 val loc_of_floc: Token.flocation -> int * int
107 val floc_of_loc: int * int -> Token.flocation
108
109 val dummy_floc: Lexing.position * Lexing.position
110
111 val raise_localized_exception: offset:int -> Token.flocation -> exn -> 'a
112
113 (* size in KB (SLOW) *)
114 val estimate_size: 'a -> int
115