package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

Platform dedicated to the analysis of source code written in C

Install

Dune Dependency

frama-c.com Readme Edit opam file Versions (23)

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-29.0-Copper.tar.gz

sha256=d2fbb3b8d0ff83945872e9e6fa258e934a706360e698dae3b4d5f971addf7493

doc/frama-c.kernel/Frama_c_kernel/Kernel_function/Make_Table/index.html

Module `Kernel_function.Make_Table`

Hashtable indexed by kernel functions and dealing with project.

see https://frama-c.com/download/frama-c-plugin-development-guide.pdf

Parameters

module Data : Datatype.S

module _ : State_builder.Info_with_size

Signature

Hashtbl are a standard computation. BUT that is INCORRECT to use projectified hashtables if keys have a custom rehash function (see Datatype.Make_input.rehash)

include State_builder.S

val self : State.t

The kind of the registered state.

val name : string

val mark_as_computed : ?project:Project.t -> unit -> unit

Indicate that the registered state will not change again for the given project (default is current ()).

val is_computed : ?project:Project.t -> unit -> bool

Returns true iff the registered state will not change again for the given project (default is current ()).

Exportation of some inputs (easier use of State_builder.Register).

module Datatype : Datatype.S

val add_hook_on_update : (Datatype.t -> unit) -> unit

Add an hook which is applied each time (just before) the project library changes the local value of the state.

since Nitrogen-20111001

val howto_marshal : (Datatype.t -> 'a) -> ('a -> Datatype.t) -> unit

howto_marshal marshal unmarshal registers a custom couple of functions (marshal, unmarshal) to be used for serialization. Default functions are identities. In particular, this function must be used if Datatype.t is not marshallable and do_not_save is not called.

since Boron-20100401

type key = t

type data = Data.t

val replace : key -> data -> unit

Add a new binding. The previous one is removed.

val add : key -> data -> unit

Add a new binding. The previous one is only hidden.

val clear : unit -> unit

Clear the table.

val length : unit -> int

Length of the table.

val iter : (key -> data -> unit) -> unit

val iter_sorted : ?cmp:(key -> key -> int) -> (key -> data -> unit) -> unit

val fold : (key -> data -> 'a -> 'a) -> 'a -> 'a

val fold_sorted : 
  ?cmp:(key -> key -> int) ->
  (key -> data -> 'a -> 'a) ->
  'a ->
  'a

val memo : ?change:(data -> data) -> (key -> data) -> key -> data

Memoization. Compute on need the data associated to a given key using the given function. If the data is already computed, it is possible to change with change.

val find : key -> data

Return the current binding of the given key.

raises Not_found
if the key is not in the table.

val find_opt : key -> data option

Return the current binding of the given key, or None if no such binding exists.

since 27.0-Cobalt

val find_all : key -> data list

Return the list of all data associated with the given key.

val mem : key -> bool

val remove : key -> unit

val to_seq : unit -> (key * data) Seq.t

Iterate on the whole table.

since 27.0-Cobalt

val add_hook_on_change : 
  ((key, data) State_builder.hashtbl_event -> unit) ->
  unit

Add an hook which is applied each time (just after) a (key,value) pair in the hashtable changes inside the current project.

since 28.0-Nickel

On This Page

Parameters
Signature