Frama-C:
Plug-ins:
Libraries:

Frama-C API - Value_datatype

Signature of the optional value associated to the key and required to build map parameters.

  • since Sodium-20150201
include Datatype.S
include Datatype.S_no_copy
val name : string

Unique name of the datatype.

val descr : t Descr.t

Datatype descriptor.

val packed_descr : Structural_descr.pack

Packed version of the descriptor.

val reprs : t list

List of representants of the descriptor.

val equal : t -> t -> bool
val compare : t -> t -> int

Comparison: same spec than Stdlib.compare.

val hash : t -> int

Hash function: same spec than Hashtbl.hash.

val pretty : Stdlib.Format.formatter -> t -> unit

Pretty print each value in an user-friendly way.

val mem_project : (Project_skeleton.t -> bool) -> t -> bool

mem_project f x must return true iff there is a value p of type Project.t in x such that f p returns true.

val copy : t -> t

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

type key
val of_string : key:key -> prev:t option -> string option -> t option

key is the key associated to this value, while prev is the previous value associated to this key (if any). The optional string is None if there is no value associated to the key, and Some v (potentially v = "") otherwise.

  • returns

    None if there is no value to associate to the key or Some v otherwise.

  • raises Cannot_build

    if there is no element corresponding to the given string.

val to_string : key:key -> t option -> string option

key is the key associated to this value. The optional string is None if there is no value associated to the key, and Some v (potentially v = "") otherwise.

  • returns

    None if there is no value to associate to the key or Some v otherwise.