package frama-c
Install
dune-project
Dependency
Authors
-
MMichele Alberti
-
TThibaud Antignac
-
GGergö Barany
-
PPatrick Baudin
-
NNicolas Bellec
-
TThibaut Benjamin
-
AAllan Blanchard
-
LLionel Blatter
-
FFrançois Bobot
-
RRichard Bonichon
-
VVincent Botbol
-
QQuentin Bouillaguet
-
DDavid Bühler
-
ZZakaria Chihani
-
LLoïc Correnson
-
JJulien Crétin
-
PPascal Cuoq
-
ZZaynah Dargaye
-
BBasile Desloges
-
JJean-Christophe Filliâtre
-
PPhilippe Herrmann
-
MMaxime Jacquemin
-
FFlorent Kirchner
-
AAlexander Kogtenkov
-
RRemi Lazarini
-
TTristan Le Gall
-
KKilyan Le Gallic
-
JJean-Christophe Léchenet
-
MMatthieu Lemerre
-
DDara Ly
-
DDavid Maison
-
CClaude Marché
-
AAndré Maroneze
-
TThibault Martin
-
FFonenantsoa Maurica
-
MMelody Méaulle
-
BBenjamin Monate
-
YYannick Moy
-
PPierre Nigron
-
AAnne Pacalet
-
VValentin Perrelle
-
GGuillaume Petiot
-
DDario Pinto
-
VVirgile Prevosto
-
AArmand Puccetti
-
FFélix Ridoux
-
VVirgile Robles
-
JJan Rochel
-
MMuriel Roger
-
CCécile Ruet-Cros
-
JJulien Signoles
-
NNicolas Stouls
-
KKostyantyn Vorobyov
-
BBoris Yakobowski
Maintainers
Sources
sha256=93a291a8764644df2f3618d7ea18258b5fbe0912ec98dfdfd180967afdf24474
doc/frama-c.kernel/Frama_c_kernel/Parameter_sig/index.html
Module Frama_c_kernel.Parameter_sig
Signatures for command line options.
Input signatures
One of these signatures is required to implement a new command line option.
module type Input = sig ... endMinimal signature to implement for each parameter corresponding to an option on the command line argument.
module type Input_with_arg = sig ... endMinimal signature to implement for each parameter corresponding to an option on the command line argument which requires an argument.
module type Input_collection = sig ... endMinimal signature for collections of custom datatype
module type String_datatype = sig ... endSignature required to build custom collection parameters in which elements are convertible to string.
module type String_datatype_with_collections = sig ... endSignature requires to build custom collection parameters in which elements are convertible to string.
module type Value_datatype = sig ... endSignature of the optional value associated to the key and required to build map parameters.
module type Multiple_value_datatype = sig ... endSignature of the optional value associated to the key and required to build multiple map parameters. Almost similar to Value_datatype.
Output signatures
Signatures corresponding to a command line option of a specific type.
Generic signatures
module type S_no_parameter = sig ... endGeneric signature of a parameter, without parameter.
module type S = sig ... endGeneric signature of a parameter.
Signatures for simple datatypes
module type Bool = sig ... endSignature for a boolean parameter.
module type Int = sig ... endSignature for an integer parameter.
module type String = sig ... endSignature for a string parameter.
module type Custom = sig ... endSignature for a custom parameter.
Custom signatures
module type With_output = sig ... endSignature for a boolean parameter that causes something to be output.
module type Filepath = sig ... endsignature for normalized pathnames.
module type Site_dir = sig ... endDune site directories (share, lib, ...) and subdirectories. They are connected to a root module (see Site_root), that may not be unique, and these are considered as installed files (although the user might provide another location).
module type Site_root = sig ... endDune site roots (share, lib, ...).
module type User_dir = sig ... endUser directories (session, config, state, ...). We do not expect these directories/files to exist. Several roots are provided in Plugin, namely Plugin.Session, Plugin.Cache_dir, Plugin.Config_dir and Plugin.State_dir.
module type User_dir_opt = sig ... endBasically User_dir but with an option to override the original path.
Collections
module type Collection_category = sig ... endSignature for a category over a collection.
module type Collection = sig ... endCommon signature to all collections.
module type Set = sig ... endSignature for sets as command line parameters.
module type String_set =
Set with type elt = string and type t = Datatype.String.Set.tmodule type Kernel_function_set =
Set
with type elt = Cil_types.kernel_function
and type t = Cil_datatype.Kf.Set.tSet of defined kernel functions. If you want to also include pure prototype, use Parameter_customize.argument_may_be_fundecl.
module type Fundec_set =
Set with type elt = Cil_types.fundec and type t = Cil_datatype.Fundec.Set.tmodule type List = sig ... endSignature for lists as command line parameters.
module type String_list = List with type elt = string and type t = string listmodule type Filepath_list =
List
with type elt = Datatype.Filepath.t
and type t = Datatype.Filepath.t listmodule type Map = sig ... endSignature for maps as command line parameters.
module type Multiple_map = sig ... endSignature for multiple maps as command line parameters. Almost similar to Map.
module type Filepath_map = Map with type key = Datatype.Filepath.tAll the different kinds of command line options as functors
module type Builder = sig ... endSignatures containing the different functors which may be used to generate new command line options.