1Misc(3) OCaml library Misc(3)
2
6 Misc - Miscellaneous useful types and functions
7
9 Module Misc
10
12 Module Misc
13 : sig end
14 Miscellaneous useful types and functions
17 Warning: this module is unstable and part of Compiler_libs .
19 val fatal_error : string -> 'a
26 val fatal_errorf : ('a, Format.formatter, unit, 'b) format4 -> 'a
31 exception Fatal_error
36 val try_finally : ?always:(unit -> unit) -> ?exceptionally:(unit ->
42 unit) -> (unit -> 'a) -> 'a
43 try_finally work ~always ~exceptionally is designed to run code in work
46 that may fail with an exception, and has two kind of cleanup routines:
47 always , that must be run after any execution of the function (typi‐
48 cally, freeing system resources), and exceptionally , that should be
49 run only if work or always failed with an exception (typically, undoing
50 user-visible state changes that would only make sense if the function
51 completes correctly). For example:
52 let objfile = outputprefix ^ .cmo in let oc = open_out_bin objfile in
55 Misc.try_finally (fun () -> bytecode ++ Timings.(accumulate_time (Gen‐
56 erate sourcefile)) (Emitcode.to_file oc modulename objfile); Warn‐
57 ings.check_fatal ()) ~always:(fun () -> close_out oc) ~exception‐
58 ally:(fun _exn -> remove_file objfile);
59 If exceptionally fail with an exception, it is propagated as usual.
61 If always or exceptionally use exceptions internally for control-flow
63 but do not raise, then try_finally is careful to preserve any exception
64 backtrace coming from work or always for easier debugging.
65 val map_end : ('a -> 'b) -> 'a list -> 'b list -> 'b list
69 val map_left_right : ('a -> 'b) -> 'a list -> 'b list
74 val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
79 val replicate_list : 'a -> int -> 'a list
84 val list_remove : 'a -> 'a list -> 'a list
89 val split_last : 'a list -> 'a list * 'a
94 val may : ('a -> unit) -> 'a option -> unit
99 val may_map : ('a -> 'b) -> 'a option -> 'b option
104 type ref_and_value =
108 | R : 'a ref * 'a -> ref_and_value
109 val protect_refs : ref_and_value list -> (unit -> 'a) -> 'a
115 protect_refs l f temporarily sets r to v for each R (r, v) in l while
118 executing f . The previous contents of the references is restored even
119 if f raises an exception.
120 module Stdlib : sig end
123 val find_in_path : string list -> string -> string
129 val find_in_path_rel : string list -> string -> string
134 val find_in_path_uncap : string list -> string -> string
139 val remove_file : string -> unit
144 val expand_directory : string -> string -> string
149 val split_path_contents : ?sep:char -> string -> string list
154 val create_hashtable : int -> ('a * 'b) list -> ('a, 'b) Hashtbl.t
159 val copy_file : in_channel -> out_channel -> unit
164 val copy_file_chunk : in_channel -> out_channel -> int -> unit
169 val string_of_file : in_channel -> string
174 val output_to_file_via_temporary : ?mode:open_flag list -> string ->
179 (string -> out_channel -> 'a) -> 'a
180 val log2 : int -> int
185 val align : int -> int -> int
190 val no_overflow_add : int -> int -> bool
195 val no_overflow_sub : int -> int -> bool
200 val no_overflow_mul : int -> int -> bool
205 val no_overflow_lsl : int -> int -> bool
210 module Int_literal_converter : sig end
214 val chop_extensions : string -> string
220 val search_substring : string -> string -> int -> int
225 val replace_substring : before:string -> after:string -> string ->
230 string
231 val rev_split_words : string -> string list
236 val get_ref : 'a list ref -> 'a list
241 val set_or_ignore : ('a -> 'b option) -> 'b option ref -> 'a -> unit
246 val fst3 : 'a * 'b * 'c -> 'a
251 val snd3 : 'a * 'b * 'c -> 'b
256 val thd3 : 'a * 'b * 'c -> 'c
261 val fst4 : 'a * 'b * 'c * 'd -> 'a
266 val snd4 : 'a * 'b * 'c * 'd -> 'b
271 val thd4 : 'a * 'b * 'c * 'd -> 'c
276 val for4 : 'a * 'b * 'c * 'd -> 'd
281 module LongString : sig end
285 val edit_distance : string -> string -> int -> int option
291 edit_distance a b cutoff computes the edit distance between strings a
294 and b . To help efficiency, it uses a cutoff: if the distance d is
295 smaller than cutoff , it returns Some d , else None .
296 The distance algorithm currently used is Damerau-Levenshtein: it com‐
298 putes the number of insertion, deletion, substitution of letters, or
299 swapping of adjacent letters to go from one word to the other. The par‐
300 ticular algorithm may change in the future.
301 val spellcheck : string list -> string -> string list
305 spellcheck env name takes a list of names env that exist in the current
308 environment and an erroneous name , and returns a list of suggestions
309 taken from env , that are close enough to name that it may be a typo
310 for one of them.
311 val did_you_mean : Format.formatter -> (unit -> string list) -> unit
315 did_you_mean ppf get_choices hints that the user may have meant one of
318 the option returned by calling get_choices . It does nothing if the
319 returned list is empty.
320 The unit -> ... thunking is meant to delay any potentially-slow compu‐
322 tation (typically computing edit-distance with many things from the
323 current environment) to when the hint message is to be printed. You
324 should print an understandable error message before calling
325 did_you_mean , so that users get a clear notification of the failure
326 even if producing the hint is slow.
327 val cut_at : string -> char -> string * string
331 String.cut_at s c returns a pair containing the sub-string before the
334 first occurrence of c in s , and the sub-string after the first occur‐
335 rence of c in s . let (before, after) = String.cut_at s c in before ^
336 String.make 1 c ^ after is the identity if s contains c .
337 Raise Not_found if the character does not appear in the string
339 Since 4.01
342 module Color : sig end
345 module Error_style : sig end
350 val normalise_eol : string -> string
356 normalise_eol s returns a fresh copy of s with any '\r' characters
359 removed. Intended for pre-processing text which will subsequently be
360 printed on a channel which performs EOL transformations (i.e. Windows)
361 val delete_eol_spaces : string -> string
365 delete_eol_spaces s returns a fresh copy of s with any end of line spa‐
368 ces removed. Intended to normalize the output of the toplevel for
369 tests.
370 val pp_two_columns : ?sep:string -> ?max_lines:int -> Format.formatter
374 -> (string * string) list -> unit
375 pp_two_columns ?sep ?max_lines ppf l prints the lines in l as two col‐
378 umns separated by sep ("|" by default). max_lines can be used to indi‐
379 cate a maximum number of lines to print -- an ellipsis gets inserted at
380 the middle if the input has too many lines.
381 Example:
383 pp_two_columns ~max_lines:3 Format.std_formatter [ "abc", "hello";
385 "def", "zzz"; "a" , "bllbl"; "bb" , "dddddd"; ]
386 prints
388 abc | hello ... bb | dddddd
390 Hook machinery
396 Hooks machinery: add_hook name f will register a function that will be
397 called on the argument of a later call to apply_hooks . Hooks are
398 applied in the lexicographical order of their names.
399 type hook_info = {
401 sourcefile : string ;
402 }
403 exception HookExnWrapper of {
409 error : exn ;
410 hook_name : string ;
411 hook_info : hook_info ;
412 }
413 An exception raised by a hook will be wrapped into a HookExnWrapper
416 constructor by the hook machinery.
417 val raise_direct_hook_exn : exn -> 'a
421 A hook can use raise_unwrapped_hook_exn to raise an exception that will
423 not be wrapped into a Misc.HookExnWrapper .
424 module type HookSig = sig end
427 module MakeHooks : functor (M : sig end) -> sig end
432 val show_config_and_exit : unit -> unit
438 configuration variables
440 val show_config_variable_and_exit : string -> unit
444 val get_build_path_prefix_map : unit -> Build_path_prefix_map.map
449 option
450 Returns the map encoded in the BUILD_PATH_PREFIX_MAP environment vari‐
452 able.
453 val debug_prefix_map_flags : unit -> string list
457 Returns the list of --debug-prefix-map flags to be passed to the assem‐
459 bler, built from the BUILD_PATH_PREFIX_MAP environment variable.
460 val print_if : Format.formatter -> bool ref -> (Format.formatter -> 'a
464 -> unit) -> 'a -> 'a
465 print_if ppf flag fmt x prints x with fmt on ppf if b is true.
468OCamldoc 2019-07-30 Misc(3)