1Misc(3) OCaml library Misc(3)
2
6 Misc - no description
7
9 Module Misc
10
12 Module Misc
13 : sig end
14 val fatal_error : string -> 'a
23 val fatal_errorf : ('a, Format.formatter, unit, 'b) Pervasives.format4
28 -> 'a
29 exception Fatal_error
34 val try_finally : (unit -> 'a) -> (unit -> unit) -> 'a
40 val map_end : ('a -> 'b) -> 'a list -> 'b list -> 'b list
45 val map_left_right : ('a -> 'b) -> 'a list -> 'b list
50 val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
55 val replicate_list : 'a -> int -> 'a list
60 val list_remove : 'a -> 'a list -> 'a list
65 val split_last : 'a list -> 'a list * 'a
70 val may : ('a -> unit) -> 'a option -> unit
75 val may_map : ('a -> 'b) -> 'a option -> 'b option
80 type ref_and_value =
84 | R : 'a Pervasives.ref * 'a -> ref_and_value
85 val protect_refs : ref_and_value list -> (unit -> 'a) -> 'a
91 protect_refs l f temporarily sets r to v for each R (r, v) in l while
94 executing f . The previous contents of the references is restored even
95 if f raises an exception.
96 module Stdlib : sig end
99 val find_in_path : string list -> string -> string
105 val find_in_path_rel : string list -> string -> string
110 val find_in_path_uncap : string list -> string -> string
115 val remove_file : string -> unit
120 val expand_directory : string -> string -> string
125 val create_hashtable : int -> ('a * 'b) list -> ('a, 'b) Hashtbl.t
130 val copy_file : Pervasives.in_channel -> Pervasives.out_channel -> unit
135 val copy_file_chunk : Pervasives.in_channel -> Pervasives.out_channel
140 -> int -> unit
141 val string_of_file : Pervasives.in_channel -> string
146 val output_to_file_via_temporary : ?mode:Pervasives.open_flag list ->
151 string -> (string -> Pervasives.out_channel -> 'a) -> 'a
152 val log2 : int -> int
157 val align : int -> int -> int
162 val no_overflow_add : int -> int -> bool
167 val no_overflow_sub : int -> int -> bool
172 val no_overflow_mul : int -> int -> bool
177 val no_overflow_lsl : int -> int -> bool
182 module Int_literal_converter : sig end
186 val chop_extensions : string -> string
192 val search_substring : string -> string -> int -> int
197 val replace_substring : before:string -> after:string -> string ->
202 string
203 val rev_split_words : string -> string list
208 val get_ref : 'a list Pervasives.ref -> 'a list
213 val fst3 : 'a * 'b * 'c -> 'a
218 val snd3 : 'a * 'b * 'c -> 'b
223 val thd3 : 'a * 'b * 'c -> 'c
228 val fst4 : 'a * 'b * 'c * 'd -> 'a
233 val snd4 : 'a * 'b * 'c * 'd -> 'b
238 val thd4 : 'a * 'b * 'c * 'd -> 'c
243 val for4 : 'a * 'b * 'c * 'd -> 'd
248 module LongString : sig end
252 val edit_distance : string -> string -> int -> int option
258 edit_distance a b cutoff computes the edit distance between strings a
261 and b . To help efficiency, it uses a cutoff: if the distance d is
262 smaller than cutoff , it returns Some d , else None .
263 The distance algorithm currently used is Damerau-Levenshtein: it com‐
265 putes the number of insertion, deletion, substitution of letters, or
266 swapping of adjacent letters to go from one word to the other. The par‐
267 ticular algorithm may change in the future.
268 val spellcheck : string list -> string -> string list
272 spellcheck env name takes a list of names env that exist in the current
275 environment and an erroneous name , and returns a list of suggestions
276 taken from env , that are close enough to name that it may be a typo
277 for one of them.
278 val did_you_mean : Format.formatter -> (unit -> string list) -> unit
282 did_you_mean ppf get_choices hints that the user may have meant one of
285 the option returned by calling get_choices . It does nothing if the
286 returned list is empty.
287 The unit -> ... thunking is meant to delay any potentially-slow compu‐
289 tation (typically computing edit-distance with many things from the
290 current environment) to when the hint message is to be printed. You
291 should print an understandable error message before calling
292 did_you_mean , so that users get a clear notification of the failure
293 even if producing the hint is slow.
294 val cut_at : string -> char -> string * string
298 String.cut_at s c returns a pair containing the sub-string before the
301 first occurrence of c in s , and the sub-string after the first occur‐
302 rence of c in s . let (before, after) = String.cut_at s c in before ^
303 String.make 1 c ^ after is the identity if s contains c .
304 Raise Not_found if the character does not appear in the string
306 Since 4.01
309 module StringSet : sig end
312 module StringMap : sig end
317 module Color : sig end
322 val normalise_eol : string -> string
328 normalise_eol s returns a fresh copy of s with any '\r' characters
331 removed. Intended for pre-processing text which will subsequently be
332 printed on a channel which performs EOL transformations (i.e. Windows)
333 val delete_eol_spaces : string -> string
337 delete_eol_spaces s returns a fresh copy of s with any end of line spa‐
340 ces removed. Intended to normalize the output of the toplevel for
341 tests.
342 === Hook machinery Hooks machinery: add_hook name f will register a
347 function that will be called on the argument of a later call to
348 apply_hooks. Hooks are applied in the lexicographical order of their
349 names. ===
350 type hook_info = {
353 sourcefile : string ;
354 }
355 exception HookExnWrapper of {
361 error : exn ;
362 hook_name : string ;
363 hook_info : hook_info ;
364 }
365 An exception raised by a hook will be wrapped into a HookExnWrapper
368 constructor by the hook machinery.
369 val raise_direct_hook_exn : exn -> 'a
373 A hook can use raise_unwrapped_hook_exn to raise an exception that will
375 not be wrapped into a Misc.HookExnWrapper .
376 module type HookSig = sig end
379 module MakeHooks : functor (M : sig end) -> sig end
384OCamldoc 2019-02-02 Misc(3)