Module Extlib

module Extlib: sig .. end
Useful operations. This module does not depend of any of frama-c module.

val nop : 'a -> unit
Do nothing.
val id : 'a -> 'a
identity function.
Since Oxygen-20120901
val adapt_filename : string -> string
Ensure that the given filename has the extension "cmo" in bytecode and "cmxs" in native
val max_cpt : int -> int -> int
max_cpt t1 t2 returns the maximum of t1 and t2 wrt the total ordering induced by tags creation. This ordering is defined as follows: forall tags t1 t2, t1 <= t2 iff t1 is before t2 in the finite sequence 0; 1; ..; max_int; min_int; min_int-1; -1
val number_to_color : int -> int

Function builders


exception Unregistered_function of string
Never catch it yourself: let the kernel do the job.
Since Oxygen-20120901
val mk_labeled_fun : string -> 'a
To be used to initialized a reference over a labeled function.
Since Oxygen-20120901
Raises Unregistered_function when not properly initialized
val mk_fun : string -> ('a -> 'b) Pervasives.ref
Build a reference to an uninitialized function
Raises Unregistered_function when not properly initialized

Function combinators


val ($) : ('b -> 'c) -> ('a -> 'b) -> 'a -> 'c
Composition.
val swap : ('a -> 'b -> 'c) -> 'b -> 'a -> 'c
Swap arguments.
val uncurry : ('a -> 'b -> 'c) -> 'a * 'b -> 'c
val iter_uncurry2 : (('a -> 'b -> unit) -> 'c -> unit) -> ('a * 'b -> unit) -> 'c -> unit

Lists


val as_singleton : 'a list -> 'a
returns the unique element of a singleton list.
Raises Invalid_argument on a non singleton list.
val last : 'a list -> 'a
returns the last element of a list.
Since Nitrogen-20111001
Raises Invalid_argument on an empty list
val filter_out : ('a -> bool) -> 'a list -> 'a list
Filter out elements that pass the test
val replace : ('a -> 'a -> bool) -> 'a -> 'a list -> 'a list
replace cmp x l replaces the first element y of l such that cmp x y is true by x. If no such element exists, x is added at the tail of l.
Since Neon-20140301
val filter_map : ('a -> bool) -> ('a -> 'b) -> 'a list -> 'b list
val filter_map' : ('a -> 'b) -> ('b -> bool) -> 'a list -> 'b list
val filter_map_opt : ('a -> 'b option) -> 'a list -> 'b list
Combines filter and map.
val fold_map : ('a -> 'b -> 'a * 'c) -> 'a -> 'b list -> 'a * 'c list
Combines fold_left and map
val fold_map_opt : ('a -> 'b -> 'a * 'c option) -> 'a -> 'b list -> 'a * 'c list
Combines filter fold_left and map
val product_fold : ('a -> 'b -> 'c -> 'a) -> 'a -> 'b list -> 'c list -> 'a
product f acc l1 l2 is similar to fold_left f acc l12 with l12 the list of all pairs of an elt of l1 and an elt of l2
val product : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
product f l1 l2 applies f to all the pairs of an elt of l1 and an element of l2.
val find_index : ('a -> bool) -> 'a list -> int
returns the index (starting at 0) of the first element verifying the condition
Raises Not_found if no element in the list matches the condition
val list_compare : ('a -> 'a -> int) -> 'a list -> 'a list -> int
Generic list comparison function, where the elements are compared with the specified function
Since Boron-20100401
val list_of_opt : 'a option -> 'a list
converts an option into a list with 0 or 1 elt.
Since Carbon-20111201-beta2
val opt_of_list : 'a list -> 'a option
converts a list with 0 or 1 element into an option.
Since Oxygen-20120901
Raises Invalid_argument on lists with more than one argument
val find_opt : ('a -> 'b option) -> 'a list -> 'b
Deprecated.18.0-Argon use List.find_opt instead
find_option p l returns the value p e, e being the first element of l such that p e is not None. Raise Not_found if there is no such value the list l.
Since Nitrogen-20111001
val iteri : (int -> 'a -> unit) -> 'a list -> unit
Same as iter, but the function to be applied take also as argument the index of the element (starting from 0). Tail-recursive
Since Nitrogen-20111001
val mapi : (int -> 'a -> 'b) -> 'a list -> 'b list
Same as map, but the function to be applied take also as argument the index of the element (starting from 0). Tail-recursive
Since Oxygen-20120901
val sort_unique : ('a -> 'a -> int) -> 'a list -> 'a list
Deprecated.use List.sort_uniq instead
Same as List.sort , but also remove duplicates.
val subsets : int -> 'a list -> 'a list list
subsets k l computes the combinations of k elements from list l. E.g. subsets 2 1;2;3;4 = [1;2];[1;3];[1;4];[2;3];[2;4];[3;4]. This function preserves the order of the elements in l when computing the sublists. l should not contain duplicates.
Since Aluminium-20160501
val list_first_n : int -> 'a list -> 'a list
list_first_n n l returns the first n elements of the list. Tail recursive. It returns an empty list if n is nonpositive and the whole list if n is greater than List.length l. It is equivalent to list_slice ~last:n l.
val list_slice : ?first:int -> ?last:int -> 'a list -> 'a list
list_slice ?first ?last l is equivalent to Python's slice operator (lfirst:last): returns the range of the list between first (inclusive) and last (exclusive), starting from 0. If omitted, first defaults to 0 and last to List.length l. Negative indices are allowed, and count from the end of the list. list_slice never raises exceptions: out-of-bounds arguments are clipped, and inverted ranges result in empty lists.
Since 18.0-Argon

Arrays


val array_exists : ('a -> bool) -> 'a array -> bool
val array_existsi : (int -> 'a -> bool) -> 'a array -> bool

Options


val has_some : 'a option -> bool
true iff its argument is Some x
Since Nitrogen-20111001
val may : ('a -> unit) -> 'a option -> unit
may f v applies f to x if v = Some(x)
val opt_conv : 'a -> 'a option -> 'a
opt_conv default v returns default if v is None and a if v is Some a
val opt_if : bool -> 'a -> 'a option
opt_if cond v returns Some v if cond is true and None otherwise
val may_map : ('a -> 'b) -> ?dft:'b -> 'a option -> 'b
may_map f ?dft x applies f to the value of x if exists. Otherwise returns the default value dft. Assume that either x or dft is defined.
val opt_map : ('a -> 'b) -> 'a option -> 'b option
val opt_fold : ('a -> 'b -> 'b) -> 'a option -> 'b -> 'b
Since Oxygen-20120901
val merge_opt : ('a -> 'b -> 'b -> 'b) -> 'a -> 'b option -> 'b option -> 'b option
merge f k a b returns It is mainly intended to be used with Map.merge
Since Oxygen-20120901
val opt_bind : ('a -> 'b option) -> 'a option -> 'b option
opt_bind f x returns None if x is None and f y if is Some y (monadic bind)
Since Nitrogen-20111001
val opt_filter : ('a -> bool) -> 'a option -> 'a option
val the : ?exn:exn -> 'a option -> 'a
Raises Returns v if the value is Some v.
Change in Magnesium-20151001: add optional argument exn
Consult the Plugin Development Guide for additional details.
val find_or_none : ('a -> 'b) -> 'a -> 'b option
val opt_equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
val opt_compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int
Since Boron-20100401
val opt_hash : ('a -> int) -> 'a option -> int
Since Sodium-20150201

Booleans


val xor : bool -> bool -> bool
exclusive-or.
Since Oxygen-20120901

Strings


val string_prefix : ?strict:bool -> string -> string -> bool
string_prefix ~strict p s returns true if and only if p is a prefix of the string s. If strict is true, the prefix must be strict (that is, s must moreover be strictly longer than p. strict is false by default.
Since Boron-20100401
val string_del_prefix : ?strict:bool -> string -> string -> string option
string_del_prefix ~strict p s returns None if p is not a prefix of s and Some s1 iff s=p^s1.
Since Oxygen-20120901
val string_suffix : ?strict:bool -> string -> string -> bool
string_suffix ~strict suf s returns true iff suf is a suffix of string s. strict, which defaults to false, indicates whether s should be strictly longer than p.
Since Aluminium-20160501
val string_del_suffix : ?strict:bool -> string -> string -> string option
string_del_suffix ~strict suf s returns Some s1 when s = s1 ^ suf and None of suf is not a suffix of s.
Since Aluminium-20160501
val string_split : string -> int -> string * string
string_split s i returns the beginning of s up to char i-1 and the end of s starting from char i+1
Since Oxygen-20120901
Raises Invalid_argument if i is not in the range [0,(length s -1)]
val make_unique_name : (string -> bool) -> ?sep:string -> ?start:int -> string -> int * string
make_unique_name mem s returns (0, s) when (mem s)=false otherwise returns (n,new_string) such that new_string is derived from (s,sep,start) and (mem new_string)=false and n<>0
Since Oxygen-20120901
val strip_underscore : string -> string
remove underscores at the beginning and end of a string. If a string is composed solely of underscores, return the empty string
Since 18.0-Argon
val html_escape : string -> string

Performance


val address_of_value : 'a -> int

Exception catcher


val try_finally : finally:(unit -> unit) -> ('a -> 'b) -> 'a -> 'b

System commands
val mkdir : ?parents:bool -> string -> Unix.file_perm -> unit
mkdir ?parents name perm creates directory name with permission perm. If parents is true, recursively create parent directories if needed. parents defaults to false. Note that this function may create some of the parent directories and then fail to create the children, e.g. if perm does not allow user execution of the created directory. This will leave the filesystem in a modified state before raising an exception.
Since 19.0-Potassium
Raises Unix.Unix_error if cannot create name or its parents.
val safe_at_exit : (unit -> unit) -> unit
Register function to call with Pervasives.at_exit, but only for non-child process (fork). The order of execution is preserved wrt ordinary calls to Pervasives.at_exit.
val cleanup_at_exit : string -> unit
cleanup_at_exit file indicates that file must be removed when the program exits (except if exit is caused by a signal). If file does not exist, nothing happens.
exception Temp_file_error of string
val temp_file_cleanup_at_exit : ?debug:bool -> string -> string -> string
Similar to Filename.temp_file except that the temporary file will be deleted at the end of the execution (see above), unless debug is set to true, in which case a message with the name of the kept file will be printed.
Raises Temp_file_error if the temp file cannot be created.
Change in Nitrogen-20111001: may now raise Temp_file_error
Change in Oxygen-20120901: optional debug argument
val temp_dir_cleanup_at_exit : ?debug:bool -> string -> string
Raises Temp_file_error if the temp dir cannot be created.
Change in Nitrogen-20111001: may now raise Temp_file_error
Change in Neon-20130301: add optional debug flag
val safe_remove : string -> unit
Tries to delete a file and never fails.
val safe_remove_dir : string -> unit

Comparison functions
val compare_basic : 'a -> 'a -> int
Use this function instead of Pervasives.compare, as this makes it easier to find incorrect uses of the latter
val compare_ignore_case : string -> string -> int
Case-insensitive string comparison. Only ISO-8859-1 accents are handled.
Since Silicon-20161101