Functor Log.Register


module Register: 
functor (P : sig
val channel : string
val label : string
val verbose_atleast : int -> bool
val debug_atleast : int -> bool
end) -> Messages
Each plugin has its own channel to output messages. This functor should not be directly applied by plug-in developer. They should apply Plugin.Register instead.
Since Beryllium-20090601-beta1
Parameters:
P : sig val channel : string val label : string val verbose_atleast : int -> bool val debug_atleast : int -> bool end

val verbose_atleast : int -> bool
Since Beryllium-20090601-beta1
val debug_atleast : int -> bool
Since Beryllium-20090601-beta1
val set_debug_keys : string list -> unit
Keys for which debugging messages are printed by debug with optional parameter dkey.
Since Nitrogen-20111001
val get_debug_keyset : unit -> string list
Returns the registered debugging keys. Only activated if "?" is member of the current debugging keys.
Since Nitrogen-20111001
val result : ?level:int -> 'a Log.pretty_printer
Results of analysis. Default level is 1.
Since Beryllium-20090601-beta1
val feedback : ?level:int -> 'a Log.pretty_printer
Progress and feedback. Level is tested against the verbose.
Since Beryllium-20090601-beta1
val debug : ?level:int -> ?dkey:string -> 'a Log.pretty_printer
Debugging information dedicated to Plugin developpers. Default level is 1. The debugging key is used in message headers. See also set_debug_keys and set_debug_keyset.
Since Beryllium-20090601-beta1
Change in Nitrogen-20111001: Optional parameter dkey
val warning : 'a Log.pretty_printer
Hypothesis and restrictions.
Since Beryllium-20090601-beta1
val error : 'a Log.pretty_printer
user error: syntax/typing error, bad expected input, etc.
Since Beryllium-20090601-beta1
val abort : ('a, 'b) Log.pretty_aborter
user error stopping the plugin.
Since Beryllium-20090601-beta1
Raises AbortError with the channel name.
val failure : 'a Log.pretty_printer
internal error of the plug-in.
val fatal : ('a, 'b) Log.pretty_aborter
internal error of the plug-in.
Since Beryllium-20090601-beta1
Raises AbortFatal with the channel name.
val verify : bool -> ('a, bool) Log.pretty_aborter
If the first argument is true, return true and do nothing else, otherwise, send the message on the fatal channel and return false.

The intended usage is: assert (verify e "Bla...") ;.
Since Beryllium-20090601-beta1

val not_yet_implemented : ('a, Format.formatter, unit, 'b) Pervasives.format4 -> 'a
raises FeatureRequest but do not send any message. If the exception is not catched, Frama-C displays a feature-request message to the user.
Since Beryllium-20090901
val deprecated : string -> now:string -> ('a -> 'b) -> 'a -> 'b
deprecated s ~now f indicates that the use of f of name s is now deprecated. It should be replaced by now.
Since Beryllium-20090902
Returns the given function itself
val with_result : (Log.event -> 'a) -> ('b, 'a) Log.pretty_aborter
Since Beryllium-20090601-beta1
val with_warning : (Log.event -> 'a) -> ('b, 'a) Log.pretty_aborter
Since Beryllium-20090601-beta1
val with_error : (Log.event -> 'a) -> ('b, 'a) Log.pretty_aborter
Since Beryllium-20090601-beta1
val with_failure : (Log.event -> 'a) -> ('b, 'a) Log.pretty_aborter
Since Beryllium-20090601-beta1
val log : ?kind:Log.kind -> ?verbose:int -> ?debug:int -> 'a Log.pretty_printer
Generic log routine. The default kind is Result. Use cases (with n,m > 0):
Since Beryllium-20090901
val with_log : (Log.event -> 'a) -> ?kind:Log.kind -> ('b, 'a) Log.pretty_aborter
Since Beryllium-20090901
val register : Log.kind -> (Log.event -> unit) -> unit
Local registry for listeners.
val register_tag_handlers : (string -> string) * (string -> string) -> unit