module Plugin:Provided plug-general services for plug-ins.sig
..end
typegroup =
Cmdline.Group.t
module type Parameter =sig
..end
module type Bool =sig
..end
module type WithOutput =sig
..end
module type Int =sig
..end
module type String =sig
..end
module type String_collection =sig
..end
module type String_set =String_collection
with type t = Datatype.String.Set.t
module type String_list =String_collection
with type t = string list
module type String_hashtbl =sig
..end
module type Indexed_val =sig
..end
module type Parameter_input =sig
..end
module type Parameter_input_with_arg =sig
..end
module type Indexed_val_input =sig
..end
IndexedVal
module type S =sig
..end
type
plugin = private {
|
p_name : |
|
p_help : |
|
p_parameters : |
Plugin.do_iterate
and Plugin.do_not_iterate
) are
registered in the field p_parameters
.module type General_services =sig
..end
You can apply the below functions juste before applying one of the functors
provided by the functor Register
and generating a new parameter.
val set_cmdline_stage : Cmdline.stage -> unit
Cmdline.Configuring
.val do_not_journalize : unit -> unit
val do_not_projectify : unit -> unit
Plugin.do_not_save
.val do_not_save : unit -> unit
val set_negative_option_name : string -> unit
val set_negative_option_help : string -> unit
val set_optional_help : (unit, Format.formatter, unit) Pervasives.format -> unit
val set_group : group -> unit
val is_invisible : unit -> unit
Plugin.do_not_iterate
.val do_iterate : unit -> unit
Plugin.iter_on_plugins
is applied to this parameter. By default
only parameters corresponding to options registered at the
Cmdline.Configuring
stage are iterable.val do_not_iterate : unit -> unit
Plugin.iter_on_plugins
to be applied on the parameter. By default, only
parameters corresponding to options registered at the
Cmdline.Configuring
stage are iterable.module Register:functor (
P
:
sig
val name :string
Name of the module. Arbitrary non-empty string.
val shortname :string
Prefix for plugin options. No space allowed.
val help :string
description of the module. Free-form text.
end
) ->
General_services
val get : string -> plugin
val iter_on_plugins : (plugin -> unit) -> unit
val get_selection : unit -> State_selection.t
val get_selection_context : unit -> State_selection.t
val positive_debug_ref : int Pervasives.ref
val at_normal_exit : (unit -> unit) -> unit
val run_normal_exit_hook : unit -> unit
Cmdline.run_normal_exit_hook
.