Frama-C:
Plug-ins:
Libraries:

Frama-C API - Builder

Signatures containing the different functors which may be used to generate new command line options.

module Bool (_ : sig ... end) : Bool
module Action (_ : Input) : Bool
module False (_ : Input) : Bool
module True (_ : Input) : Bool
module WithOutput (_ : sig ... end) : With_output
module Int (_ : sig ... end) : Int
module Zero (_ : Input_with_arg) : Int
module Float (_ : sig ... end) : Float

Parameter with an optional decimal point converted to an Ocaml float

module String (_ : sig ... end) : String
module Filepath (_ : sig ... end) : Filepath
module Make_site_dir (_ : Site_dir) (_ : sig ... end) : Site_dir

Builds a Site_dir from an existing one. The first parameter is the parent directory. The second gives the name of the directory to create.

module Make_user_dir (_ : User_dir) (_ : sig ... end) : User_dir

Builds a User_dir from an existing one. The first parameter is the parent directory. The second gives the name of the directory to create.

module Make_user_dir_opt (_ : User_dir) (_ : sig ... end) : User_dir_opt

Builds a User_dir_opt from an existing User_dir. The first parameter is the parent directory. The second gives the name of the directory to create (also used to create the option name), a possible environment variable name and the help message for the option.

module Custom (V : Value_datatype) (_ : sig ... end) : Custom with type t = V.t

Allow using custom types as parameters.

module Enum (X : sig ... end) : S with type t = X.t

A fixed set of possible values, represented by a type t, intended to be a variant with only a finite number of possible constructions. Note that t must be comparable with structural equality

exception Cannot_build of string
module Make_set (E : Value_datatype_with_collections) (_ : sig ... end) : Set with type elt = E.t and type t = E.Set.t
module Filled_string_set (_ : sig ... end) : String_set
module Make_list (E : sig ... end) (_ : sig ... end) : List with type elt = E.t and type t = E.t list
module Filepath_list (_ : sig ... end) : Filepath_list
module Value_int : Value_datatype with type t = int
module Value_string : Value_datatype with type t = string
module Make_map (K : Value_datatype_with_collections) (V : Value_datatype) (_ : sig ... end) : Map with type key = K.t and type value = V.t and type t = V.t K.Map.t

Parameter is a map where multibindings are **not** allowed.

module String_map (V : Value_datatype) (_ : sig ... end) : Map with type key = string and type value = V.t and type t = V.t Datatype.String.Map.t
module Kernel_function_map (V : Value_datatype) (_ : sig ... end) : Map with type key = Cil_types.kernel_function and type value = V.t and type t = V.t Cil_datatype.Kf.Map.t

As for Kernel_function_set, by default keys can only be defined functions. Use Parameter_customize.argument_may_be_fundecl to also include pure prototypes.

module Make_multiple_map (K : Value_datatype_with_collections) (V : Value_datatype) (_ : sig ... end) : Multiple_map with type key = K.t and type value = V.t and type t = V.t list K.Map.t

Parameter is a map where multibindings are allowed.

module String_multiple_map (V : Value_datatype) (_ : sig ... end) : Multiple_map with type key = string and type value = V.t and type t = V.t list Datatype.String.Map.t
module Kernel_function_multiple_map (V : Value_datatype) (_ : sig ... end) : Multiple_map with type key = Cil_types.kernel_function and type value = V.t and type t = V.t list Cil_datatype.Kf.Map.t

As for Kernel_function_set, by default keys can only be defined functions. Use Parameter_customize.argument_may_be_fundecl to also include pure prototypes.

val parameters : unit -> Typed_parameter.t list