package frama-c

  1. Overview
  2. Docs
package frama-c
Legend:
Library
Module
Module type
Parameter
Class
Class type

the original project from which a diff is computed.

include State_builder.Ref with type data = Project.t
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).

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 data = Project.t

Type of the referenced value.

val set : data -> unit

Change the referenced value.

val get : unit -> data

Get the referenced value.

val clear : unit -> unit

Reset the reference to its default value.

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

Memoization. Compute on need the stored value. If the data is already computed (i.e. is not None), it is possible to change with change.

val map : (data -> data) -> data option
val may : (data -> unit) -> unit
val get_option : unit -> data option
  • since Beryllium-20090901
val add_hook_on_change : (data option -> unit) -> unit

Add an hook which is applied each time (just after) the value of the state changes inside the current project.

  • since 28.0-Nickel
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct