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
55 let oc = open_out_bin objfile in
56 Misc.try_finally
57 (fun () ->
58 bytecode
59 ++ Timings.(accumulate_time (Generate sourcefile))
60 (Emitcode.to_file oc modulename objfile);
61 Warnings.check_fatal ())
62 ~always:(fun () -> close_out oc)
63 ~exceptionally:(fun _exn -> remove_file objfile);
64 If exceptionally fail with an exception, it is propagated as usual.
67 If always or exceptionally use exceptions internally for control-flow
69 but do not raise, then try_finally is careful to preserve any exception
70 backtrace coming from work or always for easier debugging.
71 val map_end : ('a -> 'b) -> 'a list -> 'b list -> 'b list
75 val map_left_right : ('a -> 'b) -> 'a list -> 'b list
80 val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
85 val replicate_list : 'a -> int -> 'a list
90 val list_remove : 'a -> 'a list -> 'a list
95 val split_last : 'a list -> 'a list * 'a
100 type ref_and_value =
104 | R : 'a ref * 'a -> ref_and_value
105 val protect_refs : ref_and_value list -> (unit -> 'a) -> 'a
111 protect_refs l f temporarily sets r to v for each R (r, v) in l while
114 executing f . The previous contents of the references is restored even
115 if f raises an exception, without altering the exception backtrace.
116 module Stdlib : sig end
119 val find_in_path : string list -> string -> string
125 val find_in_path_rel : string list -> string -> string
130 val find_in_path_uncap : string list -> string -> string
135 val remove_file : string -> unit
140 val expand_directory : string -> string -> string
145 val split_path_contents : ?sep:char -> string -> string list
150 val create_hashtable : int -> ('a * 'b) list -> ('a, 'b) Hashtbl.t
155 val copy_file : in_channel -> out_channel -> unit
160 val copy_file_chunk : in_channel -> out_channel -> int -> unit
165 val string_of_file : in_channel -> string
170 val output_to_file_via_temporary : ?mode:open_flag list -> string ->
175 (string -> out_channel -> 'a) -> 'a
176 val protect_writing_to_file : filename:string -> f:(out_channel -> 'a)
181 -> 'a
182 Open the given filename for writing (in binary mode), pass the
184 out_channel to the given function, then close the channel. If the func‐
185 tion raises an exception then filename will be removed.
186 val log2 : int -> int
190 val align : int -> int -> int
195 val no_overflow_add : int -> int -> bool
200 val no_overflow_sub : int -> int -> bool
205 val no_overflow_mul : int -> int -> bool
210 val no_overflow_lsl : int -> int -> bool
215 module Int_literal_converter : sig end
219 val chop_extensions : string -> string
225 val search_substring : string -> string -> int -> int
230 val replace_substring : before:string -> after:string -> string ->
235 string
236 val rev_split_words : string -> string list
241 val get_ref : 'a list ref -> 'a list
246 val set_or_ignore : ('a -> 'b option) -> 'b option ref -> 'a -> unit
251 val fst3 : 'a * 'b * 'c -> 'a
256 val snd3 : 'a * 'b * 'c -> 'b
261 val thd3 : 'a * 'b * 'c -> 'c
266 val fst4 : 'a * 'b * 'c * 'd -> 'a
271 val snd4 : 'a * 'b * 'c * 'd -> 'b
276 val thd4 : 'a * 'b * 'c * 'd -> 'c
281 val for4 : 'a * 'b * 'c * 'd -> 'd
286 module LongString : sig end
290 val edit_distance : string -> string -> int -> int option
296 edit_distance a b cutoff computes the edit distance between strings a
299 and b . To help efficiency, it uses a cutoff: if the distance d is
300 smaller than cutoff , it returns Some d , else None .
301 The distance algorithm currently used is Damerau-Levenshtein: it com‐
303 putes the number of insertion, deletion, substitution of letters, or
304 swapping of adjacent letters to go from one word to the other. The par‐
305 ticular algorithm may change in the future.
306 val spellcheck : string list -> string -> string list
310 spellcheck env name takes a list of names env that exist in the current
313 environment and an erroneous name , and returns a list of suggestions
314 taken from env , that are close enough to name that it may be a typo
315 for one of them.
316 val did_you_mean : Format.formatter -> (unit -> string list) -> unit
320 did_you_mean ppf get_choices hints that the user may have meant one of
323 the option returned by calling get_choices . It does nothing if the re‐
324 turned list is empty.
325 The unit -> ... thunking is meant to delay any potentially-slow compu‐
327 tation (typically computing edit-distance with many things from the
328 current environment) to when the hint message is to be printed. You
329 should print an understandable error message before calling
330 did_you_mean , so that users get a clear notification of the failure
331 even if producing the hint is slow.
332 val cut_at : string -> char -> string * string
336 String.cut_at s c returns a pair containing the sub-string before the
339 first occurrence of c in s , and the sub-string after the first occur‐
340 rence of c in s . let (before, after) = String.cut_at s c in
341 before ^ String.make 1 c ^ after is the identity if s contains c .
342 Raise Not_found if the character does not appear in the string
344 Since 4.01
347 module Color : sig end
350 module Error_style : sig end
355 val normalise_eol : string -> string
361 normalise_eol s returns a fresh copy of s with any '\r' characters re‐
364 moved. Intended for pre-processing text which will subsequently be
365 printed on a channel which performs EOL transformations (i.e. Windows)
366 val delete_eol_spaces : string -> string
370 delete_eol_spaces s returns a fresh copy of s with any end of line spa‐
373 ces removed. Intended to normalize the output of the toplevel for
374 tests.
375 val pp_two_columns : ?sep:string -> ?max_lines:int -> Format.formatter
379 -> (string * string) list -> unit
380 pp_two_columns ?sep ?max_lines ppf l prints the lines in l as two col‐
383 umns separated by sep ("|" by default). max_lines can be used to indi‐
384 cate a maximum number of lines to print -- an ellipsis gets inserted at
385 the middle if the input has too many lines.
386 Example:
388 pp_two_columns ~max_lines:3 Format.std_formatter [ "abc", "hello";
390 "def", "zzz"; "a" , "bllbl"; "bb" , "dddddd"; ]
391 prints
393 abc | hello ... bb | dddddd
395 val show_config_and_exit : unit -> unit
400 configuration variables
402 val show_config_variable_and_exit : string -> unit
406 val get_build_path_prefix_map : unit -> Build_path_prefix_map.map op‐
411 tion
412 Returns the map encoded in the BUILD_PATH_PREFIX_MAP environment vari‐
414 able.
415 val debug_prefix_map_flags : unit -> string list
419 Returns the list of --debug-prefix-map flags to be passed to the assem‐
421 bler, built from the BUILD_PATH_PREFIX_MAP environment variable.
422 val print_if : Format.formatter -> bool ref -> (Format.formatter -> 'a
426 -> unit) -> 'a -> 'a
427 print_if ppf flag fmt x prints x with fmt on ppf if b is true.
430 type filepath = string
433 type modname = string
438 type crcs = (modname * Digest.t option) list
443 type alerts = string Stdlib.String.Map.t
448 module EnvLazy : sig end
453 module Magic_number : sig end
458OCamldoc 2021-01-26 Misc(3)