Index of values

A
add [FCMap.S]

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

apply_then_set [Metrics_base.BasicMetrics]

Update a reference from a pure functional function.

B
bindings [FCMap.S]

Return the list of all bindings of the given map.

C
cardinal [FCMap.S]

Return the number of bindings of a map.

choose [FCMap.S]

Return one binding of the given map, or raise Not_found 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 [FCMap.S]

Total ordering between maps.

compute [Register_gui.ValueCoverageGUI]
compute [Register_gui.CyclomaticMetricsGUI]
compute [Register_gui.HalsteadMetricsGUI]
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
decorate_filetree [Register_gui.ValueCoverageGUI]
display_as_table [Metrics_gui]

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

display_result [Register_gui.ValueCoverageGUI]
display_result [Register_gui.CyclomaticMetricsGUI]
display_result [Register_gui.HalsteadMetricsGUI]
dump [Metrics_acsl]
dump_acsl_stats [Metrics_acsl]
dump_acsl_stats_html [Metrics_acsl]
E
empty [FCMap.S]

The empty map.

empty_acsl_stat [Metrics_acsl]
empty_metrics [Metrics_base.BasicMetrics]

Initial empty values for metrics computing.

equal [FCMap.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 [FCMap.S]

exists p m checks if at least one binding of the map satisfy the predicate p.

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

filetree_enabled [Register_gui.ValueCoverageGUI]
filetree_visible [Register_gui.ValueCoverageGUI]
filter [FCMap.S]

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

find [FCMap.S]

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

find_opt [FCMap.S]

find x m returns the current binding of x in m, or return None if no such binding 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 [FCMap.S]

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

for_all [FCMap.S]

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

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.

gui [Register_gui]
H
highlight [Register_gui.ValueCoverageGUI]
highlighter [Register_gui.ValueCoverageGUI]
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.

is_computed_by_fun [Metrics_coverage]
is_empty [FCMap.S]

Test whether a map is empty or not.

iter [FCMap.S]

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

K
kf_of_cabs_name [Metrics_base]
M
main [Register]
make_type [Datatype.Hashtbl]
map [FCMap.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 [FCMap.S]

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

max_binding [FCMap.S]

Same as FCMap.S.min_binding, but returns the largest binding of the given map.

max_elt [FCSet.S]

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

mem [FCMap.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 [FCMap.S]

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

min_binding [FCMap.S]

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

min_elt [FCSet.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.

mk_bi_label [Register_gui]
mk_hdr [Metrics_base]

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

N
name [Register_gui.ValueCoverageGUI]
name [Register_gui.CyclomaticMetricsGUI]
name [Register_gui.HalsteadMetricsGUI]
nearest_elt_ge [FCSet.S]

nearest_elt_ge v s returns the smallest element of s that is bigger or equal to v.

nearest_elt_le [FCSet.S]

nearest_elt_le v s returns the largest element of s that is smaller or equal to v.

number_entry_points [Metrics_base]

Handling entry points informations

O
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 [FCMap.S]

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

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 [Register_gui.ValueCoverageGUI]
register [Register_gui.CyclomaticMetricsGUI]
register [Register_gui.HalsteadMetricsGUI]
register_final [Register_gui]
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 [FCMap.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

result [Register_gui.ValueCoverageGUI]
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 [FCMap.S]

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

split [FCSet.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 [FCMap.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.

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

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

U
update_filetree [Register_gui.ValueCoverageGUI]
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).

V
value [Register]