Index of values

A
add [Set.S]

add x s returns a set containing all elements of s, plus x.

add [Map.S]

add key data m returns a map containing the same bindings as m, plus a binding of key to data.

add_seq [Set.S]

Add the given elements to the set, in order.

add_seq [Map.S]

Add the given bindings to the map, in order.

apply_then_set [Metrics_base.BasicMetrics]

Update a reference from a pure functional function.

B
bindings [Map.S]

Return the list of all bindings of the given map.

C
cardinal [Set.S]

Return the number of elements of a set.

cardinal [Map.S]

Return the number of bindings of a map.

choose [Set.S]

Return one element of the given set, or raise Not_found if the set is empty.

choose [Map.S]

Return one binding of the given map, or raise Not_found if the map is empty.

choose_opt [Set.S]

Return one element of the given set, or None if the set is empty.

choose_opt [Map.S]

Return one binding of the given map, or None if the map is empty.

clear_coverage_by_fun [Metrics_coverage]
coerce_panel_to_ui [Metrics_gui]

Returning a value to register in Frama-C's GUI

compare [Set.S]

Total ordering between sets.

compare [Map.S]

Total ordering between maps.

compute [Metrics_coverage]

Computes both syntactic and semantic coverage information.

compute_coverage_by_fun [Metrics_coverage]

Computes the semantic coverage by function.

compute_cyclo [Metrics_base.BasicMetrics]

Compute cyclomatic complexity from base_metrics record type.

compute_locals_size [Metrics_cilast]

Compute and print the size (in bytes) of local variables on the CIL AST.

compute_on_cabs [Metrics_cabs]

Main entry point to compute various metrics on Cabs AST instead of CIL AST.

compute_on_cilast [Metrics_cilast]

Compute metrics on whole CIL AST

compute_semantic [Metrics_coverage]

Functions analyzed by the value analysis

compute_syntactic [Metrics_coverage]

List of functions that can be syntactically reached from the function

compute_syntactic [Metrics.Metrics_coverage]
consider_function [Metrics_base]

consider_function vinfo returns false if the varinfo is not a function we are interested in.

consider_variable [Metrics_base]

consider_variable vinfo returns false if the varinfo is not an object variable we are interested in.

copy [Datatype.S]

Deep copy: no possible sharing between x and copy x.

css [Css_html]
D
diff [Set.S]

Set difference: diff s1 s2 contains the elements of s1 that are not in s2.

disjoint [Set.S]

Test if two sets are disjoint.

display_as_table [Metrics_gui]

Display the list of list of strings in a LablGTK table object

dump [Metrics_acsl]
dump_acsl_stats [Metrics_acsl]
dump_acsl_stats_html [Metrics_acsl]
E
elements [Set.S]

Return the list of all elements of the given set.

empty [Set.S]

The empty set.

empty [Map.S]

The empty map.

empty_acsl_stat [Metrics_acsl]
empty_metrics [Metrics_base.BasicMetrics]

Initial empty values for metrics computing.

equal [Set.S]

equal s1 s2 tests whether the sets s1 and s2 are equal, that is, contain equal elements.

equal [Map.S]

equal cmp m1 m2 tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data.

exists [Set.S]

exists f s checks if at least one element of the set satisfies the predicate f.

exists [Map.S]

exists f m checks if at least one binding of the map satisfies the predicate f.

exists [Parameter_sig.Set]

Is there some element satisfying the given predicate?

extract_fundef_name [Metrics_base]
F
file_of_fundef [Metrics_base]

Get the filename containing the function definition

file_of_vinfodef [Metrics_base]

Get the filename where the definition of a varinfo occurs

filter [Set.S]

filter f s returns the set of all elements in s that satisfy predicate f.

filter [Map.S]

filter f m returns the map with all the bindings in m that satisfy predicate p.

filter_map [Set.S]

filter_map f s returns the set of all v such that f x = Some v for some element x of s.

filter_map [Map.S]

filter_map f m applies the function f to every binding of m, and builds a map from the results.

find [Set.S]

find x s returns the element of s equal to x (according to Ord.compare), or raise Not_found if no such element exists.

find [Map.S]

find x m returns the current value of x in m, or raises Not_found if no binding for x exists.

find_first [Set.S]

find_first f s, where f is a monotonically increasing function, returns the lowest element e of s such that f e, or raises Not_found if no such element exists.

find_first [Map.S]

find_first f m, where f is a monotonically increasing function, returns the binding of m with the lowest key k such that f k, or raises Not_found if no such key exists.

find_first_opt [Set.S]

find_first_opt f s, where f is a monotonically increasing function, returns an option containing the lowest element e of s such that f e, or None if no such element exists.

find_first_opt [Map.S]

find_first_opt f m, where f is a monotonically increasing function, returns an option containing the binding of m with the lowest key k such that f k, or None if no such key exists.

find_last [Set.S]

find_last f s, where f is a monotonically decreasing function, returns the highest element e of s such that f e, or raises Not_found if no such element exists.

find_last [Map.S]

find_last f m, where f is a monotonically decreasing function, returns the binding of m with the highest key k such that f k, or raises Not_found if no such key exists.

find_last_opt [Set.S]

find_last_opt f s, where f is a monotonically decreasing function, returns an option containing the highest element e of s such that f e, or None if no such element exists.

find_last_opt [Map.S]

find_last_opt f m, where f is a monotonically decreasing function, returns an option containing the binding of m with the highest key k such that f k, or None if no such key exists.

find_opt [Set.S]

find_opt x s returns the element of s equal to x (according to Ord.compare), or None if no such element exists.

find_opt [Map.S]

find_opt x m returns Some v if the current value of x in m is v, or None if no binding for x exists.

float_to_string [Metrics_base]

Convert float to string with the following convention: if the float is an integer (ie, it has no digits after the decimal point), print it as such;, otherwise, print the first two digits after the decimal point.

fold [Set.S]

fold f s init computes (f xN ... (f x2 (f x1 init))...), where x1 ... xN are the elements of s, in increasing order.

fold [Map.S]

fold f m init computes (f kN dN ... (f k1 d1 init)...), where k1 ... kN are the keys of all bindings in m (in increasing order), and d1 ... dN are the associated data.

for_all [Set.S]

for_all f s checks if all elements of the set satisfy the predicate f.

for_all [Map.S]

for_all f m checks if all the bindings of the map satisfy the predicate f.

G
get_cilast_metrics [Metrics_cilast]
get_coverage [Metrics_coverage]

Returns the coverage for a given function.

get_file_type [Metrics_base]

get_file_type extension sets the output type according to extension.

get_filename [Metrics_base]
get_function_name [Parameter_sig.String]

returns the given argument only if it is a valid function name (see Parameter_customize.get_c_ified_functions for more information), and abort otherwise.

get_global_metrics [Metrics_cilast]

Returns the computed metrics for the entire AST.

get_global_stats [Metrics_acsl]
get_kf_stats [Metrics_acsl]
get_metrics [Metrics_cabs.Halstead]
get_metrics_map [Metrics_cilast]

Computes and returns individual metrics per function.

get_metrics_map [Metrics.Metrics_cilast]
get_plain_string [Parameter_sig.String]

always return the argument, even if the argument is not a function name.

get_possible_values [Parameter_sig.String]

What are the acceptable values for this parameter.

H
html_stag_functions [Metrics_base]
I
incr_asserts [Metrics_acsl]
incr_assigns [Metrics_base.BasicMetrics]
incr_calls [Metrics_base.BasicMetrics]
incr_dpoints [Metrics_base.BasicMetrics]
incr_exits [Metrics_base.BasicMetrics]
incr_f_assigns [Metrics_acsl]
incr_f_assumes [Metrics_acsl]
incr_f_behaviors [Metrics_acsl]
incr_f_ensures [Metrics_acsl]
incr_f_froms [Metrics_acsl]
incr_f_requires [Metrics_acsl]
incr_funcs [Metrics_base.BasicMetrics]

Helpers for metrics purposes for single increment steps

incr_glob_vars [Metrics_base.BasicMetrics]
incr_gotos [Metrics_base.BasicMetrics]
incr_ifs [Metrics_base.BasicMetrics]
incr_invariants [Metrics_acsl]
incr_loop_assigns [Metrics_acsl]
incr_loop_froms [Metrics_acsl]
incr_loops [Metrics_base.BasicMetrics]
incr_ptrs [Metrics_base.BasicMetrics]
incr_s_assigns [Metrics_acsl]
incr_s_assumes [Metrics_acsl]
incr_s_behaviors [Metrics_acsl]
incr_s_ensures [Metrics_acsl]
incr_s_froms [Metrics_acsl]
incr_s_requires [Metrics_acsl]
incr_slocs [Metrics_base.BasicMetrics]
incr_variants [Metrics_acsl]
init_panel [Metrics_gui]

Initialize the main Metrics panel into an upper and lower part.

inter [Set.S]

Set intersection.

is_computed_by_fun [Metrics_coverage]
is_empty [Set.S]

Test whether a set is empty or not.

is_empty [Map.S]

Test whether a map is empty or not.

is_empty [Parameter_sig.Filepath]

Whether the Filepath is empty.

iter [Set.S]

iter f s applies f in turn to all elements of s.

iter [Map.S]

iter f m applies f to all bindings in map m.

J
json_of_entry_points [Metrics_base]
json_of_varinfo_map [Metrics_base]

Build a JSON list with the varinfos in m, each as a JSON object with the varinfo name as key and additional attributes as values.

K
kf_of_cabs_name [Metrics_base]
M
make_type [Datatype.Hashtbl]
map [Set.S]

map f s is the set whose elements are f a0,f a1...

map [Map.S]

map f m returns a map with same domain as m, where the associated value a of all bindings of m has been replaced by the result of the application of f to a.

mapi [Map.S]

Same as Map.S.map, but the function receives as arguments both the key and the associated value for each binding of the map.

max_binding [Map.S]

Same as Map.S.min_binding, but returns the binding with the largest key in the given map.

max_binding_opt [Map.S]

Same as Map.S.min_binding_opt, but returns the binding with the largest key in the given map.

max_elt [Set.S]

Same as Set.S.min_elt, but returns the largest element of the given set.

max_elt_opt [Set.S]

Same as Set.S.min_elt_opt, but returns the largest element of the given set.

mem [Set.S]

mem x s tests whether x belongs to the set s.

mem [Map.S]

mem x m returns true if m contains a binding for x, and false otherwise.

mem [Parameter_sig.Set]

Does the given element belong to the set?

merge [Map.S]

merge f m1 m2 computes a map whose keys are a subset of the keys of m1 and of m2.

min_binding [Map.S]

Return the binding with the smallest key in a given map (with respect to the Ord.compare ordering), or raise Not_found if the map is empty.

min_binding_opt [Map.S]

Return the binding with the smallest key in the given map (with respect to the Ord.compare ordering), or None if the map is empty.

min_elt [Set.S]

Return the smallest element of the given set (with respect to the Ord.compare ordering), or raise Not_found if the set is empty.

min_elt_opt [Set.S]

Return the smallest element of the given set (with respect to the Ord.compare ordering), or None if the set is empty.

mk_hdr [Metrics_base]

mk_hdr level ppf hdr_strg produces a title from hdr_strg with an underline of the same length.

N
nearest_elt_ge [Datatype.Set]
nearest_elt_le [Datatype.Set]
number_entry_points [Metrics_base]

Handling entry points informations

O
of_list [Set.S]

of_list l creates a set from a list of elements.

of_seq [Set.S]

Build a set from the given bindings

of_seq [Map.S]

Build a map from the given bindings

off [Parameter_sig.Bool]

Set the boolean to false.

on [Parameter_sig.Bool]

Set the boolean to true.

output [Parameter_sig.With_output]

To be used by the plugin to output the results of the option in a controlled way.

P
partition [Set.S]

partition f s returns a pair of sets (s1, s2), where s1 is the set of all the elements of s that satisfy the predicate f, and s2 is the set of all the elements of s that do not satisfy f.

partition [Map.S]

partition f m returns a pair of maps (m1, m2), where m1 contains all the bindings of m that satisfy the predicate f, and m2 is the map with all the bindings of m that do not satisfy f.

percent_coverage [Metrics_coverage]
pp_base_metrics [Metrics_base.BasicMetrics]

Pretty printers for base metrics as text or html.

pp_base_metrics_as_html_row [Metrics_base.BasicMetrics]
pretty_acsl_stats [Metrics_acsl]
pretty_acsl_stats_html [Metrics_acsl]
pretty_entry_points [Metrics_base]
pretty_extern_vars [Metrics_base]
pretty_set [Metrics_base]

Pretty print a varinfo set, with some additional information about the varinfo.

pretty_used_files [Metrics_cilast]

Pretty-prints the result of used_files in a verbose way.

R
reachable_from_main [Metrics_cilast]

Computes the set of global variables which are syntactically reachable from the entry point of the program.

register_metrics [Metrics_gui]

register_metrics metrics_name display_function () adds a selectable choice for the metrics metrics_name and add a hook calling display_function whenever this metrics is selected and launched.

remove [Set.S]

remove x s returns a set containing all elements of s, except x.

remove [Map.S]

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map.

reset_panel [Metrics_gui]

Reset metrics panel to pristine conditions by removing children from bottom container

S
set_cyclo [Metrics_base.BasicMetrics]
set_output_dependencies [Parameter_sig.With_output]

Set the dependencies for the output of the option.

set_possible_values [Parameter_sig.String]

Set what are the acceptable values for this parameter.

singleton [Set.S]

singleton x returns the one-element set containing only x.

singleton [Map.S]

singleton x y returns the one-element map that contains a binding y for x.

split [Set.S]

split x s returns a triple (l, present, r), where l is the set of elements of s that are strictly less than x; r is the set of elements of s that are strictly greater than x; present is false if s contains no element equal to x, or true if s contains an element equal to x.

split [Map.S]

split x m returns a triple (l, data, r), where l is the map with all the bindings of m whose key is strictly less than x; r is the map with all the bindings of m whose key is strictly greater than x; data is None if m contains no binding for x, or Some v if m binds v to x.

subset [Set.S]

subset s1 s2 tests whether the set s1 is a subset of the set s2.

T
to_list [Metrics_cabs.Halstead]
to_list [Metrics_base.BasicMetrics]

Matrix-like representation of the record in "Title: value" style

to_rev_seq [Set.S]

Iterate on the whole set, in descending order

to_rev_seq [Map.S]

Iterate on the whole map, in descending order of keys

to_seq [Set.S]

Iterate on the whole set, in ascending order

to_seq [Map.S]

Iterate on the whole map, in ascending order of keys

to_seq_from [Set.S]

to_seq_from x s iterates on a subset of the elements of s in ascending order, from x or above.

to_seq_from [Map.S]

to_seq_from k m iterates on a subset of the bindings of m, in ascending order of keys, from key k or above.

U
union [Set.S]

Set union.

union [Map.S]

union f m1 m2 computes a map whose keys are a subset of the keys of m1 and of m2.

update [Map.S]

update key f m returns a map containing the same bindings as m, except for the binding of key.

used_files [Metrics_cilast]

Computes the set of files defining all global variables syntactically reachable from the entry point of the program (as given by reachable_from_main).