Previous  Up  Next

Module type Parameter_sig.S_no_parameter

module type S_no_parameter = sig .. end

Generic signature of a parameter, without parameter.

type t

Type of the parameter (an int, a string, etc). It is concrete for each module implementing this signature.

val set : t -> unit

Set the option.

val add_set_hook : (t -> t -> unit) ->
       unit

Add a hook to be called after the function Parameter_sig.S_no_parameter.set is called. The first parameter of the hook is the old value of the parameter while the second one is the new value.

val add_update_hook : (t -> t -> unit) ->
       unit

Add a hook to be called when the value of the parameter changes (by calling Parameter_sig.S_no_parameter.set or indirectly by the project library. The first parameter of the hook is the old value of the parameter while the second one is the new value. Note that it is **not** specified if the hook is applied just before or just after the effective change.

val get : unit -> t

Option value (not necessarily set on the current command line).

val clear : unit -> unit

Set the option to its default value, that is the value if set was never called.

val is_default : unit -> bool

Is the option equal to its default value?

val get_default : unit -> t

Get the default value for the option.

val option_name : string

Name of the option on the command-line

val print_help : Stdlib.Format.formatter -> unit

Print the help of the parameter in the given formatter as it would be printed on the command line by -<plugin>-help. For invisible parameters, the string corresponds to the one returned if it would be not invisible.

include State_builder.S
val equal : t -> t -> bool
val add_aliases : ?visible:bool -> ?deprecated:bool -> string list -> unit

Add some aliases for this option. That is other option names which have exactly the same semantics that the initial option. If visible is set to false, the aliases do not appear in help messages. If deprecated is set to true, the use of the aliases emits a warning.