Module `Parameter_builder.Make`

Parameters

module _ : sig ... end

Signature

module Bool (_ : sig ... end) : Parameter_sig.Bool

module Action (_ : Parameter_sig.Input) : Parameter_sig.Bool

module False (_ : Parameter_sig.Input) : Parameter_sig.Bool

module True (_ : Parameter_sig.Input) : Parameter_sig.Bool

module WithOutput (_ : sig ... end) : Parameter_sig.With_output

module Int (_ : sig ... end) : Parameter_sig.Int

module Zero (_ : Parameter_sig.Input_with_arg) : Parameter_sig.Int

module Float (_ : sig ... end) : Parameter_sig.Float

Parameter with an optional decimal point converted to an Ocaml float

module String (_ : sig ... end) : Parameter_sig.String

module Empty_string (_ : Parameter_sig.Input_with_arg) : Parameter_sig.String

module Fc_Filepath = Filepath

module Filepath (_ : sig ... end) : Parameter_sig.Filepath

module Make_site_dir
  (_ : Parameter_sig.Site_dir)
  (_ : sig ... end) : 
  Parameter_sig.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
  (_ : Parameter_sig.User_dir)
  (_ : sig ... end) : 
  Parameter_sig.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
  (_ : Parameter_sig.User_dir)
  (_ : sig ... end) : 
  Parameter_sig.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 : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.Custom with type t = V.t

Allow using custom types as parameters.

module Enum (X : sig ... end) : Parameter_sig.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 : Parameter_sig.Value_datatype_with_collections)
  (_ : sig ... end) : 
  Parameter_sig.Set with type elt = E.t and type t = E.Set.t

module String_set (_ : Parameter_sig.Input_with_arg) : Parameter_sig.String_set

module Filled_string_set (_ : sig ... end) : Parameter_sig.String_set

module Kernel_function_set
  (_ : Parameter_sig.Input_with_arg) : 
  Parameter_sig.Kernel_function_set

module Fundec_set (_ : Parameter_sig.Input_with_arg) : Parameter_sig.Fundec_set

module Make_list
  (E : sig ... end)
  (_ : sig ... end) : 
  Parameter_sig.List with type elt = E.t and type t = E.t list

module String_list
  (_ : Parameter_sig.Input_with_arg) : 
  Parameter_sig.String_list

module Filepath_list (_ : sig ... end) : Parameter_sig.Filepath_list

module Value_int : Parameter_sig.Value_datatype with type t = int

module Value_string : Parameter_sig.Value_datatype with type t = string

module Filepath_map
  (V : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.Map
    with type key = Fc_Filepath.t
     and type value = V.t
     and type t = V.t Fc_Filepath.Map.t

module Make_map
  (K : Parameter_sig.Value_datatype_with_collections)
  (V : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.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 : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.Map
    with type key = string
     and type value = V.t
     and type t = V.t Datatype.String.Map.t

module Kernel_function_map
  (V : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.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 : Parameter_sig.Value_datatype_with_collections)
  (V : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.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 : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.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 : Parameter_sig.Value_datatype)
  (_ : sig ... end) : 
  Parameter_sig.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

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frama-c.kernel/Frama_c_kernel/Parameter_builder/Make/index.html

Module `Parameter_builder.Make`

Parameters

Signature

package frama-c

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frama-c.kernel/Frama_c_kernel/Parameter_builder/Make/index.html

Module Parameter_builder.Make

Parameters

Signature

Module `Parameter_builder.Make`