package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Type declaration
Predefined type descriptors
Type descriptor builders
Coercions
Safe unmarshaling

Platform dedicated to the analysis of source code written in C

Install

dune-project

Dependency

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

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-30.0-Zinc.tar.gz

sha256=3ac0f995261ec829a7bd042bf70fc29ac6379029eb9df30bcc044748eb4d2a56

doc/frama-c.kernel/Frama_c_kernel/Descr/index.html

Module `Frama_c_kernel.Descr`

Type descriptor for safe unmarshalling.

This module provides a safe API on top of modules Unmarshal of Structural_descr, using module Type. This module offers the same power as Unmarshal, but in a safe way.

Type declaration

type 'a t

Type of a type descriptor.

Predefined type descriptors

val t_unit : unit t

val t_int : int t

val t_string : string t

val t_float : float t

val t_bool : bool t

val t_int32 : int32 t

val t_int64 : int64 t

val t_nativeint : nativeint t

val unmarshable : 'a t

Descriptor for unmarshallable types.

since Carbon-20101201

val is_unmarshable : 'a t -> bool

since Carbon-20101201

val is_abstract : 'a t -> bool

since Neon-20140301

Type descriptor builders

exception Invalid_descriptor

since Carbon-20101201

Builders for standard OCaml types

val t_record : Structural_descr.pack array -> 'a -> 'a t

Type descriptor for records (the length of the array must be equal to the number of fields in the record).

raises Invalid_descriptor
if the descriptor cannot be built.

val t_tuple : Structural_descr.pack array -> 'a -> 'a t

Type descriptor for tuples of any range (the length of the array range is the range of the tuple).

raises Invalid_descriptor
if the descriptor cannot be built.

val t_pair : 'a t -> 'b t -> ('a * 'b) t

Type descriptor for pairs (2-tuples). Safer that t_tuple for pairs.

raises Invalid_descriptor
if the descriptor cannot be built.

val t_list : 'a t -> 'a list t

Type descriptor for lists.

raises Invalid_descriptor
if the descriptor cannot be built.

val t_ref : 'a t -> 'a ref t

Type descriptor for references.

raises Invalid_descriptor
if the descriptor cannot be built.

val t_option : 'a t -> 'a option t

Type descriptor for options.

raises Invalid_descriptor
if the descriptor cannot be built.

val t_queue : 'a t -> 'a Queue.t t

Type descriptor for queues.

raises Invalid_descriptor
if the descriptor cannot be built.

Builders from others datatypes of the Type library

val of_type : 'a Type.t -> 'a t

Type descriptor from the type value.

since Carbon-20101201

val of_structural : 'a Type.t -> Structural_descr.t -> 'a t

Type descriptor from the structural descriptor. The given type value ensures safety.

since Carbon-20101201

Builders mapping `Unmarshal`'s transformers

val dependent_pair : 'a t -> ('a -> 'b t) -> ('a * 'b) t

Similar to Unmarshal.structure.Dependent_pair, but safe.

raises Invalid_descriptor
if the descriptor cannot be built.

val transform : 'a t -> ('a -> 'a) -> 'a t

Similar to Unmarshal.t.Transform, but safe.

raises Invalid_descriptor
if the given descriptor is incorrect.

val return : 'a t -> (unit -> 'a) -> 'a t

Similar to Unmarshal.t.Return, but safe.

raises Invalid_descriptor
if the descriptor cannot be built.

val dynamic : (unit -> 'a t) -> 'a t

Similar to Unmarshal.t.Dynamic.

raises Invalid_descriptor
if the descriptor cannot be built.

Coercions

val str : 'a t -> Structural_descr.t

raises Invalid_descriptor
if the given descriptor is incorrect.

since Carbon-20101201

val pack : 'a t -> Structural_descr.pack

since Carbon-20101201

Safe unmarshaling

val input_val : in_channel -> 'a t -> 'a

since Carbon-20101201