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 val chmod: int -> string -> unit (** chmod *)
  45 val normalize_path: string -> string (** /foo/./bar/..//baz -> /foo/baz *)
  46
  47   (** find all _files_ whose name matches test under a filesystem root.
  48    * Test is passed the filename path relative to the given filesystem root *)
  49 val find: ?test:(string -> bool) -> string -> string list
  50
  51   (** find_in paths name returns the first path^"/"^name such that
  52    *  is a regular file and the current user can 'stat' it.
  53    *  May raise (Failure "find_in") *)
  54 val find_in: string list -> string -> string
  55
  56 (** {2 File I/O} *)
  57
  58 val input_file: string -> string  (** read all the contents of file to string *)
  59 val input_all: in_channel -> string (** read all the contents of a channel *)
  60 val output_file: filename:string -> text:string -> unit (** other way round *)
  61
  62 (** {2 Exception handling} *)
  63
  64   (** @param finalizer finalization function (execution both in case of success
  65    * and in case of raised exception
  66    * @param f function to be invoked
  67    * @param arg argument to be passed to function *)
  68 val finally: (unit -> unit) -> ('a -> 'b) -> 'a -> 'b
  69
  70 (** {2 Char processing} *)
  71
  72 val is_alpha: char -> bool
  73 val is_blank: char -> bool
  74 val is_digit: char -> bool
  75 val is_alphanum: char -> bool (** is_alpha || is_digit *)
  76
  77 (** {2 String processing} *)
  78
  79 val split: ?sep:char -> string -> string list (** @param sep defaults to ' ' *)
  80 val trim_blanks: string -> string (** strip heading and trailing blanks *)
  81
  82 (** {2 List processing} *)
  83
  84 val list_uniq:
  85   ?eq:('a->'a->bool) -> 'a list -> 'a list (** uniq unix filter on lists *)
  86 val filter_map: ('a -> 'b option) -> 'a list -> 'b list (** filter + map *)
  87 val list_rev_map_filter: ('a -> 'b option) -> 'a list -> 'b list
  88 val list_rev_map_filter_fold: ('c -> 'a -> 'c * 'b option) -> 'c -> 'a list -> 'c * 'b list
  89 val list_concat: ?sep:'a list -> 'a list list -> 'a list (**String.concat-like*)
  90 val list_findopt: ('a -> 'b option) -> 'a list -> 'b option
  91 val flatten_map: ('a -> 'b list) -> 'a list -> 'b list
  92 val list_last: 'a list -> 'a
  93 val list_mapi: ('a -> int -> 'b) -> 'a list -> 'b list
  94 val sharing_map: ('a -> 'a) -> 'a list -> 'a list
  95 (* Iters in parallel on two lists until the first list is empty.
  96    The second one can be shorter and is padded with a default value.
  97    This function cannot fail. *)
  98 val list_iter_default2: ('a -> 'b -> unit) -> 'a list -> 'b -> 'b list -> unit
  99 (* Checks a predicate in parallel on three lists, the first two having the same
 100    length (otherwise it raises Invalid_argument). It stops when the first two
 101    lists are empty. The third one can be shorter and is padded with a default value. *)
 102 val list_forall_default3: ('a -> 'b -> 'c -> bool) -> 'a list -> 'b list -> 'c -> 'c list -> bool
 103
 104
 105   (** split_nth n l
 106    * @returns two list, the first contains at least n elements, the second the
 107    * remaining one
 108    * @raise Failure when List.length l < n *)
 109 val split_nth: int -> 'a list -> 'a list * 'a list
 110
 111 (** {2 Debugging & Profiling} *)
 112
 113 type profiler = { profile : 'a 'b. ('a -> 'b) -> 'a -> 'b }
 114
 115   (** @return a profiling function; [s] is used for labelling the total time at
 116    * the end of the execution *)
 117 val profile : ?enable:bool -> string -> profiler
 118 val set_profiling_printings : (string -> bool) -> unit
 119
 120 (** {2 Localized exceptions } *)
 121
 122 exception Localized of Stdpp.location * exn
 123
 124 val loc_of_floc: Stdpp.location -> int * int
 125 val floc_of_loc: int * int -> Stdpp.location
 126
 127 val dummy_floc: Stdpp.location
 128
 129 val raise_localized_exception: offset:int -> Stdpp.location -> exn -> 'a
 130
 131 (* size in KB (SLOW) *)
 132 val estimate_size: 'a -> int
 133
 134 (* is_prefix_of [prefix] [string], in terms of dirs:
 135  * foo/bar/ is prefix of foo/bar/baz
 136  * foo/bar  is prefix of foo/bar/baz
 137  * foo/b    isn't of     foo/bar/baz
 138  * foo/bar  is prefix of foo/bar
 139  *)
 140 val is_prefix_of: string -> string -> bool
 141 val chop_prefix: string -> string -> string
 142 val touch: string -> unit
 143
 144 val profiling_enabled: bool ref